> ## 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

> 在 WhatsApp 商业电话号码的商业用户名（Business Username）更新时触发。

使用 `whatsapp.phone_number.business_username_updated` 在您的 Webhook 端点处理此事件。

## 触发条件

在 WhatsApp 商业电话号码的商业用户名（Business Username）更新时触发。

在您[配置 Webhook 端点](https://docs.ycloud.com/zh/api-reference/guides/api-fundamentals/configure-webhooks.md)时订阅 `whatsapp.phone_number.business_username_updated`。

## 语法

YCloud 会向您配置的 Webhook URL 发送 HTTP `POST` 请求。以下结构展示了一种载荷变体。尖括号中的值为占位符；其类型列在 **参数**下。可选字段和其他变体详见下文。

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

## 参数

在处理 JSON 请求体之前，请验证 `YCloud-Signature` HTTP 请求头。请参阅[签名验证](https://docs.ycloud.com/zh/api-reference/guides/api-fundamentals/configure-webhooks.md)。

### 事件外层结构

| 参数 | 类型 | 必填 | 说明 |
| - | - | - | - |
| `id` | string | 是 | 事件的唯一 ID。最小长度：`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 | 否 | WhatsApp 商业账户 ID。 |
| `businessUsername` | string | 否 | 此电话号码当前有效的商业用户名。该值为不包含 `@` 的纯用户名。 |
| `businessUsernameStatus` | string | 否 | WhatsApp 商业电话号码的商业用户名状态。<ul><li>`not_set`：不存在处于活跃或待审核状态的商业用户名。</li><li>`active`：商业用户名处于有效状态。</li><li>`reserved`：申请的商业用户名已被 Meta 保留，可能仍在审核中。</li><li>`pending_review`：用于审核中申请的旧版兼容值。新的写入操作请使用 `reserved`。如果在已有有效用户名的同时新申请处于保留或审核中状态，则 `businessUsernameStatus` 为 `reserved`，`businessUsername` 包含仍处于有效状态的用户名，而 `requestedBusinessUsername` 包含新申请的用户名。</li></ul> |
| `requestedBusinessUsername` | string | 否 | 最新申请且仍在审核中的商业用户名。在新申请待审核期间，此值可与有效的 `businessUsername` 共存。 |
| `businessUsernameContext` | string | 否 | 此用户名通知的可选上下文。仅当当前成功的 Meta 查询返回的用户名与此撤销通知匹配时，才会显示 `revoked`。若撤销已作废或通知无上下文，则会省略。该字段不会提供历史主页警告。 |
| `businessUsernameUpdatedAt` | string (date-time) | 否 | 商业用户名状态最后一次更新的时间。 |

## 示例

以下 JSON 是传递给您的接收程序的请求体。ID、电话号码和其他账户值仅供参考说明。

> [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/zh/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.