whatsapp.phone_number.name_updated

Используйте whatsapp.phone_number.name_updated для обработки этого события на вашей конечной точке Webhook.

Триггеры

Происходит, когда отображаемое имя для бизнес-номера WhatsApp было одобрено или отклонено. Подпишитесь на whatsapp.phone_number.name_updated, когда будете настраивать конечную точку Webhook.

Синтаксис

YCloud отправляет HTTP-запрос POST на указанный вами URL-адрес Webhook. Следующая структура демонстрирует один из вариантов полезной нагрузки. Значения в угловых скобках являются плейсхолдерами; их типы перечислены в разделе Параметры. Необязательные поля и другие варианты описаны ниже.

{
  "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>"
  }
}

Параметры

Проверьте HTTP-заголовок YCloud-Signature перед обработкой тела JSON. См. проверка подписи.

Конверт события

Параметр	Тип	Обязательный	Описание
`id`	string	Да	Уникальный идентификатор события. Минимальная длина: `6`. Максимальная длина: `128`.
`type`	string	Да	Всегда `whatsapp.phone_number.name_updated`.
`apiVersion`	string	Да	Версия API, использованная для формирования этого события.
`createTime`	string (date-time)	Да	Время создания этого события в формате RFC 3339, например, `2022-06-01T12:00:00.000Z`.

Полезная нагрузка события

Параметр	Тип	Обязательный	Описание
`whatsappPhoneNumber`	object	Нет	Специфичная для события полезная нагрузка `whatsappPhoneNumber`.

Четыре общих поля конверта обязательны. Поля полезной нагрузки зависят от варианта события. В каждой таблице объектов статус Обязательный применяется, когда присутствует его родительский объект. Необязательные поля могут быть опущены; наличие в примере не делает поле обязательным.

whatsappPhoneNumber

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Идентификатор номера телефона.
`phoneNumber`	string	Нет	Номер телефона в формате E.164.
`displayPhoneNumber`	string	Нет	Отображаемый номер телефона.
`wabaId`	string	Нет	Идентификатор WhatsApp Business Account.
`verifiedName`	string	Нет	Подтвержденное имя.
`nameStatus`	string	Нет	Статус проверки текущего запроса на отображаемое имя. См. также Get Display Name Status. `APPROVED`: Имя одобрено. Теперь вы можете скачать свой сертификат. `AVAILABLE_WITHOUT_REVIEW`: Сертификат для номера доступен, и отображаемое имя готово к использованию без проверки. `DECLINED`: Имя не было одобрено. Вы не можете скачать свой сертификат. `EXPIRED`: Срок действия вашего сертификата истек, и его больше нельзя скачать. `PENDING_REVIEW`: Ваш запрос имени находится на рассмотрении. Вы не можете скачать свой сертификат. `NONE`: Сертификат недоступен.
`newNameStatus`	string	Нет	Статус проверки нового запроса на отображаемое имя. См. также Get Display Name Status. Значения: `APPROVED`, `AVAILABLE_WITHOUT_REVIEW`, `DECLINED`, `EXPIRED`, `PENDING_REVIEW`, `NONE`.
`decision`	string	Нет	Решение по проверке, принятое для этого номера телефона. Одно из значений: `APPROVED` или `REJECTED`.
`requestedVerifiedName`	string	Нет	Последнее запрошенное подтвержденное имя.
`rejectionReason`	string	Нет	Причина отклонения.

Пример

Следующий JSON представляет собой тело запроса, доставленное вашему получателю. Идентификаторы, номера телефонов и другие значения аккаунта приведены для наглядности.

{
  "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"
  }
}

После проверки подписи и надежного сохранения события верните ответ 2xx. Выполняйте длительные операции асинхронно.

HTTP/1.1 200 OK

Пошаговые сценарии см. в разделе annotated examples.

Начало работы

Руководства

Конечные точки

Webhook reference

whatsapp.phone_number.name_updated

Триггеры

Синтаксис

Параметры

Конверт события

Полезная нагрузка события

whatsappPhoneNumber

Пример

​Триггеры

​Синтаксис

​Параметры

​Конверт события

​Полезная нагрузка события

​whatsappPhoneNumber

​Пример

Триггеры

Синтаксис

Параметры

Конверт события

Полезная нагрузка события

whatsappPhoneNumber

Пример