Africa's Talking Airtime (Preview)
Provides actions to distribute airtime to your users instantly via Africa's Talking's Airtime service and to watch for status notifications regarding these airtime requests
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Advice and answers from the Africa's Talking Team |
| URL | https://help.africastalking.com/en/ |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Africa's Talking |
| Website | https://africastalking.com/airtime |
| Privacy policy | https://africastalking.com/privacy_policy |
| Categories | Communication;Finance |
Africa's Talking Airtime provides an API that allows you to distribute pinless airtime to mobile subscribers, receiving discounts for each transaction you make. This connector exposes operations that enable one to send airtime to mobile subscribers as well as to watch for notifications indicating whether the delivery was successful or failed.
Pre-requisites
In order to use this connector, you will need the following:
- An account with Africa's Talking; you can sign up here.
- A live production application; you can create one after registering.
Once you've signed up and you've created a live application, generate a new API Key for that application; you will use this key to authenticate your requests from this connector.
You will also need to contact us to activate the airtime product for your application; do so by sending an email to [email protected].
How to get credentials?
This connector uses API Key authentication. Once you've signed up and you've created a production ready application, click on this application to switch to its dashboard. Navigate to Settings > API Key to generate a new API Key for this application.
Known issues and limitations
This connector currently only works with production ready applications, so DO NOT use the default sandbox application's API key.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Find transaction status |
Find a particular airtime transaction's status |
| Send Airtime |
Send airtime to multiple recipients |
Find transaction status
Find a particular airtime transaction's status
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Username
|
username | True | string |
Your application's username |
|
Transaction ID
|
transactionId | True | string |
ID of the transaction you'd like to find. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
status | string |
status |
Send Airtime
Send airtime to multiple recipients
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Username
|
username | True | string |
Your application's username. |
|
Phone Number
|
phoneNumber | True | string |
Phone number to be topped up in international format (e.g +234811222333) |
|
Amount
|
amount | True | string |
The value of airtime to send together with the currency code (e.g. KES 10.00). |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
errorMessage
|
errorMessage | string |
errorMessage |
|
numSent
|
numSent | integer |
numSent |
|
responses
|
responses | array of object |
responses |
|
amount
|
responses.amount | string |
amount |
|
discount
|
responses.discount | string |
discount |
|
errorMessage
|
responses.errorMessage | string |
errorMessage |
|
phoneNumber
|
responses.phoneNumber | string |
phoneNumber |
|
requestId
|
responses.requestId | string |
requestId |
|
status
|
responses.status | string |
status |
|
totalAmount
|
totalAmount | string |
totalAmount |
|
totalDiscount
|
totalDiscount | string |
totalDiscount |
Triggers
| When you receive an Airtime Status Notification |
Triggered when you receive an delivery status notification for an initial request to send airtime. |
When you receive an Airtime Status Notification
Triggered when you receive an delivery status notification for an initial request to send airtime.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Username
|
username | True | string |
Your application's username |
Returns
- response
- object
Definitions
object
This is the type 'object'.