വെബ്‌ഹുക്കുകളുടെ അവലോകനം

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. ഈ ഡോക്യുമെന്റുകളിലെ മനോഹരമായി ഫോർമാറ്റ് ചെയ്ത ഉദാഹരണങ്ങൾ വായനാസൗകര്യത്തിനായി മാത്രമാണ്.

ഇവന്റ് തരങ്ങളുടെയും പേലോഡ് ഫീൽഡുകളുടെയും പൂർണ്ണ പട്ടികയ്ക്കായി ഇവന്റ്സ് കാറ്റലോഗ് കാണുക.

സിഗ്നേച്ചർ പരിശോധന#

ഓരോ റിക്വസ്റ്റിലും X-ThunderPhone-Signature ഹെഡറിൽ അസംസ്കൃത റിക്വസ്റ്റ് ബോഡി അടിസ്ഥാനമാക്കിയുള്ള HMAC-SHA256 സിഗ്നേച്ചർ ഉണ്ടായിരിക്കും. സൈനിംഗ് കീ എൻഡ്പോയിന്റിന്റെ secret ആണ് (അല്ലെങ്കിൽ ലെഗസി ഡെലിവറികൾക്കായി നിങ്ങളുടെ org-തല webhook secret).

ഘട്ടങ്ങൾ#

1. ഏതെങ്കിലും പാഴ്സിങ്ങിന് മുമ്പ് അസംസ്കൃത റിക്വസ്റ്റ് ബോഡി വായിക്കുക.
2. hmac_sha256(secret, body).hexdigest() കണക്കാക്കുക.
3. X-ThunderPhone-Signature ഹെഡറുമായി സ്ഥിരസമയത്ത് താരതമ്യം ചെയ്യുക.

ഞങ്ങൾ കൈമാറുന്ന കൃത്യമായ ബൈറ്റുകളിലാണ് സൈൻ ചെയ്യുന്നത്, ആ ബൈറ്റുകൾ കാനോനിക്കൽ JSON സീരിയലൈസേഷനാണ് (ക്രമീകരിച്ച കീകൾ, കോംപാക്റ്റ് സെപ്പറേറ്ററുകൾ). അതിനാൽ അസംസ്കൃത ബോഡിക്കെതിരെ പരിശോധിക്കുന്നത് എല്ലായ്പ്പോഴും പ്രവർത്തിക്കും — നിങ്ങളുടെ ഫ്രെയിംവർക്ക് പാഴ്സ് ചെയ്ത JSON മാത്രം നൽകുന്നുവെങ്കിൽ, ക്രമീകരിച്ച കീകളും കോംപാക്റ്റ് സെപ്പറേറ്ററുകളും ഉപയോഗിച്ച് വീണ്ടും സീരിയലൈസ് ചെയ്യുന്നത് അതേ ബൈറ്റുകൾ സൃഷ്ടിക്കും. രണ്ട് രീതികളും പരിശോധന ഗൈഡിൽ ഉൾപ്പെടുത്തിയിട്ടുണ്ട്.

import hmac
import hashlib
 
def verify_signature(body: bytes, signature: str, secret: str) -> bool:
    expected = hmac.new(
        secret.encode("utf-8"),
        body,
        hashlib.sha256,
    ).hexdigest()
    return hmac.compare_digest(expected, signature or "")
 
# Example Flask handler
from flask import Flask, request, abort
app = Flask(__name__)
 
@app.post("/thunderphone-webhook")
def handle():
    body = request.get_data()
    sig = request.headers.get("X-ThunderPhone-Signature", "")
    if not verify_signature(body, sig, WEBHOOK_SECRET):
        abort(401)
    event = request.get_json()
    # dispatch on event["type"] …
    return "", 204

import crypto from "node:crypto";
import express from "express";
 
function verifySignature(body, signature, secret) {
  const expected = crypto
    .createHmac("sha256", secret)
    .update(body)
    .digest("hex");
  if (!signature || expected.length !== signature.length) return false;
  return crypto.timingSafeEqual(
    Buffer.from(expected),
    Buffer.from(signature),
  );
}
 
const app = express();
app.post(
  "/thunderphone-webhook",
  express.raw({ type: "application/json" }),
  (req, res) => {
    const sig = req.header("X-ThunderPhone-Signature") || "";
    if (!verifySignature(req.body, sig, process.env.WEBHOOK_SECRET)) {
      return res.sendStatus(401);
    }
    const event = JSON.parse(req.body.toString("utf8"));
    // dispatch on event.type …
    res.sendStatus(204);
  },
);

ഡെലിവറി സെമാന്റിക്സ്#

ഈ സെമാന്റിക്സ് എൻഡ്‌പോയിന്റ് ഡെലിവറികൾക്ക് ബാധകമാണ്. ലെഗസി സിംഗിൾ-URL webhook റീട്രൈകളില്ലാത്ത ഒറ്റ സിൻക്രണസ് ശ്രമമാണ്.

ലെഗസിയും എൻഡ്‌പോയിന്റ്-അടിസ്ഥാനത്തിലുള്ള webhooks-ഉം തമ്മിൽ തിരഞ്ഞെടുക്കൽ#

പുതിയ ഇന്റഗ്രേഷനുകൾ എൻഡ്‌പോയിന്റ്-അടിസ്ഥാനത്തിലുള്ള webhooks വഴി ഇവന്റുകൾ കൺസ്യൂം ചെയ്യണം. പിക്കപ്പ് സമയത്ത് കോളുകൾ ഡൈനാമിക്കായി കോൺഫിഗർ ചെയ്യുന്നെങ്കിലോ webhook-മോഡ് ടൂൾ ഡിസ്പാച്ച് ഉപയോഗിക്കുന്നെങ്കിലോ മാത്രം ലെഗസി URL നിലനിർത്തുക (അല്ലെങ്കിൽ ചേർക്കുക) — ആ റിക്വസ്റ്റ്/റെസ്പോൺസ് എക്സ്ചേഞ്ചുകൾ ലെഗസി പാതയിൽ മാത്രമേ പ്രവർത്തിക്കൂ.

ബന്ധപ്പെട്ടവ#