Skip to main content

Visao geral

A Rewrite API v1 expoe endpoints publicos de projeto para enviar SMS, verificar OTP, gerenciar templates e webhooks, e consultar logs de request e entregas de webhook.

Base URL

Todos os endpoints publicos ficam em:

Autenticacao

Rotas publicas usam sua API key:

Convencoes de request

  • Use Content-Type: application/json em requests que nao sao GET.
  • Os fluxos publicos de envio e OTP aceitam um numero E.164 direto em to ou um contato salvo do projeto em contact.
  • Criacao de mensagem inline usa content.
  • Envios por template usam templateId com variables.
  • Metadata de mensagens e templates usa objeto chave/valor, nao array de pares.
  • Rotas de create/send aceitam Idempotency-Key.
Exemplo de request:

Convencoes de resposta

Respostas bem-sucedidas usam o envelope ok / data:
Rotas de lista paginadas retornam cursor no topo.

Modelo publico de eventos

  • O ciclo de entrega agora inclui message.delivered.
  • Trafego inbound aparece como message.received.
  • Entregas de webhook ficam na secao Deliveries, incluindo GET /deliveries e GET /webhooks/{id}/deliveries.

Referencias