Documentação da API

Quickstart verificável

1. Abra o Sandbox local para ver o ciclo de entrega simulado sem credencial ou envio externo.
2. Após acesso autorizado, emita uma API key limitada ao ambiente Sandbox e guarde o segredo fora do cliente.
3. Use um template aprovado, destinatário de teste autorizado e uma Idempotency-Key única. A API devolve uma operação enfileirada.
4. Consulte o identificador da mensagem no console do mesmo tenant e ambiente. Não use uma chave Sandbox em Production.

POST /api/v1/messages

Exige API key com messages:write, template aprovado e limites por tenant. Uma repetição com o mesmo payload retorna a mesma operação, sem duplicar a entrega.

curl -X POST https://connecting.chiarelli.dev/api/v1/messages \
  -H "Authorization: Bearer cc_sandbox_..." \
  -H "Idempotency-Key: msg-create-0001" \
  -H "Content-Type: application/json" \
  -d '{"channel":"whatsapp","to":"+5511999999999","type":"template","template":{"template_id":"template-id-aprovado","language":"pt_BR"}}'

Substitua somente os placeholders por credenciais e identificadores do seu Sandbox autorizado. O exemplo é uma chamada HTTP em cURL, não um SDK oficial e não deve ser executado contra Production durante o pré-lançamento.

Webhooks

Entregas incluem timestamp, id do evento e assinatura HMAC. Eventos repetidos são idempotentes. Verifique a assinatura sobre o corpo bruto antes do parse.

Limites e erros

Use 429 e Retry-After para reduzir tentativas. Uma chave revogada, um template não aprovado ou um ambiente sem controle de entrega retorna um erro sem enviar mensagem.

Dados e uso responsável

Os papéis no tratamento, retenção e descarte constam no DPA. A lista de suboperadores do serviço será informada antes da ativação em produção, conforme os documentos aplicáveis.