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"
}
}
| Polje | Vrsta | Opis |
|---|---|---|
call_id | integer | ID klica — nespremenljiv v vseh dogodkih za ta klic |
from_number | string | Številka klicatelja E.164 |
to_number | string | Cilj 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"
}
}
| Polje | Vrsta | Opis |
|---|---|---|
call_id | integer | ID klica |
origin_domain | string | Izvor strani, ki gosti gradnik |
publishable_key_prefix | string | Prvi znaki javnega ključa, ki je odprl sejo |
language, primary_language | string | Prisotno, ko seja gradnika zahteva preglasitev jezika |
voice | string | Prisotno, ko seja gradnika zahteva preglasitev glasu |
website_context | string | Prisotno, 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": []
}
| Polje | Vrsta | Obvezno | Opis |
|---|---|---|---|
prompt | niz | da | Sistemski poziv, ki usmerja agenta |
voice | niz | da | ID glasu iz GET /v1/voices, npr. john. voice_name je sprejet kot vzdevek. Neznani glasovi ne prestanejo preverjanja in zavrnejo klic |
product | niz | ne | Privzeto je spark. Dovoljeno: spark, bolt, storm-base, storm-base-with-ack, storm-extra, storm-extra-with-ack |
thinking_level | niz | ne | minimal, base (privzeto) ali extra. Za izdelke Storm je prepisano: storm-extra* vsili extra, drugi storm-* vsilijo base |
audio_context_mode | niz | ne | full (privzeto) ali reduced |
watchdog_enabled | logična vrednost | ne | Omogočite nadzor za ta klic. Privzeto false |
storm_feedback_mode | niz | ne | none, acknowledgement (privzeto) ali tick |
language | niz | ne | Okrajšava za primary_language |
primary_language | niz | ne | Jezikovna koda, normalizirana (privzeto en). Nerazrešljive kode zavrnejo klic |
has_additional_languages | logična vrednost | ne | Privzeto false |
additional_languages | polje nizov | ne | Dodatni jeziki, v katere lahko agent preklopi |
background_track | niz | null | ne | ID ambientalnega zvoka ali null |
acknowledgement_prompt_mode | niz | ne | auto (privzeto) ali manual (izdelki Storm-with-ack) |
acknowledgement_prompt | niz | ne | Uporabi se, ko je acknowledgement_prompt_mode="manual" |
silence_interval_seconds | celo število | null | ne | 5–120. Sekunde tišine klicatelja pred preverjanjem |
silence_max_checkins | celo število | null | ne | 1–10 |
silence_checkins_enabled | logična vrednost | ne | Privzeto true |
connect_tone_enabled | logična vrednost | ne | Privzeto false |
voicemail_action | niz | ne | prompt (privzeto), hangup ali message |
voicemail_message | niz | ne | Uporabi se, ko je voicemail_action="message" |
agent_name | niz | ne | Prikazno ime, prikazano na nadzornih ploščah in v pripomočku |
org_name | niz | ne | Prikazno ime organizacije za osebnost agenta |
tools | polje | ne | Vdelane sheme funkcijskih orodij (glejte Funkcijska orodja) |
call_id | celo število | ne | Izbirni 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
| Produkt | Zakasnitev | Sklepanje | Potrditev |
|---|---|---|---|
spark | Najnižja | Osnovno | — |
bolt | Nizka | Izboljšano | — |
storm-base | Srednja | Zmogljivo | — |
storm-base-with-ack | Srednja | Zmogljivo | Samodejno zapolnilo med razmišljanjem |
storm-extra | Višja | Poglobljeno | — |
storm-extra-with-ack | Višja | Poglobljeno | Samodejno zapolnilo med razmišljanjem |
Povezano
Neblokirajoči dogodek ob koncu klica.
Celotna shema JSON za tools[] in pogodba podpisane končne točke.
Naročite več URL-jev na telephony.incoming / web.incoming.
Vzorci za pozive, orodja in A/B-teste za posamezne klicatelje.