Send a test RCS text message (platform owner only)

Sends a text RCS message through the workspace's Twilio Messaging Service with automatic SMS/MMS fallback for non-RCS recipients. Blocked unless the RCS_MESSAGING feature flag and workspace_rcs_config.enabled are both true. Respects sandbox mode, DNC, and opted_in_sms exactly like SMS. SaaS platform owner access required.

POST

https://api.channelautomation.com/api/rcs/workspaces/{workspaceId}/test-send

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

workspaceId
string
required
Workspace ID to send from.

Request body JSON required

contactId
string
required
Contact UUID. Drives consent gates (sandbox/DNC/opt-out).
body
string
required
Message text to send (max 1600 chars). Sent to the contact's own phone number.
isTest
optional
boolean
Dry run. When true, runs ALL consent/safety gates (flag, config+status, contact, phone, sandbox, DNC, opt-out, Twilio creds) and returns mock success, skipping only the actual Twilio send and the DB insert. A blocked contact (DNC, opted out, no phone, etc.) returns the block reason.

Returns

200

Send attempt completed. ok:true with a messageSid when sent; ok:false with skipped:true and a reason when intentionally blocked (flag off, not configured, sandbox, DNC, opt-out, etc.).

JSON

ok
optional
boolean
messageSid
optional
string
or null
status
optional
string
or null
requestedChannel
optional
string
fallbackFrom
optional
string
or null
skipped
optional
boolean
reason
optional
string
or null
message
optional
string
or null

400

Missing required fields (contactId, body).

401

Authentication required

JSON

error
optional
string
success
optional
boolean

403

SaaS owner access required.

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

502

Twilio send failed.

503

Identity verification is temporarily unavailable.

curl --request POST \ --url 'https://api.channelautomation.com/api/rcs/workspaces/<workspaceId>/test-send' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "contactId": "string", "body": "string", "isTest": true } '