PLATAFORMA / INTEGRAÇÕES & APIBASE: API.RATELO.COM.BR · V1 · JSON

A API que entrega.

Um POST envia. Um webhook confirma. Todo o ciclo da mensagem — enfileirada, enviada, entregue, lida — como eventos que o seu sistema escuta.

Criar API keyCriar API key Ler a documentação

CICLO DA MENSAGEM

cURLNode.jsPython

copiar

$ curl -X POST https://api.ratelo.com.br/v1/mensagens \
  -H "Authorization: Bearer rtl_live_4X2…" \
  -H "Idempotency-Key: pedido-4812" \
  -d '{
    "para": "+5511988124406",
    "template": "confirmacao_agendamento",
    "variaveis": { "nome": "Marina", "horario": "16:30" }
  }'

201 CREATED182ms

{
  "id": "msg_4812",
  "status": "enfileirada",
  "criada_em": "2026-07-03T09:41:05-03:00"
}

RECURSOSREST · PAGINAÇÃO POR CURSOR · ERROS COM CÓDIGO E AÇÃO

POST/v1/mensagensEnvia template ou texto dentro da janela de 24h

GET/v1/mensagens/{id}Consulta o ciclo completo de uma mensagem

POST/v1/contatosCria ou atualiza contato com base legal registrada

GET/v1/contatos?segmento={id}Lista contatos por segmento salvo

POST/v1/eventosDispara gatilho de automação a partir do seu sistema

GET/v1/campanhas/{id}/relatorioFunil enviado → entregue → lido → respondido

DELETE/v1/contatos/{id}Exclusão definitiva — atende pedidos de titular (LGPD)

WEBHOOKSASSINADOS COM HMAC-SHA256 · RETRY EXPONENCIAL · REPLAY MANUAL

Seu sistema escuta a chegada.

Cada mudança de estado vira um evento assinado no seu endpoint. Falhou? A entrega tenta de novo — e você pode reenviar do log.

mensagem.enviadasaiu da filamensagem.entreguechegou ao aparelhomensagem.lidaconfirmação de leituramensagem.falhoucom motivo e açãoconversa.iniciadacliente respondeucontato.optoutsaiu da base — propague

POST SEU-ENDPOINT/WEBHOOKx-ratelo-assinatura: t=…,v1=…

{
  "evento": "mensagem.entregue",
  "id": "msg_4812",
  "em": "2026-07-03T09:41:07-03:00",
  "tentativa": 1
}

LOG DE ENTREGASÚLTIMAS 24H

mensagem.entregue · msg_4812200 · 09:41:07

mensagem.lida · msg_4810timeout · 09:38:12REPLAY

conversa.iniciada · cnv_2201200 · 09:42:31

SDKS · LIMITES · SEGURANÇASANDBOX COM NÚMERO DE TESTE INCLUÍDO

SDKS OFICIAIS

ratelo-nodenpm i rateloratelo-pythonpip install rateloratelo-phpcomposer requireratelo-gogo get

Tipados, com retry e idempotência embutidos. Fora da lista? A API REST é a interface completa.

LIMITES E CONDUTA

Requisições600/minEnvio em loteaté 1.000/reqRate excedido429 + retry-afterIdempotênciaIdempotency-KeyUptime (12 meses)99,95%

Erros dizem o que houve e como resolver: template_nao_aprovado → envie para análise

SEGURANÇA E LGPD

Chave exibida uma única vez; escopos de leitura, envio e adminTLS 1.2+ obrigatório; webhooks assinados com HMAC-SHA256Dados hospedados no Brasil; retenção configurável por contaExportação e exclusão de titular pela API — LGPD art. 18

Política de segurança

Primeira mensagem
em uma tarde.

Criar API keySANDBOX GRÁTIS · SEM CARTÃO

A API que entrega.

Seu sistema escuta a chegada.

Primeira mensagemem uma tarde.

Primeira mensagem
em uma tarde.