telephony.incoming / web.incoming
着信通話の設定をリアルタイムで構成するブロッキングWebhook。
着信電話がエージェントに割り当てられていない番号に到達した場合、または
mode="webhook" の公開可能キーでウェブウィジェットセッションが開始された場合、ThunderPhone は
レガシー webhook URL にブロッキング
telephony.incoming / web.incoming リクエストを送信し、設定レスポンスを最大 10 秒間待機します。この
やり取りを使用して、通話ごとにプロンプト、音声、ツールを動的に選択します。エンドツーエンドのパターンについては、
動的通話設定ガイドを参照してください。
このブロッキング交換にはフォールバックがありません。ハンドラーが
2xx 以外のステータスを返す、タイムアウトする、または検証に失敗する設定を返した場合、
通話は拒否されます(電話は接続されず、ウィジェットセッションリクエストは
502/422 で失敗します)。迅速に応答してください。判断中、発信者には呼び出し音が聞こえています。
リクエストペイロード
電話(telephony.incoming)の場合:
{
"type": "telephony.incoming",
"data": {
"call_id": 987654321,
"from_number": "+14155550199",
"to_number": "+15551234567"
}
}| フィールド | 型 | 説明 |
|---|---|---|
call_id | integer | 通話 ID。この通話のすべてのイベントで一貫している |
from_number | string | E.164 発信者番号 |
to_number | string | E.164 宛先番号(ThunderPhone 番号のいずれか) |
ウェブウィジェットセッション(web.incoming)では、data は電話番号ではなく
埋め込みページを識別します。
{
"type": "web.incoming",
"data": {
"call_id": 987654322,
"origin_domain": "https://example.com",
"publishable_key_prefix": "pk_live_a1b2"
}
}| フィールド | 型 | 説明 |
|---|---|---|
call_id | integer | 通話 ID |
origin_domain | string | ウィジェットをホストするページのオリジン |
publishable_key_prefix | string | セッションを開始した公開可能キーの先頭文字列 |
language, primary_language | string | ウィジェットセッションで言語オーバーライドが指定された場合に含まれる |
voice | string | ウィジェットセッションで音声オーバーライドが指定された場合に含まれる |
website_context | string | ウィジェットがセッションごとのページコンテキストを渡した場合に含まれる |
レスポンススキーマ
この通話のエージェント設定を記述する JSON オブジェクトを返します。
prompt と voice は必須で、それ以外はすべて任意です。
{
"prompt": "You are a helpful booking assistant for Acme Restaurant.",
"voice": "john",
"product": "spark",
"background_track": null,
"tools": []
}| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
prompt | string | はい | エージェントを動作させるシステムプロンプト |
voice | string | はい | GET /v1/voices の音声 ID。例: john。voice_name はエイリアスとして使用できます。不明な音声はバリデーションに失敗し、通話は拒否されます |
product | string | いいえ | デフォルトは spark。使用可能: spark、bolt、storm-base、storm-base-with-ack、storm-extra、storm-extra-with-ack |
thinking_level | string | いいえ | minimal、base(デフォルト)、または extra。Storm 製品では上書きされます。storm-extra* は extra を強制し、その他の storm-* は base を強制します |
audio_context_mode | string | いいえ | full(デフォルト)または reduced |
watchdog_enabled | boolean | いいえ | この通話の監視を有効にします。デフォルトは false |
additional_audio_context | boolean | null | いいえ | 最新ターンのみではなく、直近数ターン分の発信者音声を含めます。わずかなレイテンシーとコストの増加で、修正やスペル・数字の多いデータ収集を改善します。着信セッションではデフォルトでオン、発信通話ではオフです。null はデフォルトを維持します |
storm_feedback_mode | string | いいえ | none、acknowledgement(デフォルト)、または tick |
language | string | いいえ | primary_language の省略形 |
primary_language | string | いいえ | 正規化された言語コード(デフォルトは en)。解決できないコードは通話を拒否します |
has_additional_languages | boolean | いいえ | デフォルトは false |
additional_languages | array of string | いいえ | エージェントが切り替え可能な追加言語 |
native_voice_switching | boolean | いいえ | デフォルトは false。通話が別の言語に切り替わった際、設定済みの音声を維持するのではなく、その言語のネイティブ音声に切り替えます(性別を一致させます) |
background_track | string | null | いいえ | 環境音オーディオ ID または null |
acknowledgement_prompt_mode | string | いいえ | auto(デフォルト)または manual(Storm-with-ack 製品) |
acknowledgement_prompt | string | いいえ | acknowledgement_prompt_mode="manual" の場合に使用します |
silence_interval_seconds | integer | null | いいえ | 5~120。確認を行うまでの発信者の無音時間(秒) |
silence_max_checkins | integer | null | いいえ | 1~10 |
silence_checkins_enabled | boolean | いいえ | デフォルトは true |
connect_tone_enabled | boolean | いいえ | デフォルトは false |
voicemail_action | string | いいえ | prompt(デフォルト)、hangup、または message |
voicemail_message | string | いいえ | voicemail_action="message" の場合に使用します |
agent_name | string | いいえ | ダッシュボードとウィジェットに表示される表示名 |
org_name | string | いいえ | エージェントのペルソナに使用する組織の表示名 |
tools | array | いいえ | インライン関数ツールスキーマ(関数ツールを参照) |
call_id | integer | いいえ | リクエストの通話 ID を任意でエコーします。無視されます |
prompt と voice は必須のため、{} またはバリデーションに失敗する
レスポンスを返すと、通話は 422 で拒否されます。このパスでは静的エージェントへの
フォールバックはありません(webhook モードの番号またはキーには、エージェントが
割り当てられていません)。
レスポンスサイズの上限
ハンドラーの例
import hashlib
import hmac
import json
import os
from fastapi import FastAPI, HTTPException, Request
app = FastAPI()
WEBHOOK_SECRET = os.environ["THUNDERPHONE_WEBHOOK_SECRET"]
def verify(body: bytes, signature: str) -> bool:
expected = hmac.new(WEBHOOK_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"] == "telephony.incoming":
caller = event["data"]["from_number"]
prompt = (
"Greet the caller as a San Francisco local…"
if caller.startswith("+1415")
else "You are a friendly customer support agent…"
)
return {
"prompt": prompt,
"voice": "john",
"product": "spark",
}
if event["type"] == "web.incoming":
return {
"prompt": "You are the website's helpful voice assistant…",
"voice": "john",
"product": "spark",
}
return {}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" }),
(req, res) => {
if (!verify(req.body, req.header("X-ThunderPhone-Signature"))) {
return res.sendStatus(401);
}
const event = JSON.parse(req.body.toString("utf8"));
if (event.type === "telephony.incoming" || event.type === "web.incoming") {
const caller = event.data.from_number || "web";
const prompt = caller.startsWith("+1415")
? "Greet the caller as a San Francisco local…"
: "You are a friendly customer support agent…";
return res.json({
prompt,
voice: "john",
product: "spark",
});
}
res.json({});
},
);関数ツールを含むレスポンス
AI が会話中に API を呼び出せるよう、ツールを追加します。
{
"prompt": "You are a booking assistant. Use the available tools to help customers schedule appointments.",
"voice": "john",
"product": "spark",
"tools": [
{
"type": "function",
"function": {
"name": "search_appointments",
"description": "Find available appointment slots",
"parameters": {
"type": "object",
"properties": {
"date": { "type": "string", "description": "YYYY-MM-DD" },
"service": { "type": "string" }
},
"required": ["date"]
}
},
"endpoint": {
"url": "https://api.example.com/appointments/search",
"method": "POST",
"headers": {
"X-Api-Key": "your-key"
}
}
}
]
}製品ティア早見表
| 製品 | レイテンシ | 推論 | 応答 |
|---|---|---|---|
spark | 最小 | 基本 | — |
bolt | 低 | 改善済み | — |
storm-base | 中 | 高度 | — |
storm-base-with-ack | 中 | 高度 | 推論中に自動フィラー |
storm-extra | 高 | 深い | — |
storm-extra-with-ack | 高 | 深い | 推論中に自動フィラー |