Lookup coverage for a resource
Look up the coverage for a single resource by specifying the resource type, identifier (such as sender name or phone number), and associated country code.
Please log in to see full path URL. Learn why.
post
/resources/1/coverage-lookup
Authorizations:
Scopes:
Request rate limit:
10 requests / second (per account)
Request Body schema:
application/jsoncollapse all -
resourceType required | string Resource type. The request body will not be parsable if this property is missing. ALPHANUMERIC |
senderName required | string [ 0 .. 255 ] characters Alphanumeric sender name. |
countryCode required | string ^[A-Z]{2}$ Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types). |
Responses
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
429
Too Many Requests
500
Internal Server Error
Request samples
- Payload
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
Content type
application/json
Example
ALPHANUMERIC
Copy
Collapse all {- "resourceType": "ALPHANUMERIC",
- "senderName": "MySender",
- "countryCode": "GB"
}
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
Content type
application/json
Example
Alphanumeric
Copy
Collapse all {- "senderName": "MySender",
- "countryCode": "GB",
- "countryName": "United Kingdom",
- "capabilities": [
- {
- "channel": "SMS",
- "coverage": {
- "outbound": [
- {
- "mccNnc": "310260",
- "networkName": "Some network"
}
], - "inbound": false
}
}
], - "resourceType": "ALPHANUMERIC"
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See