Provides convenient access to the Africa's Talking API from applications written in ruby.
Take a look at the API docs here.
Add this line to your application's Gemfile:
gem "AfricasTalking", :git => "git@github.com:AfricasTalkingLtd/africastalking-ruby.git"
And then execute:
$ bundle
The SDK needs to be instantiated using your 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
username = 'YOUR_USERNAME' # use 'sandbox' for development in the test environment
apiKey = 'YOUR_API_KEY' # use your sandbox app API key for development in the test environment
@gateway=AfricasTalking::Gateway.new(username, apiKey)
You can now make API calls using the @gateway object
token = @gateway.token
token.createCheckoutToken phoneNumber
phoneNumber
: The phone number you want to create a subscription for
token.createCheckoutToken phoneNumber
phoneNumber
: The phone number you want to create a subscription for
Send airtime to phone numbers
airtime = @gateway.airtime
airtime.sendAirtime recipients
recipients
: Contains an hash of arrays containing the following keysphoneNumber
: Recipient of airtimeamount
: Amount sent>= 10 && <= 10K
with currency e.gKES 100
sms = @gateway.sms
sms.sendMessage message, to, from, enqueue, bulkSMSMode, retryDurationInHours
message
: SMS content.REQUIRED
to
: A single recipient or a comma separated string of recipients.REQUIRED
from
: Shortcode or alphanumeric ID that is registered with Africa's Talking account.OPTIONAL
enqueue
: Set totrue
if you would like to deliver as many messages to the API without waiting for an acknowledgement from telcos.OPTIONAL
bulkSMSMode
: This parameter will be used by the Mobile Service Provider to determine who gets billed for a message sent using a Mobile-Terminated ShortCode. The default value is 1 (which means that the sender (The AfricasTalking account being used ) gets charged).OPTIONAL
retryDurationInHours
: t specifies the number of hours your subscription message should be retried in case it's not delivered to the subscriber.OPTIONAL
sms.sendPremiumMessage message, keyword, linkId, to, from, enqueue, bulkSMSMode, retryDurationInHours
message
: SMS content.REQUIRED
keyword
: The keyword to be used for a premium service.REQUIRED
linkId
: This parameter is used for premium services to send OnDemand messages. We forward the linkId to your application when the user send a message to your service..REQUIRED
to
: A single recipient or a comma separated string of recipients.REQUIRED
from
: Shortcode or alphanumeric ID that is registered with Africa's Talking account.OPTIONAL
enqueue
: Set totrue
if you would like to deliver as many messages to the API without waiting for an acknowledgement from telcos.OPTIONAL
bulkSMSMode
: This parameter will be used by the Mobile Service Provider to determine who gets billed for a message sent using a Mobile-Terminated ShortCode. The default value is 1 (which means that the sender (The AfricasTalking account being used ) gets charged).OPTIONAL
retryDurationInHours
: t specifies the number of hours your subscription message should be retried in case it's not delivered to the subscriber.OPTIONAL
sms.fetchMessages lastReceivedId
lastReceivedId
: This is the id of the message that you last processed. The default is 0OPTIONAL
sms.createSubcriptions shortCode, keyword, phoneNumber, checkoutToken
shortCode
: This is a premium short code mapped to your account.REQUIRED
keyword
: Value is a premium keyword under the above short code and mapped to your account.REQUIRED
phoneNumber
: The phoneNumber to be subscribedREQUIRED
checkoutToken
: This is a token used to validate the subscription requestREQUIRED
sms.fetchSubscriptions shortCode, keyword, lastReceivedId
shortCode
: This is a premium short code mapped to your account.REQUIRED
keyword
: Value is a premium keyword under the above short code and mapped to your account.REQUIRED
lastReceivedId
: ID of the subscription you believe to be your last. Defaults to0
voice = @gateway.voice
voice.call to, from
to
: A single recipient or an array of recipients.REQUIRED
- array of recipients contains ['2XXXXXXXX', '2XXXXXXXX']
from
: Shortcode or alphanumeric ID that is registered with Africa's Talking account.REQUIRED
voice.fetchQueuedCalls phoneNumber
phoneNumber
: is phone number mapped to your AfricasTalking account.REQUIRED
voice.uploadMediaFile url, phoneNumber
url
: The url of the file to upload. Don't forget to start with http://REQUIRED
phoneNumber
: is phone number mapped to your AfricasTalking account.REQUIRED
account = @gateway.account
account.fetchUserData
payments = @gateway.payments
payments.initiateCardCheckout productName, currencyCode, amount, narration, checkoutToken, paymentCard, metadata
productName
: Payment Product as setup on your account.REQUIRED
currencyCode
: 3-digit ISO format currency code (onlyNGN
is supported).REQUIRED
amount
: Payment amount.REQUIRED
narration
: A short description of the transactionREQUIRED
checkoutToken
: Token that has been generated by our APIs as as result of charging a user's Payment Card in a previous transaction. When using a token, thepaymentCard
data should NOT be populated.OPTIONAL
paymentCard
: Hash of payment Card to be charged:OPTIONAL
number
: The payment card number.REQUIRED
cvvNumber
: The 3 or 4 digit Card Verification Value.REQUIRED
expiryMonth
: The expiration month on the card (e.g8
)REQUIRED
authToken
: The card's ATM PIN.REQUIRED
countryCode
: The 2-Digit countryCode where the card was issued (onlyNG
is supported).REQUIRED
metadata
: Some optional data to associate with transaction.OPTIONAL
payments.validateCardCheckout transactionId, otp
transactionId
: The transaction that your application wants to validate.REQUIRED
otp
: One Time Password that the card issuer sent to the client.REQUIRED
payments.initiateBankChargeCheckout productName, bankAccount, currencyCode, amount, narration, metadata = {}
-
productName
: Payment Product as setup on your account.REQUIRED
-
bankAccount
: Hash of bank account to be charged:accountName
: The name of the bank account.REQUIRED
accountNumber
: The account number.REQUIRED
bankCode
: A 6-Digit Integer Code for the bank that we allocate. Seepayments.BANK.*
for supported banks.REQUIRED
dateOfBirth
: Date of birth of the account owner (YYYY-MM-DD
). Required for Zenith Bank Nigeria.
-
currencyCode
: 3-digit ISO format currency code (onlyNGN
is supported).REQUIRED
-
amount
: Payment amount.REQUIRED
-
narration
: A short description of the transactionREQUIRED
-
metadata
: Some optional data to associate with transactionOPTIONAL
payments.validateBankAccountCheckout transactionId, otp
transactionId
: The transaction that your application wants to validate.REQUIRED
otp
: One Time Password that the bank sent to the client.REQUIRED
payments.initiateBankTransferRequest productName, recipients
productName
: Payment Product as setup on your account.REQUIRED
recipients
: A list of recipients. Each recipient has:bankAccount
: Bank account to be charged:accountName
: The name of the bank account.accountNumber
: The account numberREQUIRED
bankCode
: A 6-Digit Integer Code for the bank that we allocate; Seepayments.BANK.*
for supported banks.REQUIRED
currencyCode
: 3-digit ISO format currency code (onlyNGN
is supported).REQUIRED
amount
: Payment amount.REQUIRED
narration
: A short description of the transactionREQUIRED
metadata
: Some optional data to associate with transaction.
payments.initiateMobilePaymentCheckout productName, phoneNumber, currencyCode, amount, metadata
productName
: Your Payment Product.REQUIRED
phoneNumber
: The customer phone number (in international format; e.g.25471xxxxxxx
).REQUIRED
currencyCode
: 3-digit ISO format currency code (e.gKES
,USD
,UGX
etc.)REQUIRED
amount
: This is the amount.REQUIRED
metadata
: Some optional data to associate with transaction.OPTIONAL
payments.mobilePaymentB2CRequest productName ,recipients
-
productName
: Your Payment Product.REQUIRED
-
recipients
: A list of up to 10 recipients. Each recipient has:-
phoneNumber
: The payee phone number (in international format; e.g.25471xxxxxxx
).REQUIRED
-
currencyCode
: 3-digit ISO format currency code (e.gKES
,USD
,UGX
etc.)REQUIRED
-
amount
: Payment amount.REQUIRED
-
reason
: This field contains a string showing the purpose for the payment. If set, it should be one of the followingSalaryPayment SalaryPaymentWithWithdrawalChargePaid BusinessPayment BusinessPaymentWithWithdrawalChargePaid PromotionPayment
-
metadata
: Some optional data to associate with transaction.
-
payments.mobilePaymentB2BRequest productName, providerData, currencyCode, amount, metadata
-
productName
: Your Payment Product as setup on your account.REQUIRED
-
providerData
: Hash containing Provider details. this include;REQUIRED
-
provider
: String that shows the payment provider that is facilitating this transaction. Supported providers at the moment are:Athena - Please note: This is not available on our production systems Mpesa
-
transferType
: This contains the payment provider that is facilitating this transaction. Supported providers at the moment are:BusinessBuyGoods BusinessPayBill DisburseFundsToBusiness BusinessToBusinessTransfer
-
destinationChannel
: This value contains the name or number of the channel that will receive payment by the provider.REQUIRED
-
destinationAccount
: This value contains the account name used by the business to receive money on the provided destinationChannel.REQUIRED
-
-
currencyCode
: 3-digit ISO format currency code (e.gKES
,USD
,UGX
etc.)REQUIRED
-
amount
: Payment amount.REQUIRED
-
metadata
: Some optional data to associate with transaction.OPTIONAL
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/AfricasTalkingLtd. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.