本地 API 专用 Webhooks

您可订阅 Webhooks,以便在公司收到消息以及客户个人主页更新时接收相关通知。如需了解有关 WhatsApp Business 开放平台 Webhooks 的更多信息,请参阅概览 > Webhooks

Webhooks 设置不会影响 WhatsApp Business 应用程序上的电话号码。只要您不将电话号码迁移至 WhatsApp Business 开放平台,就能继续在 WhatsApp Business 应用程序中使用该号码。

准备工作

您将需要:

  • 支持 HTTPS 且具有有效 SSL 证书的代码
  • 配置为可接受核心应用所发出入站请求的回调网址端点
  • 收到通知时会返回 HTTPS 200 OK 响应内容的回调网址端点

重试

如果通知因故未被送达,或者 Webhooks 请求返回的 HTTP 状态码不是 200,我们将重试发送操作。在延迟时间达到特定超时时间(通常为 24 小时,但此设置可能不同)前,或在成功送达之前,我们会继续重试发送操作。

设置回调网址端点

/v1/settings/application 端点发送 PATCH 请求,其中 webhooks 参数设置为回调网址端点。其他常用配置参数为 sent_statuscallback_persist

请求示例

PATCH /v1/settings/application
{
    "callback_persist": true,
    "sent_status": true,  // Either use this or webhooks.message.sent, but webhooks.message.sent property is preferred as sent_status will be deprecated soon
    "webhooks": { 
    	"url": "webhook.your-domain", 
        "message": {     // Available on v2.41.2 and above
        	"sent": false,
        	"delivered": true,
        	"read": false
       },
    }
}

操作成功后,响应内容中包含 200 OK,以及 null 或 JSON 对象。

如需了解有关配置应用和其他 Webhooks 参数的更多信息,请访问应用程序设置参考文档

Webhooks 通知负载

每当触发事件发生时,WhatsApp Business 开放平台都会查看事件,并向您之前指定的 Webhooks 网址发送通知。您会收到两类通知:

  • 收到消息:当您收到消息时,系统会发送此提醒通知您。在本文档中,这些消息也称为“入站通知”。
  • 消息状态和定价通知:当消息状态更改时(如消息已被读取或送达),系统会发送此提醒通知您。在本文档中,这些消息也称为“出站通知”。

请参阅组件,了解每个字段的相关信息。

错误通知

{
    "errors": [ {
       "code": <error-code>,
       "title": "<error-title>",
       "details": "<error-description>",
       "href": "location for error detail"
    },
    {
       ...
    }
    ]
 }

应用端点示例

若要测试 Webhooks,可创建配置通知接收端点的应用示例。