Webhooks

Os webhooks da nossa API permitem que você receba notificações em tempo real sobre os eventos que acontecem para cada mensagem enviada.

Sempre que uma mensagem gerar algum evento de atualização de DLR ou MO, faremos uma chamada HTTP diretamente para a URL cadastrada nas Configurações da sua conta.

Passo a passo para registrar seu webhook.

Chamadas individuais por mensagem

Cada evento gera uma requisição independente, garantindo que você tenha o controle total sobre o processamento de cada mensagem.

Método HTTP

Todas as chamadas a sua url serão feitas exclusivamente o método POST com a chave Content-Type do header com o valor application/json

Formato de dados

O corpo da requisição é enviado em JSON, contendo todas as informações relevantes do evento para que você possa tratá-lo em sua aplicação.

TIMEOUT - 300 milissegundos

Este é o tempo de espera máxima que nossos servidores usam para ter uma resposta (positiva ou negativa) do seu endpoint cadastrado. Passado esse tempo, o pacote de dados será descartado, sem possibilidade de reenvio

CACHE

Para garantir melhor performance em nossos sistemas utilizamos regras de cache de dados que podem resultar em atraso de alguns minutos para refletir alterações realizadas.

DLR (Delivery Report)

Toda mensagem enviada que for aceita, irá gerar um DLR com o status intermediário ou final da sua mensagem. Veja abaixo o modelo de dados que será enviado ao seu endpoint

JSON

{
  "id": "6eda4709-109c-4626-a08f-a9ea143c7b20",
  "batchId":"019adc93-67bc-74e4-a8c9-dd7bb9a4b0d1",
  "customId": "abc-xyz-123",
  "ip": "127.0.0.1",
  "phone": "5511944556677",
  "statusCode": 2,
  "statusName": "DELIVRD",
  "statusDate": "2025-09-12T19:43:45.298Z"
}

Tabela de parâmetros

Código de Status

MO (Message Originator)

Toda mensagem enviada pode ser respondida pelo destinatário e quando isso acontecer, vamos direcionar o modelo abaixo de dados ao seu endpoint.

💡 DICA

Considere que o MO sempre é referente ao último MT e da mesma forma, pode-se considerar o MT como DELIVRD.

JSON

{
  "id": "4451bb99-c17d-4e08-a008-3164377fd8b7",
  "phone": "5511944556677",
  "text": "Hi",
  "statusCode": 8,
  "statusName": "RECEIVD",
  "statusDate": "2025-09-12T19:44:48.498Z"
}

Tabela de parâmetros

É importante verificar com a equipe de suporte se a conexão que você está utilizando possui acesso a essa funcionalidade e quais os custos envolvidos.