企業內部 API 專用 Webhooks

訂閱 Webhooks 以獲取通知,查看企業收到的訊息和顧客個人檔案更新。如需更多 WhatsApp Business 平台 Webhooks 相關資訊,請參閱概覽,Webhooks

Webhooks 設定不會影響在您 WhatsApp Business 應用程式上的手機號碼。將手機號碼轉移至 WhatsApp Business 平台後,您將無法再於 WhatsApp Business 應用程式上使用該號碼。

準備工作

您將需要:

  • 支援 HTTPS 且附帶有效 SSL 憑證的代碼
  • 配置為接受從核心應用程式所傳來要求的回呼網址端點
  • 在收到通知時傳回 HTTPS 200 OK 回應的回呼網址端點

重試

如果出於任何原因而未能傳送通知,或 Webhooks 要求傳回 200 以外的 HTTP 狀態碼,我們會再次嘗試傳送 Webhooks。我們會繼續重試傳送,並將延遲時間增加到特定逾時期限(一般為 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
       },
    }
}

成功後,回應會包含帶有 null 或 JSON 物件的 200 OK

請瀏覽應用程式設定參考資料,進一步了解配置應用程式相關資訊以及其他 Webhooks 參數。

Webhook 通知裝載

每當觸發事件發生時,WhatsApp Business 平台便會查看事件,並向您之前指定的 Webhook 網址傳送通知。您可以收到兩類通知:

  • 已收到的訊息:此類提醒會在您收到訊息時通知您。本文件也會將這些訊息稱為「已接收通知」。
  • 訊息狀態和定價通知:此提醒會在訊息狀態變更時(如訊息已被讀取或已送達)通知您。本文件也會將這些訊息稱為「已發出通知」。

請參閱元件,了解每個欄位的相關資訊。

錯誤通知

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

應用程式端點範例

如要測試 Webhooks,您可以建立含有端點的應用程式範例,用作接收通知。