Webhooks

Обзор вебхуков

Как ThunderPhone доставляет события в реальном времени, как проверять подписи и чем отличаются устаревшая и основанная на эндпоинтах модели доставки.

ThunderPhone отправляет HTTP-запросы POST на ваш сервер, когда во время звонка происходят события — начинается входящий звонок, завершается звонок, завершается запуск оценки, срабатывает оповещение и так далее. Есть две модели доставки:

Все десять типов событий из каталога событий доставляются через конечные точки вебхуков. Шесть событий жизненного цикла звонка (telephony.incoming, telephony.complete, telephony.tool, web.incoming, web.complete, web.tool) также отправляются в устаревший вебхук с одним URL — если у вас есть и устаревший URL, и подходящая конечная точка, вы получите событие по обоим путям. Блокирующее поведение ( обмен конфигурацией telephony.incoming / web.incoming и отправка вызовов инструментов в режиме вебхука) доступно только по устаревшему пути; каждая доставка в конечную точку — это уведомление без ожидания ответа.

Формат полезной нагрузки#

Доставка в конечную точку представляет собой объект 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 уникален для каждого отправленного события. Он остаётся одинаковым при повторных попытках и для каждой конечной точки, получающей событие — используйте его для дедупликации.

Устаревший вебхук с одним URL отправляет те же type и data, но без event_id:

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

При передаче каждый объект сериализуется канонически — ключи сортируются по алфавиту, без пробелов, в UTF-8. Примеры с форматированием в этой документации приведены только для удобства чтения.

Полный список типов событий и полей полезной нагрузки см. в каталоге событий.

Проверка подписи#

Каждый запрос содержит подпись HMAC-SHA256 для исходного тела запроса в заголовке X-ThunderPhone-Signature. Ключом подписи служит 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, только если динамически настраиваете звонки в момент приёма или используете вызов инструментов в режиме вебхуков — эти обмены запросами и ответами выполняются только через устаревший путь.

Связанные материалы#