Exemplos de Webhook de Encerramento de Chamadas do WhatsApp

Para o catálogo exaustivo derivado do schema, consulte todos os exemplos.

O que é

Processe eventos de encerramento de chamadas do WhatsApp.

Antes de começar

Crie um endpoint HTTPS público em sua aplicação.
Configure um endpoint de webhook da YCloud para os tipos de eventos necessários.
Armazene o segredo de assinatura do endpoint com segurança.
Torne o processamento de eventos idempotente.

Como funciona

A YCloud envia uma requisição HTTP POST quando o evento ocorre. Verifique a assinatura, registre o evento de forma durável, retorne uma resposta 2xx e processe tarefas lentas de forma assíncrona.

Requisição

Os cenários abaixo mostram as requisições entregues ao seu URL de webhook. Trate o id do evento como o identificador de entrega e use type para rotear o payload.

Resposta

Retorne um status 2xx após aceitar o evento.

HTTP/1.1 200 OK

Para configuração de endpoint, validação de assinatura e comportamento de novas tentativas, consulte Configurar webhooks.

Tanto a empresa quanto o usuário do WhatsApp podem encerrar a chamada a qualquer momento. Quando a empresa ou o usuário do WhatsApp encerra a chamada, você recebe um webhook de Call Terminate:

Chamada concluída

Requisição

{
  "id": "evt_6757b889a5a42d369ef48481",
  "type": "whatsapp.call.terminate",
  "apiVersion": "v2",
  "createTime": "2024-12-10T03:42:01.822Z",
  "callingTerminate": {
    "id": "6757b889960b25543b9ecc67",
    "wacid": "wacid.HBgNNjI4MTM2MTkwNTE",
    "phoneId": "461269257068832",
    "from": "+6281361905133",
    "fromUserId": "ID.13491208655302741918",
    "fromParentUserId": "ID.11815799212886844830",
    "to": "+6283138205150",
    "direction": "USER_INITIATED",
    "startTime": 1733734738000,
    "endTime": 1733734771000,
    "duration": 33,
    "status": "COMPLETED"
  }
}

Resposta

Confirme o recebimento após aceitar o evento de forma durável.

HTTP/1.1 200 OK

Explicação

Roteie o evento por type, remova duplicatas por id e transfira tarefas lentas ou sujeitas a falhas para um processador assíncrono.

Chamada com falha

Requisição

{
  "id": "evt_675907f431c55113a751d0e7",
  "type": "whatsapp.call.terminate",
  "apiVersion": "v2",
  "createTime": "2024-12-11T03:33:08.679Z",
  "callingTerminate": {
    "id": "675907a13ae4a901f05fee95",
    "wacid": "wacid.HBgNODYxNTE1NzEzNzYyM",
    "phoneId": "461269257068832",
    "from": "+6281361905133",
    "fromUserId": "ID.13491208655302741918",
    "fromParentUserId": "ID.11815799212886844830",
    "to": "+6283138205150",
    "direction": "USER_INITIATED",
    "startTime": 1733826484000,
    "endTime": 1733826637000,
    "duration": 30,
    "status": "FAILED",
    "errorCode": "131000"
  }
}

Resposta

Confirme o recebimento após aceitar o evento de forma durável.

HTTP/1.1 200 OK

Explicação

Roteie o evento por type, remova duplicatas por id e transfira tarefas lentas ou sujeitas a falhas para um processador assíncrono.

Primeiros passos

Guias

Endpoints

Webhooks

Exemplos de Webhook de Encerramento de Chamadas do WhatsApp

O que é

Antes de começar

Como funciona

Requisição

Resposta

Chamada concluída

Requisição

Resposta

Explicação

Chamada com falha

Requisição

Resposta

Explicação

​O que é

​Antes de começar

​Como funciona

​Requisição

​Resposta

​Chamada concluída

​Requisição

​Resposta

​Explicação

​Chamada com falha

​Requisição

​Resposta

​Explicação

O que é

Antes de começar

Como funciona

Requisição

Resposta

Chamada concluída

Requisição

Resposta

Explicação

Chamada com falha

Requisição

Resposta

Explicação