ThunderPhone 2.0 er lansert.Kom i gang selv, fra 2 ¢/min.Les mer om lanseringen

Webhooks

telephony.incoming / web.incoming

Blokkerende webhook som former konfigurasjonen for et innkommende anrop i sanntid.

Når et innkommende telefonanrop når et nummer uten en tilordnet stemmeagent, eller en webwidget-økt starter på en publiserbar nøkkel i mode="webhook", sender ThunderPhone en blokkerende telephony.incoming / web.incoming-forespørsel til eldre webhook-URL og venter opptil 10 sekunder på et konfigurasjonssvar. Bruk denne utvekslingen til å velge prompt, stemme og verktøy dynamisk for hvert anrop — se veiledningen for dynamisk anropskonfigurasjon for hele mønsteret.

Den blokkerende utvekslingen har ingen reserve: Hvis handleren din returnerer en status som ikke er 2xx, tidsavbrytes eller returnerer en konfigurasjon som ikke består validering, avvises anropet (telefonanropet kobles ikke til; forespørselen om widgetøkten mislykkes med 502/422). Svar raskt — innringeren hører ringetone mens du avgjør dette.

Forespørselsnyttelast

For telefonanrop (telephony.incoming):

{
  "type": "telephony.incoming",
  "data": {
    "call_id":     987654321,
    "from_number": "+14155550199",
    "to_number":   "+15551234567"
  }
}
FeltTypeBeskrivelse
call_idintegerAnrops-ID — stabil på tvers av alle hendelser for dette anropet
from_numberstringE.164-nummeret til innringeren
to_numberstringE.164-destinasjon (ett av ThunderPhone-numrene dine)

For webwidget-økter (web.incoming) identifiserer data innbyggingssiden i stedet for telefonnumre:

{
  "type": "web.incoming",
  "data": {
    "call_id": 987654322,
    "origin_domain": "https://example.com",
    "publishable_key_prefix": "pk_live_a1b2"
  }
}
FeltTypeBeskrivelse
call_idintegerAnrops-ID
origin_domainstringOpprinnelsen til siden som er vert for widgeten
publishable_key_prefixstringDe første tegnene i den publiserbare nøkkelen som åpnet økten
language, primary_languagestringFinnes når widgetøkten ba om en språkoverstyring
voicestringFinnes når widgetøkten ba om en stemmeoverstyring
website_contextstringFinnes når widgeten sendte sidekontekst per økt

Svarskjema

Returner et JSON-objekt som beskriver stemmeagentkonfigurasjonen for dette anropet. prompt og voice er påkrevd; alt annet er valgfritt.

{
  "prompt":  "You are a helpful booking assistant for Acme Restaurant.",
  "voice":   "john",
  "product": "spark",
  "background_track": null,
  "tools":   []
}
FeltTypePåkrevdBeskrivelse
promptstringjaSysteminstruks som styrer agenten
voicestringjaStemme-ID fra GET /v1/voices, f.eks. john. voice_name godtas som alias. Ukjente stemmer feiler valideringen og avviser anropet
productstringneiStandard er spark. Tillatt: spark, bolt, storm-base, storm-base-with-ack, storm-extra, storm-extra-with-ack
thinking_levelstringneiminimal, base (standard) eller extra. Overstyres for Storm-produkter: storm-extra* tvinger extra, andre storm-* tvinger base
audio_context_modestringneifull (standard) eller reduced
watchdog_enabledbooleanneiAktiver overvåking for dette anropet. Standard er false
additional_audio_contextboolean | nullneiInkluder de siste par omgangene med innringerens lyd i stedet for bare den nyeste omgangen, noe som forbedrer korrigeringer og innsamling av data med mye staving eller tall, med en liten økning i forsinkelse og kostnad. Er som standard på for innkommende økter og av for utgående telefonsamtaler; null beholder standardverdien
storm_feedback_modestringneinone, acknowledgement (standard) eller tick
languagestringneiKortform for primary_language
primary_languagestringneiSpråkkode, normalisert (standard en). Koder som ikke kan løses, avviser anropet
has_additional_languagesbooleanneiStandard er false
additional_languagesarray of stringneiEkstra språk agenten kan bytte til
native_voice_switchingbooleanneiStandard er false. Når anropet bytter til et annet språk, bytt til en stemme som har dette språket som morsmål (matchet etter kjønn), i stedet for å beholde den konfigurerte stemmen
background_trackstring | nullneiID for bakgrunnslyd eller null
acknowledgement_prompt_modestringneiauto (standard) eller manual (Storm-med-ack-produkter)
acknowledgement_promptstringneiBrukes når acknowledgement_prompt_mode="manual"
silence_interval_secondsinteger | nullnei5–120. Sekunder med stillhet fra innringeren før en oppfølging
silence_max_checkinsinteger | nullnei1–10
silence_checkins_enabledbooleanneiStandard er true
connect_tone_enabledbooleanneiStandard er false
voicemail_actionstringneiprompt (standard), hangup eller message
voicemail_messagestringneiBrukes når voicemail_action="message"
agent_namestringneiVisningsnavn som rapporteres til kontrollpaneler og widgeten
org_namestringneiOrganisasjonens visningsnavn for agentens persona
toolsarrayneiInnebygde skjemaer for funksjonsverktøy (se Funksjonsverktøy)
call_idintegerneiValgfritt ekko av anrops-ID-en i forespørselen; ignoreres

Siden prompt og voice er påkrevd, vil retur av {} eller et svar som ikke består valideringen, avvise anropet med 422 — det finnes ingen reserve for statisk agent på denne banen (et nummer eller en nøkkel i webhook-modus har ingen tilordnet agent).


Grense for responsstørrelse


Eksempelbehandler

Python (FastAPI)
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 {}
Node.js (Express)
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({});
  },
);

Svar med funksjonsverktøy

Legg ved verktøy slik at AI-en kan kalle API-ene dine midt i samtalen:

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

Hurtigoversikt over produktnivåer

ProduktForsinkelseResonneringBekreftelse
sparkLavestGrunnleggende
boltLavForbedret
storm-baseMiddelsSterk
storm-base-with-ackMiddelsSterkAutomatisk utfylling mens den tenker
storm-extraHøyereDyp
storm-extra-with-ackHøyereDypAutomatisk utfylling mens den tenker

Relatert