> ## Documentation Index
> Fetch the complete documentation index at: https://docs.thunderphone.com/llms.txt
> Use this file to discover all available pages before exploring further.
# telephony.incoming / web.incoming
> Estävä webhook, joka muokkaa saapuvan puhelun määrityksiä 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](/api-reference/organizations#legacy-single-url-webhook)
ja odottaa määritysvasteita enintään **10 sekuntia**. Käytä tätä
vaihtoa valitaksesi dynaamisesti kehotteen, äänen ja työkalut puhelukohtaisesti —
katso kokonaisvaltainen toimintamalli
[dynaamisen puhelumäärityksen oppaasta](/fi/guides/dynamic-call-config).
Tilatut [webhook-päätepisteet](/fi/webhooks/endpoints) vastaanottavat myös
`telephony.incoming` / `web.incoming` -tapahtumat — **jokaisesta**
saapuvasta puhelusta ja web-istunnosta, riippumatta siitä, onko agentti
määritetty — mutta nämä toimitukset ovat fire-and-forget-ilmoituksia,
joissa on `event_id`, eivätkä ne koskaan estä toimintaa.
Vain vanha yhden URL-osoitteen webhook sisältää tämän sivun
määritysvaihdon. Päätepisteilmoitusten muodot ovat
[tapahtumaluettelossa](/fi/webhooks/events).
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 koodeilla `502`/`422`). Vastaa nopeasti — soittaja kuulee
soittoäänen, kun teet päätöstä.
## Pyynnön tietosisältö
Puheluille (`telephony.incoming`):
```json theme={null}
{
"type": "telephony.incoming",
"data": {
"call_id": 987654321,
"from_number": "+14155550199",
"to_number": "+15551234567"
}
}
```
| Kenttä | Tyyppi | Kuvaus |
| ------------- | ------- | --------------------------------------------------------- |
| `call_id` | integer | Puhelun tunnus — sama kaikissa tämän puhelun tapahtumissa |
| `from_number` | string | Soittajan E.164-numero |
| `to_number` | string | E.164-kohde (yksi ThunderPhone-numeroistasi) |
Web-widget-istunnoissa (`web.incoming`) `data` tunnistaa
upotussivun puhelinnumeroiden sijaan:
```json theme={null}
{
"type": "web.incoming",
"data": {
"call_id": 987654322,
"origin_domain": "https://example.com",
"publishable_key_prefix": "pk_live_a1b2"
}
}
```
| Kenttä | Tyyppi | Kuvaus |
| ------------------------------ | ------- | ------------------------------------------------------------ |
| `call_id` | integer | Puhelun tunnus |
| `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, kun widget-istunto pyysi kieliohjausta |
| `voice` | string | Sisältyy, kun widget-istunto pyysi äänen ohjausta |
| `website_context` | string | Sisältyy, kun widget välitti istuntokohtaisen sivukontekstin |
Webhook-tilan widgetit toimittavat tämän pyynnön julkaistavan avaimen
omaan `webhook_url`-osoitteeseen, kun sellainen on määritetty, ja
käyttävät muuten organisaatiotason webhook-URL-osoitetta. Kummassakin
tapauksessa pyyntö allekirjoitetaan organisaation webhook-avaimella `secret`.
***
## Vastausskeema
Palauta JSON-objekti, joka kuvaa agentin määrityksen tätä puhelua varten.
`prompt` ja `voice` ovat pakollisia; kaikki muu on valinnaista.
```json theme={null}
{
"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ä | Äänitunnus kohteesta [`GET /v1/voices`](/api-reference/agents#voices), esim. `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` (oletusarvo) tai `extra`. Ohitetaan Storm-tuotteissa: `storm-extra*` pakottaa arvon `extra`, muut `storm-*` pakottavat arvon `base` |
| `audio_context_mode` | string | ei | `full` (oletusarvo) tai `reduced` |
| `watchdog_enabled` | boolean | ei | Ota valvonta käyttöön tälle puhelulle. Oletusarvo `false` |
| `storm_feedback_mode` | string | ei | `none`, `acknowledgement` (oletusarvo) tai `tick` |
| `language` | string | ei | Lyhenne kentälle `primary_language` |
| `primary_language` | string | ei | Kielikoodi, normalisoitu (oletusarvo `en`). Ratkaisemattomat koodit hylkäävät puhelun |
| `has_additional_languages` | boolean | ei | Oletusarvo `false` |
| `additional_languages` | array of string | ei | Lisäkielet, joihin agentti voi vaihtaa |
| `background_track` | string \| null | ei | Taustaäänen tunnus tai `null` |
| `acknowledgement_prompt_mode` | string | ei | `auto` (oletusarvo) 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 tilannetarkistusta |
| `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` (oletusarvo), `hangup` tai `message` |
| `voicemail_message` | string | ei | Käytetään, kun `voicemail_action="message"` |
| `agent_name` | string | ei | Hallintapaneeleissa ja widgetissä näytettävä nimi |
| `org_name` | string | ei | Organisaation näyttönimi agentin personaa varten |
| `tools` | array | ei | Upotetut funktiotyökalujen skeemat (katso [Funktiotyökalut](/fi/tools/overview)) |
| `call_id` | integer | ei | Pyynnön puhelutunnuksen valinnainen kaiku; ohitetaan |
Tuntemattomat ylimmän tason avaimet **ohitetaan** hiljaisesti — kirjoitusvirheellinen
kentän nimi ei hylkää määritystä, mutta sitä ei vain käytetä. Puhejärjestystä
ja `max_hold_seconds` ei hyväksytä täällä; ne voi määrittää vain itse
[Agentille](/api-reference/agents).
Koska `prompt` ja `voice` ovat pakollisia, arvon `{}` tai minkä tahansa
validoinnin läpäisemättömän vastauksen palauttaminen hylkää puhelun tilakoodilla `422` —
tällä reitillä ei ole staattisen agentin varavaihtoehtoa (webhook-tilassa numerolle
tai avaimelle ei ole määritetty agenttia).
***
## Esimerkkikäsittelijä
```python Python (FastAPI) theme={null}
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 {}
```
```javascript Node.js (Express) theme={null}
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 funktiotyökaluilla
Liitä työkaluja, jotta tekoäly voi kutsua rajapintojasi kesken keskustelun:
```json theme={null}
{
"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"
}
}
}
]
}
```
Työkalujen päätepistepyynnöt allekirjoitetaan **samalla organisaation webhook-salaisuudella**, jolla tämä vaihto allekirjoitettiin. Katso tarkka rakenne ja allekirjoitetun pyynnön muoto kohdasta [Function Tools](/fi/tools/overview).
***
## Tuotetason pikaopas
| Tuote | Viive | Päättely | Kuittaus |
| ---------------------- | --------- | ---------- | ------------------------------- |
| `spark` | Pienin | Perustaso | — |
| `bolt` | Pieni | Parannettu | — |
| `storm-base` | Keskitaso | Vahva | — |
| `storm-base-with-ack` | Keskitaso | Vahva | Automaattinen täyte ajatellessa |
| `storm-extra` | Suurempi | Syvällinen | — |
| `storm-extra-with-ack` | Suurempi | Syvällinen | Automaattinen täyte ajatellessa |
***
## Aiheeseen liittyvää
Estämätön puhelun päättymistapahtuma.
Täydellinen JSON-skeema kohteelle `tools[]` ja allekirjoitetun päätepisteen sopimus.
Tilaa useita URL-osoitteita tapahtumille `telephony.incoming` / `web.incoming`.
Mallit soittajakohtaisille kehotteille, työkaluille ja A/B-testeille.