telephony.incoming / web.incoming

ब्लॉकिंग वेबहुक जो रियल टाइम में इनबाउंड कॉल के कॉन्फ़िगरेशन को आकार देता है।

जब कोई इनबाउंड फोन कॉल बिना असाइन किए गए एजेंट वाले नंबर पर पहुंचती है, या वेब विजेट सेशन mode="webhook" में किसी पब्लिशेबल की पर शुरू होता है, तो ThunderPhone आपके लीगेसी वेबहुक URL को एक ब्लॉकिंग telephony.incoming / web.incoming रिक्वेस्ट भेजता है और कॉन्फ़िगरेशन रिस्पॉन्स की प्रतीक्षा करता है: फोन कॉल के लिए अधिकतम 13 सेकंड, जिसमें एक रीट्राई शामिल है, और विजेट सेशन के लिए अधिकतम 10 सेकंड (टाइमआउट और रीट्राई देखें)। हर कॉल के लिए प्रॉम्प्ट, वॉइस, और टूल्स को डायनामिक रूप से चुनने के लिए इस एक्सचेंज का उपयोग करें — एंड-टू-एंड पैटर्न के लिए डायनामिक कॉल कॉन्फ़िगरेशन गाइड देखें।

टाइमआउट और रिट्राइ#

जल्दी जवाब दें: आपके निर्णय लेने के दौरान कॉलर लाइन पर इंतज़ार कर रहा है।

फोन कॉल (telephony.incoming) के लिए:

• पहले प्रयास में 10 सेकंड तक लग सकते हैं।
• अगर टाइमआउट होता है, कनेक्ट नहीं हो पाता, या 5xx, 408 या 429 रिस्पॉन्स मिलता है, तो ThunderPhone एक बार फिर कोशिश करता है। रिट्राइ को पूरे एक्सचेंज के लिए 13-सेकंड के बजट में बचा हुआ समय मिलता है: टाइमआउट हुए पहले प्रयास के बाद लगभग 3 सेकंड, तेज़ विफलता के बाद लगभग पूरे 13 सेकंड। अगर 2 सेकंड से कम समय बचता है, तो रिट्राइ नहीं किया जाता।
• कोई भी अन्य 4xx रिस्पॉन्स, साइज़ सीमा से बड़ा रिस्पॉन्स, या ऐसा 2xx जिसका बॉडी मान्य कॉन्फ़िगरेशन नहीं है, अंतिम माना जाता है और उस पर रिट्राइ नहीं होता।
• दोनों प्रयास एक ही बॉडी, एक ही X-ThunderPhone-Signature, और एक ही X-ThunderPhone-Idempotency-Key हेडर (telephony-incoming-<call_id>) भेजते हैं, इसलिए साइड इफेक्ट्स वाला हैंडलर रिट्राइ को पहचान सकता है।

कोई फॉलबैक एजेंट नहीं है। अगर उपयोग योग्य कॉन्फ़िगरेशन नहीं मिलता, तो कॉलर को साइलेंट लाइन पर छोड़ने के बजाय कॉल तुरंत समाप्त कर दी जाती है। यह कॉल हिस्ट्री में end_reason inbound_config_webhook_failed के साथ एक असफल, बिना बिल वाली कॉल के रूप में दिखाई देती है, और सामान्य telephony.complete इवेंट भेजा जाता है।

विजेट सेशन (web.incoming) को 10 सेकंड तक का केवल एक प्रयास मिलता है। अगर यह विफल होता है, तो सेशन रिक्वेस्ट 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"
  }
}

ओवरराइड फ़ील्ड (language, voice, website_context, और कोई भी ब्राउज़र variables) केवल तब आते हैं जब publishable key उन्हें अपने ब्राउज़र ओवरराइड्स में अनुमति देती है। ऐसा सेशन रिक्वेस्ट जिसमें ऐसी कोई फ़ील्ड हो जिसकी key अनुमति नहीं देती, इस webhook के कॉल होने से पहले अस्वीकार कर दिया जाता है।

रिस्पॉन्स स्कीमा#

इस कॉल के लिए एजेंट कॉन्फ़िगरेशन का वर्णन करने वाला 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"
        }
      }
    }
  ]
}

प्रोडक्ट टियर चीट शीट#

संबंधित#