Skip to main content
POST
Enviar mensagem

Authorizations

Authorization
string
header
required

Chave de API do projeto, no formato rt_live_... ou rt_test_..., enviada como Authorization: Bearer <chave>.

Headers

Idempotency-Key
string

Chave única por mensagem lógica (um UUID v4, por exemplo). Repetir a requisição com a mesma chave e o mesmo corpo devolve a resposta original, com o header Idempotent-Replay: true. Uma chave reutilizada com outro corpo retorna 409 idempotency_key_reuse. O registro é mantido por 24 horas.

Body

application/json
channel
string
required

Identificador do canal pelo qual enviar (chan_...).

Example:

"chan_01J8ZK9M3Q7XABCDEFGHJKMNPQ"

to
string
required

Destinatário em formato E.164, por exemplo +5581999999999. O + inicial é opcional. O formato é verificado aqui; se o número não pode existir no país indicado, a API retorna invalid_recipient.

Pattern: ^\+?[1-9]\d{1,14}$
Example:

"+5581999999999"

text
string

Corpo da mensagem de texto. Não pode ser usado junto com template.

Example:

"Olá! Seu pedido foi confirmado."

template
object

Template aprovado a enviar. Não pode ser usado junto com text.

metadata
object

Até 20 pares chave-valor de texto, de propriedade do cliente, com 1 KB no total. É devolvido na consulta e nos eventos.

Response

Aceito. O processamento é assíncrono

id
string
required

Identificador da mensagem.

Example:

"msg_01J8ZK9M3Q7XABCDEFGHJKMNPQ"

channel
string
required

Identificador do canal usado.

Example:

"chan_01J8ZK9M3Q7XABCDEFGHJKMNPQ"

direction
enum<string>
required

Direção da mensagem: outbound (enviada por você) ou inbound (recebida).

Available options:
outbound,
inbound
from
string
required

Endereço de origem, em E.164.

Example:

"+5581988888888"

to
string
required

Endereço de destino, em E.164.

Example:

"+5581999999999"

content
object
required

Conteúdo da mensagem. O campo type indica o formato.

status
enum<string>
required

Estado atual no ciclo de vida. O status nunca retrocede.

Available options:
accepted,
sent,
delivered,
read,
failed
metadata
object
required

Até 20 pares chave-valor de texto, de propriedade do cliente.

accepted_at
string<date-time>
required

Quando a Routa aceitou a mensagem.

Example:

"2026-09-04T13:22:41.031Z"

sent_at
string<date-time> | null
required

Quando o provedor aceitou a mensagem. null se ainda não ocorreu.

Example:

"2026-09-04T13:22:41.031Z"

delivered_at
string<date-time> | null
required

Quando a entrega foi confirmada. null se ainda não ocorreu.

Example:

"2026-09-04T13:22:41.031Z"

read_at
string<date-time> | null
required

Quando o destinatário leu. null se ainda não ocorreu.

Example:

null

failed_at
string<date-time> | null
required

Quando a mensagem falhou. null se não falhou.

Example:

null