• Developer Solutions

 

 

You are here: Developer Solutions | Clickatell's SOAP Protocol

Clickatell API icon

Clickatell's SOAP Protocol

Any site, application or prograamme can be SMS-enabled with Clickatell's API's

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

Our SOAP Protocol is right for you, if as a mobile applications developer...
  • You need to enable two-way SMS text messaging.
  • You need to be able to send batch SMS messages with personalised messages.
  • You need to enable functions such as Token Pay for 'spend a voucher' campaigns.
  • You need to offer escalation to an alternative gateway for delayed text message delivery. And to be able to set up priority levels for queues.
  • You need a set-up period for bulk SMS sending; Clickatell offers you a 7-day delivery delay window.
  • You need to be able to query network coverage status as well as text message delivery status.
  • You need to set maximum credit limits on text messages purchased and sent.
  • You need to specify the features that you need.
The entire range of SMS Gateway API connections has the following features:
  • They are all fast, reliable and easy to integrate into any system.
  • They all support text, Unicode, binary SMS, EMS and Flash text messaging.
  • They all support extended length messages.
  • They all offer delivery acknowledgment.
  • They all allow customers to specify sender ID details.
  • They all come with excellent documentation, script libraries and converters.
  • They all offer logo and ringtone converters (VCards and VCal).
  • Most of them have bi-directional features and so we can offer two-way messaging capability in over 100 countries.
  • Clickatell's technical staff is extensively trained in all products.
  • Clickatell offers an extensive network reach to over 222 countries through more than 819 networks.

We offer you 10 message credits to test our SMS Gateway with a free trial of our SOAP Protocol.

How to connect using SOAP:
  • Sign up for a SOAP account and you will be given a username, password and api_id: keep these at hand.
  • Once you have registered and been activated you will receive 10 free credits with which to test our service.
  • Have the number you wish to send to ready in international format e.g. 448311234567.
  • 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 SOAP


SOAP Resources:

SOAP Specification Version 1.1.4
SOAP FAQ
SOAP Guides

Clickatell AU: Calculate Message Costs



privacy off Click to verify BBB accreditation and to see a BBB report.