Check capability of a phone number for an RBM agent

Use this action to check capability of a phone number to receive messages from the specified RBM agent.

To enable this feature for your account, contact our Customer Support Team.

General requirements

Path Params
string
required

The phone number that the service should check for capability to receive messages from the specified RBM agent.

string
required
length ≤ 20

Narrows the check to the phone number's capability to use the RBM agent specified by this unique identifier.

Responses

status.code property in the response payload, rather than the HTTP status code of the response.

Status codeText stringDescription
3055Delivery channel not supported by the end user's deviceThe device associated with this phone number cannot use the selected channel.
3060Delivery channel supported by the end user's deviceThe device associated with this phone number can use the selected channel.
3115Destination phone number not in coverageThe device associated with this phone number can use the selected channel, but it is not in coverage for Telesign Messaging.

status.code property in the response payload, rather than the HTTP status code of the response.

Status codeText stringDescription
3109Invalid value for parameter sender_id: {sender_id}The value of the sender_id parameter in your request is invalid.
3110Invalid requestThis API request was not properly formatted. (Final)

status.code property in the response payload, rather than the HTTP status code of the response.

Status codeText stringDescription
3210Capability Check not enabled for Customer IDThis feature (Capability Check) is not enabled for this Customer ID. (Final)

status.code property in the response payload, rather than the HTTP status code of the response.

Status codeText stringDescription
3204Rate limit exceededAllowed number of requests per second on the Telesign Messaging API has been exceeded. (Final)

status.code property in the response payload, rather than the HTTP status code of the response.

Status codeText stringDescription
3041Carrier rejected - temporary problemThe channel provider failed to respond. The request should be resubmitted.
3500System UnavailableThe system is currently unavailable. The request should be resubmitted. (Final)

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json