Check RCS capability Early access
Use this endpoint to verify whether the phone numbers in a given list can receive RCS messages from the specified sender. You can check up to 500 phone numbers in a single request. The response will provide the list of capability statuses for each phone number individually.
Ensure the sender is configured and launched on the mobile network/carrier that manages the phone numbers being tested for RCS capability. If the sender is not launched on the network, the capability check request will always return a negative status for the tested phone numbers.
Authorizations:
Scopes:
Request Body schema:
sender required | string The sender ID. It can be alphanumeric or numeric (for example, | ||||||||
phoneNumbers required | Array of strings [ 1 .. 500 ] items A list of phone numbers (1 to 500) to check for RCS capability (for example, | ||||||||
options | object | ||||||||
|
Responses
OK
Bad Request
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
Request samples
- Payload
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
{- "sender": "441134960000",
- "phoneNumbers": [
- "441134960001",
- "441134960002"
], - "options": {
- "platform": {
- "entityId": "Example entity id",
- "applicationId": "Example application id"
}
}
}
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
{- "capabilityCheckResults": [
- {
- "messageId": "d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8",
- "phoneNumber": "441134960001",
- "code": "ENABLED"
}, - {
- "messageId": "b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3",
- "phoneNumber": "441134960002",
- "code": "UNREACHABLE"
}
], - "options": {
- "platform": {
- "entityId": "Example entity id",
- "applicationId": "Example application id"
}
}
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See