Webhook 概覽
ThunderPhone 會在通話期間發生事件時,向你的伺服器傳送 HTTP POST 請求——例如有來電開始、通話結束、評分執行完成、警示觸發等。目前提供 兩種傳送模式:
支援多個 URL、每個端點各自的密鑰、每個端點各自的事件篩選,以及自動重試。
透過 GET/POST/PATCH/DELETE /v1/developer/webhook-endpoints 管理。
每個機構一個 URL。承載通話生命週期事件,包括 封鎖式 設定交換。透過 GET/PUT /v1/webhook 管理。
事件目錄中的全部十種事件類型均會透過 Webhook 端點傳送。六種通話生命週期事件
(telephony.incoming、telephony.complete、telephony.tool、
web.incoming、web.complete、web.tool)亦會傳送至舊版單一 URL Webhook——如你同時設有舊版 URL 及相符的端點,便會在 兩個 路徑上收到該事件。封鎖式行為(telephony.incoming / web.incoming 設定交換及 Webhook 模式的工具分派)僅存在於舊版路徑;所有端點傳送均為無需等待回應的通知。
Payload 格式
端點傳送的內容為包含 data、event_id 及 type 的 JSON 物件:
{
"data": {
"call_id": 987654321,
"from_number": "+14155550199",
"to_number": "+15551234567"
},
"event_id": "3f6b2ad0-1c9e-4a57-9f2b-8f6f0f9d2f11",
"type": "telephony.incoming"
}
每個發出的事件均有唯一的 event_id。它在重試期間 以及 每個接收該事件的端點之間均保持一致——請以此作去重處理。
舊版單一 URL Webhook 會傳送相同的 type 及 data,但不會包含 event_id:
{
"type": "telephony.incoming",
"data": { "call_id": 987654321, "from_number": "+14155550199", "to_number": "+15551234567" }
}
在傳輸時,每個內容均會以規範化格式序列化——鍵按字母順序排列、不含空白字元、使用 UTF-8。本文檔中的格式化範例僅為方便閱讀。
請參閱事件目錄,了解完整的事件類型及 payload 欄位列表。
簽章驗證
每個請求都會在 X-ThunderPhone-Signature 標頭中附帶一個針對原始請求主體計算的 HMAC-SHA256 簽章。簽署金鑰為端點的 secret(或舊有傳送所使用、機構層級 webhook 的 secret)。
步驟
- 在進行任何剖析之前讀取原始請求主體。
- 計算
hmac_sha256(secret, body).hexdigest()。 - 以固定時間方式與
X-ThunderPhone-Signature標頭比較。
我們會對實際傳送的位元組進行簽署,而這些位元組正是標準化 JSON 序列化結果(已排序的鍵、精簡分隔符)。因此,針對原始主體驗證一定有效——如果你的框架只提供已剖析的 JSON,以已排序的鍵和精簡分隔符重新序列化,便會產生完全相同的位元組。兩種做法均載於驗證指南。
import hmac
import hashlib
def verify_signature(body: bytes, signature: str, secret: str) -> bool:
expected = hmac.new(
secret.encode("utf-8"),
body,
hashlib.sha256,
).hexdigest()
return hmac.compare_digest(expected, signature or "")
# Example Flask handler
from flask import Flask, request, abort
app = Flask(__name__)
@app.post("/thunderphone-webhook")
def handle():
body = request.get_data()
sig = request.headers.get("X-ThunderPhone-Signature", "")
if not verify_signature(body, sig, WEBHOOK_SECRET):
abort(401)
event = request.get_json()
# dispatch on event["type"] …
return "", 204
import crypto from "node:crypto";
import express from "express";
function verifySignature(body, signature, secret) {
const expected = crypto
.createHmac("sha256", secret)
.update(body)
.digest("hex");
if (!signature || expected.length !== signature.length) return false;
return crypto.timingSafeEqual(
Buffer.from(expected),
Buffer.from(signature),
);
}
const app = express();
app.post(
"/thunderphone-webhook",
express.raw({ type: "application/json" }),
(req, res) => {
const sig = req.header("X-ThunderPhone-Signature") || "";
if (!verifySignature(req.body, sig, process.env.WEBHOOK_SECRET)) {
return res.sendStatus(401);
}
const event = JSON.parse(req.body.toString("utf8"));
// dispatch on event.type …
res.sendStatus(204);
},
);
傳送語義
以下語義適用於 端點 傳送。舊版單一 URL webhook 只會進行一次同步嘗試,不會重試。
重試
每個事件會立即嘗試傳送一次。任何 2xx 回應
均會確認傳送成功。出現任何其他結果時(非 2xx、
連線錯誤、逾時),系統會在首次嘗試後 1 分鐘、5 分鐘、30 分鐘、2 小時、6 小時、
12 小時及 24 小時重試——合共 8 次嘗試,橫跨
24 小時。若所有嘗試均失敗,傳送將會停止,而端點
會在webhook 端點中標示為
status="failing"。有效負載一經可靠接收,請盡快回傳 2xx;
以非同步方式處理。
排序
傳送排序採用盡力而為原則。實際上,我們會按照事件發出
的順序傳送,但重試可能會在失敗後改變順序。
請一律按 call_id/物件 id 去重及對帳。
重複項目
傳送採用至少一次語義:在我們未能收到回應後進行的
重試,可能會造成事件重複。每次重試均會攜帶相同的
event_id,因此請儲存已處理的 id 並略過重複項目。event_id
亦會在各端點之間共用——訂閱同一事件的兩個端點會收到相同的 event_id。
逾時
每次端點傳送的逾時時間為 30 秒。在舊版路徑中,會影響即時
通話行為的阻塞式請求——
telephony.incoming / web.incoming
設定交換——會在 10 秒後逾時,但緩慢的回應會延遲接聽通話,
因此建議在數秒內回應。Webhook 模式的工具分派允許 20 秒。
來源 IP
外發 webhook 來自 ThunderPhone 的雲端 IP 範圍。 如你的防火牆需要設定允許清單,請聯絡支援團隊,我們會 提供目前的範圍。
在舊版與端點式 webhook 之間選擇
| 功能 | 舊版(/v1/webhook) | 端點(/v1/developer/webhook-endpoints) |
|---|---|---|
| URL 數量 | 每個機構 1 個 | 每個機構可有多個 |
| 事件涵蓋範圍 | 僅限 telephony.*/web.* | 全部 10 種事件類型 |
| 事件篩選 | — | 按端點設定 |
| 重試 | 無 | 24 小時內 8 次嘗試 |
| 封套 | type + data | type + data + event_id |
| 密鑰輪換 | 替換單一密鑰 | 每個端點各自設有密鑰 |
| 不刪除即可停用 | — | status=disabled |
| 狀態可見度 | — | active / disabled / failing |
| 阻塞式設定交換 | 是(telephony.incoming / web.incoming) | 絕不——僅限通知 |
| 最適合用途 | 動態通話設定 | 生產環境中的事件處理 |
新整合應透過端點式 webhook 處理事件。只有在你需要於 接聽通話時動態設定通話,或使用 webhook 模式工具分派時, 才應保留(或新增)舊版 URL——該等請求/回應交換僅會在舊版路徑上執行。