Send SMS

To send a message you will need to make a HTTP POST request to the following url:
POST URL: http://api.africastalking.com/version1/messaging
The server expects:
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 username Yes
to Body The recipients Yes
message Body This is the message to b sent Yes
from Body Shortcode or alphanumeric that is registered with your Africa's Talking account. If missing, the default value (20414) will be populated on the message No
bulkSMSMode Body 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). This parameter will be ignored for messages sent using alphanumerics or Mobile-Originated shortcodes. The value must be set to 1 for bulk messages No
enqueue Body This parameter is used for Bulk SMS clients that would like deliver as many messages to the API before waiting for an Ack from the Telcos. If enabled, the API will store the messages in its databases and send them out asynchronously after responding to the request No
keyword Body This parameter is used for premium services. It is essential for subscription premium services. No (Essential for subscription premium services)
linkId Body 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. No (Essential for onDemand services.)
retryDurationInHours Body This parameter is used for premium messages. It specifies the number of hours your subscription message should be retried in case it's not delivered to the subscriber. No

Upon successful processing, the server shall respond in the following format:
XML
                        
<?xml version="1.0"?>
  <AfricastalkingResponse>
   <SMSMessageData>
     <Recipients>
       <Recipient>
         <number>+254711XXXYYY</number>
         <cost>KES YY</cost>
         <status>Success</status>
         <messageId>ATSid_1</messageId>
       </Recipient>
       .
       .
       .
       .
       <Recipient>
         <number>+254733YYYZZZ</number>
         <cost>KES XX</cost>
         <messageId>ATSid_2</messageId>
       </Recipient>
       
      </Recipients>
    </SMSMessageData>
  </AfricastalkingResponse>
 
JSON

{"SMSMessageData":
  {"Recipients":
    [
      {
       "number"    : "+254711XXXYYY",
       "cost"      : "KES YY",
       "status"    : "Success",
       "messageId" : "ATSid_1"
      },
      .
      .
      .
      .
      {
        "number"    : "+254733YYYZZZ",
        "cost"      : "KES XX",
        "status"    : "Success",
        "messageId" : "ATSid_n"
      }
    ]
  }
}
Example using CURL client
curl -v -H "Accept: application/xml" -d "username=myusername&message=hello test&to=+254711XXXYYY,+254733YYYZZZ" -H "Apikey:fb752d3417021812f0961y6c9464832dd1adb1
e555c73f1e7c32bcc006488674" -X POST http://api.africastalking.com/version1/messaging --insecure

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

Send messages via url call

Our APIs allows a sender to send messages by opening a URL link. That's how easy it is to send a message.

The response is in XML format. see the xml response here

Sending a Message

# send to a single user

https://api.africastalking.com/restless/send?username=myusername&Apikey=XXXX&to=+254711XXXYYY&message=We love code


# send to many users: comma-separate numbers as shown

https://api.africastalking.com/restless/send?username=myusername&Apikey=XXXX&to=+254711XXXYYY,+254733YYYZZZ&message=We love code

Sending messages: Use short code/Sender id

# for sender id

https://api.africastalking.com/restless/send?username=myusername&Apikey=XXXX&from=MYSENDERID&to=+254711XXXYYY&message=We love code

# for short code

https://api.africastalking.com/restless/send?username=myusername&Apikey=XXXX&from=MYShortCode&to=+254711XXXYYY&message=We love code

Sending messages: Queue messages to be sent later


# from parameter is optional

https://api.africastalking.com/restless/send?username=myusername&Apikey=XXXX&from=MYSENDERID&to=+254711XXXYYY&enqueue=1&message=We love code

Sending premium rated (subscription) messages

# set bulkSMSMode flag to 0

https://api.africastalking.com/restless/send?username=myusername&Apikey=XXXX&from=MyShortCode&keyword=MyPremiumKeyword&bulkSMSMode=0&to=+254711XXXYYY&message=My daily quote