Create subscription

You need your AfricasTalking username and APIKey for any request to our API. If you don't have an APIKey, please click here to get one.

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

The code uses our VB gateway class: AfricasTalkingGateway.vb [ Download]

Imports System.IO
Imports System.Collections
Imports System.Collections.Generic

Public Class Application
	Public Shared Sub Main()
		
			' Specify your login credentials
			
			Dim username As String = "myAfricasTalkingUsername"
			Dim apikey As String   = "myAPIKey"
			
			' Specify the number that you want to subscribe
			' Please ensure you include the country code (+254 for Kenya in this case)
            Dim phoneNumber As String   = "+254711XXXYYY";
			
			' Specify your Africa's Talking premium short code and keyword
			Dim shortCode As String = "myAfricasTalkingShortCode"
			Dim keyword As String  = "myAfricasTalkingKeyword"
			
			' Create a new instance of our awesome gateway class
			Dim gateway As New AfricasTalkingGateway(username, apikey)
			
			' Wrap the function call in a Try block
			' Any Exception will be captured by our custom AfricasTalkingException class
			
			Try
				Object result = gateway.createSubscription(phoneNumber, shortCode, keyword)
				System.Console.WriteLine("Status: " + result("status"))
				System.Console.WriteLine("Description: " + result("description"))
				
			catch ex As AfricasTalkingGatewayException
				System.Console.WriteLine(ex.Message())
		
		End Try 
	End Sub
End Class
To receive messages you will need to make a HTTP POST request to the following url:
POST URL: http://api.africastalking.com/version1/subscription/create
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
<?xml version="1.0"?>
  <AfricastalkingResponse>
    <status>Success</status>
    <description>Waiting for user input</description>
</AfricastalkingResponse>
JSON

{
  "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" https://api.africastalking.com/version1/subscription/create --insecure