telephony.incoming / web.incoming
Блокирующий вебхук, который в реальном времени задаёт конфигурацию входящего звонка.
Когда входящий телефонный звонок поступает на номер без назначенного
агента или начинается сеанс веб-виджета на публикуемом ключе в
mode="webhook", ThunderPhone отправляет блокирующий
запрос telephony.incoming / web.incoming на ваш
устаревший URL вебхука
и ожидает до 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 |
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 | нет | Идентификатор фонового аудио или 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 — для этого
пути нет резервного статического агента (у номера или ключа в режиме 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({});
},
);Ответ с инструментами функций
Добавьте инструменты, чтобы ИИ мог вызывать ваши 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-тестов для каждого звонящего.