telephony.incoming / web.incoming

Webhook blocant care configurează în timp real o apelare de intrare.

Când un apel telefonic primit ajunge la un număr fără un agent atribuit sau când o sesiune de widget web începe pe o cheie publicabilă în mode="webhook", ThunderPhone trimite o solicitare blocantă telephony.incoming / web.incoming către adresa URL webhook veche și așteaptă un răspuns de configurare: până la 13 secunde pentru un apel telefonic, inclusiv o reîncercare, și până la 10 secunde pentru o sesiune de widget (consultați Expirări și reîncercări). Utilizați acest schimb pentru a alege dinamic un prompt, o voce și instrumente pentru fiecare apel — consultați ghidul de configurare dinamică a apelurilor pentru modelul complet.

Expirări de timp și reîncercări#

Răspundeți rapid: apelantul așteaptă pe linie în timp ce decideți.

Pentru un apel telefonic (telephony.incoming):

• Prima încercare poate dura până la 10 secunde.
• Dacă expiră, nu se poate conecta sau primește un răspuns 5xx, 408 ori 429, ThunderPhone încearcă încă o dată. Reîncercarea primește timpul rămas dintr-un buget de 13 secunde pentru întregul schimb: aproximativ 3 secunde după o primă încercare care a expirat, aproape toate cele 13 secunde după un eșec rapid. Nu există reîncercare dacă ar rămâne mai puțin de 2 secunde.
• Orice alt răspuns 4xx, un răspuns care depășește limita de dimensiune sau un răspuns 2xx al cărui corp nu este o configurație validă este final și nu este reîncercat.
• Ambele încercări trimit același corp, același antet X-ThunderPhone-Signature și același antet X-ThunderPhone-Idempotency-Key (telephony-incoming-<call_id>), astfel încât un handler cu efecte secundare poate recunoaște reîncercarea.

Nu există agent de rezervă. Dacă nu sosește o configurație utilizabilă, apelul este încheiat imediat, în loc ca apelantul să rămână pe o linie silențioasă. Acesta apare în istoricul apelurilor ca un apel eșuat, nefacturat, cu end_reason inbound_config_webhook_failed, iar evenimentul obișnuit telephony.complete este trimis.

O sesiune de widget (web.incoming) primește o singură încercare de până la 10 secunde. Dacă aceasta eșuează, solicitarea sesiunii eșuează cu 502 sau 422.

Încărcătura solicitării#

Pentru apelurile telefonice (telephony.incoming):

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

Pentru sesiunile widgetului web (web.incoming), data identifică pagina de încorporare în locul numerelor de telefon:

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

Câmpurile de suprascriere (language, voice, website_context și orice variables din browser) sosesc numai când cheia publicabilă le permite în suprascrierile din browser. O solicitare de sesiune care conține una pe care cheia nu o permite este respinsă înainte ca acest webhook să fie apelat.

Schema de răspuns#

Returnați un obiect JSON care descrie configurația agentului pentru acest apel. prompt și voice sunt obligatorii; toate celelalte câmpuri sunt opționale.

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

Deoarece prompt și voice sunt obligatorii, returnarea {} sau a oricărui răspuns care nu trece validarea respinge apelul: un apel telefonic este încheiat conform descrierii din Expirări și reîncercări, iar o solicitare de sesiune pentru widget eșuează cu 422. Nu există o rezervă către un agent static pe această cale (un număr sau o cheie în modul webhook nu are un agent atribuit).

Limită de dimensiune a răspunsului#

Exemplu de handler#

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

Răspuns cu instrumente de funcții#

Atașați instrumente astfel încât AI-ul să vă poată apela API-urile în timpul conversației:

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

Fișă rapidă a nivelurilor de produs#

Asociate#