> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# whatsapp.phone_number.business_username_updated

> Происходит при обновлении Business Username у бизнес-номера телефона WhatsApp.

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

## Триггеры

Происходит при обновлении Business Username у бизнес-номера телефона WhatsApp.

Подпишитесь на `whatsapp.phone_number.business_username_updated`, когда будете [настраивать конечную точку Webhook](https://docs.ycloud.com/ru/api-reference/guides/api-fundamentals/configure-webhooks.md).

## Синтаксис

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

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "<ID>",
  "type": "whatsapp.phone_number.business_username_updated",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappPhoneNumber": {
    "id": "<ID>",
    "wabaId": "<WABA_ID>",
    "phoneNumber": "<PHONE_NUMBER>",
    "businessUsername": "<BUSINESS_USERNAME>",
    "businessUsernameStatus": "<BUSINESS_USERNAME_STATUS>",
    "businessUsernameContext": "<BUSINESS_USERNAME_CONTEXT>"
  }
}
```

## Параметры

Проверяйте HTTP-заголовок `YCloud-Signature` перед обработкой тела JSON. См. раздел [проверка подписи](https://docs.ycloud.com/ru/api-reference/guides/api-fundamentals/configure-webhooks.md).

### Оболочка события

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

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

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

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

#### whatsappPhoneNumber

| Параметр | Тип | Обязательный | Описание |
| - | - | - | - |
| `id` | string | Нет | ID номера телефона. |
| `phoneNumber` | string | Нет | Номер телефона в формате [E.164](https://en.wikipedia.org/wiki/E.164). |
| `displayPhoneNumber` | string | Нет | Отображаемый номер телефона. |
| `wabaId` | string | Нет | ID аккаунта WhatsApp Business. |
| `businessUsername` | string | Нет | Активный Business Username для этого номера телефона. Значение представляет собой простое имя пользователя без `@`. |
| `businessUsernameStatus` | string | Нет | Статус Business Username для бизнес-номера телефона WhatsApp.<ul><li>`not_set`: активный или ожидающий подтверждения Business Username отсутствует.</li><li>`active`: Business Username активен.</li><li>`reserved`: запрошенный Business Username зарезервирован Meta и может все еще находиться на рассмотрении.</li><li>`pending_review`: устаревшее значение для совместимости, обозначающее запрос на рассмотрении. При новых операциях записи используется `reserved`. Если активное имя пользователя уже существует, пока новый запрос зарезервирован или находится на рассмотрении, то `businessUsernameStatus` имеет значение `reserved`, поле `businessUsername` содержит все еще активное имя пользователя, а `requestedBusinessUsername` — запрошенное имя пользователя.</li></ul> |
| `requestedBusinessUsername` | string | Нет | Последний запрошенный Business Username, который все еще находится на рассмотрении. Это значение может сосуществовать с активным `businessUsername`, пока новый запрос находится на рассмотрении. |
| `businessUsernameContext` | string | Нет | Необязательный контекст для этого уведомления об имени пользователя. `revoked` появляется только в том случае, если имя пользователя, возвращенное успешным текущим запросом к Meta, совпадает с этим уведомлением об отзыве. Опускается при устаревшем отзыве или уведомлении без контекста. Это поле не отображает историю предупреждений страницы. |
| `businessUsernameUpdatedAt` | string (date-time) | Нет | Время последнего обновления статуса Business Username. |

## Пример

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

> [accordion] Имя пользователя компании отозвано и заменено
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_business_username_revoked_123",
>   "type": "whatsapp.phone_number.business_username_updated",
>   "apiVersion": "v2",
>   "createTime": "2026-10-10T08:00:00.000Z",
>   "whatsappPhoneNumber": {
>     "id": "1234567890123456",
>     "wabaId": "whatsapp-business-account-id",
>     "phoneNumber": "+12025550124",
>     "businessUsername": "autogenerated_name",
>     "businessUsernameStatus": "active",
>     "businessUsernameContext": "revoked"
>   }
> }
> ```

> [accordion] Событие обновления имени пользователя компании для номера телефона WhatsApp
>
> Пример полезной нагрузки, когда имя пользователя компании для номера телефона WhatsApp становится активным
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_business_username_updated_123",
>   "type": "whatsapp.phone_number.business_username_updated",
>   "apiVersion": "v2",
>   "createTime": "2026-05-26T12:00:00.000Z",
>   "whatsappPhoneNumber": {
>     "id": "1234567890123456",
>     "phoneNumber": "+12025550124",
>     "displayPhoneNumber": "+1 631-555-1111",
>     "wabaId": "whatsapp-business-account-id",
>     "businessUsername": "acme.support",
>     "businessUsernameStatus": "active",
>     "businessUsernameUpdatedAt": "2026-05-26T12:00:00.000Z"
>   }
> }
> ```

> [accordion] Событие резервирования имени пользователя компании для номера телефона WhatsApp
>
> Пример полезной нагрузки, когда для номера телефона WhatsApp отправлен запрос на резервирование имени пользователя компании
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_business_username_pending_123",
>   "type": "whatsapp.phone_number.business_username_updated",
>   "apiVersion": "v2",
>   "createTime": "2026-05-26T12:30:00.000Z",
>   "whatsappPhoneNumber": {
>     "id": "1234567890123456",
>     "phoneNumber": "+12025550124",
>     "displayPhoneNumber": "+1 631-555-1111",
>     "wabaId": "whatsapp-business-account-id",
>     "businessUsername": "acme.support",
>     "businessUsernameStatus": "reserved",
>     "requestedBusinessUsername": "acme.help",
>     "businessUsernameUpdatedAt": "2026-05-26T12:30:00.000Z"
>   }
> }
> ```

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

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```

Пошаговый разбор сценариев см. в разделе [примеры с пояснениями](https://docs.ycloud.com/ru/api-reference/guides/examples/webhook-examples/whatsapp-business-account-updated-webhook-examples).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.