telephony.incoming / web.incoming

Keď prichádzajúci telefonický hovor dorazí na číslo bez priradeného hlasového agenta, alebo sa relácia webového widgetu spustí na verejnom kľúči v režime mode="webhook", ThunderPhone odošle blokujúcu požiadavku telephony.incoming / web.incoming na vašu staršiu URL webhooku a na odpoveď s konfiguráciou čaká až 10 sekúnd. Túto výmenu použite na dynamický výber promptu, hlasu a nástrojov pre každý hovor — celý postup nájdete v sprievodcovi dynamickou konfiguráciou hovorov.

Blokujúca výmena nemá záložné riešenie: ak váš obslužný program vráti stav iný než 2xx, vyprší časový limit alebo vráti konfiguráciu, ktorá neprejde overením, hovor sa odmietne (telefonický hovor sa nepripojí; požiadavka relácie widgetu zlyhá s 502/422). Odpovedzte rýchlo — volajúci počas vášho rozhodovania počuje vyzváňací tón.

Údaje požiadavky

Pre telefonické hovory (telephony.incoming):

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

Pre relácie webového widgetu (web.incoming) data identifikuje stránku s vloženým widgetom namiesto telefónnych čísel:

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

Schéma odpovede

Vráťte objekt JSON opisujúci konfiguráciu agenta pre tento hovor. prompt a voice sú povinné; všetko ostatné je voliteľné.

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

Keďže prompt a voice sú povinné, vrátenie {} alebo akejkoľvek odpovede, ktorá neprejde validáciou, odmietne hovor s kódom 422 — na tejto ceste neexistuje záložný statický agent (číslo alebo kľúč v režime webhooku nemá priradeného agenta).

Limit veľkosti odpovede

Príklad obslužnej funkcie

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

Odpoveď s funkčnými nástrojmi

Pripojte nástroje, aby hlasový agent AI mohol počas konverzácie volať 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"
        }
      }
    }
  ]
}

Rýchly prehľad produktových úrovní

Súvisiace