telephony.incoming / web.incoming
Blokkoló webhook, amely valós időben alakítja a bejövő hívás konfigurációját.
Amikor egy bejövő telefonhívás egy hozzárendelt
ügynök nélküli számot ér el, vagy egy webes widgetmunkamenet egy
mode="webhook" értékű közzétehető kulcson indul el, a ThunderPhone egy blokkoló
telephony.incoming / web.incoming kérést küld az Ön
régi webhook-URL-jére,
és legfeljebb 10 másodpercig vár a konfigurációs válaszra. Ezzel
a cserével hívásonként dinamikusan választhat promptot, hangot és eszközöket —
a teljes folyamatért tekintse meg a dinamikus híváskonfigurációs útmutatót.
A blokkoló csere nem rendelkezik tartalék megoldással: ha a kezelője nem
2xx állapotot ad vissza, időtúllépés történik, vagy olyan konfigurációt ad
vissza, amely nem felel meg az ellenőrzésnek, a hívást elutasítjuk (a
telefonhívás nem kapcsolódik; a widgetmunkamenet-kérés 502/422 hibával
meghiúsul). Válaszoljon gyorsan — a hívó kicsengést hall, amíg Ön dönt.
Kérés hasznos adatai
Telefonhívásokhoz (telephony.incoming):
{
"type": "telephony.incoming",
"data": {
"call_id": 987654321,
"from_number": "+14155550199",
"to_number": "+15551234567"
}
}| Mező | Típus | Leírás |
|---|---|---|
call_id | integer | Hívásazonosító — a hívás minden eseményében változatlan |
from_number | string | A hívó E.164-es száma |
to_number | string | E.164-es célállomás (az Ön egyik ThunderPhone-száma) |
Webes widgetmunkameneteknél (web.incoming) a data telefonos számok
helyett a beágyazó oldalt azonosítja:
{
"type": "web.incoming",
"data": {
"call_id": 987654322,
"origin_domain": "https://example.com",
"publishable_key_prefix": "pk_live_a1b2"
}
}| Mező | Típus | Leírás |
|---|---|---|
call_id | integer | Hívásazonosító |
origin_domain | string | A widgetet tároló oldal origója |
publishable_key_prefix | string | A munkamenetet megnyitó közzétehető kulcs első karakterei |
language, primary_language | string | Akkor van jelen, ha a widgetmunkamenet nyelvi felülbírálást kért |
voice | string | Akkor van jelen, ha a widgetmunkamenet hangfelülbírálást kért |
website_context | string | Akkor van jelen, ha a widget munkamenetenkénti oldalkontextust adott át |
Válaszséma
Adjon vissza egy JSON-objektumot, amely leírja az ügynök konfigurációját ehhez a híváshoz.
A prompt és a voice kötelező; minden más opcionális.
{
"prompt": "You are a helpful booking assistant for Acme Restaurant.",
"voice": "john",
"product": "spark",
"background_track": null,
"tools": []
}| Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
prompt | string | igen | Az ügynököt vezérlő rendszerszintű utasítás |
voice | string | igen | Hangazonosító innen: GET /v1/voices, például john. A voice_name aliasként elfogadott. Az ismeretlen hangok nem felelnek meg az ellenőrzésnek, és a hívás elutasításra kerül |
product | string | nem | Alapértelmezett értéke: spark. Engedélyezett értékek: spark, bolt, storm-base, storm-base-with-ack, storm-extra, storm-extra-with-ack |
thinking_level | string | nem | minimal, base (alapértelmezett) vagy extra. Storm termékek esetén felülíródik: a storm-extra* az extra értéket kényszeríti ki, a többi storm-* a base értéket |
audio_context_mode | string | nem | full (alapértelmezett) vagy reduced |
watchdog_enabled | boolean | nem | Felügyelet engedélyezése ehhez a híváshoz. Alapértelmezett érték: false |
additional_audio_context | boolean | null | nem | A hívó hangjának legutóbbi néhány fordulóját is tartalmazza, nem csak a legutóbbi fordulót, ami kis késleltetési- és költségtöbblet mellett javítja a javításokat, valamint a betűzés- és számintenzív adatgyűjtést. Bejövő munkameneteknél alapértelmezetten be van kapcsolva, kimenő telefonhívásoknál ki van kapcsolva; a null megtartja az alapértelmezett értéket |
storm_feedback_mode | string | nem | none, acknowledgement (alapértelmezett) vagy tick |
language | string | nem | Rövidítés a primary_language számára |
primary_language | string | nem | Nyelvkód, normalizálva (alapértelmezett: en). A fel nem oldható kódok elutasítják a hívást |
has_additional_languages | boolean | nem | Alapértelmezett érték: false |
additional_languages | array of string | nem | További nyelvek, amelyekre az ügynök átválthat |
native_voice_switching | boolean | nem | Alapértelmezett érték: false. Amikor a hívás másik nyelvre vált, a konfigurált hang megtartása helyett az adott nyelvhez anyanyelvi hangra vált (nem szerint egyeztetve) |
background_track | string | null | nem | Környezeti hang azonosítója vagy null |
acknowledgement_prompt_mode | string | nem | auto (alapértelmezett) vagy manual (Storm-with-ack termékek) |
acknowledgement_prompt | string | nem | Akkor használatos, ha acknowledgement_prompt_mode="manual" |
silence_interval_seconds | integer | null | nem | 5–120. A hívó csendjének másodpercei egy állapotellenőrzés előtt |
silence_max_checkins | integer | null | nem | 1–10 |
silence_checkins_enabled | boolean | nem | Alapértelmezett érték: true |
connect_tone_enabled | boolean | nem | Alapértelmezett érték: false |
voicemail_action | string | nem | prompt (alapértelmezett), hangup vagy message |
voicemail_message | string | nem | Akkor használatos, ha voicemail_action="message" |
agent_name | string | nem | Az irányítópultokon és a widgetben megjelenített név |
org_name | string | nem | A szervezet megjelenített neve az ügynök személyiségéhez |
tools | array | nem | Beágyazott funkcióeszköz-sémák (lásd: Funkcióeszközök) |
call_id | integer | nem | A kérés hívásazonosítójának opcionális visszhangja; figyelmen kívül marad |
Mivel a prompt és a voice kötelező, a {} vagy bármely
ellenőrzésen megbukó válasz 422 értékkel elutasítja a hívást — ezen
az útvonalon nincs statikus ügynökös tartalékmegoldás (webhook módban egy számhoz vagy kulcshoz
nincs ügynök hozzárendelve).
Válaszméret-korlát
Példakezelő
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({});
},
);Válasz funkcióeszközökkel
Csatoljon eszközöket, hogy az AI a beszélgetés közben meghívhassa az API-jait:
{
"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"
}
}
}
]
}Termékszint áttekintő
| Termék | Késleltetés | Érvelés | Visszaigazolás |
|---|---|---|---|
spark | Legalacsonyabb | Alapszintű | — |
bolt | Alacsony | Fejlettebb | — |
storm-base | Közepes | Erős | — |
storm-base-with-ack | Közepes | Erős | Automatikus kitöltő szöveg gondolkodás közben |
storm-extra | Magasabb | Mélyreható | — |
storm-extra-with-ack | Magasabb | Mélyreható | Automatikus kitöltő szöveg gondolkodás közben |
Kapcsolódó
A hívás végét jelző, nem blokkoló esemény.
A tools[] teljes JSON-sémája és az aláírt végpont szerződése.
Több URL feliratkoztatása a telephony.incoming / web.incoming eseményekre.
Minták hívónkénti prompthoz, eszközökhöz és A/B tesztekhez.