The wrapper provides convenient access to the Africa's Talking API from applications written for Node.js.
Take a look at the API docs here.
You can install the package from npm by running:
$ npm install --save africastalking
The package needs to be configured with your app username and API key, which you can get from the dashboard.
You can use this SDK for either production or sandbox apps. For sandbox, the app username is ALWAYS
sandbox
const credentials = {
apiKey: 'YOUR_API_KEY', // use your sandbox app API key for development in the test environment
username: 'YOUR_USERNAME', // use 'sandbox' for development in the test environment
};
const Africastalking = require('africastalking')(credentials);
// Initialize a service e.g. SMS
const sms = Africastalking.SMS
// Use the service
const options = {
to: ['+254711XXXYYY', '+254733YYYZZZ'],
message: "I'm a lumberjack and its ok, I work all night and sleep all day"
}
// Send message and capture the response or error
sms.send(options)
.then( response => {
console.log(response);
})
.catch( error => {
console.log(error);
});
See example for more usage examples.
Initialize the SDK as a requirement by doing require('africastalking')(options)
. After initialization, you can get instances of offered services as follows:
-
Application Service :
AfricasTalking.APPLICATION
-
Airtime Service :
AfricasTalking.AIRTIME
-
SMS Service :
AfricasTalking.SMS
-
Voice Service :
AfricasTalking.VOICE
-
Token Service :
AfricasTalking.TOKEN
-
USSD : USSD API
All methods are asynchronous
All phone numbers use the international format. e.g. +234xxxxxxxx
.
fetchApplicationData()
: Get app information. e.g. balance
For more information, please read https://developers.africastalking.com/docs/application
-
airtime.send({ recipients })
: Send airtime to a bunch of phone numbers. -
recipients
: An array of objects containing the following keys:phoneNumber
: Recipient of airtime.REQUIRED
.currencyCode
: 3-digit ISO format currency code.REQUIRED
.amount
: Amount to charge.REQUIRED
.
-
maxNumRetry
: This allows you to specify the maximum number of retries in case of failed airtime deliveries due to various reasons such as telco unavailability. The default retry period is 8 hours and retries occur every 60seconds. For example, settingmaxNumRetry=4
means the transaction will be retried every 60seconds for the next 4 hours.OPTIONAL
. -
Example:
airtime.send({
recipients: [
{
phoneNumber: '+xxxxxxxxxxxx',
currencyCode: 'KES',
amount: 90
},
{
phoneNumber: '+xxxxxxxxxxxx',
currencyCode: 'KES',
amount: 897
}
],
maxNumRetry: 3, // Will retry the transaction every 60seconds for the next 3 hours.
});
For more information, please read https://developers.africastalking.com/docs/airtime/sending
-
Send a message to one recipient.
send({ to: '+xxxxxxxxxxxx', from: 'XYZ LTD', message: 'Hello world', enqueue: true, });
-
Send a message to multiple recipients.
send({ to: ['+xxxxxxxxxxxx','+yyyyyyyyyyyy','+zzzzzzzzzzzz'], from: 'XYZ LTD', message: 'Hello world', enqueue: true, });
-
Send different messages to different recipients.
send([ { to: ['+aaaaaaaaaaaa','+bbbbbbbbbbbb','+cccccccccccc'], from: 'XYZ LTD', message: 'Congratulations team! You have won it!', enqueue: true, }, { to: '+xxxxxxxxxxxx', from: 'XYZ LTD', message: 'Congratulations coach! Your team has won!', enqueue: true, } ]);
to
: Recipient(s) phone number.REQUIRED
from
: Shortcode or alphanumeric ID that is registered with Africa's Talking accountmessage
: SMS content.REQUIRED
enqueue
: Set to true if you would like to deliver as many messages to the API without waiting for an acknowledgement from telcos.
-
sendPremium({ to, from, message, enqueue, keyword, linkId, retryDurationInHours })
: Send premium SMSsend()
parameters plus:keyword
: You premium product keywordlinkId
: We forward thelinkId
to your application when the user send a message to your serviceretryDurationInHours
: It specifies the number of hours your subscription message should be retried in case it's not delivered to the subscriber
-
fetchMessages({ lastReceivedId })
: Manually retrieve your messageslastReceivedId
: "This is the id of the message that you last processed". Defaults to0
-
fetchSubscription({ shortCode, keyword, lastReceivedId })
: Fetch your premium subscription datashortCode
: This is the premium short code mapped to your account.REQUIRED
keyword
: A premium keyword under the above short code and mapped to your account.REQUIRED
lastReceivedId
: "This is the id of the message that you last processed". Defaults to0
-
createSubscription({ shortCode, keyword, phoneNumber })
: Create a premium subscriptionshortCode
: This is the premium short code mapped to your account.REQUIRED
keyword
: A premium keyword under the above short code and mapped to your account.REQUIRED
phoneNumber
: The phone number to be subscribed.REQUIRED
For more information on:
- SMS service: https://developers.africastalking.com/docs/sms/overview
- How to fetch subscriptions: https://developers.africastalking.com/docs/sms/premium_subscriptions/fetch
- How to listen for subscription notifications: https://developers.africastalking.com/docs/sms/notifications
-
voice.call({ callFrom, callTo })
: Initiate a phone callcallFrom
: Your Africa's Talking issued virtual phone number.REQUIRED
callTo
: Comma-separated string of phone numbers to call.REQUIRED
clientRequestId
: Additional information that can be used to tag the call in your callback URL.
-
voice.fetchQuedCalls({ phoneNumber })
: Get queued callsphoneNumber
: Your Africa's Talking issued virtual phone number.REQUIRED
-
voice.uploadMediaFile({ phoneNumber, url })
: Upload voice media filephoneNumber
: Your Africa's Talking issued virtual phone number.REQUIRED
url
: URL to your media file.REQUIRED
Helpers that will construct proper
xml
to send back to Africa's Taking API when it comesPOST
ing.
Say
,Play
,GetDigits
,Dial
,Record
,Enqueue
,Dequeue
,Conference
,Redirect
,Reject
Remember to send back an HTTP 200.
For more information, please read https://developers.africastalking.com/docs/voice/overview and issue #15
generateAuthToken()
: Generate an auth token to use for authentication instead of an API key.
For more information, please read https://developers.africastalking.com/docs/ussd/overview
Run all tests:
$ npm install
$ npm test
or on Windows...
$ npm install
$ npm run test-windows
If you find a bug, please file an issue on our issue tracker on GitHub.