telephony.incoming / web.incoming

Ko dohodni telefonski klic doseže številko brez dodeljenega agenta ali se seja spletnega gradnika začne z javnim ključem v mode="webhook", ThunderPhone pošlje blokirajočo zahtevo telephony.incoming / web.incoming na vaš podedovani URL webhooka in čaka do 10 sekund na odgovor s konfiguracijo. S to izmenjavo za vsak klic dinamično izberite poziv, glas in orodja — za celoten vzorec glejte vodnik za dinamično konfiguracijo klicev.

Blokirajoča izmenjava nima nadomestne možnosti: če vaš obdelovalnik vrne status, ki ni 2xx, poteče časovna omejitev ali vrne konfiguracijo, ki ne prestane preverjanja, je klic zavrnjen (telefonski klic se ne vzpostavi; zahteva seje gradnika ne uspe s 502/422). Odgovorite hitro — klicatelj med vašim odločanjem sliši signal zvonjenja.

Telo zahteve

Za telefonske klice (telephony.incoming):

{
  "type": "telephony.incoming",
  "data": {
    "call_id":     987654321,
    "from_number": "+14155550199",
    "to_number":   "+15551234567"
  }
}
PoljeVrstaOpis
call_idintegerID klica — nespremenljiv v vseh dogodkih za ta klic
from_numberstringŠtevilka klicatelja E.164
to_numberstringCilj E.164 (ena od vaših številk ThunderPhone)

Za seje spletnega gradnika (web.incoming) data namesto telefonskih številk določa stran, v katero je gradnik vdelan:

{
  "type": "web.incoming",
  "data": {
    "call_id": 987654322,
    "origin_domain": "https://example.com",
    "publishable_key_prefix": "pk_live_a1b2"
  }
}
PoljeVrstaOpis
call_idintegerID klica
origin_domainstringIzvor strani, ki gosti gradnik
publishable_key_prefixstringPrvi znaki javnega ključa, ki je odprl sejo
language, primary_languagestringPrisotno, ko seja gradnika zahteva preglasitev jezika
voicestringPrisotno, ko seja gradnika zahteva preglasitev glasu
website_contextstringPrisotno, ko gradnik posreduje kontekst strani za posamezno sejo

Shema odgovora

Vrnite predmet JSON, ki opisuje konfiguracijo agenta za ta klic. prompt in voice sta obvezna; vse drugo ni obvezno.

{
  "prompt":  "You are a helpful booking assistant for Acme Restaurant.",
  "voice":   "john",
  "product": "spark",
  "background_track": null,
  "tools":   []
}
PoljeVrstaObveznoOpis
promptnizdaSistemski poziv, ki usmerja agenta
voicenizdaID glasu iz GET /v1/voices, npr. john. voice_name je sprejet kot vzdevek. Neznani glasovi ne prestanejo preverjanja in zavrnejo klic
productniznePrivzeto je spark. Dovoljeno: spark, bolt, storm-base, storm-base-with-ack, storm-extra, storm-extra-with-ack
thinking_levelnizneminimal, base (privzeto) ali extra. Za izdelke Storm je prepisano: storm-extra* vsili extra, drugi storm-* vsilijo base
audio_context_modeniznefull (privzeto) ali reduced
watchdog_enabledlogična vrednostneOmogočite nadzor za ta klic. Privzeto false
storm_feedback_modeniznenone, acknowledgement (privzeto) ali tick
languagenizneOkrajšava za primary_language
primary_languagenizneJezikovna koda, normalizirana (privzeto en). Nerazrešljive kode zavrnejo klic
has_additional_languageslogična vrednostnePrivzeto false
additional_languagespolje nizovneDodatni jeziki, v katere lahko agent preklopi
background_trackniz | nullneID ambientalnega zvoka ali null
acknowledgement_prompt_modenizneauto (privzeto) ali manual (izdelki Storm-with-ack)
acknowledgement_promptnizneUporabi se, ko je acknowledgement_prompt_mode="manual"
silence_interval_secondscelo število | nullne5–120. Sekunde tišine klicatelja pred preverjanjem
silence_max_checkinscelo število | nullne1–10
silence_checkins_enabledlogična vrednostnePrivzeto true
connect_tone_enabledlogična vrednostnePrivzeto false
voicemail_actionnizneprompt (privzeto), hangup ali message
voicemail_messagenizneUporabi se, ko je voicemail_action="message"
agent_nameniznePrikazno ime, prikazano na nadzornih ploščah in v pripomočku
org_nameniznePrikazno ime organizacije za osebnost agenta
toolspoljeneVdelane sheme funkcijskih orodij (glejte Funkcijska orodja)
call_idcelo številoneIzbirni odmev ID-ja klica iz zahteve; prezrto

Ker sta prompt in voice obvezna, vrnitev {} ali katerega koli odgovora, ki ne prestane preverjanja, zavrne klic s 422 — na tej poti ni nadomestne možnosti statičnega agenta (številka ali ključ v načinu spletnega kavlja nima dodeljenega agenta).


Omejitev velikosti odgovora


Primer upravljalnika

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

Odgovor s funkcijskimi orodji

Pripnite orodja, da lahko AI med pogovorom kliče vaše API-je:

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

Hiter pregled produktnih stopenj

ProduktZakasnitevSklepanjePotrditev
sparkNajnižjaOsnovno
boltNizkaIzboljšano
storm-baseSrednjaZmogljivo
storm-base-with-ackSrednjaZmogljivoSamodejno zapolnilo med razmišljanjem
storm-extraVišjaPoglobljeno
storm-extra-with-ackVišjaPoglobljenoSamodejno zapolnilo med razmišljanjem

Povezano