whatsapp.phone_number.name_updated

Use whatsapp.phone_number.name_updated para processar este evento no seu endpoint de webhook.

Gatilhos

Ocorre quando o nome de um número de telefone comercial do WhatsApp é aprovado ou rejeitado. Assine whatsapp.phone_number.name_updated 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. Campos opcionais e outras variantes são descritos abaixo.

{
  "id": "<ID>",
  "type": "whatsapp.phone_number.name_updated",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappPhoneNumber": {
    "id": "<ID>",
    "phoneNumber": "<PHONE_NUMBER>",
    "wabaId": "<WABA_ID>",
    "verifiedName": "<VERIFIED_NAME>",
    "requestedVerifiedName": "<REQUESTED_VERIFIED_NAME>",
    "decision": "<DECISION>",
    "nameStatus": "<NAME_STATUS>",
    "newNameStatus": "<NEW_NAME_STATUS>"
  }
}

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.name_updated`.
`apiVersion`	string	Sim	A versão da API usada para renderizar este evento.
`createTime`	string (data e hora)	Sim	O momento em que este evento foi criado, formatado 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 específico do evento `whatsappPhoneNumber`.

Os quatro campos comuns do envelope são obrigatórios. Os campos do payload dependem da variante do evento. Em cada tabela de objeto, Obrigatório se aplica quando o objeto pai estiver presente. 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.
`verifiedName`	string	Não	Nome verificado.
`nameStatus`	string	Não	O status de análise da solicitação atual de nome de exibição. Consulte também Get Display Name Status. `APPROVED`: o nome foi aprovado. Você já pode baixar seu certificado. `AVAILABLE_WITHOUT_REVIEW`: o certificado para o telefone está disponível e o nome de exibição está pronto para ser usado sem análise. `DECLINED`: o nome não foi aprovado. Não é possível baixar seu certificado. `EXPIRED`: seu certificado expirou e não pode mais ser baixado. `PENDING_REVIEW`: sua solicitação de nome está em análise. Não é possível baixar seu certificado. `NONE`: nenhum certificado disponível.
`newNameStatus`	string	Não	O status de análise da nova solicitação de nome de exibição. Consulte também Get Display Name Status. Valores: `APPROVED`, `AVAILABLE_WITHOUT_REVIEW`, `DECLINED`, `EXPIRED`, `PENDING_REVIEW`, `NONE`.
`decision`	string	Não	Decisão de análise tomada para este número de telefone. Um entre `APPROVED` ou `REJECTED`.
`requestedVerifiedName`	string	Não	Último nome verificado solicitado.
`rejectionReason`	string	Não	Motivo da rejeição.

Exemplo

O JSON a seguir é 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_name_updated",
  "type": "whatsapp.phone_number.name_updated",
  "apiVersion": "v2",
  "createTime": "2026-05-26T12:00:00.000Z",
  "whatsappPhoneNumber": {
    "id": "1234567890123456",
    "phoneNumber": "+12025550124",
    "wabaId": "whatsapp-business-account-id",
    "verifiedName": "Example business",
    "requestedVerifiedName": "Example business",
    "decision": "APPROVED",
    "nameStatus": "APPROVED",
    "newNameStatus": "APPROVED"
  }
}

Após verificar a assinatura e aceitar o evento de forma duradoura, retorne uma resposta 2xx. Processe tarefas lentas de forma assíncrona.

HTTP/1.1 200 OK

Para orientações passo a passo sobre cenários, consulte os exemplos comentados.

Primeiros passos

Guias

Endpoints

Webhook reference

whatsapp.phone_number.name_updated

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