Webhooks

Webhook

ThunderPhone

ThunderPhone, bir çağrı sırasında gerçekleşen durumlarda — gelen çağrının başlaması, çağrının sona ermesi, derecelendirme çalışmasının tamamlanması, uyarının tetiklenmesi vb. — sunucunuza HTTP POST istekleri gönderir. İki teslim modeli vardır:

Olay kataloğundaki on olay türünün tümü webhook uç noktaları üzerinden teslim edilir. Altı çağrı yaşam döngüsü olayı (telephony.incoming, telephony.complete, telephony.tool, web.incoming, web.complete, web.tool) eski tek URL'li webhook'a ayrıca gönderilir — hem eski bir URL'niz hem de eşleşen bir uç noktanız varsa olayı her iki yolda da alırsınız. Engelleyici davranış (telephony.incoming / web.incoming yapılandırma alışverişi ve webhook modundaki araç yönlendirme) yalnızca eski yolda bulunur; her uç nokta teslimi, yanıt beklemeden gönderilen bir bildirimdir.

Yük biçimi#

Uç nokta teslimleri, data, event_id ve type içeren bir JSON nesnesidir:

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

event_id, yayımlanan her olay için benzersizdir. Yeniden denemeler arasında ve olayı alan her uç nokta arasında aynıdır — tekilleştirme için bunu kullanın.

Eski tek URL'li webhook aynı type ve data değerlerini, ancak event_id olmadan gönderir:

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

Aktarım sırasında her gövde standart biçimde serileştirilir — anahtarlar alfabetik olarak sıralanır, boşluk içermez ve UTF-8 kullanır. Bu belgelerdeki girintili örnekler yalnızca okunabilirlik içindir.

Olay türlerinin ve yük alanlarının tam listesi için Olay kataloğu sayfasına bakın.

İmza doğrulama#

Her istek, X-ThunderPhone-Signature başlığında ham istek gövdesi üzerinde oluşturulmuş bir HMAC-SHA256 imzası taşır. İmzalama anahtarı, uç noktanın secret değeridir (veya eski teslimatlar için kuruluş düzeyindeki webhook secret değerinizdir).

Adımlar#

1. Herhangi bir ayrıştırma işleminden önce ham istek gövdesini okuyun.
2. hmac_sha256(secret, body).hexdigest() değerini hesaplayın.
3. Sonucu X-ThunderPhone-Signature başlığıyla sabit zamanda karşılaştırın.

Gönderdiğimiz baytları tam olarak imzalarız ve bu baytlar kanonik JSON serileştirmesidir (sıralanmış anahtarlar, sıkıştırılmış ayırıcılar). Bu nedenle ham gövdeye karşı doğrulama her zaman çalışır — çerçeveniz yalnızca ayrıştırılmış JSON veriyorsa, bunu sıralanmış anahtarlar ve sıkıştırılmış ayırıcılarla yeniden serileştirmek aynı baytları üretir. Her iki yöntem de doğrulama kılavuzunda açıklanmıştır.

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

Teslimat anlamları#

Bu anlamlar uç nokta teslimatları için geçerlidir. Eski tek URL'li webhook, yeniden denemesi olmayan tek bir eşzamanlı denemedir.

Eski ve uç nokta tabanlı webhook'lar arasında seçim yapma#

Yeni entegrasyonlar olayları uç nokta tabanlı webhook'lar üzerinden tüketmelidir. Yalnızca çağrıları yanıtlanma anında dinamik olarak yapılandırıyorsanız veya webhook modunda araç yönlendirme kullanıyorsanız eski bir URL'yi koruyun (veya ekleyin) — bu istek/yanıt alışverişleri yalnızca eski yolda çalışır.

İlgili#