telephony.incoming / web.incoming
Kada dolazni telefonski poziv stigne na broj bez dodijeljenog
agenta ili se sesija web-widgeta pokrene na javnom ključu u
mode="webhook", ThunderPhone šalje blokirajući
zahtjev telephony.incoming / web.incoming na Vaš
naslijeđeni URL web-dojavnika
i čeka do 10 sekundi na odgovor s konfiguracijom. Upotrijebite ovu
razmjenu za dinamički odabir upita, glasa i alata za svaki poziv —
pogledajte vodič za dinamičku konfiguraciju poziva
za cjeloviti obrazac.
Blokirajuća razmjena nema zamjensku opciju: ako Vaš obrađivač vrati
status koji nije 2xx, istekne mu vrijeme ili vrati konfiguraciju koja ne
prođe provjeru valjanosti, poziv se odbija (telefonski se poziv ne povezuje;
zahtjev sesije widgeta ne uspijeva sa statusom 502/422). Odgovorite brzo
— pozivatelj čuje signal zvonjenja dok odlučujete.
Sadržaj zahtjeva
Za telefonske pozive (telephony.incoming):
{
"type": "telephony.incoming",
"data": {
"call_id": 987654321,
"from_number": "+14155550199",
"to_number": "+15551234567"
}
}
| Polje | Vrsta | Opis |
|---|---|---|
call_id | integer | ID poziva — nepromjenjiv u svim događajima za ovaj poziv |
from_number | string | E.164 broj pozivatelja |
to_number | string | E.164 odredište (jedan od Vaših ThunderPhone brojeva) |
Za sesije web-widgeta (web.incoming) data identificira stranicu na
kojoj je widget ugrađen umjesto telefonskih brojeva:
{
"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 poziva |
origin_domain | string | Izvor stranice na kojoj je smješten widget |
publishable_key_prefix | string | Prvi znakovi javnog ključa koji je otvorio sesiju |
language, primary_language | string | Prisutan kada je sesija widgeta zatražila nadjačavanje jezika |
voice | string | Prisutan kada je sesija widgeta zatražila nadjačavanje glasa |
website_context | string | Prisutan kada je widget proslijedio kontekst stranice po sesiji |
Shema odgovora
Vratite JSON objekt koji opisuje konfiguraciju agenta za ovaj poziv.
prompt i voice su obavezni; sve ostalo nije obavezno.
{
"prompt": "You are a helpful booking assistant for Acme Restaurant.",
"voice": "john",
"product": "spark",
"background_track": null,
"tools": []
}
| Polje | Vrsta | Obavezno | Opis |
|---|---|---|---|
prompt | string | da | Sistemski prompt koji upravlja agentom |
voice | string | da | ID glasa iz GET /v1/voices, npr. john. voice_name prihvaća se kao alias. Nepoznati glasovi ne prolaze validaciju i odbijaju poziv |
product | string | ne | Zadano je spark. Dopušteno: spark, bolt, storm-base, storm-base-with-ack, storm-extra, storm-extra-with-ack |
thinking_level | string | ne | minimal, base (zadano) ili extra. Nadjačano za Storm proizvode: storm-extra* prisiljava extra, ostali storm-* prisiljavaju base |
audio_context_mode | string | ne | full (zadano) ili reduced |
watchdog_enabled | boolean | ne | Omogućite nadzor za ovaj poziv. Zadano je false |
storm_feedback_mode | string | ne | none, acknowledgement (zadano) ili tick |
language | string | ne | Skraćeni naziv za primary_language |
primary_language | string | ne | Jezični kôd, normaliziran (zadano en). Kodovi koje nije moguće razriješiti odbijaju poziv |
has_additional_languages | boolean | ne | Zadano je false |
additional_languages | array of string | ne | Dodatni jezici na koje se agent može prebaciti |
background_track | string | null | ne | ID ambijentalnog zvuka ili null |
acknowledgement_prompt_mode | string | ne | auto (zadano) ili manual (Storm-with-ack proizvodi) |
acknowledgement_prompt | string | ne | Upotrebljava se kada je acknowledgement_prompt_mode="manual" |
silence_interval_seconds | integer | null | ne | 5–120. Sekunde tišine pozivatelja prije provjere |
silence_max_checkins | integer | null | ne | 1–10 |
silence_checkins_enabled | boolean | ne | Zadano je true |
connect_tone_enabled | boolean | ne | Zadano je false |
voicemail_action | string | ne | prompt (zadano), hangup ili message |
voicemail_message | string | ne | Upotrebljava se kada je voicemail_action="message" |
agent_name | string | ne | Naziv za prikaz koji se prijavljuje upravljačkim pločama i widgetu |
org_name | string | ne | Naziv organizacije za prikaz u personi agenta |
tools | array | ne | Umetnute sheme funkcijskih alata (pogledajte Funkcijski alati) |
call_id | integer | ne | Neobavezni odjek ID-a poziva iz zahtjeva; zanemaruje se |
Budući da su prompt i voice obavezni, vraćanje {} ili bilo kojeg
odgovora koji ne prođe validaciju odbija poziv s 422 — na ovom putu
nema zamjenskog statičkog agenta (broj ili ključ u webhook načinu rada
nema dodijeljenog agenta).
Ograničenje veličine odgovora
Primjer rukovatelja
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 alatima funkcija
Priložite alate kako bi AI mogao pozivati vaše API-je usred razgovora:
{
"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"
}
}
}
]
}
Brzi pregled razina proizvoda
| Proizvod | Latencija | Zaključivanje | Potvrda |
|---|---|---|---|
spark | Najniža | Osnovno | — |
bolt | Niska | Poboljšano | — |
storm-base | Srednja | Snažno | — |
storm-base-with-ack | Srednja | Snažno | Automatska dopuna tijekom razmišljanja |
storm-extra | Viša | Duboko | — |
storm-extra-with-ack | Viša | Duboko | Automatska dopuna tijekom razmišljanja |
Povezano
Neblokirajući događaj završetka poziva.
Potpuna JSON shema za tools[] i ugovor potpisane krajnje točke.
Pretplatite više URL-ova na telephony.incoming / web.incoming.
Obrasci za upute, alate i A/B testove po pozivatelju.