ThunderPhone 2.0 уже доступен.Самостоятельное подключение — от 2 центов/мин.Читать анонс

Webhooks

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_idintegerИдентификатор звонка — неизменен во всех событиях этого звонка
from_numberstringНомер звонящего в формате E.164
to_numberstringАдресат в формате 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_idintegerИдентификатор звонка
origin_domainstringИсточник страницы, на которой размещён виджет
publishable_key_prefixstringПервые символы публикуемого ключа, открывшего сеанс
language, primary_languagestringПрисутствует, если в сеансе виджета запрошено переопределение языка
voicestringПрисутствует, если в сеансе виджета запрошено переопределение голоса
website_contextstringПрисутствует, если виджет передал контекст страницы для конкретного сеанса

Схема ответа

Верните объект JSON, описывающий конфигурацию агента для этого звонка. prompt и voice обязательны; всё остальное необязательно.

{
  "prompt":  "You are a helpful booking assistant for Acme Restaurant.",
  "voice":   "john",
  "product": "spark",
  "background_track": null,
  "tools":   []
}
ПолеТипОбязательноОписание
promptstringдаСистемный промпт, управляющий агентом
voicestringдаИдентификатор голоса из GET /v1/voices, например john. voice_name принимается как псевдоним. Неизвестные голоса не проходят проверку и отклоняют звонок
productstringнетПо умолчанию spark. Допустимые значения: spark, bolt, storm-base, storm-base-with-ack, storm-extra, storm-extra-with-ack
thinking_levelstringнетminimal, base (по умолчанию) или extra. Переопределяется для продуктов Storm: storm-extra* принудительно задаёт extra, остальные storm-*base
audio_context_modestringнетfull (по умолчанию) или reduced
watchdog_enabledbooleanнетВключает мониторинг этого звонка. По умолчанию false
additional_audio_contextboolean | nullнетВключает несколько последних реплик аудио звонящего вместо только самой последней, что улучшает исправления и сбор данных с частым произнесением букв и чисел при небольшом увеличении задержки и стоимости. По умолчанию включено для входящих сессий и выключено для исходящих телефонных звонков; null сохраняет значение по умолчанию
storm_feedback_modestringнетnone, acknowledgement (по умолчанию) или tick
languagestringнетСокращение для primary_language
primary_languagestringнетКод языка в нормализованном виде (по умолчанию en). Нераспознаваемые коды отклоняют звонок
has_additional_languagesbooleanнетПо умолчанию false
additional_languagesarray of stringнетДополнительные языки, на которые агент может переключаться
native_voice_switchingbooleanнетПо умолчанию false. Когда звонок переключается на другой язык, используется голос, являющийся носителем этого языка (с совпадением по полу), вместо сохранения настроенного голоса
background_trackstring | nullнетИдентификатор фонового аудио или null
acknowledgement_prompt_modestringнетauto (по умолчанию) или manual (для продуктов Storm-with-ack)
acknowledgement_promptstringнетИспользуется, когда acknowledgement_prompt_mode="manual"
silence_interval_secondsinteger | nullнет5–120. Количество секунд молчания звонящего перед проверкой связи
silence_max_checkinsinteger | nullнет1–10
silence_checkins_enabledbooleanнетПо умолчанию true
connect_tone_enabledbooleanнетПо умолчанию false
voicemail_actionstringнетprompt (по умолчанию), hangup или message
voicemail_messagestringнетИспользуется, когда voicemail_action="message"
agent_namestringнетОтображаемое имя, передаваемое в панели управления и виджет
org_namestringнетОтображаемое название организации для образа агента
toolsarrayнетВстроенные схемы инструментов-функций (см. Инструменты-функции)
call_idintegerнетНеобязательное эхо идентификатора звонка из запроса; игнорируется

Поскольку prompt и voice обязательны, возврат {} или любого ответа, не прошедшего проверку, отклоняет звонок с кодом 422 — для этого пути нет резервного статического агента (у номера или ключа в режиме webhook нет назначенного агента).


Ограничение размера ответа


Пример обработчика

Python (FastAPI)
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 {}
Node.js (Express)
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Более высокаяГлубокоеАвтоматическая фраза-заполнитель во время размышления

Связанные материалы