Общ преглед на уебкуките

Как ThunderPhone доставя събития в реално време, как да проверявате подписи и как се сравняват наследеният и базираният на крайни точки модели за доставка.

ThunderPhone изпраща HTTP POST заявки до вашия сървър, когато по време на разговор се случат определени неща — започва входящ разговор, разговорът приключва, изпълнение на оценяване завършва, задейства се предупреждение и т.н. Има два модела за доставка:

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

Формат на полезния товар#

Доставките до крайни точки са 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 е уникален за всяко генерирано събитие. Той е идентичен при повторни опити и за всяка крайна точка, която получава събитието — използвайте го за дедупликация.

Остарелият webhook с един URL адрес изпраща същите type и data, но без event_id:

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

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

Вижте Каталога на събитията за пълния списък с типове събития и полета на полезния товар.

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

Всяка заявка съдържа два подписа, и двата HMAC-SHA256 с ключ secret на крайната точка (или secret на webhook на ниво организация за наследени доставки):

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

Семантика на доставянето#

Тази семантика се прилага за доставки към крайни точки. Наследеният webhook с един URL е един синхронен опит без повторни опити, с изключение на обмена на конфигурация за телефонни обаждания telephony.incoming, който се повтаря веднъж.

Избор между наследени уебкуки и уебкуки, базирани на крайни точки#

Новите интеграции трябва да получават събития чрез уебкуки, базирани на крайни точки. Запазете (или добавете) наследен URL само ако конфигурирате повиквания динамично при приемането им или използвате извикване на инструменти в режим на уебкуки — тези обмени заявка/отговор се изпълняват само по наследения път.

Свързани#