Developer Docs

REST API integrations and SDK parameters.

Quickly integrate real-time lookups into your platform. Validate authorization headers and parse standardized response payloads.

API Specifications

1. Authentication
2. POST Verify Destination
3. Carrier Status Codes

1. Authentication

All request endpoints require a secure SHA-256 Bearer Token passed via standard header flags. Access keys start with the prefix rcsk_live_.

Authorization: Bearer rcsk_live_your_plain_token_value

2. POST Verify Destination

Verify capability for a single phone destination. Phone inputs should ideally be in standard international E.164 formats.

POST /api/v1/rcs/check
Content-Type: application/json

{
  "destination": "+14155552671"
}

Standard API Response Payload:

{
  "destination": "+14155552671",
  "rcs_capable": true,
  "status": "RCS_CAPABLE",
  "carrier": "T-Mobile US",
  "credits_charged": 1,
  "latency_ms": 32
}

3. Carrier Status Codes

The platform abstracts distinct capability router outcomes using these standardized codes:

RCS_CAPABLE: The destination supports rich messages.
RCS_NOT_CAPABLE: The destination does not support rich templates.
UNKNOWN: The capability status cannot be determined.
INVALID_NUMBER: The destination phone number format is invalid.