Documentation Index
Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt
Use this file to discover all available pages before exploring further.
RCS API
RCS Business Messaging is the modern carrier-grade replacement for SMS on Android — rich cards, suggested replies, verified sender, read receipts. This surface registers your brand, creates verified agents, manages templates, and invites testers. Sending RCS messages themselves goes through the Messaging API at POST /v1/messages/rcs.
Base path: /v1/rcs
Authentication: API key (X-API-Key) or session JWT.
Brands
A brand is the customer-facing entity that owns one or more RCS agents. Brand verification with the carrier is required before launch.
| Method | Path | Purpose |
|---|
POST | /v1/rcs/brands | Create a brand |
GET | /v1/rcs/brands | List brands |
GET | /v1/rcs/brands/{id} | Get a brand |
PATCH | /v1/rcs/brands/{id} | Update brand details |
DELETE | /v1/rcs/brands/{id} | Delete brand |
POST | /v1/rcs/brands/{id}/submit | Submit for carrier verification |
Agents (bots)
An RCS agent (sometimes called a “bot”) is the actual sending identity — logo, color, contact info, and behavior. Agents must be verified before they can send to consumers.
| Method | Path | Purpose |
|---|
POST | /v1/rcs/bots | Create an agent |
GET | /v1/rcs/bots | List agents |
GET | /v1/rcs/bots/{id} | Get an agent |
PUT | /v1/rcs/bots | Update agent profile |
DELETE | /v1/rcs/bots/{id} | Delete an agent |
POST | /v1/rcs/bots/{id}/verify | Submit for verification |
Test devices
Add specific phone numbers that can receive messages from an unverified agent — used during integration and QA.
| Method | Path | Purpose |
|---|
GET | /v1/rcs/bots/{id}/devices | List test devices |
POST | /v1/rcs/bots/{id}/devices | Add a test device |
DELETE | /v1/rcs/bots/{id}/devices | Remove a test device |
POST | /v1/rcs/bots/{id}/tester-invite | Send a tester invite to a phone |
Templates
Pre-approved message templates with rich card components, suggested replies, and quick actions.
| Method | Path | Purpose |
|---|
GET | /v1/rcs/bots/{id}/templates | List templates |
POST | /v1/rcs/bots/{id}/templates | Create a template |
GET | /v1/rcs/bots/{id}/templates/{name} | Get a template by name |
PUT | /v1/rcs/bots/{id}/templates/{name} | Update a template |
DELETE | /v1/rcs/bots/{id}/templates/{name} | Delete a template |
Capability check
Before sending RCS to a number, check whether the device + carrier supports it.
curl https://orbit-api.devotel.io/api/v1/rcs/capability/bot_abc/+14155552671 \
-H "X-API-Key: dv_live_sk_your_key_here"
| Method | Path | Purpose |
|---|
GET | /v1/rcs/capability/{botId}/{phone} | Probe RCS capability for a phone |
Test account
A sandbox flow for first-time testers — verify your own phone via OTP, then receive sample messages from an unverified agent.
| Method | Path | Purpose |
|---|
GET | /v1/rcs/test-account/status | Check test-account status |
POST | /v1/rcs/test-account/send-otp | Send OTP to a phone |
POST | /v1/rcs/test-account/verify-otp | Verify OTP and enroll the device |
See also
