• Developer Solutions

 

   

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

Clickatell API icon

The SOAP Protocol SMS Gateway API

Clickatell's API SMS gateway API's are easy to integrate and easy to use.

The SOAP Protocol API 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. Clickatell's SOAP API uses the XML-based Web Services Description Language to provide a model for describing Web services.

  Clickatell: Sign up now
Advantages of using our SOAP Protocol API:
  • Clients have access to gateway escalation and queuing options .
  • They have the option of delaying delivery giving them up to 7 days to load their text messages prior to sending.
  • It enables two-way SMS text messaging.
  • Clients can specify a maximum credit limit.
  • Clients can query coverage as well as the statuses of their SMS text messages (both push and pull).
  • It allows for batch sending of SMS messages.
  • Clients can specify features that they need.
  • It enables Token Pay for 'spend a voucher' campaigns.

All of Clickatell's API mobile messaging solutions offer the following features:

  • Almost immediate SMS text messaging functionality for any site or application.
  • Clickatell's mobile messaging API's support text, Unicode, binary SMS, EMS and Flash messaging.
  • Our SMS Gateway API's support extended length messages.
  • Clickatell's mobile messaging API products come with extensive documentation and script libraries , saving you precious development time.
  • VCard and VCal converters are available at no charge for logo and ringtone conversions.
  • Our SMS Gateway API's have delivery acknowledgement features and customized sender ID options.
  • Two-way text messaging is enabled for most of our products and we can offer this feature through 819 networks in 222 countries.
  • Automatic rerouting to an alternative delivery gateway i f a message is delayed for a client specified period of time.
  • Customer-specified priority level SMS delivery queues.
  • SMS delivery delay of up to 7 days (excluding SMPP API).
  • Customers can query network coverage as well as text message status for both inbound and outbound messages (push and pull).

Take the free trial now of our SOAP Protocol, with 10 free message credits to send pre-populated text messages and see how easy it is to connect to our SMS Gateway.

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

Sign up for SOAP

Clickatell ZA | Message Pricing



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