Como usar o Webhook messages.updated da API WhatsApp

A API WhatsApp oferece o evento messages.updated, que é acionado sempre que o status de uma mensagem é atualizado. Este guia ensina como configurar e utilizar este webhook de forma eficiente.

O que este evento faz?

Quando uma mensagem tem seu status alterado (por exemplo: PENDING, DELIVERY_ACK ou READ), a API envia uma requisição POST ao endpoint configurado na instância. O payload enviado contém informações detalhadas sobre a mensagem e seu novo status.

Estrutura do Retorno

O retorno recebido no webhook terá o seguinte formato:

{
  "instance_uuid": "b1a06ec1-1970-4ff3-996e-7214a68609d5",
  "event": "messages.update",
  "date_time": "2025-01-28 23:47:46",
  "data": {
    "message_id": "3FE65329901176F287BC",
    "message_status": "READ"
  }
}

Como interpretar os dados?

  • instance_uuid: O identificador único da instância que enviou o evento.
  • event: O tipo do evento (messages.update).
  • date_time: Data e hora em que o evento foi disparado.
  • data: Informações específicas da mensagem:
    • message_id: O ID único da mensagem.
    • message_status: O novo status da mensagem, que pode ser:
      • PENDING: Mensagem aguardando envio.
      • DELIVERY_ACK: Mensagem entregue ao destinatário.
      • READ: Mensagem lida pelo destinatário.

Como configurar o Webhook?

  1. Acesse sua instância na API WhatsApp.
  2. No painel de configuração, localize a opção Webhook URL.
  3. Insira o URL do seu endpoint que receberá as requisições POST.
  4. Certifique-se de que seu servidor está preparado para receber e processar os dados no formato JSON exibido acima.

Exemplo de processamento do Webhook

Abaixo, segue um exemplo em PHP para processar o webhook:


// Exemplo básico de recebimento do webhook
$json = file_get_contents('php://input');
$data = json_decode($json, true);

// Log ou processamento do status da mensagem
$messageId = $data['data']['message_id'];
$messageStatus = $data['data']['message_status'];

file_put_contents('webhook_log.txt', "Mensagem $messageId está agora com status $messageStatus\n", FILE_APPEND);

Conclusão

O webhook messages.updated é uma ferramenta poderosa para acompanhar o status das mensagens enviadas pela sua API WhatsApp.

Configure-o corretamente e utilize as informações recebidas para melhorar o acompanhamento e a automação dos seus processos.

Ця відповідь Вам допомогла? 1 Користувачі, які знайшли це корисним (1 Голосів)