ThunderPhone 2.0 je tady.Začnete bez obchodníka, od 2 ¢/min.Přečíst oznámení

Webhooks

telephony.incoming / web.incoming

Blokující webhook, který v reálném čase upravuje konfiguraci příchozího hovoru.

Když příchozí telefonní hovor dorazí na číslo bez přiřazeného agenta nebo když se relace webového widgetu spustí na publikovatelném klíči v režimu mode="webhook", ThunderPhone odešle blokující požadavek telephony.incoming / web.incoming na vaši starší URL webhooku a až 10 sekund čeká na odpověď s konfigurací. Pomocí této výměny dynamicky zvolte výzvu, hlas a nástroje pro každý hovor — kompletní postup najdete v průvodci dynamickou konfigurací hovorů.

Blokující výměna nemá záložní řešení: pokud váš obslužný program vrátí stav jiný než 2xx, vyprší jeho časový limit nebo vrátí konfiguraci, která neprojde ověřením, hovor bude odmítnut (telefonní hovor se nespojí; požadavek na relaci widgetu selže s 502/422). Odpovězte rychle — volající během vašeho rozhodování slyší vyzváněcí tón.

Datová část požadavku

Pro telefonní hovory (telephony.incoming):

{
  "type": "telephony.incoming",
  "data": {
    "call_id":     987654321,
    "from_number": "+14155550199",
    "to_number":   "+15551234567"
  }
}
PoleTypPopis
call_idcelé čísloID hovoru — stabilní napříč všemi událostmi tohoto hovoru
from_numberřetězecČíslo volajícího ve formátu E.164
to_numberřetězecCíl ve formátu E.164 (jedno z vašich čísel ThunderPhone)

Pro relace webového widgetu (web.incoming) data identifikuje stránku s vloženým widgetem namísto telefonních čísel:

{
  "type": "web.incoming",
  "data": {
    "call_id": 987654322,
    "origin_domain": "https://example.com",
    "publishable_key_prefix": "pk_live_a1b2"
  }
}
PoleTypPopis
call_idcelé čísloID hovoru
origin_domainřetězecPůvod stránky hostující widget
publishable_key_prefixřetězecPrvní znaky publikovatelného klíče, který otevřel relaci
language, primary_languageřetězecPřítomno, když relace widgetu požadovala přepsání jazyka
voiceřetězecPřítomno, když relace widgetu požadovala přepsání hlasu
website_contextřetězecPřítomno, když widget předal kontext stránky pro danou relaci

Schéma odpovědi

Vraťte objekt JSON popisující konfiguraci agenta pro tento hovor. prompt a voice jsou povinné; vše ostatní je volitelné.

{
  "prompt":  "You are a helpful booking assistant for Acme Restaurant.",
  "voice":   "john",
  "product": "spark",
  "background_track": null,
  "tools":   []
}
PoleTypPovinnéPopis
promptstringanoSystémový prompt řídící agenta
voicestringanoID hlasu z GET /v1/voices, například john. voice_name je přijímáno jako alias. Neznámé hlasy neprojdou ověřením a hovor odmítnou
productstringneVýchozí hodnota je spark. Povolené hodnoty: spark, bolt, storm-base, storm-base-with-ack, storm-extra, storm-extra-with-ack
thinking_levelstringneminimal, base (výchozí) nebo extra. Pro produkty Storm je přepsáno: storm-extra* vynutí extra, ostatní storm-* vynutí base
audio_context_modestringnefull (výchozí) nebo reduced
watchdog_enabledbooleannePovolí dohled pro tento hovor. Výchozí hodnota je false
additional_audio_contextboolean | nullneZahrne posledních několik tahů zvuku volajícího namísto pouze posledního tahu, čímž zlepší opravy a sběr dat s častým hláskováním či čísly za cenu mírného zvýšení latence a nákladů. Pro příchozí relace je ve výchozím nastavení zapnuto a pro odchozí telefonní hovory vypnuto; null zachová výchozí nastavení
storm_feedback_modestringnenone, acknowledgement (výchozí) nebo tick
languagestringneZkrácený zápis pro primary_language
primary_languagestringneKód jazyka, normalizovaný (výchozí hodnota en). Nevyřešitelné kódy hovor odmítnou
has_additional_languagesbooleanneVýchozí hodnota je false
additional_languagesarray of stringneDalší jazyky, do kterých může agent přepnout
native_voice_switchingbooleanneVýchozí hodnota je false. Když hovor přepne do jiného jazyka, místo zachování nakonfigurovaného hlasu se použije hlas, který je pro daný jazyk rodilý (shodný podle pohlaví)
background_trackstring | nullneID zvukového pozadí nebo null
acknowledgement_prompt_modestringneauto (výchozí) nebo manual (produkty Storm s potvrzením)
acknowledgement_promptstringnePoužije se, když acknowledgement_prompt_mode="manual"
silence_interval_secondsinteger | nullne5–120. Počet sekund ticha volajícího před kontrolním oslovením
silence_max_checkinsinteger | nullne1–10
silence_checkins_enabledbooleanneVýchozí hodnota je true
connect_tone_enabledbooleanneVýchozí hodnota je false
voicemail_actionstringneprompt (výchozí), hangup nebo message
voicemail_messagestringnePoužije se, když voicemail_action="message"
agent_namestringneZobrazovaný název hlášený na dashboardech a ve widgetu
org_namestringneZobrazovaný název organizace pro personu agenta
toolsarrayneVložená schémata funkčních nástrojů (viz Funkční nástroje)
call_idintegerneVolitelné zopakování ID hovoru z požadavku; ignorováno

Protože jsou prompt a voice povinné, vrácení {} nebo jakékoli odpovědi, která neprojde ověřením, odmítne hovor s kódem 422 — pro tuto cestu neexistuje záložní statický agent (číslo ani klíč v režimu webhooku nemají přiřazeného agenta).


Limit velikosti odpovědi


Příklad obslužné funkce

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

Odpověď s funkčními nástroji

Připojte nástroje, aby AI mohla během konverzace volat vaše 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"
        }
      }
    }
  ]
}

Přehled produktových úrovní

ProduktLatenceUvažováníPotvrzení
sparkNejnižšíZákladní
boltNízkáVylepšené
storm-baseStředníSilné
storm-base-with-ackStředníSilnéAutomatická výplň během uvažování
storm-extraVyššíHloubkové
storm-extra-with-ackVyššíHloubkovéAutomatická výplň během uvažování

Související