ThunderPhone 2.0 正式上线。全程自助,低至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"]
  }'

组件会在每次会话开始时向此 URL 发送 POST 请求。

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字符串默认为 spark。实验性产品仅面向已加入允许名单的组织提供。
background_track字符串 | 空值环境音频 ID
acknowledgement_prompt_mode字符串auto 或 manual(仅适用于带确认功能的 Storm)
acknowledgement_prompt字符串当模式为 manual 时必填
tools数组内联函数工具架构——请参阅函数工具

保留已保存的智能体并提供变量

返回 {"agent_id": 12, "variables": {"name": "Ada"}} 以使用该组织已保存的智能体,并提供每通电话的数据。其提示词可以包含 {{name}} 或 {{name|Friend}}。Webhook 变量会覆盖请求级变量;null 会使用占位符默认值,如未提供默认值则使用空文本。最终 值和未解析的名称会显示在通话详情和完成 Webhook 中。 已保存智能体响应仅接受 agent_id、variables 和 timezone。如果存在 prompt, 响应将使用内联配置并忽略 agent_id(包括 null 或非整数元数据);内联提示词仍必须有效。内联 配置响应也可以包含 variables。已保存智能体响应会在电话和小组件通话中使用该智能体已部署的 A/B 分流,然后渲染变量。有关限制 和会话 API 支持,请参阅通话变量。 阻塞式配置来自旧版电话号码/组织 URL 或 Webhook 模式的小组件密钥;端点系统传入事件仅为通知。

为每通电话设置时区

一个智能体可以为处于不同时区的联系人接听电话。将 IANA 名称 timezone 添加到已保存智能体或内联响应中,智能体会针对本次通话说明该时区的日期和时间,并提供该时区的可选时间,而非使用智能体自身的时区:

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

请在 variables 中发送时区而不是时间戳:智能体的时钟会在通话期间持续运行,而您传入的时间会过期。不是 IANA 时区的值会被忽略,通话将以智能体所在时区接通。

模式

已登录用户上下文

在 Webhook 模式组件中,访客所在的页面已经知道其身份。 使用组件 SDK 会转发的查询字符串参数调用您的 Webhook (?customer_id=123),然后在服务器端查找客户信息。

A/B 提示词发布

在您自行实现之前,请注意 ThunderPhone 提供原生 实验功能 (/dashboard/experiments 和智能体构建器中的 A/B 选项卡),可用于 定义变体、分流流量,并按变体比较结果——无需 Webhook。

如果您仍需要在 Webhook 端控制:对 call_id 进行哈希 → 分桶; 为 0..49 提供提示词 A,为 50..99 提供提示词 B。将您选择的 分桶记录到自己的数据库中,之后再与已完成通话的评分进行关联。

基于时间的路由

营业时间 → “人工支持”智能体;非营业时间 → “留言”智能体。 在处理程序中仅需基于 new Date().getUTCHours() 进行切换。


后续步骤