telephony.incoming / web.incoming

Blokkoló webhook, amely valós időben alakítja a bejövő hívás konfigurációját.

Amikor egy bejövő telefonhívás egy hozzárendelt AI-ügynök nélküli számot ér el, vagy egy webes widget-munkamenet egy közzétehető kulcson indul mode="webhook" módban, a ThunderPhone blokkoló telephony.incoming / web.incoming kérést küld az Ön régi webhook URL-címére, és konfigurációs válaszra vár: telefonhívás esetén legfeljebb 13 másodpercig, egy újrapróbálkozást is beleértve, widget-munkamenet esetén pedig legfeljebb 10 másodpercig (lásd: Időtúllépések és újrapróbálkozások). Ezzel a kommunikációval hívásonként dinamikusan választhat promptot, hangot és eszközöket — a teljes körű mintáért lásd a dinamikus híváskonfiguráció útmutatóját.

Időtúllépések és újrapróbálkozások#

Válaszoljon gyorsan: a hívó a vonalban vár, amíg Ön dönt.

Telefonhívás esetén (telephony.incoming):

• Az első kísérlet legfeljebb 10 másodpercig tarthat.
• Ha időtúllépés történik, nem sikerül kapcsolódni, vagy 5xx, 408 vagy 429 választ kap, a ThunderPhone még egyszer megpróbálja. Az újrapróbálkozás a teljes műveletre rendelkezésre álló 13 másodperces időkeretből fennmaradó időt kapja: egy időtúllépéssel végződő első kísérlet után körülbelül 3 másodpercet, gyors hiba után pedig majdnem mind a 13 másodpercet. Nincs újrapróbálkozás, ha kevesebb mint 2 másodperc maradna.
• Bármely egyéb 4xx válasz, a méretkorlátot meghaladó válasz, illetve olyan 2xx válasz, amelynek törzse nem érvényes konfiguráció, végleges, és nincs újrapróbálkozás.
• Mindkét kísérlet ugyanazt a törzset, ugyanazt az X-ThunderPhone-Signature és ugyanazt az X-ThunderPhone-Idempotency-Key fejlécet küldi (telephony-incoming-<call_id>), így a mellékhatásokat végrehajtó kezelő felismerheti az újrapróbálkozást.

Nincs tartalék ügynök. Ha nem érkezik használható konfiguráció, a hívás azonnal befejeződik ahelyett, hogy a hívó néma vonalban várakozna. A híváselőzményekben sikertelen, számlázatlan hívásként jelenik meg end_reason inbound_config_webhook_failed értékkel, és a szokásos telephony.complete esemény elküldésre kerül.

Egy widgetmunkamenet (web.incoming) esetében egyetlen, legfeljebb 10 másodpercig tartó kísérlet történik. Ha ez sikertelen, a munkamenet-kérés 502 vagy 422 hibával meghiúsul.

Kérés hasznos adatai#

Telefonhívásokhoz (telephony.incoming):

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

Webes widgetmunkameneteknél (web.incoming) a data telefonos számok helyett a beágyazó oldalt azonosítja:

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

A felülbírálási mezők (language, voice, website_context és bármely böngészőbeli variables) csak akkor érkeznek meg, ha a publikálható kulcs engedélyezi őket a böngészőfelülbírálásokban. Az olyan munkamenetkérést, amely a kulcs által nem engedélyezett felülbírálást tartalmaz, a rendszer elutasítja, mielőtt ezt a webhookot meghívná.

Válaszséma#

Adjon vissza egy JSON-objektumot, amely leírja az ügynök konfigurációját ehhez a híváshoz. A prompt és a voice kötelező; minden más opcionális.

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

Mivel a prompt és a voice kötelező, a {} vagy bármely, az ellenőrzésen megbukó válasz elutasítja a hívást: a telefonhívás a Időtúllépések és újrapróbálkozások című részben leírtak szerint megszakad, a widget-munkamenet kérése pedig 422 hibával meghiúsul. Ezen az útvonalon nincs statikus ügynökes visszaesés (webhook módban egy számhoz vagy kulcshoz nincs ügynök hozzárendelve).

Válaszméret-korlát#

Példakezelő#

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

Válasz funkcióeszközökkel#

Csatoljon eszközöket, hogy az AI a beszélgetés közben meghívhassa az API-jait:

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

Termékszint áttekintő#

Kapcsolódó#