telephony.incoming / web.incoming

Blokujący webhook, który kształtuje konfigurację połączenia przychodzącego w czasie rzeczywistym.

Gdy przychodzące połączenie telefoniczne trafia na numer bez przypisanego agenta głosowego albo sesja widżetu internetowego rozpoczyna się przy użyciu klucza publikowalnego w mode="webhook", ThunderPhone wysyła blokujące żądanie telephony.incoming / web.incoming na Twój starszy adres URL webhooka i czeka na odpowiedź z konfiguracją: do 13 sekund w przypadku połączenia telefonicznego, z uwzględnieniem jednej ponownej próby, oraz do 10 sekund w przypadku sesji widżetu (zobacz Limity czasu i ponowne próby). Użyj tej wymiany, aby dynamicznie wybierać prompt, głos i narzędzia dla każdego połączenia — pełny wzorzec znajdziesz w przewodniku po dynamicznej konfiguracji połączeń.

Przekroczenia limitu czasu i ponowne próby#

Odpowiadaj szybko: rozmówca czeka na linii, gdy podejmujesz decyzję.

W przypadku połączenia telefonicznego (telephony.incoming):

• Pierwsza próba może trwać do 10 sekund.
• Jeśli przekroczy limit czasu, nie może się połączyć lub otrzyma odpowiedź 5xx, 408 albo 429, ThunderPhone podejmuje jeszcze jedną próbę. Ponowna próba otrzymuje pozostałą część 13-sekundowego budżetu na całą wymianę: około 3 sekundy po pierwszej próbie, która przekroczyła limit czasu, i prawie całe 13 sekund po szybkim niepowodzeniu. Nie podejmuje się ponownej próby, gdy pozostałyby mniej niż 2 sekundy.
• Każda inna odpowiedź 4xx, odpowiedź przekraczająca limit rozmiaru lub odpowiedź 2xx, której treść nie jest prawidłową konfiguracją, jest ostateczna i nie jest ponawiana.
• Obie próby wysyłają tę samą treść, ten sam nagłówek X-ThunderPhone-Signature oraz ten sam nagłówek X-ThunderPhone-Idempotency-Key (telephony-incoming-<call_id>), dzięki czemu procedura obsługi powodująca skutki uboczne może rozpoznać ponowną próbę.

Nie ma agenta awaryjnego. Jeśli nie nadejdzie użyteczna konfiguracja, połączenie jest natychmiast kończone, zamiast pozostawiać rozmówcę na cichej linii. W Historii połączeń jest widoczne jako nieudane połączenie, za które nie naliczono opłaty, z end_reason inbound_config_webhook_failed, a standardowe zdarzenie telephony.complete jest wysyłane.

Sesja widżetu (web.incoming) otrzymuje jedną próbę trwającą do 10 sekund. Jeśli się nie powiedzie, żądanie sesji kończy się błędem 502 lub 422.

Ładunek żądania#

Dla połączeń telefonicznych (telephony.incoming):

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

W przypadku sesji widżetu internetowego (web.incoming) pole data identyfikuje stronę osadzającą zamiast numerów telefonów:

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

Pola zastępujące (language, voice, website_context oraz wszelkie przeglądarkowe variables) są przekazywane tylko wtedy, gdy klucz publiczny zezwala na nie w swoich zastąpieniach przeglądarkowych. Żądanie sesji zawierające pole, na które klucz nie zezwala, jest odrzucane przed wywołaniem tego webhooka.

Schemat odpowiedzi#

Zwróć obiekt JSON opisujący konfigurację agenta dla tego połączenia. prompt i voice są wymagane; wszystkie pozostałe pola są opcjonalne.

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

Ponieważ prompt i voice są wymagane, zwrócenie {} lub dowolnej odpowiedzi, która nie przejdzie walidacji, odrzuca połączenie: połączenie telefoniczne jest kończone zgodnie z opisem w Limitach czasu i ponowieniach, a żądanie sesji widżetu kończy się błędem 422. Na tej ścieżce nie ma awaryjnego użycia statycznego agenta (numer lub klucz w trybie webhook nie ma przypisanego agenta).

Limit rozmiaru odpowiedzi#

Przykładowy moduł obsługi#

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

Odpowiedź z narzędziami funkcyjnymi#

Dołącz narzędzia, aby AI mogła wywoływać Twoje API w trakcie rozmowy:

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

Ściągawka dotycząca poziomów produktów#

Powiązane#