Sign up today and get 10 FREE messages
You are here: Home > APIs & Scripts > APIs > SOAP

SOAP

SOAP is a protocol for exchanging XML-based messages using HTTP/HTTPS. SOAP forms the foundation layer of the web services protocol stack providing a basic messaging framework upon which abstract layers can be built.

Download the SOAP Developer Guide

Features of SOAP API

  • Supports text, Unicode, binary SMS and flash messaging.
  • Supports extended length messages.
  • Converts ringtones and logos into the correct format.
  • Use our VCard and VCal converters.
  • Delivery acknowledgement and Sender ID can be set up.
  • Gateway escalation: Should the message be delayed for a predefined length of time, it can be escalated to an alternative delivery gateway. Queuing lets you specify up to 3 prioritized queues which your messages can be sent out on.
  • Specify a delay of up to 7 days when sending messages.
  • Batch sending and two-way messaging.

SOAP API Quickstart Guide

This tutorial will explain in just a few simple steps how you can send an SMS using Clickatell’s SOAP API.  Note: in the manual example outlined below it is assumed that developers will utilize server-generated commands to insert these posts into their code automatically.


  • Step 1

    Register for the SOAP API. Go to the SOAP API page and click on the Sign Up Now button.

  • Step 2

    Next fill in your registration details on the registration form and press “submit”.  The 3 pieces of information you will need to send an SMS will be your “username”, your “password” and your API_ID.  Your API_ID gets issued immediately upon confirmation of registration. Note:  Once you have registered and been activated, you will automatically receive 10 FREE SMS credits which you can use for testing.

  • Step 3

    Have the following information ready:
    User: xxxx
    Password: xxxx
    Api_ID: xxxx
    To: xxxxxxx (number you would like to send the message to in an international format e.g. 448311234567)

  • Step 4

    Replace the authentication details and destination number in the SOAP packet below with your details and submit it to http://api.clickatell.com/soap/webservice.php:

    <?xml version="1.0" encoding="ISO-8859-1"?> <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="soap.clickatell.com"> <SOAP-ENV:Body>

    <tns:sendmsg xmlns:tns="soap.clickatell.com"> <session_id xsi:nil="true" xsi:type="xsd:string"/> <api_id xsi:type="xsd:int">1234</api_id> <user xsi:type="xsd:string">demo</user> <password xsi:type="xsd:string">demo</password>

    <to xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[2]"> <item xsi:type="xsd:string">2799912345</item> <item xsi:type="xsd:string">27999123134</item> </to>

    <from xsi:type="xsd:string">me</from> <text xsi:type="xsd:string">Initial test message</text> <concat xsi:nil="true" xsi:type="xsd:int"/> <deliv_ack xsi:nil="true" xsi:type="xsd:int"/> <callback xsi:nil="true" xsi:type="xsd:int"/> <deliv_time xsi:nil="true" xsi:type="xsd:int"/> <max_credits xsi:nil="true" xsi:type="xsd:float"/> <req_feat xsi:nil="true" xsi:type="xsd:int"/> <queue xsi:nil="true" xsi:type="xsd:int"/> <escalate xsi:nil="true" xsi:type="xsd:int"/> <mo xsi:nil="true" xsi:type="xsd:int"/> <cliMsgId xsi:nil="true" xsi:type="xsd:string"/> <unicode xsi:nil="true" xsi:type="xsd:int"/> <msg_type xsi:nil="true" xsi:type="xsd:string"/> <udh xsi:nil="true" xsi:type="xsd:string"/> <data xsi:nil="true" xsi:type="xsd:string"/> <validity xsi:nil="true" xsi:type="xsd:int"/> </tns:sendmsg>

    </SOAP-ENV:Body> </SOAP-ENV:Envelope>

    Sign up for Developers’ Central now and get 10 free test messages