SMS API Authentication

How to Authenticate an SMS API

You can authenticate an API request by sending your username, password and API ID as GET parameters by opening a URL in your browser as follows;

API Authentication Command

https://api.clickatell.com/http/auth?user=xxxx&password=xxxx&api_id=xxxx

If you would like to avoid sending your username and password with every API request, you can use a session ID. This command can be used to generate the session ID.

The session ID will expire after 15 minutes of inactivity and you will have to call this API verification command again to create a new session ID. Alternatively, you can use the Ping command about every 10 minutes to ensure that the session ID is kept alive.

Note that any API command using a session ID will cause your session ID to remain active for another 15 minutes.


API Authentication Parameters

Parameter

Description

user

Your API username

password

Your API password

api_id

Your API ID



SMS SPI Authentication Examples

Bash:

username="place username here"
password="place password here"
api_id="place password here"

curl --data "user=$username&password=$password&api_id=$api_id" \
    'https://api.clickatell.com/http/auth'

Example PHP Code:

<?php
$username = urlencode("place username here");
$password = urlencode("place password here");
$api_id   = urlencode("place password here");

echo file_get_contents("https://api.clickatell.com/http/auth?"
    + "user=$username&password=$password&api_id=$api_id");
?>

Example using Python:

import urllib2, urllib

params = {
    "user": "place username here",
    "password": "place password here",
    "api_id": "place password here"
}

params = urllib.urlencode(params)
f = urllib2.urlopen("https://api.clickatell.com/http/auth", params)
print f.read()


API Verification responses

Example response

Successful API response:

OK: f6b9af2a2c9e5b18ee2d257e3def5d66

Error response:

ERR: 001, Authentication failed

API response Format

Successful API response:

OK: <session ID>

Error response:

ERR: <error code>, <error description>