Fetch premium subscriptions

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 your premium shortcode and keyword
			Dim shortCode As String = "XXXXX";
			Dim keyword As String = "myPremiumKeyword";
			
			' Create a new instance of our awesome gateway class
			Dim gateway As New AfricasTalkingGateway(username, apikey)
			
			' Our gateway will return 100 subscription numbers at a time back to you, starting with
			' what you currently believe is the lastReceivedId. Specify 0 for the first
			' time you access the gateway, and the ID of the last number we sent you
			' on subsequent results
			
			Dim lastReceivedId As Integer = 0;
			
			' Any gateway errors will be captured by our custom Exception class below,
			' so wrap the call in a try-catch block
			
			Try
			 
			 Dim subscriptions As Object() = gateway.fetchPremiumSubscriptions(shortCode, keyword, lastReceivedId)
			 
			 While subscriptions.Length > 0
			 	
			 	Dim result As Object
			 	for each result in subscriptions
			 		System.Console.WriteLine("Phone number: " + result("phoneNumber"))
			 		lastReceivedId = result("id")
			 	next
			 	
			 	subscriptions = gateway.fetchPremiumSubscriptions(shortCode, keyword, lastReceivedId)
			 	
			 End While
			 
		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 GET request to the following url:
GET URL: http://api.africastalking.com/version1/subscription
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 URL This is your Africa'sTalking username Yes
shortCode URL This is a premium short code mapped to your account Yes
keyword URL Value is a premium keyword under the above short code and mapped to your account Yes
lastReceivedId URL ID of the subscription you believe to be your last. Set it to 0 to for the first time. Yes
Upon successful processing, the server shall respond in the following format:
XML
<?xml version="1.0"?>
  <AfricastalkingResponse>
    <Subscriptions>
      <Subscription>
        <id>100</id>
        <phoneNumber>+254711XXXYYY</phoneNumber>
        <date>Timestamp</date>
      </Subscription>
      .
      .
      .
      .
      <Subscription>
        <id>200</id>
        <phoneNumber>+254733YYYZZZ</phoneNumber>
        <date>Timestamp</date>
      </Subscription>
    </Subscriptions>
</AfricastalkingResponse>
JSON

{"Subscriptions" :
  [
    {
      "id" : 100,
      "phoneNumber" : "+254711XXXYYY",
      "date" : "Timestamp"
    }
    .
    .
    .
    .
    {
      "id" : 200,
      "phoneNumber" : "+254733YYYZZZ",
      "date" : "Timestamp"
    }
  ]
}
Example using CURL client
curl -H "Accept: application/xml" -H "Apikey:fb752d3417021812f0961y6c9464832dd1adb1e555c73f1e7c32bcc006488674" "https://api.africastalking.com/version1/subscription?username=myUsername&shortCode=12345&keyword=myPremiumKeyword" --insecure