ವೆಬ್‌ಹುಕ್‌ಗಳ ಅವಲೋಕನ

ThunderPhone ನೈಜ-ಸಮಯದ ಈವೆಂಟ್‌ಗಳನ್ನು ಹೇಗೆ ತಲುಪಿಸುತ್ತದೆ, ಸಹಿಗಳನ್ನು ಹೇಗೆ ಪರಿಶೀಲಿಸುವುದು ಮತ್ತು ಹಳೆಯ ಹಾಗೂ ಎಂಡ್‌ಪಾಯಿಂಟ್-ಆಧಾರಿತ ವಿತರಣಾ ಮಾದರಿಗಳು ಹೇಗೆ ಹೋಲುತ್ತವೆ ಎಂಬುದನ್ನು ತಿಳಿಯಿರಿ.

ThunderPhone ಕರೆ ನಡೆಯುವಾಗ ಘಟನೆಗಳು ಸಂಭವಿಸಿದಾಗ ನಿಮ್ಮ ಸರ್ವರ್‌ಗೆ HTTP POST ವಿನಂತಿಗಳನ್ನು ಕಳುಹಿಸುತ್ತದೆ — ಒಳಬರುವ ಕರೆ ಆರಂಭವಾಗುವುದು, ಕರೆ ಕೊನೆಗೊಳ್ಳುವುದು, ಗ್ರೇಡಿಂಗ್ ಚಾಲನೆ ಪೂರ್ಣಗೊಳ್ಳುವುದು, ಎಚ್ಚರಿಕೆ ಸಕ್ರಿಯಗೊಳ್ಳುವುದು, ಇತ್ಯಾದಿ. ಎರಡು ವಿತರಣಾ ಮಾದರಿಗಳಿವೆ:

ಘಟನೆಗಳ ಕ್ಯಾಟಲಾಗ್ ನಲ್ಲಿರುವ ಎಲ್ಲಾ ಹತ್ತು ಘಟನೆ ಪ್ರಕಾರಗಳು ವೆಬ್‌ಹುಕ್ ಎಂಡ್‌ಪಾಯಿಂಟ್‌ಗಳ ಮೂಲಕ ವಿತರಿಸಲ್ಪಡುತ್ತವೆ. ಆರು ಕರೆ-ಜೀವನಚಕ್ರದ ಘಟನೆಗಳು (telephony.incoming, telephony.complete, telephony.tool, web.incoming, web.complete, web.tool) ಪರಂಪರಾಗತ ಏಕ-URL ವೆಬ್‌ಹುಕ್‌ಗೆ ಸಹ ಕಳುಹಿಸಲಾಗುತ್ತವೆ — ನೀವು ಪರಂಪರಾಗತ URL ಮತ್ತು ಹೊಂದಾಣಿಕೆಯಾಗುವ ಎಂಡ್‌ಪಾಯಿಂಟ್ ಎರಡನ್ನೂ ಹೊಂದಿದ್ದರೆ, ನೀವು ಘಟನೆಯನ್ನು ಎರಡೂ ಮಾರ್ಗಗಳಲ್ಲಿ ಸ್ವೀಕರಿಸುತ್ತೀರಿ. ತಡೆಯುವ ನಡವಳಿಕೆ (telephony.incoming / web.incoming ಸಂರಚನಾ ವಿನಿಮಯ ಮತ್ತು ವೆಬ್‌ಹುಕ್-ಮೋಡ್‌ನ ಉಪಕರಣ ರವಾನೆ) ಪ್ರತ್ಯೇಕವಾಗಿ ಪರಂಪರಾಗತ ಮಾರ್ಗದಲ್ಲೇ ಇರುತ್ತದೆ; ಪ್ರತಿಯೊಂದು ಎಂಡ್‌ಪಾಯಿಂಟ್ ವಿತರಣೆಯು ಪ್ರತಿಕ್ರಿಯೆಗಾಗಿ ಕಾಯದ ಅಧಿಸೂಚನೆಯಾಗಿದೆ.

ಪೇಲೋಡ್ ಸ್ವರೂಪ#

ಎಂಡ್‌ಪಾಯಿಂಟ್ ವಿತರಣೆಗಳು 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 ವೆಬ್‌ಹುಕ್ ಅದೇ 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 ಆಗಿರುತ್ತದೆ (ಅಥವಾ ಹಳೆಯ ಡೆಲಿವರಿಗಳಿಗಾಗಿ ನಿಮ್ಮ ಸಂಸ್ಥೆ-ಮಟ್ಟದ ವೆಬ್‌ಹುಕ್ 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 ಅನ್ನು ಉಳಿಸಿಕೊಳ್ಳಿ (ಅಥವಾ ಸೇರಿಸಿ) — ಆ ವಿನಂತಿ/ಪ್ರತಿಕ್ರಿಯೆ ವಿನಿಮಯಗಳು ಲೆಗಸಿ ಮಾರ್ಗದಲ್ಲಷ್ಟೇ ಕಾರ್ಯನಿರ್ವಹಿಸುತ್ತವೆ.

ಸಂಬಂಧಿತ#