telephony.incoming / web.incoming

Блокирующий вебхук, который в реальном времени задаёт конфигурацию входящего звонка.

Когда входящий телефонный звонок поступает на номер без назначенного агента, или сеанс веб-виджета запускается с публикуемым ключом в mode="webhook", ThunderPhone отправляет блокирующий запрос telephony.incoming / web.incoming на ваш устаревший URL вебхука и ожидает ответ с конфигурацией: до 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 секунд. Если она завершается ошибкой, запрос сессии завершается с 502 или 422.

Полезная нагрузка запроса#

Для телефонных звонков (telephony.incoming):

{
  "type": "telephony.incoming",
  "data": {
    "call_id":     987654321,
    "from_number": "+14155550199",
    "to_number":   "+15551234567"
  }
}

Для сеансов веб-виджета (web.incoming) объект data определяет встраивающую страницу вместо телефонных номеров:

{
  "type": "web.incoming",
  "data": {
    "call_id": 987654322,
    "origin_domain": "https://example.com",
    "publishable_key_prefix": "pk_live_a1b2"
  }
}

Поля переопределения (language, voice, website_context и любые браузерные variables) передаются только тогда, когда публикуемый ключ разрешает их в своих переопределениях браузера. Запрос сессии, содержащий параметр, который ключ не разрешает, отклоняется до вызова этого вебхука.

Схема ответа#

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

{
  "prompt":  "You are a helpful booking assistant for Acme Restaurant.",
  "voice":   "john",
  "product": "spark",
  "background_track": null,
  "tools":   []
}

Поскольку 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"
        }
      }
    }
  ]
}

Краткая памятка по тарифам продуктов#

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