API Reference

Send an RCS message

post
https://api.liguelead.com.br/v1/rcs

Sends an RCS message to one or more recipients. Two mutually-exclusive modes are supported:

  • Template send: pass template_id (from a template created via POST /rcs/templates/*). Use template_variables to override the placeholders declared on the template at send time.
  • Freeform send: pass message (capped at 306 characters because the same content is reused as the SMS fallback).

Exactly one of template_id or message must be provided. Devices that don't support RCS receive the SMS fallback automatically — taken from the template's fallback_message for template sends, or from message itself for freeform sends.

The endpoint returns 202 Accepted immediately; delivery status arrives later via the configured webhook (event: 'queued' | 'sent' | 'delivered' | 'read' | 'failed' | 'undelivered').

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
phones
array of strings
required

Recipient phone numbers. Accepts national 11-digit, international with +55, or DDI form.

phones*
string

Identifier returned by POST /rcs/templates/*. Mutually exclusive with message.

template_variables
array of objects

Override values for the placeholders declared on the template's default_variables. Same array-of-pairs format used by the template-creation endpoints.

template_variables
string
length ≤ 306

Freeform message body for template-less sends. Capped at 306 chars because the same text is reused as the SMS fallback. Mutually exclusive with template_id.

Responses

Updated about 1 month ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago