ThunderPhone 2.0 હવે લાઇવ છે.સેલ્ફ-સર્વ, 2¢/મિનિટથી.જાહેરાત વાંચો

Webhooks

telephony.incoming / web.incoming

બ્લોકિંગ webhook જે આવનારા કૉલનું કન્ફિગરેશન વાસ્તવિક સમયમાં આકાર આપે છે.

જ્યારે ઇનબાઉન્ડ ફોન કૉલ કોઈ સોંપાયેલા એજન્ટ વિના નંબર પર પહોંચે, અથવા વેબ વિજેટ સત્ર mode="webhook"માં publishable key પર શરૂ થાય, ત્યારે ThunderPhone તમારી લેગસી webhook URL પર બ્લોકિંગ telephony.incoming / web.incoming વિનંતી મોકલે છે અને કૉન્ફિગરેશન પ્રતિસાદ માટે 10 સેકન્ડ સુધી રાહ જુએ છે. દરેક કૉલ માટે prompt, વૉઇસ અને ટૂલ્સને ડાયનેમિક રીતે પસંદ કરવા માટે આ વિનિમયનો ઉપયોગ કરો — સંપૂર્ણ પેટર્ન માટે ડાયનેમિક કૉલ કૉન્ફિગરેશન માર્ગદર્શિકા જુઓ.

બ્લોકિંગ વિનિમયમાં કોઈ ફૉલબૅક નથી: જો તમારું હેન્ડલર non-2xx સ્ટેટસ પરત કરે, ટાઇમઆઉટ થાય, અથવા વૅલિડેશનમાં નિષ્ફળ જતું કૉન્ફિગ પરત કરે, તો કૉલ નકારવામાં આવે છે (ફોન કૉલ કનેક્ટ થતો નથી; વિજેટ સત્ર વિનંતી 502/422 સાથે નિષ્ફળ જાય છે). ઝડપથી જવાબ આપો — તમે નિર્ણય લઈ રહ્યાં હો ત્યારે કૉલરને રિંગબૅક સંભળાય છે.

વિનંતી પેલોડ

ફોન કૉલ માટે (telephony.incoming):

{
  "type": "telephony.incoming",
  "data": {
    "call_id":     987654321,
    "from_number": "+14155550199",
    "to_number":   "+15551234567"
  }
}
ફીલ્ડપ્રકારવર્ણન
call_idintegerકૉલ id — આ કૉલના તમામ ઇવેન્ટ્સમાં સ્થિર
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કૉલ id
origin_domainstringવિજેટ હોસ્ટ કરતા પેજનું ઓરિજિન
publishable_key_prefixstringસત્ર ખોલનાર publishable keyના શરૂઆતના અક્ષરો
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હાએજન્ટને સંચાલિત કરતો સિસ્ટમ prompt
voicestringહાGET /v1/voices માંથી વૉઇસ id, દા.ત. 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
additional_audio_contextboolean | nullનાફક્ત સૌથી તાજેતરના ટર્નને બદલે કૉલરના ઑડિયોના છેલ્લા કેટલાક ટર્ન શામેલ કરો, જે નાના લેટન્સી/ખર્ચના ઓવરહેડ સાથે સુધારાઓ અને સ્પેલિંગ/નંબર-આધારિત ડેટા સંગ્રહને બહેતર બનાવે છે. ઇનબાઉન્ડ સત્રો માટે ડિફૉલ્ટ રૂપે ચાલુ અને આઉટબાઉન્ડ ફોન કૉલ્સ માટે બંધ; null ડિફૉલ્ટ જાળવી રાખે છે
storm_feedback_modestringનાnone, acknowledgement (ડિફૉલ્ટ), અથવા tick
languagestringનાprimary_language માટે સંક્ષિપ્ત રૂપ
primary_languagestringનાભાષા કોડ, સામાન્યકૃત (ડિફૉલ્ટ en). ઉકેલી ન શકાય તેવા કોડ કૉલ નકારે છે
has_additional_languagesbooleanનાડિફૉલ્ટ false
additional_languagesstring નો arrayનાએજન્ટ જે વધારાની ભાષાઓ પર સ્વિચ કરી શકે તે
native_voice_switchingbooleanનાડિફૉલ્ટ false. કૉલ બીજી ભાષા પર સ્વિચ થાય ત્યારે, કન્ફિગર કરેલા વૉઇસને જાળવી રાખવાને બદલે તે ભાષાના મૂળ વક્તાનો વૉઇસ (લિંગ અનુસાર મેળ ખાતો) વાપરો
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નાઇનલાઇન ફંક્શન-ટૂલ સ્કીમાઓ (Function Tools જુઓ)
call_idintegerનાવિનંતીના કૉલ id નો વૈકલ્પિક ઇકો; અવગણવામાં આવે છે

prompt અને voice આવશ્યક હોવાથી, {} અથવા વૅલિડેશનમાં નિષ્ફળ જતો કોઈપણ પ્રતિસાદ કૉલને 422 સાથે નકારે છે — આ પાથ પર કોઈ સ્ટેટિક-એજન્ટ ફૉલબૅક નથી (વેબહૂક મોડમાં નંબર અથવા કીને કોઈ એજન્ટ અસાઇન કરેલો હોતો નથી).


પ્રતિસાદ કદ મર્યાદા


ઉદાહરણ હેન્ડલર

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

ફંક્શન ટૂલ્સ સાથેનો પ્રતિસાદ

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વધુઊંડુંવિચાર દરમિયાન સ્વચાલિત ફિલર

સંબંધિત