Webhooks

Webhookの概要

ThunderPhoneがリアルタイムイベントを配信する仕組み、署名を検証する方法、従来型とエンドポイントベースの配信モデルの比較。

ThunderPhoneは、通話中にイベントが発生するとサーバーへ HTTP POST リクエストを送信します。たとえば、着信通話の開始、通話の終了、評価実行の完了、アラートの発火などです。配信モデルは2種類あります。

イベントカタログの10種類すべてのイベントは、Webhook エンドポイントを通じて配信されます。6種類の通話ライフサイクルイベント（telephony.incoming、telephony.complete、telephony.tool、web.incoming、web.complete、web.tool）は、レガシーの単一 URL Webhookにも同時に送信されます。レガシー URL と一致するエンドポイントの両方がある場合、イベントは両方のパスで受信します。ブロッキング動作（telephony.incoming / web.incoming の設定交換およびWebhookモードのツールディスパッチ）はレガシーパス専用です。すべてのエンドポイント配信は、応答を待たない通知です。

ペイロード形式#

エンドポイントへの配信は、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 が使用されます。このドキュメント内の整形済みの例は、読みやすさのためだけに掲載しています。

イベントタイプとペイロードフィールドの完全な一覧は、イベントカタログを参照してください。

署名の検証#

すべてのリクエストには、生のリクエスト本文 に対する HMAC-SHA256 署名が X-ThunderPhone-Signature ヘッダーに含まれます。署名キーは エンドポイントの secret です（レガシー配信では組織レベルの webhook secret）。

手順#

1. 解析を行う前に、生のリクエスト本文を読み取ります。
2. hmac_sha256(secret, body).hexdigest() を計算します。
3. X-ThunderPhone-Signature ヘッダーと定数時間で比較します。

ThunderPhone は送信するバイト列をそのまま署名します。そのバイト列は 正規化された 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 は、再試行なしの単一同期試行です。

従来型 Webhook とエンドポイントベース Webhook の選択#

新しい統合では、エンドポイントベースの Webhook を通じてイベントを処理してください。通話応答時に通話を動的に設定する場合、または Webhook モードのツールディスパッチを使用する場合にのみ、従来の URL を維持または追加してください。これらのリクエスト/レスポンス交換は従来のパスでのみ実行されます。

関連#