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

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। ਇਨ੍ਹਾਂ ਦਸਤਾਵੇਜ਼ਾਂ ਵਿੱਚ ਪ੍ਰਿਟੀ-ਪ੍ਰਿੰਟ ਕੀਤੀਆਂ ਉਦਾਹਰਨਾਂ ਸਿਰਫ਼ ਪੜ੍ਹਨਯੋਗਤਾ ਲਈ ਹਨ।

ਇਵੈਂਟ ਕਿਸਮਾਂ ਅਤੇ ਪੇਲੋਡ ਫੀਲਡਾਂ ਦੀ ਪੂਰੀ ਸੂਚੀ ਲਈ ਇਵੈਂਟ ਕੈਟਾਲਾਗ ਵੇਖੋ।

ਦਸਤਖ਼ਤ ਦੀ ਤਸਦੀਕ#

ਹਰ ਬੇਨਤੀ ਵਿੱਚ ਦੋ ਦਸਤਖਤ ਹੁੰਦੇ ਹਨ, ਦੋਵੇਂ endpoint ਦੇ secret (ਜਾਂ ਪੁਰਾਣੀਆਂ ਡਿਲੀਵਰੀਆਂ ਲਈ ਤੁਹਾਡੇ org-ਪੱਧਰੀ 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 ਕੰਫਿਗਰੇਸ਼ਨ ਐਕਸਚੇਂਜ ਦੇ, ਜਿਸ ਲਈ ਇੱਕ ਵਾਰ ਮੁੜ-ਕੋਸ਼ਿਸ਼ ਕੀਤੀ ਜਾਂਦੀ ਹੈ।

ਪੁਰਾਣੇ ਅਤੇ ਐਂਡਪੌਇੰਟ-ਅਧਾਰਿਤ webhooks ਵਿੱਚੋਂ ਚੋਣ#

ਨਵੀਆਂ ਇੰਟੀਗ੍ਰੇਸ਼ਨਾਂ ਨੂੰ ਐਂਡਪੌਇੰਟ-ਅਧਾਰਿਤ webhooks ਰਾਹੀਂ ਇਵੈਂਟ ਵਰਤਣੇ ਚਾਹੀਦੇ ਹਨ। ਪੁਰਾਣਾ URL ਕੇਵਲ ਤਦ ਹੀ ਰੱਖੋ (ਜਾਂ ਜੋੜੋ) ਜੇ ਤੁਸੀਂ ਪਿਕਅੱਪ ਸਮੇਂ ਕਾਲਾਂ ਨੂੰ ਡਾਇਨਾਮਿਕ ਤੌਰ 'ਤੇ ਕੌਂਫਿਗਰ ਕਰਦੇ ਹੋ ਜਾਂ webhook-ਮੋਡ ਟੂਲ ਡਿਸਪੈਚ ਵਰਤਦੇ ਹੋ — ਉਹ ਬੇਨਤੀ/ਜਵਾਬ ਅਦਲਾ-ਬਦਲੀਆਂ ਸਿਰਫ਼ ਪੁਰਾਣੇ ਪਾਥ 'ਤੇ ਹੀ ਚਲਦੀਆਂ ਹਨ।

ਸੰਬੰਧਿਤ#