> ## 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
> Webhook bloquant qui configure en temps réel les paramètres d’un appel entrant.
Lorsqu'un appel téléphonique entrant atteint un numéro **sans agent
attribué**, ou qu'une session de widget web démarre sur une clé publiable en
`mode="webhook"`, ThunderPhone envoie une requête **bloquante**
`telephony.incoming` / `web.incoming` à votre
[URL de webhook héritée](/api-reference/organizations#legacy-single-url-webhook)
et attend jusqu'à **10 secondes** une réponse de configuration. Utilisez cet
échange pour choisir dynamiquement un prompt, une voix et des outils pour chaque appel —
consultez le [guide de configuration dynamique des appels](/fr/guides/dynamic-call-config)
pour le processus complet.
Les [endpoints de webhook](/fr/webhooks/endpoints) abonnés reçoivent également
`telephony.incoming` / `web.incoming` — pour **chaque** appel entrant
et session web, qu'un agent soit configuré ou non — mais ces livraisons sont
des notifications fire-and-forget avec un `event_id`, et ne sont jamais bloquantes.
Seul le webhook hérité à URL unique assure l'échange de configuration
décrit sur cette page. Les formats des notifications d'endpoint sont disponibles dans le
[catalogue des événements](/fr/webhooks/events).
L'échange bloquant n'a pas de solution de repli : si votre gestionnaire renvoie un
statut non 2xx, expire ou renvoie une configuration qui échoue à la validation,
l'appel est rejeté (l'appel téléphonique ne se connecte pas ; la requête de session du widget
échoue avec `502`/`422`). Répondez rapidement — l'appelant entend la tonalité de retour d'appel pendant que vous décidez.
## Charge utile de la requête
Pour les appels téléphoniques (`telephony.incoming`) :
```json theme={null}
{
"type": "telephony.incoming",
"data": {
"call_id": 987654321,
"from_number": "+14155550199",
"to_number": "+15551234567"
}
}
```
| Champ | Type | Description |
| ------------- | ------- | -------------------------------------------------------------- |
| `call_id` | integer | ID de l'appel — stable pour tous les événements de cet appel |
| `from_number` | string | Numéro de l'appelant au format E.164 |
| `to_number` | string | Destination au format E.164 (l'un de vos numéros ThunderPhone) |
Pour les sessions de widget web (`web.incoming`), `data` identifie la
page d'intégration au lieu des numéros de téléphone :
```json theme={null}
{
"type": "web.incoming",
"data": {
"call_id": 987654322,
"origin_domain": "https://example.com",
"publishable_key_prefix": "pk_live_a1b2"
}
}
```
| Champ | Type | Description |
| ------------------------------ | ------- | ---------------------------------------------------------------------- |
| `call_id` | integer | ID de l'appel |
| `origin_domain` | string | Origine de la page qui héberge le widget |
| `publishable_key_prefix` | string | Premiers caractères de la clé publiable qui a ouvert la session |
| `language`, `primary_language` | string | Présent lorsque la session du widget a demandé une surcharge de langue |
| `voice` | string | Présent lorsque la session du widget a demandé une surcharge de voix |
| `website_context` | string | Présent lorsque le widget a transmis un contexte de page par session |
Les widgets en mode webhook envoient cette requête à la
`webhook_url` propre à la clé publiable lorsqu'elle est définie, avec
repli sur l'URL de webhook au niveau de l'organisation. Dans tous les cas, elle est signée avec le
`secret` du webhook de l'organisation.
***
## Schéma de réponse
Renvoyez un objet JSON décrivant la configuration de l’agent pour cet appel.
`prompt` et `voice` sont requis ; tous les autres champs sont facultatifs.
```json theme={null}
{
"prompt": "You are a helpful booking assistant for Acme Restaurant.",
"voice": "john",
"product": "spark",
"background_track": null,
"tools": []
}
```
| Champ | Type | Requis | Description |
| ----------------------------- | --------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `prompt` | string | oui | Prompt système qui pilote l’agent |
| `voice` | string | oui | ID de voix provenant de [`GET /v1/voices`](/api-reference/agents#voices), par exemple `john`. `voice_name` est accepté comme alias. Les voix inconnues échouent à la validation et rejettent l’appel |
| `product` | string | non | Valeur par défaut : `spark`. Valeurs autorisées : `spark`, `bolt`, `storm-base`, `storm-base-with-ack`, `storm-extra`, `storm-extra-with-ack` |
| `thinking_level` | string | non | `minimal`, `base` (par défaut) ou `extra`. Remplacé pour les produits Storm : `storm-extra*` force `extra`, les autres `storm-*` forcent `base` |
| `audio_context_mode` | string | non | `full` (par défaut) ou `reduced` |
| `watchdog_enabled` | boolean | non | Active la supervision pour cet appel. Valeur par défaut : `false` |
| `storm_feedback_mode` | string | non | `none`, `acknowledgement` (par défaut) ou `tick` |
| `language` | string | non | Raccourci pour `primary_language` |
| `primary_language` | string | non | Code de langue, normalisé (valeur par défaut : `en`). Les codes impossibles à résoudre rejettent l’appel |
| `has_additional_languages` | boolean | non | Valeur par défaut : `false` |
| `additional_languages` | array of string | non | Langues supplémentaires vers lesquelles l’agent peut basculer |
| `background_track` | string \| null | non | ID d’audio d’ambiance ou `null` |
| `acknowledgement_prompt_mode` | string | non | `auto` (par défaut) ou `manual` (produits Storm-with-ack) |
| `acknowledgement_prompt` | string | non | Utilisé lorsque `acknowledgement_prompt_mode="manual"` |
| `silence_interval_seconds` | integer \| null | non | 5–120. Secondes de silence de l’appelant avant une relance |
| `silence_max_checkins` | integer \| null | non | 1–10 |
| `silence_checkins_enabled` | boolean | non | Valeur par défaut : `true` |
| `connect_tone_enabled` | boolean | non | Valeur par défaut : `false` |
| `voicemail_action` | string | non | `prompt` (par défaut), `hangup` ou `message` |
| `voicemail_message` | string | non | Utilisé lorsque `voicemail_action="message"` |
| `agent_name` | string | non | Nom d’affichage transmis aux tableaux de bord et au widget |
| `org_name` | string | non | Nom d’affichage de l’organisation pour la personnalité de l’agent |
| `tools` | array | non | Schémas d’outils de fonction en ligne (voir [Outils de fonction](/fr/tools/overview)) |
| `call_id` | integer | non | Écho facultatif de l’ID d’appel de la requête ; ignoré |
Les clés de niveau supérieur inconnues sont silencieusement **ignorées** — un nom
de champ comportant une faute ne rejette pas la configuration, il ne s’applique
simplement pas. L’ordre de parole et `max_hold_seconds` ne sont pas acceptés ici ;
ils sont configurables uniquement sur l’[agent](/api-reference/agents) lui-même.
Comme `prompt` et `voice` sont requis, renvoyer `{}` ou toute réponse
qui échoue à la validation rejette l’appel avec `422` — il n’existe
aucun repli vers un agent statique sur ce chemin (un numéro ou une clé en mode webhook
n’a aucun agent attribué).
***
## Exemple de gestionnaire
```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({});
},
);
```
***
## Réponse avec des outils de fonction
Ajoutez des outils afin que l'IA puisse appeler vos API au cours de la conversation :
```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"
}
}
}
]
}
```
Les requêtes vers les points de terminaison des outils sont signées avec le
**même secret de webhook de l'organisation** que celui qui a signé cet échange. Consultez
[Outils de fonction](/fr/tools/overview) pour connaître la structure exacte et le format
des requêtes signées.
***
## Aide-mémoire des niveaux de produit
| Produit | Latence | Raisonnement | Acquiescement verbal |
| ---------------------- | -------------- | ------------ | -------------------------------------------- |
| `spark` | La plus faible | Basique | — |
| `bolt` | Faible | Amélioré | — |
| `storm-base` | Moyenne | Solide | — |
| `storm-base-with-ack` | Moyenne | Solide | Remplissage automatique pendant la réflexion |
| `storm-extra` | Plus élevée | Approfondi | — |
| `storm-extra-with-ack` | Plus élevée | Approfondi | Remplissage automatique pendant la réflexion |
***
## Associé
L’événement de fin d’appel non bloquant.
Schéma JSON complet pour `tools[]` et le contrat d’endpoint signé.
Abonnez plusieurs URL à `telephony.incoming` / `web.incoming`.
Modèles pour les prompts, outils et tests A/B par appelant.