跳至主要內容

如何設定及使用 Wati 中的 Webhook

今日已更新

總結

Wati 中的 Webhook 允許您通過將事件數據發送到您的伺服器,來接收有關訊息及其狀態的即時更新。本指南說明您可以追蹤哪些事件、如何設定 webhook,以及基於會話的回調如何運作,以便您可以可靠地處理系統中的訊息活動。

指示

Webhook 可以捕獲哪些事件?

當以下事件發生時,Wati webhook 可以通知您的系統:

  • 收到的訊息

  • 已發送的訊息(範本和會話訊息)

  • 訊息狀態更新:

    • 已發送

    • 已送達

    • 已讀取

這些事件會作為回調有效負載發送到您配置的 webhook URL。

如何在 Wati 中新增 webhook

請按照以下步驟設置 webhook:

  • 登入您的 Wati 儀表板。

  • 前往連接器,然後點擊頂部導航選單中的 Webhook

  • 點擊新增 Webhook

  • 輸入您的完整 webhook URL。

  • 將狀態設置為已啟用

  • 選擇您要捕獲的事件。

  • 點擊儲存

如何測試您的 webhook

新增 webhook 後,您可以測試連線:

  • 使用觸發範例回調選項。

  • Wati 會將範例有效負載發送到您的 webhook URL。

  • 驗證您的伺服器是否正確接收和處理有效負載。

了解基於會話的 webhook

在 WhatsApp Business API 中,對話會被追蹤為 24 小時的會話。當商業訊息送達時,會話開始。

會話類型

  • 活動會話

    • 企業和客戶都至少交換了一條訊息。

    • 範例:企業發送範本訊息,客戶回覆。

  • 非活動會話

    • 只有一方發送了訊息,而另一方沒有回覆。

    • 範例:企業發送範本訊息,但客戶沒有回覆。

注意:Webhook 回調可能會根據會話是處於活動狀態還是非活動狀態而有所不同。

Webhook 回應和重試邏輯

為確保可靠的傳遞,您的 webhook 必須正確回應。

  • 您的伺服器必須傳回 200 OK 回應,以確認已收到事件。

  • 如果未收到 200 回應:

    • Wati 會重試發送事件。

    • 最多可以重試 144 次的情況。

    • 重試嘗試以 10 分鐘的間隔執行。

  • 如果超過 100 次連續失敗

    • Webhook 會被標記為有問題

    • 您會收到電子郵件通知。

如果所有重試嘗試都失敗,則事件將不再發送。

最佳實踐

  • 確保您的 webhook 端點始終可用且響應迅速。

  • 記錄傳入的有效負載,以便於除錯。

  • 處理重複的事件,因為重試可能會多次發送相同的有效負載。

  • 驗證傳入的請求,以確保它們來自 Wati。

此設置有助於您使系統與 Wati 中的即時訊息活動保持同步。

常見問題 (FAQ)

Webhook 概述

1. Wati 中的 Webhook 有什麼作用?

Wati 中的 Webhook 會通過將事件數據傳遞到配置的 webhook URL,來發送有關訊息及其狀態的即時更新到您的伺服器。

2. Wati webhook 可以捕獲哪些類型的事件?

Wati webhook 可以捕獲以下事件:

  • 收到的訊息

  • 已發送的訊息(範本和會話訊息)

  • 訊息狀態更新,包括已發送、已送達和已讀取

Webhook 設定和測試

3. 如何在 Wati 中新增和測試 webhook?

若要在 Wati 中新增和測試 webhook:

  • 登入您的 Wati 儀表板。

  • 前往連接器,然後點擊 Webhook。

  • 點擊新增 Webhook。

  • 輸入您的 webhook URL,並將狀態設定為已啟用。

  • 選擇您要捕獲的事件,然後點擊儲存。

  • 使用觸發範例回調選項發送範例有效負載。

  • 驗證您的伺服器是否正確接收和處理有效負載。

基於會話的 webhook

4. 什麼是 WhatsApp Business API 中的會話?

會話是當商業訊息送達時開始的 24 小時對話窗口。

5. 活動會話和非活動會話有什麼區別?

當企業和客戶都至少交換了一條訊息時,就會發生活動會話。 當只有一方發送訊息而另一方沒有回覆時,就會發生非活動會話。

Webhook 可靠性和重試

6. 您的伺服器必須傳回什麼回應才能成功傳遞 webhook?

您的伺服器必須傳回 200 OK 回應,以確認已收到 webhook 事件。

7. 如果您的伺服器未傳回 200 OK 回應會發生什麼情況?

如果您的伺服器未傳回 200 OK 回應,Wati 會以 10 分鐘的間隔重試發送事件最多 144 次。

8. 如果 webhook 傳遞持續失敗會發生什麼情況?

如果連續失敗次數超過 100 次,則 webhook 會被標記為有問題,並發送電子郵件通知。 如果所有重試嘗試都失敗,則事件將不再發送。

最佳實踐

9. 如何確保可靠的 webhook 處理?

若要確保可靠的 webhook 處理:

  • 讓您的 webhook 端點保持可用且響應迅速

  • 記錄傳入的有效負載以進行除錯

  • 處理重複事件,因為重試可能會多次發送相同的有效負載

  • 驗證傳入的請求以確認它們來自 Wati

是否回答了您的問題?