telephony.incoming / web.incoming
Estävä webhook, joka määrittää saapuvan puhelun asetukset reaaliajassa.
Kun saapuva puhelu saapuu numeroon, jolle ei ole määritetty
agenttia, tai web-widget-istunto käynnistyy julkaistavalla avaimella
mode="webhook", ThunderPhone lähettää estävän
telephony.incoming / web.incoming -pyynnön
vanhaan webhook-URL-osoitteeseesi
ja odottaa enintään 10 sekuntia määritysvastausta. Käytä tätä
vaihtoa valitaksesi dynaamisesti kehotteen, äänen ja työkalut puhelukohtaisesti —
katso kokonaisvaltainen malli dynaamisen puhelumäärityksen oppaasta.
Estävällä vaihdolla ei ole varavaihtoehtoa: jos käsittelijäsi palauttaa
muun kuin 2xx-tilan, aikakatkaistaan tai palauttaa määrityksen, joka ei
läpäise validointia, puhelu hylätään (puhelua ei yhdistetä; widget-istunnon
pyyntö epäonnistuu virheellä 502/422). Vastaa nopeasti — soittaja kuulee
soittoääntä samalla, kun teet päätöksen.
Pyynnön sisältö
Puheluille (telephony.incoming):
{
"type": "telephony.incoming",
"data": {
"call_id": 987654321,
"from_number": "+14155550199",
"to_number": "+15551234567"
}
}| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
call_id | integer | Puhelutunnus — pysyy samana tämän puhelun kaikissa tapahtumissa |
from_number | string | Soittajan E.164-numero |
to_number | string | Kohteen E.164-numero (yksi ThunderPhone-numeroistasi) |
Web-widget-istunnoissa (web.incoming) data tunnistaa puhelinnumeroiden
sijaan upottavan sivun:
{
"type": "web.incoming",
"data": {
"call_id": 987654322,
"origin_domain": "https://example.com",
"publishable_key_prefix": "pk_live_a1b2"
}
}| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
call_id | integer | Puhelutunnus |
origin_domain | string | Widgetiä isännöivän sivun alkuperä |
publishable_key_prefix | string | Istunnon avanneen julkaistavan avaimen ensimmäiset merkit |
language, primary_language | string | Sisältyy pyyntöön, kun widget-istunto pyysi kieliohitusasetusta |
voice | string | Sisältyy pyyntöön, kun widget-istunto pyysi äänen ohitusasetusta |
website_context | string | Sisältyy pyyntöön, kun widget välitti istuntokohtaisen sivukontekstin |
Vastausskeema
Palauta JSON-objekti, joka kuvaa tämän puhelun agentin määrityksen.
prompt ja voice ovat pakollisia; kaikki muu on valinnaista.
{
"prompt": "You are a helpful booking assistant for Acme Restaurant.",
"voice": "john",
"product": "spark",
"background_track": null,
"tools": []
}| Kenttä | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
prompt | string | kyllä | Agenttia ohjaava järjestelmäkehote |
voice | string | kyllä | Ääni-ID kohteesta GET /v1/voices, esimerkiksi john. voice_name hyväksytään aliaksena. Tuntemattomat äänet eivät läpäise validointia ja puhelu hylätään |
product | string | ei | Oletusarvo on spark. Sallitut arvot: spark, bolt, storm-base, storm-base-with-ack, storm-extra, storm-extra-with-ack |
thinking_level | string | ei | minimal, base (oletus) tai extra. Storm-tuotteet ohittavat tämän: storm-extra* pakottaa arvon extra, muut storm-*-tuotteet pakottavat arvon base |
audio_context_mode | string | ei | full (oletus) tai reduced |
watchdog_enabled | boolean | ei | Ota valvonta käyttöön tälle puhelulle. Oletusarvo false |
additional_audio_context | boolean | null | ei | Sisällytä soittajan äänen viimeiset muutamat vuorot pelkän viimeisimmän vuoron sijaan. Tämä parantaa korjauksia sekä paljon oikeinkirjoitusta tai numeroita sisältävää tietojen keruuta pienellä viive- ja kustannuslisällä. Oletusarvoisesti käytössä saapuvissa istunnoissa ja pois käytöstä lähtevissä puheluissa; null säilyttää oletusarvon |
storm_feedback_mode | string | ei | none, acknowledgement (oletus) tai tick |
language | string | ei | Lyhenne kentälle primary_language |
primary_language | string | ei | Kielikoodi, normalisoitu (oletus en). Koodit, joita ei voida ratkaista, hylkäävät puhelun |
has_additional_languages | boolean | ei | Oletusarvo false |
additional_languages | array of string | ei | Lisäkielet, joihin agentti voi vaihtaa |
native_voice_switching | boolean | ei | Oletusarvo false. Kun puhelu vaihtuu toiseen kieleen, vaihda kyseiselle kielelle natiivin puhujan ääneen (sukupuolen mukaan vastaavaan) määritetyn äänen säilyttämisen sijaan |
background_track | string | null | ei | Taustaäänen ID tai null |
acknowledgement_prompt_mode | string | ei | auto (oletus) tai manual (Storm-with-ack-tuotteet) |
acknowledgement_prompt | string | ei | Käytetään, kun acknowledgement_prompt_mode="manual" |
silence_interval_seconds | integer | null | ei | 5–120. Soittajan hiljaisuuden sekunnit ennen tarkistusta |
silence_max_checkins | integer | null | ei | 1–10 |
silence_checkins_enabled | boolean | ei | Oletusarvo true |
connect_tone_enabled | boolean | ei | Oletusarvo false |
voicemail_action | string | ei | prompt (oletus), hangup tai message |
voicemail_message | string | ei | Käytetään, kun voicemail_action="message" |
agent_name | string | ei | Näyttönimi, joka ilmoitetaan hallintapaneeleille ja widgetille |
org_name | string | ei | Organisaation näyttönimi agentin persoonalle |
tools | array | ei | Upotetut funktiotyökalujen skeemat (katso Funktiotyökalut) |
call_id | integer | ei | Valinnainen pyyntöön sisältyvän puhelutunnuksen kaiku; ohitetaan |
Koska prompt ja voice ovat pakollisia, {}-objektin tai minkä tahansa
validoinnin epäonnistuvan vastauksen palauttaminen hylkää puhelun koodilla 422 —
tällä reitillä ei ole staattisen agentin varavaihtoehtoa (webhook-tilassa
numerolle tai avaimelle ei ole määritetty agenttia).
Vastauksen kokorajoitus
Esimerkkikäsittelijä
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({});
},
);Vastaus toimintotyökaluilla
Liitä työkaluja, jotta tekoäly voi kutsua rajapintojasi keskustelun aikana:
{
"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"
}
}
}
]
}Tuotetason pikaopas
| Tuote | Viive | Päättely | Kuittaus |
|---|---|---|---|
spark | Pienin | Perustaso | — |
bolt | Matala | Parannettu | — |
storm-base | Keskitaso | Vahva | — |
storm-base-with-ack | Keskitaso | Vahva | Automaattinen täytesana ajattelun aikana |
storm-extra | Korkeampi | Syvällinen | — |
storm-extra-with-ack | Korkeampi | Syvällinen | Automaattinen täytesana ajattelun aikana |
Aiheeseen liittyvät
Estämätön puhelun päättymistapahtuma.
Täydellinen JSON-skeema kohteelle tools[] ja allekirjoitettu päätepistesopimus.
Tilaa useita URL-osoitteita tapahtumille telephony.incoming / web.incoming.
Mallit soittajakohtaisille kehotteille, työkaluille ja A/B-testeille.