You are here: Clickatell | Support |Guides | Clickatell Gateway | API Guide

Clickatell API

This product provides an interface between your existing systems and Clickatell's Messaging Gateway. It is a lower level connectivity option, but offers the most functionality and flexibility for the end user. With the API you can set up alert-based sms delivery from your server, deliver information to your mobile sales staff and keep in contact with your customers. There are a few key steps to getting going: Definitions HTTP/S SMTP COM OBJECT XML FTP SMPP SOAP Each of these is described in more detail on it's own. To go directly to a particular section, click on the appropriate link. DEFINITION Product Dropdown: You can choose to set the preferences or retrieve reports on a API product from this dropdown. Please set meaningful descriptions in the specific API preferences to facilitate easier selection of a particular API. Control: This displays your authentication information for your API. This page also enables you to download the PDF's of the API. Please contact us if are experiencing any problems with the integration of the API. Report: This reporting module is very powerful and can be used to track the number of messages sent by day or by individual API. PREFERENCES Unique Product Name: This is a unique description that you will give this particular product. It is used mainly to identify a single API when you have multiple sub_products. IP Lock Down: This variable is used to increase the security of your account. Any requests to the API from your account not matching this IP address will be denied. You may have multiple IP Addresses separated by commas e.g. 192.168.1.1, 192.168.1.2. Dial Prefix: If a lot of local numbers are sent with this API which start with a zero, you can specify the default country prefix to replace the leading zero. Ie: if you are sending primarily to the UK, you can specify that the default prefix is 44. This will change the leading zero (if present) to 44. Callback URL: This URL when set and used in conjunction with the callback variable will enable your server to pick up message delivery status. See PDF's for more information. For those less technically minded, this tutorial will explain in just a few simple steps how you can send an SMS using Clickatell's HTTP API. Note: the manual example outlined below is not the intended purpose of the HTTP post. Instead it is assumed that developers will utilise server generated commands to insert these posts into their code automatically. Step 1. Register for the HTTP product. Go to the HTTP API page and click on the grey button near the top right hand corner of the page which reads 'Register for Free'. Step 2. Next, fill in your registration details on the registration form and press "submit". The 3 bits of information that 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: xxxxx password: xxxxx api_id: xxxxx to: xxxxxxxx (number you would like to send the message to in International format e.g. 448311234567) text: Meet me outside (actual message you would like to send) Step 4. Open your Browser (e.g. Internet Explorer), and type in your info in the address bar in the following sequence: a) The basic start is http://api.clickatell.com/http/sendmsg? b) Adding your personal authentication detail - you will then type the following into the browser: http://api.clickatell.com/http/sendmsg?user=xxxxx&password =xxxxx&api_id=xxxxx&to=xxxxxxxxx&text=Meet+me+outside Press "Enter", and your message will be sent. If the message is sent successfully a confirmation code will appear in your browser. If not, you will receive an error message. If you would like more information on this subject please view our more technical HTTP specification document. Please download the specification document below for full instructions. You will need to register for an account by clicking on "Register for FREE" before making use of this product.   :: Technical Documentation HTTP Post Specification Version 2.3.6 [ 550K ] For those less technically minded, this tutorial will explain in just a few simple steps how you can send an SMS using Clickatell's SMTP API, which in effect will convert an email message into a text message. Note: the manual example outlined below is not the intended purpose of the SMTP API. Instead it is assumed that developers will automatically generate these commands in their application code. Step 1. Register for the SMTP product. Go to the SMTP API page and click on the grey button near the top right hand corner of the page which reads "Register for Free". Step 2. Next, fill in your registration details on the registration form and press "submit". The 3 bits of information that you will need to send an SMS will be your "username", your "password", and your API_ID. Your API_ID will get 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; your username, your password, your api_id, the number you would like to send the message to in international format e.g. 448311234567, and the text of the message itself. Step 4. Open your Email client (e.g. Microsoft Outlook), and open a new email. Make sure the email is in plain text format and not html. Next, fill in the following details: 1. In the email address field type in the address sms@messaging.clickatell.com (this is the address of our server where the message will be converted) 2. Type in your account and message details in the body of the email laid out as follows user:xxxxx password:xxxxx api_id:xxxxx to:xxxxxxxxx text:meet me at home This is what it will look like in your email: Step 5. Press "Send", and your SMS message will be sent. If you would like more information on this subject please view our more technical SMTP specification document. Please download the specification document below for full instructions. You will need to register for an account by clicking on "Register for FREE" before making use of this product. :: Technical Documentation SMTP Post Specification Version 2.3.5 [ 337K ] The Clickatell HTTP specification describes how a user can interact with Clickatell Central via the HTTP or HTTPS communication protocols. Since not everybody is able or willing to implement the whole HTTP/S channel, Clickatell has made a COM object available that takes the hassle out of the whole process. The Clickatell_COMAPI object exports a rich set of methods and definitions that will make it easy for a user to integrate SMS sending into their programs or ASP pages. Various sections of this document will show you how to send SMS’s in Visual Basic, both in early and late binding mode, and in VBScript (essentially late bound Visual Basic). Since the COM object interface is fully documented any COM enabled programming language can be used. You will need to register for an account by clicking on "Register for FREE" before making use of this of the spec document.   :: Technical Documentation COM Object Programmers Reference Manual Version 2.2.8 [ 353K ] COM Object Version 2.0.0.42 [ 1230K ] If you are using XML to program in, you can include any SMS functionality or application through an XML connection to Clickatell's global SMS gateway. Supporting Text, Flash, Unicode and 8-bit SMS messaging. Clickatell's API is immediately multicast messaging enabled, allowing integration to any front-end or legacy system, with a direct connection into Clickatell's Global gateways. Please download the specification document below for full instructions. You will need to register for an account by clicking on "Register for FREE" before making use of this product.   :: Technical Documentation XML Specification Version 2.3.9 [ 748K ] For those familiar with FTP, and who have an FTP client, the Clickatell FTP Upload facility is ideal. The product is intended for clients who can build up a text file based on an existing database of recipients. This text file will be uploaded to Clickatell’s FTP site for a single delivery. It’s as easy as creating an excel spreadsheet, exporting it and uploading this to our ftp servers! This method is well suited for once-off, high volume message dispatches. It can either be a single message to all receipients or multiple personalised messages to each recipient. Full instructions for using the Clickatell FTP Upload facility are included in the PDF document.   :: Technical Documentation FTP Upload Specification Version 2.3.7 [ 336K ] If you have an SMPP Client, and wish to connect to Clickatell via the SMPP protocol, we invite you to create a test account and start sending through our global gateways. Clickatell supports connections via SMPP using the global SMPP 3.3 standard. Not only will you have the ability to deliver through our international gateways via our SMPP Server, but you will also have the opportunity to use all Clickatell's powerful administrative tools, such as sub-user management, extensive message reports, and more!   :: Technical Documentation SMPP Specification Version 2.4.3 [ 209K ] If you are using SOAP, you can include any SMS functionality or application using XML over HTTP/HTTPS to connect to Clickatell's global SMS gateway. The SOAP API uses Web Services Description Language, which is an XML-based language that provides a model for describing Web services. Supporting Text, Flash, Unicode and 8-bit SMS messaging. Clickatell's SOAP API is immediately multicast messaging enabled, allowing integration to any front-end or legacy system, with a direct connection into Clickatell's Global gateways. Please download the specification document below for full instructions. You will need to register for an account by clicking on "Register for FREE" before making use of this product.   :: Technical Documentation SOAP Specification Version 1.1.3 [ 380K ]