Webhookide ülevaade

Kuidas ThunderPhone edastab reaalajas sündmusi, kuidas allkirju kontrollida ning kuidas võrrelda pärand- ja lõpp-punktil põhinevaid edastusmudeleid.

ThunderPhone saadab sinu serverile HTTP POST päringuid, kui kõne ajal midagi juhtub — sissetulev kõne algab, kõne lõpeb, hindamisprotsess lõpeb, käivitub hoiatus jne. Saadaval on kaks edastusmudelit:

Kõik kümme sündmuste kataloogis olevat sündmusetüüpi edastatakse veebikonksu lõpp-punktide kaudu. Kuus kõne elutsükli sündmust (telephony.incoming, telephony.complete, telephony.tool, web.incoming, web.complete, web.tool) saadetakse samuti ühe URL-iga pärandveebikonksu kaudu — kui sul on nii pärand-URL kui ka sobiv lõpp-punkt, saad sündmuse mõlemale teele. Blokeeriv käitumine (telephony.incoming / web.incoming konfiguratsioonivahetus ja veebikonksurežiimi tööriista väljakutse) on ainult pärandteel; iga lõpp-punkti edastus on teavitus, mis ei oota vastust.

Andmevorming#

Lõpp-punkti edastused on JSON-objektid väljadega data, event_id ja type:

{
  "data": {
    "call_id": 987654321,
    "from_number": "+14155550199",
    "to_number": "+15551234567"
  },
  "event_id": "3f6b2ad0-1c9e-4a57-9f2b-8f6f0f9d2f11",
  "type": "telephony.incoming"
}

event_id on iga väljastatud sündmuse jaoks kordumatu. See on sama nii korduskatsete kui ka iga sündmuse saanud lõpp-punkti puhul — kasuta seda duplikaatide eemaldamiseks.

Ühe URL-iga pärandveebikonks saadab sama type ja data, kuid ilma event_id-ta:

{
  "type": "telephony.incoming",
  "data": { "call_id": 987654321, "from_number": "+14155550199", "to_number": "+15551234567" }
}

Võrgus serialiseeritakse iga sisu kanooniliselt — võtmed sorditakse tähestikulises järjekorras, tühikuid pole, kodeering on UTF-8. Nendes dokumentides olevad vormindatud näited on ainult loetavuse huvides.

Täieliku sündmusetüüpide ja andmeväljade loendi leiad sündmuste kataloogist.

Allkirja kontrollimine#

Iga päring sisaldab päises X-ThunderPhone-Signature HMAC-SHA256 allkirja, mis on arvutatud toorpäringu sisust. Allkirjastamisvõti on lõpp-punkti secret (või pärand-edastuste korral sinu organisatsioonitaseme veebikonksu secret).

Sammud#

1. Loe toorpäringu sisu enne mis tahes parsimist.
2. Arvuta hmac_sha256(secret, body).hexdigest().
3. Võrdle tulemust konstantse ajaga päisega X-ThunderPhone-Signature.

Allkirjastame täpselt need baidid, mida edastame, ning need baidid on kanoniseeritud JSON-i serialiseering (sorditud võtmed, kompaktsed eraldajad). Seega töötab kontrollimine toorsisu alusel alati — ja kui sinu raamistik annab sulle ainult parsitud JSON-i, tekitab selle uuesti serialiseerimine sorditud võtmete ja kompaktsete eraldajatega identsed baidid. Mõlemat meetodit käsitletakse kontrollimise juhendis.

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);
  },
);

Edastamise semantika#

Need semantikad kehtivad lõpp-punkti edastustele. Pärandne ühe URL-iga veebikonks teeb ühe sünkroonse katse ilma korduskatseteta.

Valimine pärandsete ja lõpp-punktipõhiste veebikonksude vahel#

Uued integratsioonid peaksid sündmusi vastu võtma lõpp-punktipõhiste veebikonksude kaudu. Hoia (või lisa) pärand-URL ainult siis, kui konfigureerid kõnesid dünaamiliselt kõnele vastamise ajal või kasutad veebikonksurežiimis tööriista väljakutsumist — need päringu/vastuse vahetused toimivad ainult pärandteel.

Seotud#