Send a test RCS message to a workspace's test device (workspace admin)

Self-serve validation: a workspace admin sends a test RCS to their test device. Because RCS always sends to a contact's own phone (so consent gates + history stay bound to one identity), the device phone is resolved to an EXISTING contact in the workspace — no contact is created (the contacts table has webhook/badge triggers, so auto-create would have side effects). If no contact matches the number, returns sent:false with a clear reason so the admin can add it as a contact first. The send runs the full guardrail chain (RCS_MESSAGING flag, workspace_rcs_config enabled+status, sandbox, DNC, opted_in_sms and configured eligibility tag) via the shared sendRcsTextDirectly path. Non-RCS devices fall back to SMS automatically.

POST

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

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

workspaceId
string
required

Request body JSON optional

phone
optional
string
E.164 test device number. Defaults to the saved test_device_phone.
body
optional
string
Message text (max 1600). Defaults to a standard test message.

Returns

200

Always 200 on a well-formed request. sent:true with a messageSid when sent; sent:false with a reason (no_contact, no_test_phone, dnc, sms_opt_out, rcs_not_approved, etc.) otherwise.

400

Invalid phone format.

401

Authentication required

JSON

error
optional
string
success
optional
boolean

403

Workspace admin access required.

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

503

Identity or workspace access verification is temporarily unavailable.

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