Skip to main content
POST

Autorizações

​
Authorization
string
header
obrigatório

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

Cabeçalhos

​
Idempotency-Key
string

Chave única para evitar envio duplicado.

​
x-idempotency-key
string

Alternativa ao Idempotency-Key.

Corpo

application/json

Envio canônico: to (E.164) e conteúdo em payload. type: basic, card, carousel, file ou template.

​
to
string[]
obrigatório

Números E.164 sem +. Uma mensagem por número. BASIC 140 créditos; CARD/CAROUSEL/FILE 200 créditos.

Required array length: 1 - 500 elements
​
payload
object
obrigatório

Conteúdo conforme type. basic: { message }. card: { message, cardImage, cardTitle, cardMessage, buttons? }. carousel: { message, cards }. file: { message, file, fileName }.

​
from
string
obrigatório

Agente RCS: id ou nome (opcional se o workspace usa remetente compartilhado).

​
schedule
object
​
refer
string
Maximum string length: 255
​
metadata
object

Metadados string→string (máx. 20 chaves).

​
options
object
​
localization
object
​
i18n
object

Resposta

RCS aceito(s). En cola(s) para envio imediato ou agendado.

​
success
boolean
obrigatório
​
data
object
obrigatório