# 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 the availability of delivery routes and features) and there is no guarantee that all your messages will be charged this value.

### **Command**

{% code overflow="wrap" %}

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

{% endcode %}

### **Parameters**

<table><thead><tr><th width="179">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>apimsgid</code></td><td>This is the mobile number you would like to query; must be in international format (no leading zeros or + symbols.</td></tr></tbody></table>

### **Examples**

#### **Bash**

{% code lineNumbers="true" %}

```
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'
```

{% endcode %}

#### **PHP**

{% code lineNumbers="true" %}

```
<?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");
?>
```

{% endcode %}

**Python**

{% code lineNumbers="true" %}

```
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()
```

{% endcode %}

### **API responses**

#### **Example response**

*Successful API response:*

{% code overflow="wrap" %}

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

{% endcode %}

OR:

{% code overflow="wrap" %}

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

{% endcode %}

*Error response:*

```
ERR: 001, Authentication failed
```

#### **Format**

*Successful API response:*

{% code overflow="wrap" %}

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

{% endcode %}

OR:

{% code overflow="wrap" %}

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

{% endcode %}

*Error response:*

```
ERR: <error code>, <error description>
```

&#x20;


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.clickatell.com/developers-api-reference/developers-archive/sms-http-s-api/get-coverage-command.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.