telephony.incoming / web.incoming

Када долазни телефонски позив стигне на број без додељеног агента, или када сесија веб виџета започне на јавном кључу у mode="webhook", ThunderPhone шаље блокирајући захтев telephony.incoming / web.incoming на вашу застарелу URL адресу вебхука и чека до 10 секунди на одговор са конфигурацијом. Користите ову размену да бисте динамички изабрали упит, глас и алате за сваки позив — погледајте водич за динамичку конфигурацију позива за комплетан образац.

Блокирајућа размена нема резервну опцију: ако ваш обрађивач врати статус који није 2xx, прекорачи време или врати конфигурацију која не прође валидацију, позив се одбија (телефонски позив се не повезује; захтев за сесију виџета не успева са 502/422). Одговорите брзо — позивалац чује сигнал звона док доносите одлуку.

Садржај захтева

За телефонске позиве (telephony.incoming):

{
  "type": "telephony.incoming",
  "data": {
    "call_id":     987654321,
    "from_number": "+14155550199",
    "to_number":   "+15551234567"
  }
}
ПољеТипОпис
call_idintegerИдентификатор позива — непромењен у свим догађајима за овај позив
from_numberstringE.164 број позиваоца
to_numberstringE.164 одредиште (један од ваших ThunderPhone бројева)

За сесије веб виџета (web.incoming), data идентификује страницу на којој је виџет уграђен уместо телефонских бројева:

{
  "type": "web.incoming",
  "data": {
    "call_id": 987654322,
    "origin_domain": "https://example.com",
    "publishable_key_prefix": "pk_live_a1b2"
  }
}
ПољеТипОпис
call_idintegerИдентификатор позива
origin_domainstringПорекло странице на којој се налази виџет
publishable_key_prefixstringПрви знакови јавног кључа који је отворио сесију
language, primary_languagestringПрисутно када је сесија виџета захтевала замену језика
voicestringПрисутно када је сесија виџета захтевала замену гласа
website_contextstringПрисутно када је виџет проследио контекст странице по сесији

Шема одговора

Вратите JSON објекат који описује конфигурацију агента за овај позив. prompt и voice су обавезни; све остало је опционално.

{
  "prompt":  "You are a helpful booking assistant for Acme Restaurant.",
  "voice":   "john",
  "product": "spark",
  "background_track": null,
  "tools":   []
}
ПољеТипОбавезноОпис
promptstringдаСистемска инструкција која управља агентом
voicestringдаID гласа из GET /v1/voices, нпр. john. voice_name је прихваћен као псеудоним. Непознати гласови не пролазе валидацију и одбијају позив
productstringнеПодразумевано је spark. Дозвољено: spark, bolt, storm-base, storm-base-with-ack, storm-extra, storm-extra-with-ack
thinking_levelstringнеminimal, base (подразумевано) или extra. Преписује се за Storm производе: storm-extra* намеће extra, а остали storm-* намећу base
audio_context_modestringнеfull (подразумевано) или reduced
watchdog_enabledbooleanнеОмогућите надзор за овај позив. Подразумевано је false
storm_feedback_modestringнеnone, acknowledgement (подразумевано) или tick
languagestringнеСкраћеница за primary_language
primary_languagestringнеКод језика, нормализован (подразумевано en). Кодови који се не могу разрешити одбијају позив
has_additional_languagesbooleanнеПодразумевано је false
additional_languagesarray of stringнеДодатни језици на које агент може да пређе
background_trackstring | nullнеID амбијенталног звука или null
acknowledgement_prompt_modestringнеauto (подразумевано) или manual (Storm-with-ack производи)
acknowledgement_promptstringнеКористи се када је acknowledgement_prompt_mode="manual"
silence_interval_secondsinteger | nullне5–120. Секунде тишине позиваоца пре провере
silence_max_checkinsinteger | nullне1–10
silence_checkins_enabledbooleanнеПодразумевано је true
connect_tone_enabledbooleanнеПодразумевано је false
voicemail_actionstringнеprompt (подразумевано), hangup или message
voicemail_messagestringнеКористи се када је voicemail_action="message"
agent_namestringнеПриказано име које се пријављује контролним таблама и виџету
org_namestringнеПриказано име организације за персону агента
toolsarrayнеУметнуте шеме алата функција (погледајте Алати функција)
call_idintegerнеОпциони одјек ID-ја позива из захтева; занемарује се

Пошто су prompt и voice обавезни, враћање {} или било ког одговора који не пролази валидацију одбија позив са 422 — на овој путањи не постоји резервна опција статичког агента (број или кључ у режиму webhook-а нема додељеног агента).


Ограничење величине одговора


Пример обрађивача

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({});
  },
);

Одговор са алаткама функција

Додајте алатке како би AI могао да позива Ваше API-је током разговора:

{
  "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"
        }
      }
    }
  ]
}

Брзи преглед нивоа производа

ПроизводКашњењеРасуђивањеПотврда
sparkНајнижеОсновно
boltНискоПобољшано
storm-baseСредњеСнажно
storm-base-with-ackСредњеСнажноАутоматски попуњавач током размишљања
storm-extraВишеДубоко
storm-extra-with-ackВишеДубокоАутоматски попуњавач током размишљања

Повезано