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 應用程式在任何時候都只能設定一個端點。如果您需要將 Webhook 更新傳送到多個端點,則需要多個 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 物件。