whatsapp.phone_number.deleted

Use whatsapp.phone_number.deleted para manipular este evento no seu endpoint de webhook.

Gatilhos

Ocorre quando um número de telefone comercial do WhatsApp é excluído. Inscreva-se em whatsapp.phone_number.deleted ao configurar seu endpoint de webhook.

Sintaxe

A YCloud envia uma solicitação HTTP POST para a URL de webhook configurada. O formato a seguir mostra uma variante do payload. Os valores entre colchetes angulares são marcadores de posição; seus tipos estão listados em Parâmetros. Os campos opcionais e outras variantes são descritos abaixo.

{
  "id": "<ID>",
  "type": "whatsapp.phone_number.deleted",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappPhoneNumber": {
    "id": "<ID>",
    "phoneNumber": "<PHONE_NUMBER>",
    "wabaId": "<WABA_ID>"
  }
}

Parâmetros

Valide o cabeçalho HTTP YCloud-Signature antes de processar o corpo JSON. Consulte a validação de assinatura.

Envelope do evento

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID exclusivo do evento. Tamanho mínimo: `6`. Tamanho máximo: `128`.
`type`	string	Sim	Sempre `whatsapp.phone_number.deleted`.
`apiVersion`	string	Sim	A versão da API usada para renderizar este evento.
`createTime`	string (date-time)	Sim	A data e hora em que este evento foi criado, formatada em RFC 3339. Ex.: `2022-06-01T12:00:00.000Z`.

Payload do evento

Parâmetro	Tipo	Obrigatório	Descrição
`whatsappPhoneNumber`	object	Não	Payload `whatsappPhoneNumber` específico do evento.

Os quatro campos comuns do envelope são obrigatórios. Os campos do payload dependem da variante do evento. Em cada tabela de objetos, Obrigatório se aplica quando o objeto pai estiver presente. Os campos opcionais podem ser omitidos; um exemplo não torna um campo obrigatório.

whatsappPhoneNumber

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	ID do número de telefone.
`phoneNumber`	string	Não	Número de telefone no formato E.164.
`displayPhoneNumber`	string	Não	Número de telefone de exibição.
`wabaId`	string	Não	ID da conta do WhatsApp Business.
`updateEvent`	string	Não	Evento de atualização da conta que acionou esta alteração de status do número de telefone. Valores: `ACCOUNT_RECONNECTED`, `ACCOUNT_OFFBOARDED`.

Exemplo

O seguinte JSON é o corpo entregue ao seu receptor. IDs, números de telefone e outros valores de conta são ilustrativos.

{
  "id": "evt_example_whatsapp_phone_number_deleted",
  "type": "whatsapp.phone_number.deleted",
  "apiVersion": "v2",
  "createTime": "2026-05-26T12:00:00.000Z",
  "whatsappPhoneNumber": {
    "id": "1234567890123456",
    "phoneNumber": "+12025550124",
    "wabaId": "whatsapp-business-account-id"
  }
}

Depois de verificar a assinatura e aceitar o evento de forma duradoura, retorne uma resposta 2xx. Processe tarefas demoradas de forma assíncrona.

HTTP/1.1 200 OK

Para orientações detalhadas de cenários, consulte exemplos anotados.

Primeiros passos

Guias

Endpoints

Webhook reference

whatsapp.phone_number.deleted

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

whatsappPhoneNumber

Exemplo

​Gatilhos

​Sintaxe

​Parâmetros

​Envelope do evento

​Payload do evento

​whatsappPhoneNumber

​Exemplo

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

whatsappPhoneNumber

Exemplo