Skip to main content
POST
Send RCS message

Authorizations

Authorization
string
header
required

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Headers

Idempotency-Key
string

Chave única para evitar envio duplicado.

x-idempotency-key
string

Chave de idempotência (alternativa).

Body

application/json
to
string[]
required

Lista de números no formato E.164 (ex.: 5511999999999). Uma mensagem RCS por número; cada uma consome 60 créditos.

Required array length: 1 - 100 elements
payload
object
required

Conteúdo conforme messageType. BASIC: { message }. CARD: { message, cardImage, cardTitle, cardMessage, buttons? }. CAROUSEL: { message, cards } (cada card: cardImage, cardTitle, cardMessage, buttons?). FILE: { message, file, fileName } (file = URL pública).

type
enum<string>

Message type (canonical, lowercase): basic (text), card, carousel, file, or template (workspace). Use messageType in UPPERCASE as a compatibility alias.

Available options:
basic,
card,
carousel,
file,
template
messageType
enum<string>

Alias de compatibilidade para type. Prefer type em minúsculo para novos integradores.

Available options:
BASIC,
CARD,
CAROUSEL,
FILE
schedule
object
refer
string

Referência opcional para correlação (ex.: ID do pedido).

options
object
metadata
object

Metadados em RcsLog.metadata (string→string).

Response

RCS aceito(s). Enfileirado(s) para envio imediato ou agendado.

success
boolean
required
Example:

true

data
object
required