Webhooks 设置

订阅 Webhooks,以便在 WhatsApp Business 商业帐号设置及质量信号发生变动时接收通知。

Webhooks 设置不会影响 WhatsApp Business 应用程序上的电话号码。只有将电话号码迁移至 WhatsApp Business 开放平台,才会导致您无法在 WhatsApp Business 应用程序中使用该号码。

创建端点

在可以开始接收通知前,您需要在服务器上建立一个端点来接收通知。

您的端点必须能够处理两类 HTTPS 请求:验证请求和事件通知。这两类请求都使用 HTTPS,因此您必须为服务器正确配置和安装有效的 TLS 或 SSL 证书。不支持自签名证书。

进一步了解验证请求和事件通知

订阅 Webhooks

如要订阅 Webhooks,您需要获得 Meta 应用编号和权限。如要执行此操作,首先前往 Meta 应用面板。您需要在其中执行以下操作:

  1. 在 Meta 应用面板中创建 Meta 应用
  2. 在应用面板中,将 Webhooks 产品添加到您的 Meta 应用

    在任何情况下,您只能为每个 Meta 应用配置一个端点。如果您需要将 Webhooks 更新发送到多个端点,则需要多个 Meta 应用。

在您准备好扩展商家消息功能后,可能需要执行以下操作:

  1. 在应用面板中添加 whatsapp_business_management 权限
  2. 成功完成 Meta 应用审核 — 这个步骤需要一些时间,但是您可在整个审核流程期间继续测试。

可用订阅字段

可用订阅字段

字段名称 描述

account_review_update

审查 WhatsApp Business 商业帐号时向您发送通知。

account_update

当您的 WhatsApp Business 商业帐号发生更改时,向您发送通知。这些更改包括更新电话号码、违反政策规定以及 WhatsApp Business 商业帐号被封号等。

business_capability_update

更新功能时向您发送通知。这些更新包括更改每个 WABA 可以关联的电话号码数量上限或者每个电话号码可以发起的对话数量上限。

message_template_status_update

消息模板获批、未通过或遭到禁用时向您发送通知。

messages

当您的企业收到客户发来的消息、您向客户发送消息、消息送达客户以及客户已阅读您的消息时,向您发送通知。

phone_number_name_update

与电话号码关联的名称获批或未通过时向您发送通知。

phone_number_quality_update

在电话号码的质量相关状态有更新时向您发送通知。

security

发生以下情况时向您发送通知:

  • 您请求停用两步验证代码
  • 两步验证代码遭停用
  • 两步验证代码已更新
  • 请参阅 WhatsApp Business 商业帐号 Webhooks 参考文档 ,进一步了解各个负载字段;并参阅 WhatsApp 云端 API Webhooks 参考文档 ,详细了解您会收到的不同类型 messages 通知。

    通知负载

    所有通知均采用以下通用格式:

    [{
        "object": "whatsapp_business_account",
        "entry": [{
           "id": "{whatsapp-business-account-id}",
            "time": {unix-timestamp},
            "changes": [{
                "field": "{subscribed-field}",
                "value": {
                    # Information that was update
                }
              }]
          }]
      }]

    顶层数组包含两个主要对象:

    参数描述

    object

    此为订阅对象。

    entry

    此对象包含触发 Webhooks 调用的更改的详细信息。

    如需查看所有可用的 Webhooks 对象,请参阅组件