Visit your regional website: Clickatell Ireland Regional Website Clickatell Australia Regional Website Clickatell United Kingdom Regional Website Clickatell United States Regional Website Clickatell India Regional Website Clickatell South Africa Regional Website
  • Developer Solutions

 

 

    

You are here: Developer Solutions | SOAP

soap API icon

Using SOAP to connect to our gateway
Easy integration and HTTP/HTTPS compatibility

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.

Clickatell: Sign up today

What you can do when you connect using SOAP:
  • Like all our APIs, the SOAP connection supports text, Unicode, binary SMS and flash messaging.
  • It gives you support for extended length messages.
  • You're able to use our converters to turn ringtones and logos into the correct format.
  • You can use our VCard and VCal converters.
  • Delivery acknowledgement and sender ID can be set up.
  • You will have access to gateway escalation which prompts an escalation to an alternative delivery gateway, should the message be delayed for a predefined length of time, and queuing which lets you specify up to 3 prioritised queues according to which your messages will be sent out.
  • Delivery delay gives you the ability to specify a delay of up to 7 days when sending messages.
  • You can set up batch sending.
  • Two-way messaging is available.
  • Take a look at the full list of our Clickatell gateway features and supported message types.

What does it cost?

There's no charge to connect to our gateway using the SOAP API. To send messages via the gateway you need simply to purchase message credits. The cost of these varies depending on the volume purchased and the destination you intend sending to.

We have a convenient calculator to help you calculate your message costs.

Free trial:

Sign up and we'll give you 10 free message credits which you can use to test the connection.

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 [ 382K ]
SOAP FAQ
SOAP Guides

Sign up for SOAP

 
  Terms | Privacy | Site Map Copyright © 2009 Clickatell (Pty) Ltd Bulk SMS Gateway
       
Payment Options   Associations and Security  
Clickatell: Payment methods


Clickatell: MMA logo Clickatell: GSM Clickatell: Thawte Click to verify BBB accreditation and to see a BBB report.