> ## 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 bloqueante que define a configuração de uma chamada recebida em tempo real.
Quando uma chamada telefônica recebida chega a um número **sem um
agente atribuído**, ou uma sessão do widget web é iniciada em uma chave
publicável em `mode="webhook"`, o ThunderPhone envia uma solicitação
**bloqueante** `telephony.incoming` / `web.incoming` para a sua
[URL legada de webhook](/api-reference/organizations#legacy-single-url-webhook)
e aguarda até **10 segundos** por uma resposta de configuração. Use esse
intercâmbio para escolher dinamicamente um prompt, uma voz e ferramentas por chamada —
consulte o [guia de configuração dinâmica de chamadas](/pt/guides/dynamic-call-config)
para ver o padrão completo.
[Endpoints de webhook](/pt/webhooks/endpoints) inscritos também recebem
`telephony.incoming` / `web.incoming` — para **todas** as chamadas
recebidas e sessões web, configuradas com agente ou não — mas essas entregas são
notificações sem espera com um `event_id`, nunca bloqueantes.
Somente o webhook legado de URL única realiza o intercâmbio de configuração
desta página. Os formatos das notificações de endpoint estão no
[catálogo de eventos](/pt/webhooks/events).
O intercâmbio bloqueante não tem alternativa: se o seu manipulador retornar um
status diferente de 2xx, exceder o tempo limite ou retornar uma configuração que não
passe na validação, a chamada será rejeitada (a chamada telefônica não é conectada; a
solicitação de sessão do widget falha com `502`/`422`). Responda rápido — quem liga
ouve o tom de chamada enquanto você decide.
## Payload da solicitação
Para chamadas telefônicas (`telephony.incoming`):
```json theme={null}
{
"type": "telephony.incoming",
"data": {
"call_id": 987654321,
"from_number": "+14155550199",
"to_number": "+15551234567"
}
}
```
| Campo | Tipo | Descrição |
| ------------- | ------- | --------------------------------------------------------- |
| `call_id` | integer | ID da chamada — estável em todos os eventos desta chamada |
| `from_number` | string | Número de quem liga no formato E.164 |
| `to_number` | string | Destino E.164 (um dos seus números do ThunderPhone) |
Para sessões do widget web (`web.incoming`), `data` identifica a
página de incorporação em vez de números de telefone:
```json theme={null}
{
"type": "web.incoming",
"data": {
"call_id": 987654322,
"origin_domain": "https://example.com",
"publishable_key_prefix": "pk_live_a1b2"
}
}
```
| Campo | Tipo | Descrição |
| ------------------------------ | ------- | ----------------------------------------------------------------------- |
| `call_id` | integer | ID da chamada |
| `origin_domain` | string | A origem da página que hospeda o widget |
| `publishable_key_prefix` | string | Primeiros caracteres da chave publicável que abriu a sessão |
| `language`, `primary_language` | string | Presente quando a sessão do widget solicitou uma substituição de idioma |
| `voice` | string | Presente quando a sessão do widget solicitou uma substituição de voz |
| `website_context` | string | Presente quando o widget transmitiu o contexto da página por sessão |
Widgets no modo webhook entregam esta solicitação ao próprio
`webhook_url` da chave publicável quando um está definido, recorrendo à
URL de webhook no nível da organização. Em ambos os casos, ela é assinada com o `secret`
do webhook da organização.
***
## Esquema de resposta
Retorne um objeto JSON descrevendo a configuração do agente para esta chamada.
`prompt` e `voice` são obrigatórios; todo o restante é opcional.
```json theme={null}
{
"prompt": "You are a helpful booking assistant for Acme Restaurant.",
"voice": "john",
"product": "spark",
"background_track": null,
"tools": []
}
```
| Campo | Tipo | Obrigatório | Descrição |
| ----------------------------- | --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `prompt` | string | sim | Prompt de sistema que orienta o agente |
| `voice` | string | sim | ID de voz de [`GET /v1/voices`](/api-reference/agents#voices), por exemplo, `john`. `voice_name` é aceito como um alias. Vozes desconhecidas falham na validação e rejeitam a chamada |
| `product` | string | não | O padrão é `spark`. Permitidos: `spark`, `bolt`, `storm-base`, `storm-base-with-ack`, `storm-extra`, `storm-extra-with-ack` |
| `thinking_level` | string | não | `minimal`, `base` (padrão) ou `extra`. Substituído para produtos Storm: `storm-extra*` força `extra`, outros `storm-*` forçam `base` |
| `audio_context_mode` | string | não | `full` (padrão) ou `reduced` |
| `watchdog_enabled` | boolean | não | Ativa a supervisão para esta chamada. O padrão é `false` |
| `storm_feedback_mode` | string | não | `none`, `acknowledgement` (padrão) ou `tick` |
| `language` | string | não | Abreviação de `primary_language` |
| `primary_language` | string | não | Código de idioma, normalizado (padrão `en`). Códigos não resolvíveis rejeitam a chamada |
| `has_additional_languages` | boolean | não | O padrão é `false` |
| `additional_languages` | array de string | não | Idiomas extras para os quais o agente pode alternar |
| `background_track` | string \| null | não | ID de áudio ambiente ou `null` |
| `acknowledgement_prompt_mode` | string | não | `auto` (padrão) ou `manual` (produtos Storm com ack) |
| `acknowledgement_prompt` | string | não | Usado quando `acknowledgement_prompt_mode="manual"` |
| `silence_interval_seconds` | integer \| null | não | 5–120. Segundos de silêncio de quem liga antes de uma verificação |
| `silence_max_checkins` | integer \| null | não | 1–10 |
| `silence_checkins_enabled` | boolean | não | O padrão é `true` |
| `connect_tone_enabled` | boolean | não | O padrão é `false` |
| `voicemail_action` | string | não | `prompt` (padrão), `hangup` ou `message` |
| `voicemail_message` | string | não | Usado quando `voicemail_action="message"` |
| `agent_name` | string | não | Nome de exibição informado aos painéis e ao widget |
| `org_name` | string | não | Nome de exibição da organização para a persona do agente |
| `tools` | array | não | Esquemas de ferramentas de função inline (consulte [Ferramentas de Função](/pt/tools/overview)) |
| `call_id` | integer | não | Eco opcional do ID da chamada da solicitação; ignorado |
Chaves de nível superior desconhecidas são **ignoradas** silenciosamente — um nome
de campo com erro de digitação não rejeita a configuração, apenas não é aplicado. A ordem
de fala e `max_hold_seconds` não são aceitos aqui; eles são
configuráveis apenas no próprio [Agente](/api-reference/agents).
Como `prompt` e `voice` são obrigatórios, retornar `{}` ou qualquer
resposta que falhe na validação rejeita a chamada com `422` — não há
alternativa de agente estático nesta rota (um número ou chave no modo webhook
não tem um agente atribuído).
***
## Exemplo de manipulador
```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({});
},
);
```
***
## Resposta com ferramentas de função
Anexe ferramentas para que a IA possa chamar suas APIs durante a conversa:
```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"
}
}
}
]
}
```
As solicitações ao endpoint da ferramenta são assinadas com o **mesmo
segredo de webhook da organização** que assinou esta troca. Consulte
[Ferramentas de função](/pt/tools/overview) para ver a estrutura exata e o formato
de solicitação assinada.
***
## Guia rápido de níveis de produto
| Produto | Latência | Raciocínio | Confirmação |
| ---------------------- | ---------- | ---------- | --------------------------------------- |
| `spark` | Mais baixa | Básico | — |
| `bolt` | Baixa | Aprimorado | — |
| `storm-base` | Média | Forte | — |
| `storm-base-with-ack` | Média | Forte | Preenchimento automático enquanto pensa |
| `storm-extra` | Mais alta | Profundo | — |
| `storm-extra-with-ack` | Mais alta | Profundo | Preenchimento automático enquanto pensa |
***
## Relacionado
O evento de fim de chamada sem bloqueio.
Esquema JSON completo para `tools[]` e o contrato de endpoint assinado.
Assine várias URLs para `telephony.incoming` / `web.incoming`.
Padrões para prompts, ferramentas e testes A/B por quem liga.