ThunderPhone 2.0 on nyt julkaistu.Ota käyttöön itse – alkaen 2¢/min.Lue lisää julkistuksesta

Webhooks

telephony.incoming / web.incoming

Estävä webhook, joka määrittää saapuvan puhelun asetukset reaaliajassa.

Kun saapuva puhelu saapuu numeroon, jolle ei ole määritetty agenttia, tai web-widget-istunto käynnistyy julkaistavalla avaimella mode="webhook", ThunderPhone lähettää estävän telephony.incoming / web.incoming -pyynnön vanhaan webhook-URL-osoitteeseesi ja odottaa enintään 10 sekuntia määritysvastausta. Käytä tätä vaihtoa valitaksesi dynaamisesti kehotteen, äänen ja työkalut puhelukohtaisesti — katso kokonaisvaltainen malli dynaamisen puhelumäärityksen oppaasta.

Estävällä vaihdolla ei ole varavaihtoehtoa: jos käsittelijäsi palauttaa muun kuin 2xx-tilan, aikakatkaistaan tai palauttaa määrityksen, joka ei läpäise validointia, puhelu hylätään (puhelua ei yhdistetä; widget-istunnon pyyntö epäonnistuu virheellä 502/422). Vastaa nopeasti — soittaja kuulee soittoääntä samalla, kun teet päätöksen.

Pyynnön sisältö

Puheluille (telephony.incoming):

{
  "type": "telephony.incoming",
  "data": {
    "call_id":     987654321,
    "from_number": "+14155550199",
    "to_number":   "+15551234567"
  }
}
KenttäTyyppiKuvaus
call_idintegerPuhelutunnus — pysyy samana tämän puhelun kaikissa tapahtumissa
from_numberstringSoittajan E.164-numero
to_numberstringKohteen E.164-numero (yksi ThunderPhone-numeroistasi)

Web-widget-istunnoissa (web.incoming) data tunnistaa puhelinnumeroiden sijaan upottavan sivun:

{
  "type": "web.incoming",
  "data": {
    "call_id": 987654322,
    "origin_domain": "https://example.com",
    "publishable_key_prefix": "pk_live_a1b2"
  }
}
KenttäTyyppiKuvaus
call_idintegerPuhelutunnus
origin_domainstringWidgetiä isännöivän sivun alkuperä
publishable_key_prefixstringIstunnon avanneen julkaistavan avaimen ensimmäiset merkit
language, primary_languagestringSisältyy pyyntöön, kun widget-istunto pyysi kieliohitusasetusta
voicestringSisältyy pyyntöön, kun widget-istunto pyysi äänen ohitusasetusta
website_contextstringSisältyy pyyntöön, kun widget välitti istuntokohtaisen sivukontekstin

Vastausskeema

Palauta JSON-objekti, joka kuvaa tämän puhelun agentin määrityksen. prompt ja voice ovat pakollisia; kaikki muu on valinnaista.

{
  "prompt":  "You are a helpful booking assistant for Acme Restaurant.",
  "voice":   "john",
  "product": "spark",
  "background_track": null,
  "tools":   []
}
KenttäTyyppiPakollinenKuvaus
promptstringkylläAgenttia ohjaava järjestelmäkehote
voicestringkylläÄäni-ID kohteesta GET /v1/voices, esimerkiksi john. voice_name hyväksytään aliaksena. Tuntemattomat äänet eivät läpäise validointia ja puhelu hylätään
productstringeiOletusarvo on spark. Sallitut arvot: spark, bolt, storm-base, storm-base-with-ack, storm-extra, storm-extra-with-ack
thinking_levelstringeiminimal, base (oletus) tai extra. Storm-tuotteet ohittavat tämän: storm-extra* pakottaa arvon extra, muut storm-*-tuotteet pakottavat arvon base
audio_context_modestringeifull (oletus) tai reduced
watchdog_enabledbooleaneiOta valvonta käyttöön tälle puhelulle. Oletusarvo false
additional_audio_contextboolean | nulleiSisällytä soittajan äänen viimeiset muutamat vuorot pelkän viimeisimmän vuoron sijaan. Tämä parantaa korjauksia sekä paljon oikeinkirjoitusta tai numeroita sisältävää tietojen keruuta pienellä viive- ja kustannuslisällä. Oletusarvoisesti käytössä saapuvissa istunnoissa ja pois käytöstä lähtevissä puheluissa; null säilyttää oletusarvon
storm_feedback_modestringeinone, acknowledgement (oletus) tai tick
languagestringeiLyhenne kentälle primary_language
primary_languagestringeiKielikoodi, normalisoitu (oletus en). Koodit, joita ei voida ratkaista, hylkäävät puhelun
has_additional_languagesbooleaneiOletusarvo false
additional_languagesarray of stringeiLisäkielet, joihin agentti voi vaihtaa
native_voice_switchingbooleaneiOletusarvo false. Kun puhelu vaihtuu toiseen kieleen, vaihda kyseiselle kielelle natiivin puhujan ääneen (sukupuolen mukaan vastaavaan) määritetyn äänen säilyttämisen sijaan
background_trackstring | nulleiTaustaäänen ID tai null
acknowledgement_prompt_modestringeiauto (oletus) tai manual (Storm-with-ack-tuotteet)
acknowledgement_promptstringeiKäytetään, kun acknowledgement_prompt_mode="manual"
silence_interval_secondsinteger | nullei5–120. Soittajan hiljaisuuden sekunnit ennen tarkistusta
silence_max_checkinsinteger | nullei1–10
silence_checkins_enabledbooleaneiOletusarvo true
connect_tone_enabledbooleaneiOletusarvo false
voicemail_actionstringeiprompt (oletus), hangup tai message
voicemail_messagestringeiKäytetään, kun voicemail_action="message"
agent_namestringeiNäyttönimi, joka ilmoitetaan hallintapaneeleille ja widgetille
org_namestringeiOrganisaation näyttönimi agentin persoonalle
toolsarrayeiUpotetut funktiotyökalujen skeemat (katso Funktiotyökalut)
call_idintegereiValinnainen pyyntöön sisältyvän puhelutunnuksen kaiku; ohitetaan

Koska prompt ja voice ovat pakollisia, {}-objektin tai minkä tahansa validoinnin epäonnistuvan vastauksen palauttaminen hylkää puhelun koodilla 422 — tällä reitillä ei ole staattisen agentin varavaihtoehtoa (webhook-tilassa numerolle tai avaimelle ei ole määritetty agenttia).


Vastauksen kokorajoitus


Esimerkkikäsittelijä

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

Vastaus toimintotyökaluilla

Liitä työkaluja, jotta tekoäly voi kutsua rajapintojasi keskustelun aikana:

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

Tuotetason pikaopas

TuoteViivePäättelyKuittaus
sparkPieninPerustaso
boltMatalaParannettu
storm-baseKeskitasoVahva
storm-base-with-ackKeskitasoVahvaAutomaattinen täytesana ajattelun aikana
storm-extraKorkeampiSyvällinen
storm-extra-with-ackKorkeampiSyvällinenAutomaattinen täytesana ajattelun aikana

Aiheeseen liittyvät