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

當功能有所更新時,您會收到通知。這些更新可能包括變更每個 WhatsApp Business 帳戶可關聯的電話號碼數量上限,或者變更每個電話號碼可發起的對話數量上限。

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 物件,請參閱組成部分