telephony.incoming / web.incoming

Blokkerende webhook som former konfigurasjonen for et innkommende anrop i sanntid.

Når et innkommende telefonanrop når et nummer uten en tilordnet stemmeagent, eller en nettwidgetøkt starter med en publiserbar nøkkel i mode="webhook", sender ThunderPhone en blokkerende telephony.incoming / web.incoming-forespørsel til din eldre webhook-URL og venter på et konfigurasjonssvar: opptil 13 sekunder for et telefonanrop, inkludert ett nytt forsøk, og opptil 10 sekunder for en widgetøkt (se Tidsavbrudd og nye forsøk). Bruk denne utvekslingen til å velge prompt, stemme og verktøy dynamisk for hvert anrop — se veiledningen for dynamisk samtalekonfigurasjon for det fullstendige mønsteret.

Tidsavbrudd og nye forsøk#

Svar raskt: innringeren venter på linjen mens du avgjør.

For en telefonsamtale (telephony.incoming):

• Det første forsøket kan ta opptil 10 sekunder.
• Hvis det får tidsavbrudd, ikke kan koble til eller får et 5xx-, 408- eller 429-svar, prøver ThunderPhone én gang til. Det nye forsøket får det som gjenstår av et 13-sekunders budsjett for hele utvekslingen: omtrent 3 sekunder etter et første forsøk som fikk tidsavbrudd, og nesten alle 13 etter en rask feil. Det gjøres ikke et nytt forsøk hvis det ville gjenstått mindre enn 2 sekunder.
• Ethvert annet 4xx-svar, et svar over størrelsesgrensen, eller et 2xx-svar med en brødtekst som ikke er en gyldig konfigurasjon, er endelig og prøves ikke på nytt.
• Begge forsøkene sender den samme brødteksten, den samme X-ThunderPhone-Signature-headeren og den samme X-ThunderPhone-Idempotency-Key-headeren (telephony-incoming-<call_id>), slik at en håndterer med sideeffekter kan gjenkjenne det nye forsøket.

Det finnes ingen reserve-stemmeagent. Hvis ingen brukbar konfigurasjon kommer frem, blir samtalen avsluttet med én gang i stedet for å la innringeren vente på en stille linje. Den vises i samtalehistorikken som en mislykket, ikke-fakturert samtale med end_reason inbound_config_webhook_failed, og den vanlige telephony.complete-hendelsen sendes.

En widgetøkt (web.incoming) får ett enkelt forsøk på opptil 10 sekunder. Hvis det mislykkes, mislykkes øktforespørselen med 502 eller 422.

Forespørselsnyttelast#

For telefonanrop (telephony.incoming):

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

For webwidget-økter (web.incoming) identifiserer data innbyggingssiden i stedet for telefonnumre:

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

Overstyringsfeltene (language, voice, website_context og eventuelle nettleser-variables) kommer bare når den publiserbare nøkkelen tillater dem i sine nettleseroverstyringer. En øktforespørsel som inneholder en overstyring nøkkelen ikke tillater, avvises før denne webhooken kalles.

Svarskjema#

Returner et JSON-objekt som beskriver stemmeagentkonfigurasjonen for dette anropet. prompt og voice er påkrevd; alt annet er valgfritt.

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

Fordi prompt og voice er obligatoriske, avviser retur av {} eller et svar som ikke består valideringen anropet: en telefonsamtale avsluttes som beskrevet i Tidsavbrudd og nye forsøk, og en forespørsel om widgetøkt mislykkes med 422. Det finnes ingen reserve for statisk agent på denne banen (et nummer eller en nøkkel i webhook-modus har ingen tildelt agent).

Grense for responsstørrelse#

Eksempelbehandler#

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

Svar med funksjonsverktøy#

Legg ved verktøy slik at AI-en kan kalle API-ene dine midt i samtalen:

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

Hurtigoversikt over produktnivåer#

Relatert#