ThunderPhone 2.0 er lanceret.Selvbetjening fra 2 cent/min.Læs mere om lanceringen

Webhooks

telephony.incoming / web.incoming

Blokerende webhook, der former konfigurationen for et indgående opkald i realtid.

Når et indgående telefonopkald når et nummer uden en tilknyttet agent, eller en webwidgetsession starter på en publicerbar nøgle i mode="webhook", sender ThunderPhone en blokerende telephony.incoming / web.incoming-anmodning til din ældre webhook-URL og venter op til 10 sekunder på et konfigurationssvar. Brug denne udveksling til dynamisk at vælge prompt, stemme og værktøjer pr. opkald — se vejledningen til dynamisk opkaldskonfiguration for det samlede mønster.

Den blokerende udveksling har ingen fallback: Hvis din handler returnerer en ikke-2xx-status, får timeout eller returnerer en konfiguration, der ikke består valideringen, afvises opkaldet (telefonopkaldet forbindes ikke; widgetsessionens anmodning fejler med 502/422). Svar hurtigt — opkalderen hører ringetone, mens du beslutter dig.

Anmodningspayload

For telefonopkald (telephony.incoming):

{
  "type": "telephony.incoming",
  "data": {
    "call_id":     987654321,
    "from_number": "+14155550199",
    "to_number":   "+15551234567"
  }
}
FeltTypeBeskrivelse
call_idintegerOpkalds-id — stabilt på tværs af alle hændelser for dette opkald
from_numberstringOpkaldernummer i E.164-format
to_numberstringDestination i E.164-format (et af dine ThunderPhone-numre)

For webwidgetsessioner (web.incoming) identificerer data indlejringssiden i stedet for telefonnumre:

{
  "type": "web.incoming",
  "data": {
    "call_id": 987654322,
    "origin_domain": "https://example.com",
    "publishable_key_prefix": "pk_live_a1b2"
  }
}
FeltTypeBeskrivelse
call_idintegerOpkalds-id
origin_domainstringSidens origin, som hoster widgetten
publishable_key_prefixstringFørste tegn i den publicerbare nøgle, der åbnede sessionen
language, primary_languagestringFindes, når widgetsessionen anmodede om en sprogtilsidesættelse
voicestringFindes, når widgetsessionen anmodede om en stemmetilsidesættelse
website_contextstringFindes, når widgetten sendte sidekontekst pr. session

Svarskema

Returner et JSON-objekt, der beskriver agentkonfigurationen for dette opkald. prompt og voice er påkrævede; alt andet er valgfrit.

{
  "prompt":  "You are a helpful booking assistant for Acme Restaurant.",
  "voice":   "john",
  "product": "spark",
  "background_track": null,
  "tools":   []
}
FeltTypePåkrævetBeskrivelse
promptstringjaSystemprompt, der styrer agenten
voicestringjaStemme-id fra GET /v1/voices, f.eks. john. voice_name accepteres som et alias. Ukendte stemmer fejler validering og afviser opkaldet
productstringnejStandard er spark. Tilladt: spark, bolt, storm-base, storm-base-with-ack, storm-extra, storm-extra-with-ack
thinking_levelstringnejminimal, base (standard) eller extra. Tilsidesættes for Storm-produkter: storm-extra* gennemtvinger extra, andre storm-* gennemtvinger base
audio_context_modestringnejfull (standard) eller reduced
watchdog_enabledbooleannejAktivér overvågning for dette opkald. Standard er false
additional_audio_contextboolean | nullnejMedtag de seneste par omgange af opkalderens lyd i stedet for kun den seneste omgang, hvilket forbedrer rettelser og indsamling af data med mange stavninger eller tal med en mindre forsinkelses- og meromkostning. Er som standard slået til for indgående sessioner og slået fra for udgående telefonopkald; null bevarer standardindstillingen
storm_feedback_modestringnejnone, acknowledgement (standard) eller tick
languagestringnejForkortelse for primary_language
primary_languagestringnejSprogkode, normaliseret (standard en). Koder, der ikke kan løses, afviser opkaldet
has_additional_languagesbooleannejStandard er false
additional_languagesarray of stringnejEkstra sprog, som agenten kan skifte til
native_voice_switchingbooleannejStandard er false. Når opkaldet skifter til et andet sprog, skiftes der til en stemme, som har det pågældende sprog som modersmål (matchet efter køn), i stedet for at beholde den konfigurerede stemme
background_trackstring | nullnejId for baggrundslyd eller null
acknowledgement_prompt_modestringnejauto (standard) eller manual (Storm-with-ack-produkter)
acknowledgement_promptstringnejBruges, når acknowledgement_prompt_mode="manual"
silence_interval_secondsinteger | nullnej5–120. Sekunder med stilhed fra opkalderen før en opfølgning
silence_max_checkinsinteger | nullnej1–10
silence_checkins_enabledbooleannejStandard er true
connect_tone_enabledbooleannejStandard er false
voicemail_actionstringnejprompt (standard), hangup eller message
voicemail_messagestringnejBruges, når voicemail_action="message"
agent_namestringnejVist navn, der rapporteres til dashboards og widgetten
org_namestringnejOrganisationens viste navn til agentens persona
toolsarraynejIntegrerede skemaer for funktionsværktøjer (se Funktionsværktøjer)
call_idintegernejValgfrit ekko af anmodningens opkalds-id; ignoreres

Da prompt og voice er påkrævede, afviser returnering af {} eller ethvert svar, der ikke består validering, opkaldet med 422 — der er ingen fallback til en statisk agent på denne sti (et nummer eller en nøgle i webhooktilstand har ingen tildelt agent).


Grænse for svarstørrelse


Eksempel på handler

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 funktionsværktøjer

Tilknyt værktøjer, så AI'en kan kalde dine API'er 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"
        }
      }
    }
  ]
}

Produktniveauer – hurtig oversigt

ProduktLatensRæsonneringBekræftelse
sparkLavestGrundlæggende
boltLavForbedret
storm-baseMellemStærk
storm-base-with-ackMellemStærkAutomatisk udfyldning, mens der tænkes
storm-extraHøjereDyb
storm-extra-with-ackHøjereDybAutomatisk udfyldning, mens der tænkes

Relateret