వెబ్‌హుక్‌ల అవలోకనం

ThunderPhone రియల్-టైమ్ ఈవెంట్‌లను ఎలా అందిస్తుందో, సంతకాలను ఎలా ధృవీకరించాలో, అలాగే లెగసీ మరియు ఎండ్‌పాయింట్-ఆధారిత డెలివరీ మోడల్‌లు ఎలా పోల్చబడతాయో తెలుసుకోండి.

కాల్ సమయంలో సంఘటనలు జరిగినప్పుడు ThunderPhone మీ సర్వర్‌కు HTTP POST అభ్యర్థనలను పంపుతుంది — ఇన్‌బౌండ్ కాల్ ప్రారంభమైనప్పుడు, కాల్ ముగిసినప్పుడు, గ్రేడింగ్ రన్ పూర్తైనప్పుడు, అలర్ట్ ట్రిగ్గర్ అయినప్పుడు మొదలైనవి. రెండు డెలివరీ మోడళ్లు ఉన్నాయి:

ఈవెంట్‌ల కేటలాగ్లో జాబితా చేసిన అన్ని ఈవెంట్ రకాలు webhook ఎండ్‌పాయింట్ల ద్వారా డెలివర్ చేయబడతాయి. ఆరు కాల్-లైఫ్‌సైకిల్ ఈవెంట్‌లు (telephony.incoming, telephony.complete, telephony.tool, web.incoming, web.complete, web.tool) లెగసీ సింగిల్-URL webhookకు కూడా పంపబడతాయి — మీ వద్ద లెగసీ URL మరియు సరిపోలే ఎండ్‌పాయింట్ రెండూ ఉంటే, మీరు ఈవెంట్‌ను రెండు పాత్‌లలోనూ అందుకుంటారు. బ్లాకింగ్ ప్రవర్తన (telephony.incoming / web.incoming కాన్ఫిగరేషన్ ఎక్స్ఛేంజ్ మరియు webhook-మోడ్ టూల్ డిస్పాచ్) ప్రత్యేకంగా లెగసీ పాత్‌లోనే ఉంటుంది; ప్రతి ఎండ్‌పాయింట్ డెలివరీ పంపి-వదిలే నోటిఫికేషన్ మాత్రమే.

పేలోడ్ ఫార్మాట్#

ఎండ్‌పాయింట్ డెలివరీలు data, event_id, మరియు typeతో కూడిన JSON ఆబ్జెక్ట్:

{
  "data": {
    "call_id": 987654321,
    "from_number": "+14155550199",
    "to_number": "+15551234567"
  },
  "event_id": "3f6b2ad0-1c9e-4a57-9f2b-8f6f0f9d2f11",
  "type": "telephony.incoming"
}

event_id విడుదల చేసిన ప్రతి ఈవెంట్‌కు ప్రత్యేకమైనది. రీట్రైల అంతటా మరియు ఈవెంట్‌ను స్వీకరించే ప్రతి ఎండ్‌పాయింట్ అంతటా ఇది ఒకేలా ఉంటుంది — దాని ఆధారంగా డీడూప్లికేట్ చేయండి.

లెగసీ సింగిల్-URL webhook అదే type మరియు dataను పంపుతుంది, కానీ event_id లేకుండా:

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

వైర్‌పై, ప్రతి బాడీ కానానికల్‌గా సీరియలైజ్ చేయబడుతుంది — కీలు అక్షర క్రమంలో సార్టు చేయబడతాయి, ఖాళీ స్థలం ఉండదు, UTF-8 ఉపయోగించబడుతుంది. ఈ డాక్యుమెంటేషన్‌లోని అందంగా ఫార్మాట్ చేసిన ఉదాహరణలు చదవడానికి సులభంగా ఉండటానికే.

ఈవెంట్ రకాలు మరియు పేలోడ్ ఫీల్డ్‌ల పూర్తి జాబితా కోసం ఈవెంట్‌ల కేటలాగ్ చూడండి.

సంతకం ధృవీకరణ#

ప్రతి అభ్యర్థనలో రెండు సంతకాలు ఉంటాయి. రెండూ endpoint యొక్క secretతో (లేదా లెగసీ డెలివరీల కోసం మీ సంస్థ-స్థాయి webhook secretతో) కీ చేయబడిన HMAC-SHA256ను ఉపయోగిస్తాయి:

• X-ThunderPhone-Signature-V2: t=<unix seconds>,v1=<hex> టైమ్‌స్టాంప్, మెథడ్, పాత్ మరియు క్వెరీ, అలాగే రా బాడీపై సంతకం చేస్తుంది. దీన్ని ధృవీకరించండి మరియు క్యాప్చర్ చేసిన అభ్యర్థనను తర్వాత మళ్లీ ప్లే చేయకుండా నిరోధించడానికి, మీ గడియారంతో పోలిస్తే t 5 నిమిషాల కంటే ఎక్కువ తేడా ఉన్న అభ్యర్థనలను తిరస్కరించండి. రీట్రైలు పంపినప్పుడు వాటికి మళ్లీ సంతకం చేయబడుతుంది.
• X-ThunderPhone-Signature రా బాడీపై మాత్రమే సంతకం చేస్తుంది. ఇప్పటికే ఉన్న వెరిఫైయర్లు పని చేస్తూనే ఉండేందుకు, ఇది మార్పు లేకుండా ఇప్పటికీ పంపబడుతుంది.

దశలు#

1. ఏదైనా పార్సింగ్‌కు ముందు హెడర్, మెథడ్, రా పాత్ మరియు క్వెరీ, అలాగే రా బాడీని చదవండి.
2. మీ సీక్రెట్‌తో <t>\n<METHOD>\n<path and query>\n<body> యొక్క హెక్స్ HMAC-SHA256ను గణించండి.
3. t 300 సెకన్ల కంటే ఎక్కువ తేడాతో ఉంటే, లేదా ఫలితం స్థిర-సమయ పోలికలో v1తో సరిపోలకపోతే అభ్యర్థనను తిరస్కరించండి.

బాడీలు కానానికల్ JSON సీరియలైజేషన్‌గా ఉంటాయి (క్రమబద్ధీకరించిన కీలు, కాంపాక్ట్ సెపరేటర్లు), మరియు మేము ప్రసారం చేసే ఖచ్చితమైన బైట్‌లకే సంతకం చేస్తాము. ధృవీకరణ గైడ్లో ఖచ్చితమైన సంతకం చేసిన స్ట్రింగ్, ఒక ఉదాహరణ, SDK లేకుండా కోడ్, మరియు లెగసీ హెడర్ ఉన్నాయి.

from flask import Flask, abort, request
from thunderphone import verify_signature
 
app = Flask(__name__)
 
@app.post("/thunderphone-webhook")
def handle():
    query = request.query_string.decode()
    if not verify_signature(
        request.headers.get("X-ThunderPhone-Signature-V2"),
        secret=WEBHOOK_SECRET,
        method=request.method,
        path=request.path + (f"?{query}" if query else ""),
        body=request.get_data(),  # raw bytes
    ):
        abort(401)
    event = request.get_json()
    # dispatch on event["type"] …
    return "", 204

import express from "express";
import { verifySignature } from "@thunderphone/sdk";
 
const app = express();
app.post(
  "/thunderphone-webhook",
  express.raw({ type: "application/json" }),
  (req, res) => {
    const ok = verifySignature({
      header: req.header("X-ThunderPhone-Signature-V2"),
      secret: process.env.WEBHOOK_SECRET,
      method: req.method,
      path: req.originalUrl,
      body: req.body,
    });
    if (!ok) return res.sendStatus(401);
    const event = JSON.parse(req.body.toString("utf8"));
    // dispatch on event.type …
    res.sendStatus(204);
  },
);

డెలివరీ సెమాంటిక్స్#

ఈ సెమాంటిక్స్ ఎండ్‌పాయింట్ డెలివరీలకు వర్తిస్తాయి. లెగసీ సింగిల్-URL వెబ్‌హుక్ అనేది రీట్రైలు లేని ఒకే సమకాలిక ప్రయత్నం, అయితే ఫోన్ కాల్‌కు సంబంధించిన telephony.incoming కాన్ఫిగరేషన్ మార్పిడి మాత్రమే ఒకసారి రీట్రై చేయబడుతుంది.

లెగసీ మరియు ఎండ్‌పాయింట్-ఆధారిత వెబ్‌హుక్‌ల మధ్య ఎంచుకోవడం#

కొత్త ఇంటిగ్రేషన్‌లు ఎండ్‌పాయింట్-ఆధారిత వెబ్‌హుక్‌ల ద్వారా ఈవెంట్‌లను వినియోగించాలి. పికప్ సమయంలో కాల్‌లను డైనమిక్‌గా కాన్ఫిగర్ చేస్తే లేదా వెబ్‌హుక్-మోడ్ టూల్ డిస్పాచ్‌ను ఉపయోగిస్తే మాత్రమే లెగసీ URLను ఉంచండి (లేదా జోడించండి) — ఆ రిక్వెస్ట్/ప్రతిస్పందన మార్పిడులు లెగసీ పాత్‌లో మాత్రమే నడుస్తాయి.

సంబంధితవి#