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"
        }
      }
    }
  ]
}

Коротка довідка щодо рівнів продукту#

Пов’язане#