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

Как 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 с ключом secret конечной точки (или secret вебхука на уровне организации для устаревших доставок):

• X-ThunderPhone-Signature-V2: t=<unix seconds>,v1=<hex> подписывает метку времени, метод, путь и параметры запроса, а также необработанное тело. Проверяйте эту подпись и отклоняйте запросы, у которых t отличается от времени на ваших часах более чем на 5 минут, чтобы перехваченный запрос нельзя было повторно отправить позже. Повторные попытки подписываются заново при отправке.
• X-ThunderPhone-Signature подписывает только необработанное тело. Она по-прежнему отправляется без изменений, чтобы существующие средства проверки продолжали работать.

Шаги#

1. Прочитайте заголовок, метод, необработанные путь и строку запроса, а также необработанное тело до любого разбора.
2. Вычислите HMAC-SHA256 в шестнадцатеричном формате для <t>\n<METHOD>\n<path and query>\n<body> с помощью вашего секрета.
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, который повторяется один раз.

Выбор между устаревшими вебхуками и вебхуками на основе конечных точек#

Новые интеграции должны получать события через вебхуки на основе конечных точек. Сохраняйте (или добавляйте) устаревший URL, только если вы динамически настраиваете звонки в момент принятия или используете вызов инструментов в режиме вебхука — эти обмены «запрос/ответ» выполняются только по устаревшему пути.

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