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 — для цього
шляху немає резервного статичного агента (номер або ключ у режимі вебхука
не має призначеного агента).
Обмеження розміру відповіді
Приклад обробника
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-тестів для кожного абонента.