Create subscription

You need your AfricasTalking username and APIKey for any request to our API. If you don't have an APIKey, you can generate one from your applications settings page.

The Ruby code snippet below shows how to add a number to a subscription service using our API.

The code uses our Ruby and Rails gateway class: AfricasTalkingGateway.rb [ Download]

# Include the helper gateway class
require './AfricasTalkingGateway'

# Specify your login credentials
username = "MyAppUsername";
apikey   = "MyAppAPIKey";

#Specify the number that you want to subscribe
#Please ensure you include the country code (+254 for Kenya in this case)
phoneNumber   = "+254711XXXYYY";
#Specify your Africa's Talking short code and keyword
shortCode = "MyAppShortCode";
keyword   = "MyAppKeyword";

# Create a new instance of our awesome gateway class
gateway =, apikey)

# Any gateway error will be captured by our custom Exception class below,
# so wrap the call in a try-catch block
  result = gateway.createSubscription(phoneNumber, shortCode, keyword)
  puts 'status=' + result['status'] + ' ;Description=' + result['description']
rescue AfricasTalkingGatewayException => ex
  puts 'Encountered an error: ' + ex.message


To receive messages you will need to make a HTTP POST request to the following url:
The server shall expect:
Parameter Location Description Required
API key Header API key generated from your account settings Yes
Accept Header This is the format you would like your data formatted. It may be application/xml or application/json. The default is application/xml. The gateway classes provided uses appliaction/json. No
username Body This is your Africa'sTalking username Yes
shortCode Body This is a premium short code mapped to your account Yes
keyword Body Value is a premium keyword under the above short code and mapped to your account Yes
phoneNumber Body The phoneNumber to be subscribed Yes
Upon successful processing, the server shall respond in the following format:
<?xml version="1.0"?>
    <description>Waiting for user input</description>

  "status": "Success",
  "description": "Waiting for user input"
Example using CURL client
curl -H "Accept: application/xml" -H "Apikey:fb752d3417021812f0961y6c9464832dd1adb1e555c73f1e7c32bcc006488674" -d "username=myUsername&shortCode=12345&keyword=myPremiumKeyword&phoneNumber=+254711XXXYYY" --insecure