telephony.incoming / web.incoming
Когато входящо телефонно обаждане достигне номер без назначен
агент, или сесия на уеб джаджа започне с публикуем ключ в
mode="webhook", ThunderPhone изпраща блокираща
заявка telephony.incoming / web.incoming към вашия
URL адрес за legacy webhook
и изчаква до 10 секунди за отговор с конфигурация. Използвайте този
обмен, за да избирате динамично подкана, глас и инструменти за всяко обаждане —
вижте ръководството за динамична конфигурация на обаждания
за цялостния модел.
Блокиращият обмен няма резервен вариант: ако вашият обработчик върне
статус извън 2xx, изтече времето му или върне конфигурация, която не премине
валидация, обаждането се отхвърля (телефонното обаждане не се свързва; заявката
за сесия на джаджата е неуспешна с 502/422). Отговорете бързо — обаждащият се
чува сигнал за свободна линия, докато вземате решение.
Тяло на заявката
За телефонни обаждания (telephony.incoming):
{
"type": "telephony.incoming",
"data": {
"call_id": 987654321,
"from_number": "+14155550199",
"to_number": "+15551234567"
}
}
| Поле | Тип | Описание |
|---|---|---|
call_id | integer | Идентификатор на обаждането — постоянен за всички събития за това обаждане |
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 | Идентификатор на обаждането |
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, напр. 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 |
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 | не | Допълнителни езици, към които агентът може да премине |
background_track | string | null | не | Идентификатор на фоново аудио или 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 | не | Незадължително ехо на идентификатора на обаждането от заявката; игнорира се |
Тъй като prompt и voice са задължителни, връщането на {} или на какъвто и да е
отговор, който не преминава валидацията, отхвърля обаждането с 422 — по този
път няма резервен статичен агент (номер или ключ в режим на уебхуки няма
зададен агент).
Ограничение за размера на отговора
Примерен обработчик
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 | По-високо | Задълбочено | Автоматично запълване по време на обмисляне |
Свързано
Неблокиращото събитие при приключване на разговора.
Пълна JSON схема за tools[] и договорът за подписаната крайна точка.
Абонирайте няколко URL адреса за telephony.incoming / web.incoming.
Шаблони за подсказки, инструменти и A/B тестове за всеки обаждащ се.