Skip to main content
Para o catálogo completo derivado do esquema, consulte todos os exemplos.

​
O que é

Processe atualizações de status de suspensão de grupos 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 evento de que você precisa.
  • 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 maneira assíncrona.

​
Requisição

Os cenários abaixo mostram requisições entregues na sua 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.
Para configuração de endpoint, validação de assinatura e comportamento de repetição, consulte Configurar webhooks.

​
Grupo suspenso

Quando um grupo do WhatsApp for suspenso, você receberá um webhook com a seguinte estrutura de payload:

​
Requisição

​
Resposta

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

​
Explicação

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

​
Suspensão de grupo cancelada

Quando a suspensão de um grupo do WhatsApp for cancelada, você receberá um webhook com a seguinte estrutura de payload:

​
Requisição

​
Resposta

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

​
Explicação

  • type: Sempre whatsapp.group.status_update para eventos de status de suspensão de grupo
  • whatsappGroup: Contém os detalhes do status de suspensão do grupo
    • field: Sempre group_status_update
    • type: O tipo de evento de status, seja group_suspend ou group_suspend_cleared
    • status: O status normalizado do grupo, seja suspended ou suspend_cleared
    • groupId: O ID do grupo do WhatsApp
    • webhookTime: O horário em que o WhatsApp disparou este webhook