HTTP API Get Coverage Command

This command allows you to check our coverage of a network or mobile number, without sending a message to that handset. This command should NOT be used before sending each message.

The returned credit charge value indicates the lowest possible credit charge at that point in time (for a single plain-text message). Credit charges may fluctuate (based on availability of delivery routes and features) and there is no guarantee that all your messages will be charged this value.


Command

https://api.clickatell.com/utils/routecoverage?user=xxxx&password=xxxx&api_id=xxxx&msisdn=xxxx

Parameters

Parameter

Description

apimsgid

This is the mobile number you would like to query, must be in international format (no leading zeros or + symbols.



Examples

Bash:

username="place username here"
password="place password here"
api_id="place password here"
msisdn="mobile number"

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

PHP:

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

$msisdn    = "mobile number";

echo file_get_contents("https://api.clickatell.com/utils/routecoverage"
  . "?user=$username&password=$password&api_id=$api_id&msisdn=$msisdn");
?>

Python:

import urllib2, urllib

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

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



API responses

Example response

Successful API response:

OK: This prefix is currently supported. Messages sent to this prefix will be routed. Charge: 1

OR:

ERR: This prefix is not currently supported. Messages sent to this prefix will fail. Please contact support for assistance.

Error response:

ERR: 001, Authentication failed


Format

Successful API response:

OK: This prefix is currently supported. Messages sent to this prefix will be routed. Charge: <cost of message>

OR:

ERR: This prefix is not currently supported. Messages sent to this prefix will fail. Please contact support for assistance.

Error response:

ERR: <error code>, <error description>