வெப்ஹுக்குகள் கண்ணோட்டம்

ThunderPhone நிகழ்நேர நிகழ்வுகளை எவ்வாறு வழங்குகிறது, கையொப்பங்களை எவ்வாறு சரிபார்ப்பது, மற்றும் மரபு மற்றும் எண்ட்பாயிண்ட் அடிப்படையிலான விநியோக மாதிரிகள் எவ்வாறு ஒப்பிடப்படுகின்றன.

ThunderPhone, அழைப்பின் போது நிகழ்வுகள் நடந்தால் உங்கள் சர்வருக்கு HTTP POST கோரிக்கைகளை அனுப்புகிறது — உள்வரும் அழைப்பு தொடங்கும்போது, அழைப்பு முடிவடையும்போது, தரப்படுத்தல் இயக்கம் நிறைவடையும்போது, எச்சரிக்கை செயல்படும்போது மற்றும் பல. இரண்டு வழங்கல் மாதிரிகள் உள்ளன:

event பட்டியலில் உள்ள அனைத்து பத்து நிகழ்வு வகைகளும் 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" }
}

நெட்வொர்க்கில், ஒவ்வொரு body-யும் முறையான வடிவில் வரிசைப்படுத்தப்படுகிறது — கீக்கள் அகரவரிசையில் வரிசைப்படுத்தப்படும், இடைவெளிகள் இல்லை, UTF-8. இந்த ஆவணங்களில் உள்ள அழகாக வடிவமைக்கப்பட்ட எடுத்துக்காட்டுகள் வாசிப்பதற்கான வசதிக்காக மட்டுமே.

நிகழ்வு வகைகள் மற்றும் பேலோட் புலங்களின் முழுப் பட்டியலுக்கு நிகழ்வுகள் பட்டியலை பார்க்கவும்.

கையொப்பச் சரிபார்ப்பு#

ஒவ்வொரு கோரிக்கையிலும் X-ThunderPhone-Signature ஹெடரில் மூல கோரிக்கை உடல் மீது HMAC-SHA256 கையொப்பம் இருக்கும். கையொப்ப விசை என்பது எண்ட்பாயிண்டின் secret ஆகும் (அல்லது பழைய டெலிவரிகளுக்கு உங்கள் நிறுவன-நிலை வெப்ஹுக் 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 வெப்ஹுக் என்பது மீண்டும் முயற்சிகளற்ற ஒற்றை ஒத்திசைவு முயற்சியாகும்.

பழைய மற்றும் எண்ட்பாயிண்ட் அடிப்படையிலான வெப்ஹுக்குகளுக்கு இடையே தேர்வு செய்தல்#

புதிய ஒருங்கிணைப்புகள் எண்ட்பாயிண்ட் அடிப்படையிலான வெப்ஹுக்குகள் மூலம் நிகழ்வுகளை நுகர வேண்டும். அழைப்பு எடுக்கப்படும் நேரத்தில் அழைப்புகளை டைனமிக்காக உள்ளமைத்தால் அல்லது வெப்ஹுக்-முறை கருவி அனுப்புதலைப் பயன்படுத்தினால் மட்டுமே பழைய URL ஐ வைத்திருக்கவும் (அல்லது சேர்க்கவும்) — அந்த கோரிக்கை/பதில் பரிமாற்றங்கள் பழைய பாதையில் மட்டுமே இயங்கும்.

தொடர்புடையவை#