curl -X POST "https://api.tracklysms.com/api/v2/lists/42/rcs-capability-check" \
-H "X-Api-Key: trk_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{"phone_number":"+13105551234"}'
{ "reachable": true }
{ "reachable": false }
{ "error": "List not found", "code": "not_found" }
Lists (v2)
Check RCS Reachability
Check whether an RCS agent can currently reach a US phone number.
POST
/
v2
/
lists
/
{list_id}
/
rcs-capability-check
curl -X POST "https://api.tracklysms.com/api/v2/lists/42/rcs-capability-check" \
-H "X-Api-Key: trk_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{"phone_number":"+13105551234"}'
{ "reachable": true }
{ "reachable": false }
{ "error": "List not found", "code": "not_found" }
Checks the specified RCS sending list’s current reachability for one US number. The API key needs the
lists.read scope, and the list must be active, belong to the key’s account, and have an enabled RCS agent. Both live and sandbox keys make a real reachability lookup.
The limit is 60 checks per account per minute. A 429 response includes Retry-After in seconds.
The result is a point-in-time check for this list’s RCS agent. reachable: false does not distinguish an unsupported or disabled handset from an agent that has not launched on the recipient’s network. A successful lookup does not check consent, list membership, or suppression and does not guarantee delivery. This request sends no message. Normal sends do not run this lookup automatically.
Path Parameters
Body Parameters
Response Fields
Whether the list’s RCS agent can currently reach this number. A number that the agent cannot reach returns
false with HTTP 200.Examples
curl -X POST "https://api.tracklysms.com/api/v2/lists/42/rcs-capability-check" \
-H "X-Api-Key: trk_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{"phone_number":"+13105551234"}'
{ "reachable": true }
{ "reachable": false }
{ "error": "List not found", "code": "not_found" }
Error Codes
| HTTP Status | Error Code | Description |
|---|---|---|
| 400 | invalid_param | Invalid JSON or missing, malformed, or non-US phone_number. |
| 401 | invalid_credentials | API key is missing or invalid. |
| 403 | insufficient_scope / account_suspended | The key lacks lists.read, or the account is suspended. |
| 404 | not_found | The list is missing, deleted, or belongs to another account. This differs from an unreachable number, which returns HTTP 200. |
| 422 | unsupported_list_type | The specified list is not an RCS list. |
| 422 | inactive_list | The RCS list is paused or suspended. |
| 429 | rate_limit_exceeded | The account exceeded 60 checks per minute. Wait for the Retry-After interval before retrying. |
| 503 | capability_unavailable | The RCS agent is disabled or misconfigured, or the reachability service is temporarily unavailable. Retry after the agent or service is available. |