ਵੈੱਬਹੁੱਕਸ ਸੰਖੇਪ ਜਾਣਕਾਰੀ

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 ਸਿਰਫ਼ ਤਦ ਹੀ ਰੱਖੋ (ਜਾਂ ਜੋੜੋ) ਜੇ ਤੁਸੀਂ ਕਾਲਾਂ ਨੂੰ ਪਿਕਅੱਪ ਸਮੇਂ ਡਾਇਨਾਮਿਕ ਤੌਰ 'ਤੇ ਕੌਂਫਿਗਰ ਕਰਦੇ ਹੋ ਜਾਂ ਵੈੱਬਹੁੱਕ-ਮੋਡ ਟੂਲ ਡਿਸਪੈਚ ਵਰਤਦੇ ਹੋ — ਉਹ ਬੇਨਤੀ/ਜਵਾਬ ਐਕਸਚੇਂਜ ਸਿਰਫ਼ ਪੁਰਾਣੇ ਪਾਥ 'ਤੇ ਚੱਲਦੇ ਹਨ।

ਸੰਬੰਧਿਤ