telephony.incoming / web.incoming

Когато входящо телефонно обаждане достигне номер без назначен агент, или сесия на уеб джаджа започне с публикуем ключ в mode="webhook", ThunderPhone изпраща блокираща заявка telephony.incoming / web.incoming към вашия URL адрес за legacy webhook и изчаква до 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
storm_feedback_modestringнеnone, acknowledgement (по подразбиране) или tick
languagestringнеСъкратен запис за primary_language
primary_languagestringнеЕзиков код, нормализиран (по подразбиране en). Кодове, които не могат да бъдат разрешени, отхвърлят обаждането
has_additional_languagesbooleanнеПо подразбиране false
additional_languagesarray of stringнеДопълнителни езици, към които агентът може да премине
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 — по този път няма резервен статичен агент (номер или ключ в режим на уебхуки няма зададен агент).


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


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

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({});
  },
);

Отговор с инструменти за функции

Прикачете инструменти, за да може AI да извиква вашите 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По-високоЗадълбоченоАвтоматично запълване по време на обмисляне

Свързано