Open in
telephony.incoming / web.incoming
着信通話の設定をリアルタイムで構成するブロッキングWebhook。
着信電話が エージェントが割り当てられていない番号にかかるか、Web ウィジェットセッションが公開キーで
mode="webhook" を使用して開始されると、ThunderPhone は ブロッキング方式で
telephony.incoming / web.incoming リクエストを
レガシー Webhook URL
に送信し、設定レスポンスを待機します。電話の場合は再試行1回を含めて 13秒以内、ウィジェットセッションの場合は 10秒以内です(タイムアウトと再試行を参照)。このやり取りを使用して、通話ごとにプロンプト、音声、ツールを動的に選択できます。エンドツーエンドのパターンについては、
動的な通話設定ガイド
を参照してください。
タイムアウトと再試行
迅速に応答してください。判断している間、発信者は回線上で待っています。
電話通話(telephony.incoming)の場合:
- 最初の試行には最大 10 秒かかることがあります。
- タイムアウトした場合、接続できない場合、または
5xx、408、429のレスポンスを受け取った場合、ThunderPhone はもう一度試行します。再試行には、 やり取り全体に対する 13 秒の予算の残り時間が割り当てられます。最初の試行が タイムアウトした場合は約 3 秒、高速に失敗した場合はほぼ 13 秒です。 残り時間が 2 秒未満の場合、再試行は行われません。 - その他の
4xxレスポンス、サイズ制限を超えるレスポンス、 または本文が有効な設定ではない2xxは最終結果となり、再試行されません。 - 両方の試行で同じ本文、同じ
X-ThunderPhone-Signature、 同じX-ThunderPhone-Idempotency-Keyヘッダー (telephony-incoming-<call_id>)が送信されるため、副作用のあるハンドラーでも 再試行を認識できます。
フォールバックエージェントはありません。使用可能な設定が届かない場合、発信者を無音の
回線で待たせるのではなく、通話は直ちに終了します。通話履歴には、end_reason
inbound_config_webhook_failed の失敗した課金対象外の通話として表示され、通常の
telephony.complete イベントが送信されます。
ウィジェットセッション(web.incoming)は最大 10 秒の試行を 1 回行います。失敗した場合、
セッションリクエストは 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 | ウィジェットがセッションごとのページコンテキストを渡した場合に存在 |
オーバーライドフィールド(language、voice、website_context、および任意の
ブラウザvariables)は、公開可能キーが
ブラウザオーバーライドで許可している場合にのみ届きます。キーで許可されていないフィールドを含む
セッションリクエストは、このWebhookが呼び出される前に拒否されます。
レスポンススキーマ
この通話のエージェント設定を記述する JSON オブジェクトを返します。
prompt と voice は必須で、それ以外はすべて任意です。
{
"prompt": "You are a helpful booking assistant for Acme Restaurant.",
"voice": "john",
"product": "spark",
"background_track": null,
"tools": []
}| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
prompt | 文字列 | はい | エージェントを動作させるシステムプロンプト |
voice | 文字列 | はい | GET /v1/voices の音声 ID(例: john)。voice_name はエイリアスとして使用できます。不明な音声は検証に失敗し、通話は拒否されます |
product | 文字列 | いいえ | デフォルトは spark。使用可能な値: spark、bolt、storm-base、storm-base-with-ack、storm-extra、storm-extra-with-ack |
thinking_level | 文字列 | いいえ | minimal、base(デフォルト)、または extra。Storm 製品では上書きされます。storm-extra* は extra を強制し、その他の storm-* は base を強制します |
audio_context_mode | 文字列 | いいえ | full(デフォルト)または reduced |
watchdog_enabled | ブール値 | いいえ | この通話の監視を有効にします。デフォルトは false |
additional_audio_context | ブール値 | null | いいえ | 直近のターンのみではなく、発信者音声の直近数ターンを含めます。わずかなレイテンシーとコストの増加で、修正やスペル・数字を多く含むデータ収集が向上します。着信セッションではデフォルトでオン、発信電話ではオフです。null を指定するとデフォルトが維持されます |
storm_feedback_mode | 文字列 | いいえ | none、acknowledgement(デフォルト)、または tick |
language | 文字列 | いいえ | primary_language の短縮形 |
primary_language | 文字列 | いいえ | 正規化された言語コード(デフォルトは en)。解決できないコードは通話を拒否します |
has_additional_languages | ブール値 | いいえ | デフォルトは false |
additional_languages | 文字列の配列 | いいえ | エージェントが切り替え可能な追加言語 |
native_voice_switching | ブール値 | いいえ | デフォルトは false。通話中に別の言語へ切り替わると、設定済みの音声を維持する代わりに、その言語のネイティブ音声へ切り替えます(性別を一致させます) |
language_switching | 文字列 | null | いいえ | ask_first(デフォルト)または follow_caller。null は ask_first と同じです。多言語エージェントが、発信者が別の対応言語を話した場合にどう処理するかを指定します。ask_first は、発信者がその言語を求めるか、その言語で完全な文を話した場合に直ちに切り替え、「はい」のような短い発話の後にはその言語で続けるか確認します。follow_caller は、単語ひとつであっても、発信者が話す設定済み言語へ切り替えます。additional_languages が設定されている場合にのみ適用されます |
background_track | 文字列 | null | いいえ | 環境音声 ID または null |
acknowledgement_prompt_mode | 文字列 | いいえ | auto(デフォルト)または manual(Storm-with-ack 製品) |
acknowledgement_prompt | 文字列 | いいえ | acknowledgement_prompt_mode="manual" の場合に使用されます |
silence_interval_seconds | 整数 | null | いいえ | 5~120。確認前に発信者が無音でいる秒数 |
silence_max_checkins | 整数 | null | いいえ | 1~10 |
silence_checkins_enabled | ブール値 | いいえ | デフォルトは true |
connect_tone_enabled | ブール値 | いいえ | デフォルトは false |
pronunciation_dicts | ブール値 | null | いいえ | デフォルトは false。null は false と同じです。true の場合、通話の Cartesia 音声は、存在する場合にその通話の言語向け ThunderPhone 発音辞書を使用します。電話通話とウィジェット通話で動作します。ThunderPhone 独自の Cartesia 音声にのみ適用され、独自の Cartesia API キーの音声には適用されません。保存済みエージェントの設定が適用される agent_id では使用されません |
voicemail_action | 文字列 | いいえ | prompt(デフォルト)、hangup、または message |
voicemail_message | 文字列 | いいえ | voicemail_action="message" の場合に使用されます |
agent_name | 文字列 | いいえ | ダッシュボードとウィジェットに表示される表示名 |
org_name | 文字列 | いいえ | エージェントのペルソナ用の組織表示名 |
tools | 配列 | いいえ | インライン関数ツールスキーマ(関数ツールを参照) |
transfer_destinations | オブジェクトの配列 | null | いいえ | この通話で転送可能な {name, number} エントリを最大 50 件指定します。エージェントの転送先番号と同様に検証されます。エージェントは名前で転送し、指定された宛先にのみ転送します。[] は転送なしを意味します。省略するか null を送信すると、エージェントが選択した番号へ転送できます |
timezone | 文字列 | いいえ | America/Chicago など、この通話の IANA タイムゾーン。エージェントは自身のタイムゾーンより優先して、このタイムゾーンの日付と時刻を案内します。agent_id と併用することもできます。IANA タイムゾーンではない値は無視されます。通話ごとにタイムゾーンを設定するを参照してください |
call_id | 整数 | いいえ | リクエストの通話 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 | 高 | 深い | 推論中に自動フィラー |