telephony.complete / web.complete

每次通話結束後，都會觸發一個完成事件——包括來電電話、撥出電話、網頁通話或測試通話（Builder 咪高峰工作階段）。此事件為非阻塞：請以任何 2xx 回應。

事件會透過以下兩種途徑傳送：

• **Webhook 端點**會接收 telephony.complete（電話通話）或 web.complete（網頁通話及 Builder 咪高峰測試通話），包括下文所述的穩定 payload、每次傳送專屬的 event_id、30 秒逾時時間，以及最長 24 小時的重試機制。
• **舊版單一 URL webhook**會以稍有不同的 payload 進行一次同步嘗試（10 秒逾時，不會重試）——請參閱舊版 payload 差異。

請求 payload（端點傳送）

{
  "data": {
    "billable_minutes": 1.25,
    "billing_total_cents": 8,
    "call_id": 987654321,
    "direction": "inbound",
    "duration_seconds": 54,
    "end_reason": "user_hangup",
    "end_time": "2026-04-20T18:25:04.822Z",
    "from_number": "+14155550199",
    "product": "spark",
    "recording_url": "https://storage.example.com/…",
    "start_time": "2026-04-20T18:24:10.113Z",
    "status": "completed",
    "to_number": "+15551234567",
    "transcripts": [ /* see Transcript format */ ],
    "transfer_number": null,
    "voice": "john"
  },
  "event_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
  "type": "telephony.complete"
}

結束原因

逐輪對話記錄格式

transcripts 中每個項目均代表一個對話輪次。角色包括 user（來電者語音）、model（智能體語音及工具呼叫）、 tool（工具結果）及 system（例如語言切換等通話事件）。

[
  {
    "role": "user",
    "content_type": "text/plain",
    "content": "Hi, I'm calling about my appointment.",
    "start_ms": 1200,
    "end_ms":   4100,
    "audio_url": "https://storage.example.com/…"
  },
  {
    "role": "model",
    "content_type": "text/plain",
    "content": "Sure, what date works best?",
    "start_ms": 4200,
    "end_ms":   6100
  },
  {
    "role": "model",
    "content_type": "application/json",
    "content": {
      "tool_call": "search_appointments",
      "arguments": { "date": "2026-04-21" }
    }
  },
  {
    "role": "tool",
    "content_type": "application/json",
    "content": {
      "tool_name": "search_appointments",
      "response": { "available_slots": ["9:00 AM", "2:00 PM"] }
    }
  }
]

如需完整結構化的輪次記錄（包括中斷標記、 確認提示及原始位置），請使用 GET /v1/calls/{call_id}/history。

舊版負載差異

舊版單一 URL webhook 封裝為 {"type": "telephony.complete" | "web.complete", "data": {…}}，且 不設 event_id；其 data 與端點負載有所不同：

• 輪次陣列位於 history，而非 transcripts（輪次結構與上述相同）。
• 欄位集合為原始通話結束報告，可能包含上表以外的額外內部欄位——請將未知欄位視為資訊性資料。
• 網頁通話（direction: "web"）不會提供 from_number / to_number， 並會加入 origin_domain。
• Builder 咪高峰測試通話會在舊版路徑中回報為 telephony.complete （端點系統會將其映射為 web.complete）。
• **轉駁協調：**通話以轉駁結束時，系統會同步呼叫舊版 webhook，而該 webhook 可回應 {"transfer_ready": false}，表示交接目標尚未準備就緒。任何其他回應 （或沒有舊版 webhook）均會讓轉駁繼續進行。端點傳送絕不會用作此用途。

範例處理程式

import hashlib
import hmac
import json
import os

from fastapi import FastAPI, HTTPException, Request

app = FastAPI()
SECRET = os.environ["THUNDERPHONE_WEBHOOK_SECRET"]

def verify(body: bytes, signature: str) -> bool:
    expected = hmac.new(SECRET.encode(), body, hashlib.sha256).hexdigest()
    return hmac.compare_digest(expected, signature or "")

@app.post("/thunderphone-webhook")
async def webhook(request: Request):
    body = await request.body()
    if not verify(body, request.headers.get("X-ThunderPhone-Signature", "")):
        raise HTTPException(status_code=401)

    event = json.loads(body)
    if event["type"] in ("telephony.complete", "web.complete"):
        data = event["data"]
        # Endpoint deliveries use "transcripts"; the legacy webhook uses "history".
        turns = data.get("transcripts") or data.get("history") or []
        await persist_call_record(
            call_id=data["call_id"],
            turns=turns,
            recording_url=data.get("recording_url"),
        )
        if data["end_reason"] in ("ai_transfer", "ai_warm_transfer"):
            await notify_team(data.get("transfer_number"), data["call_id"])
    return {"ok": True}

import crypto from "node:crypto";
import express from "express";

const app = express();
const SECRET = process.env.THUNDERPHONE_WEBHOOK_SECRET;

function verify(body, signature) {
  const expected = crypto.createHmac("sha256", SECRET).update(body).digest("hex");
  return signature &&
    crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(signature));
}

app.post(
  "/thunderphone-webhook",
  express.raw({ type: "application/json" }),
  async (req, res) => {
    if (!verify(req.body, req.header("X-ThunderPhone-Signature"))) {
      return res.sendStatus(401);
    }
    const event = JSON.parse(req.body.toString("utf8"));
    if (["telephony.complete", "web.complete"].includes(event.type)) {
      const data = event.data;
      // Endpoint deliveries use "transcripts"; the legacy webhook uses "history".
      const turns = data.transcripts ?? data.history ?? [];
      await persistCallRecord({ ...data, turns });
      if (["ai_transfer", "ai_warm_transfer"].includes(data.end_reason)) {
        await notifyTeam(data.transfer_number, data.call_id);
      }
    }
    res.json({ ok: true });
  },
);

常見使用案例

相關內容