ThunderPhone v3 現已上線。自助開通,價格低至每分鐘 2¢。查看公告

Developer cookbook

每通來電的動態設定

透過你自行控制的 webhook 中自訂邏輯,為每通來電個別選擇接聽智能體,或重寫其提示詞及設定。

預設情況下,每個電話號碼及可公開金鑰均已指派固定智能體。當你需要按 每位來電者 或 每位訪客 自訂設定——VIP 路由、已登入用戶內容、A/B 提示詞測試——請切換至 webhook 模式,讓你的伺服器作出決定。

運作方式

  1. 你訂閱 telephony.incoming (電話)或 web.incoming(小工具) 事件。兩者均為阻塞式 webhook:ThunderPhone 會在繼續通話前等待你的 回應;電話通話最長等待 13 秒(包括一次重試),小工具工作階段則為 10 秒。
  2. ThunderPhone 會向你傳送 {call_id, from_number, to_number}(小工具 工作階段會傳送小工具專用欄位而非號碼——請參閱 請求結構)。
  3. 你的伺服器會回傳智能體設定(提示詞、語音、 產品、工具、詞彙)。ThunderPhone 會在通話中使用該設定。
  4. 系統不設備援智能體。如你回傳 {} 或無效的 設定,或請求在其 重試後仍然失敗,電話 通話會立即結束,並以 end_reason inbound_config_webhook_failed 記錄;小工具工作階段請求則會失敗。

1. 設定 webhook 目的地

如要設定電話號碼,請讓你的端點訂閱 telephony.incoming:

curl -X POST https://api.thunderphone.com/v1/developer/webhook-endpoints \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label":  "Prod call-incoming",
    "url":    "https://example.com/thunderphone/incoming",
    "events": ["telephony.incoming"]
  }'

回應會包含一次性 secret——請妥善儲存;你會用它 驗證簽名。

如要設定小工具工作階段,請建立一個 mode="webhook" 的可公開金鑰, 並內嵌你的端點 URL:

curl -X POST https://api.thunderphone.com/v1/publishable-key \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name":            "Dynamic widget",
    "mode":            "webhook",
    "webhook_url":     "https://example.com/thunderphone/widget-incoming",
    "allowed_domains": ["example.com"]
  }'

小工具會在每次工作階段開始時 POST 至此 URL。

2. 實作處理程式

三項實用原則:

  • 每個請求均須驗證簽名(參閱 驗證 webhook 簽名)。 切勿在開發環境略過此步驟——一次正確實作後即可重用。
  • 快速回應。通話的首次嘗試會在 10 秒後截斷,整個交換則在 13 秒後結束,而每一秒對來電者而言都是靜默等待。如有需要可查詢資料庫,但不要同步呼叫下游 LLM——如需動態生成提示,請預先計算並快取。
  • 妥善回退。如遇任何非預期狀態,請回傳預設的 prompt 及 voice(或已儲存的 agent_id)。回傳 {} 或錯誤狀態會結束通話。
FastAPI
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, sig: str) -> bool:
    expected = hmac.new(SECRET.encode(), body, hashlib.sha256).hexdigest()
    return hmac.compare_digest(expected, sig or "")
 
@app.post("/thunderphone/incoming")
async def incoming(request: Request):
    body = await request.body()
    if not verify(body, request.headers.get("X-ThunderPhone-Signature", "")):
        raise HTTPException(401)
 
    event = json.loads(body)
    if event["type"] not in ("telephony.incoming", "web.incoming"):
        return {}  # fall back to default
 
    caller = event["data"]["from_number"]
    # Cheap DB lookup: is this a known VIP?
    customer = lookup_customer(caller)
    if customer and customer.tier == "vip":
        return {
            "prompt":  f"You are a VIP concierge for {customer.name}. Be proactive…",
            "voice":   "john",
            "product": "storm-base",
        }
    return {}  # default agent handles non-VIPs
 
def lookup_customer(phone: str):
    # ... your CRM integration ...
    pass
Express
import crypto from "node:crypto";
import express from "express";
 
const app = express();
const SECRET = process.env.THUNDERPHONE_WEBHOOK_SECRET;
 
function verify(body, sig) {
  const expected = crypto.createHmac("sha256", SECRET).update(body).digest("hex");
  return sig &&
    crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(sig));
}
 
app.post(
  "/thunderphone/incoming",
  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"));
 
    const IMPORTANT_TYPES = new Set([
      "telephony.incoming",
      "web.incoming",
    ]);
    if (!IMPORTANT_TYPES.has(event.type)) return res.json({});
 
    const customer = await lookupCustomer(event.data.from_number);
    if (customer?.tier === "vip") {
      return res.json({
        prompt:  `You are a VIP concierge for ${customer.name}. Be proactive…`,
        voice:   "john",
        product: "storm-base",
      });
    }
    res.json({}); // fall back to default agent
  },
);

3. 回應結構

回應主體與 來電回應結構 完全一致。常用欄位如下:

欄位類型說明
prompt字串(必填)智能體的系統提示
voice字串(必填)來自 GET /v1/voices 的語音 ID
product字串傳送 bolt。預設為 spark,此舊有值仍獲支援。
background_track字串 | null環境音訊 ID
acknowledgement_prompt_mode字串auto 或 manual(僅適用於較舊的 -with-ack 產品值)
acknowledgement_prompt字串當模式為 manual 時必填
language_switching字串適用於多語言智能體,可設為 ask_first 或 follow_caller
tools陣列內嵌函式工具結構描述——參閱 函式工具

保留已儲存的智能體並提供變數或內容

傳回 {"agent_id": 12, "variables": {"name": "Ada"}},即可使用該機構已儲存的 智能體,並附上每次通話的資料。其提示可包含 {{name}} 或 {{name|Friend}}。Webhook 變數會覆蓋請求層級變數;null 會使用佔位符預設值,如未提供預設值則使用空白文字。最終 值及未解析的名稱會顯示於通話詳情及完成 Webhook。 加入 context(最多 20,000 個字元的自由格式字串),即可向智能體提供 本次通話簡介(例如 CRM 備註、你預期通話的原因); 系統會將其加入提示之後的分隔區塊中。 已儲存智能體回應只接受 agent_id、variables、context、timezone 及 language。如存在 prompt, 回應會使用內嵌設定並忽略 agent_id;內嵌提示仍必須有效。如你的 Webhook 是已指派智能體本身的通話設定 Webhook,你亦可省略 agent_id,只傳回 variables、context、timezone 或 language,以保留該已指派智能體(包括任何版本鎖定)用於通話。內嵌 設定回應亦可包含 variables 及 context。已儲存智能體回應會在電話及小工具通話中使用 智能體已部署的 A/B 分流,然後呈現變數。請參閱 通話變數 以了解限制及工作階段 API 支援。阻塞式設定來自舊版 電話號碼/機構 URL 或 Webhook 模式的小工具金鑰;端點系統的傳入事件僅作通知用途。

為每通電話設定時區

一個智能體可以為身處不同時區的聯絡人接聽電話。在已儲存的智能體或內嵌回應中加入 IANA 名稱 timezone,智能體便會在這通電話中按該時區說明日期和時間,並提供該時區的可選時間,而非使用智能體本身的時區:

{"agent_id": 12, "timezone": "America/Chicago", "variables": {"name": "Ada"}}

請在 variables 中傳送時區,而非時間戳記:智能體的時鐘會在通話期間持續運行,而你傳入的時間會過時。不是 IANA 時區的值會被忽略,通話將以智能體的時區接通。

為每次通話設定語言

一個智能體可使用其每種語言接聽。將 language(支援的語言代碼,例如 es,而 es-MX 會視為 es)加入 agent_id 旁邊,通話便會以該語言開始:

{"agent_id": 12, "language": "es", "variables": {"name": "Ada"}}

智能體會以該語言的對應語音說話:其 language_voices 項目;否則,如已啟用 native_voice_switching,則使用智能體會切換至該語言的原生語音;再否則,如其本身的語音支援該語言,便使用其本身的語音。對於未錄音的通話,ThunderPhone 亦會以通話語言播放即時處理通知。其後,智能體的其他語言及主要語言仍可供切換。如以上語音均不支援該語言,通話仍會以該語言開始,並使用該語言的預設語音(使用自訂語音的智能體會保留其自訂語音),而不提供其他語言。如通話期間其後切換至智能體支援的另一種語言,當兩種語音均為目錄語音時,亦會使用該語言的 language_voices 項目;否則,會套用一般切換規則。全雙工智能體則不同:在任何支援的語言中,通話會保留智能體本身的語音,且不會套用 language_voices 及原生語音切換。只有不屬於支援語言的代碼會被拒絕。Widget 及 realtime 工作階段均使用相同的 language 欄位。

模式

已登入用戶內容

在 webhook 模式小工具中,訪客頁面已知道其 身分。透過小工具 SDK 會轉送的查詢字串參數 (?customer_id=123)呼叫你的 webhook,並在伺服器端查詢客戶資料。

A/B 提示推出

在自行實作前,請注意 ThunderPhone 提供原生 實驗功能 (/dashboard/experiments 及智能體建立工具的 A/B 分頁),可 定義變體、分流流量,並按變體比較結果—— 無需 webhook。

如仍需要由 webhook 端控制:將 call_id 雜湊 → 分組; 為 0..49 提供提示 A,為 50..99 提供提示 B。在你自己的資料庫中記錄 所選分組,稍後再與已完成通話的評分建立關聯。

按時間路由

辦公時間 → 「真人支援」智能體;非辦公時間 → 「記錄訊息」 智能體。在處理常式中直接根據 new Date().getUTCHours() 切換即可。


下一步