ภาพรวม Webhook

ThunderPhone ส่งคำขอ HTTP POST ไปยังเซิร์ฟเวอร์ของคุณเมื่อมีเหตุการณ์ เกิดขึ้นระหว่างการโทร เช่น สายเรียกเข้าเริ่มต้น สายสิ้นสุด การรันการประเมิน เสร็จสมบูรณ์ มีการแจ้งเตือน และอื่นๆ มีรูปแบบการส่งข้อมูลอยู่สองรูปแบบ:

เหตุการณ์ทั้งสิบประเภทในแค็ตตาล็อกเหตุการณ์จะถูก ส่งผ่าน webhook endpoint เหตุการณ์ตลอดวงจรชีวิตการโทรทั้งหกรายการ (telephony.incoming, telephony.complete, telephony.tool, web.incoming, web.complete, web.tool)จะถูกส่งไปยัง webhook แบบเดิมที่ใช้ URL เดียวด้วย — หากคุณมีทั้ง URL แบบเดิมและ endpoint ที่ตรงกัน คุณจะได้รับเหตุการณ์ผ่านทั้งสองเส้นทาง พฤติกรรมแบบบล็อก (การแลกเปลี่ยนการกำหนดค่า telephony.incoming / web.incoming และการส่งต่อเครื่องมือใน โหมด webhook)มีอยู่เฉพาะบนเส้นทางแบบเดิมเท่านั้น การส่งข้อมูลไปยัง endpoint ทุกครั้งเป็นการแจ้งเตือนแบบส่งแล้วไม่รอผลลัพธ์

รูปแบบ payload

การส่งข้อมูลไปยัง endpoint เป็นออบเจ็กต์ JSON ที่มี data, event_id และ type:

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

event_id ไม่ซ้ำกันสำหรับแต่ละเหตุการณ์ที่ส่งออก โดยจะเหมือนกันในการลองใหม่ และในทุก endpoint ที่ได้รับเหตุการณ์ — ใช้ค่านี้เพื่อตัดรายการซ้ำ

webhook แบบเดิมที่ใช้ URL เดียวส่ง type และ data เดียวกัน แต่ ไม่มี event_id:

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

ในการส่งผ่านเครือข่าย เนื้อหาทุกรายการจะถูกซีเรียลไลซ์แบบมาตรฐาน — คีย์เรียงตาม ตัวอักษร ไม่มีช่องว่าง และใช้ UTF-8 ตัวอย่างที่จัดรูปแบบให้อ่านง่ายใน เอกสารนี้มีไว้เพื่อความสะดวกในการอ่านเท่านั้น

ดูแค็ตตาล็อกเหตุการณ์สำหรับรายการประเภทเหตุการณ์และ ฟิลด์ payload ทั้งหมด

การตรวจสอบลายเซ็น

ทุกคำขอจะมีลายเซ็น HMAC-SHA256 ที่คำนวณจาก เนื้อหาคำขอดิบ อยู่ในส่วนหัว X-ThunderPhone-Signature คีย์ที่ใช้ลงลายเซ็นคือ secret ของปลายทาง (หรือ secret ของ webhook ระดับองค์กรสำหรับ การส่งแบบเดิม)

ขั้นตอน

1. อ่านเนื้อหาคำขอดิบ ก่อน การแยกวิเคราะห์ใดๆ
2. คำนวณ hmac_sha256(secret, body).hexdigest()
3. เปรียบเทียบกับส่วนหัว X-ThunderPhone-Signature โดยใช้เวลาคงที่

เราลงลายเซ็นบนไบต์ที่เราส่งอย่างตรงตัว และไบต์เหล่านั้นคือ JSON serialization แบบมาตรฐาน (เรียงลำดับคีย์ ตัวคั่นแบบกระชับ) ดังนั้น การตรวจสอบกับเนื้อหาดิบจึงใช้ได้เสมอ — และหากเฟรมเวิร์กของคุณ ส่งให้เฉพาะ JSON ที่แยกวิเคราะห์แล้ว การ serialize ใหม่โดยเรียงลำดับคีย์ และใช้ตัวคั่นแบบกระชับจะสร้างไบต์ที่เหมือนกัน ทั้งสองวิธีอธิบายไว้ใน คู่มือการตรวจสอบ

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 แบบเดิมไว้เฉพาะเมื่อคุณกำหนดค่าการโทร แบบไดนามิกขณะรับสาย หรือใช้การเรียกใช้เครื่องมือในโหมดเว็บฮุก — การแลกเปลี่ยน คำขอ/การตอบกลับเหล่านั้นทำงานบนเส้นทางเดิมเท่านั้น

ที่เกี่ยวข้อง