telephony.incoming / web.incoming

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

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

વિનંતી પેલોડ

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

{
  "type": "telephony.incoming",
  "data": {
    "call_id":     987654321,
    "from_number": "+14155550199",
    "to_number":   "+15551234567"
  }
}

વેબ વિજેટ સત્રો માટે (web.incoming), data ફોન નંબરોને બદલે એમ્બેડ કરતું પેજ ઓળખે છે:

{
  "type": "web.incoming",
  "data": {
    "call_id": 987654322,
    "origin_domain": "https://example.com",
    "publishable_key_prefix": "pk_live_a1b2"
  }
}

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

આ કોલ માટે એજન્ટ કન્ફિગરેશનનું વર્ણન કરતું JSON ઑબ્જેક્ટ પરત કરો. prompt અને voice આવશ્યક છે; બાકીનું બધું વૈકલ્પિક છે.

{
  "prompt":  "You are a helpful booking assistant for Acme Restaurant.",
  "voice":   "john",
  "product": "spark",
  "background_track": null,
  "tools":   []
}

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

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

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

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

પ્રોડક્ટ ટિયર સંદર્ભ

સંબંધિત