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 PHP code snippet below shows how to fetch subscribed numbers from a subscription service using our API.

The code uses our PHP gateway class: AfricasTalkingGateway.php [ Download]

Also, please ensure that you have the php_curl module enabled. To enable it uncomment the line: ;extension=php_curl.dll in php.ini and restart apache

<?php
// Include the helper gateway class
require_once('AfricasTalkingGateway.php');

// Specify your login credentials
$username   = "MyAfricasTalkingUsername";
$apikey     = "MyAfricasTalkingAPIKey";

// Specify your premium shortcode and keyword
$shortCode = "XXXXX";
$keyword   = "myPremiumKeyword";

// Create a new instance of our awesome gateway class
$gateway  = new AfricasTalkingGateway($username, $apikey);

// Any gateway errors will be captured by our custom Exception class below, 
// so wrap the call in a try-catch block
try 
{
  // 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 message we sent you
  // on subsequent results
  $lastReceivedId = 0;
  
  // Here is a sample of how to fetch all messages using a while loop
  do {
    
    $results = $gateway->fetchPremiumSubscriptions($shortCode, $keyword, $lastReceivedId);
    foreach($results as $result) {
      
      echo " From: " .$result->phoneNumber;
      echo " id: ".$result->id;
      echo "\n";
      $lastReceivedId = $result->id;
      
      
    }
  } while ( count($results) > 0 );
  
  // NOTE: Be sure to save lastReceivedId here for next time
  
}
catch ( AfricasTalkingGatewayException $e )
{
  echo "Encountered an error: ".$e->getMessage();
}
// DONE!!!

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