Примеры Webhook для соединения вызовов WhatsApp Calling Connect

Полный каталог, сформированный на основе схемы, см. в разделе все примеры.

Что это такое

Обработка событий подключения вызовов WhatsApp.

Перед началом работы

Создайте общедоступную конечную точку HTTPS в вашем приложении.
Настройте конечную точку Webhook в YCloud для необходимых вам типов событий.
Надежно сохраните секретный ключ подписи конечной точки.
Обеспечьте идемпотентность обработки событий.

Как это работает

YCloud отправляет запрос HTTP POST при возникновении события. Проверьте подпись, надежно сохраните событие, верните ответ 2xx и выполняйте длительные операции асинхронно.

Запрос

В сценариях ниже показаны запросы, отправляемые на ваш URL Webhook. Рассматривайте id события как идентификатор доставки и используйте type для маршрутизации полезной нагрузки.

Ответ

Возвращайте статус 2xx после принятия события.

HTTP/1.1 200 OK

Информацию о настройке конечной точки, проверке подписи и поведении при повторных попытках см. в разделе Настройка Webhook.

Calling Connect, инициированный пользователем

Когда пользователь WhatsApp звонит вашей компании, инициируется Webhook Call Connect с предложением SDP Offer:

Запрос

{
  "id": "evt_6757b723a5a42d369ef48480",
  "type": "whatsapp.call.connect",
  "apiVersion": "v2",
  "createTime": "2024-12-10T03:36:03.749Z",
  "callingConnect": {
    "id": "6757b723960b25543b9ecc66",
    "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxrtLopSdPMwd",
    "phoneId": "461269257068832",
    "from": "+6281361905133",
    "fromUserId": "ID.13491208655302741918",
    "fromParentUserId": "ID.11815799212886844830",
    "to": "+6283138205150",
    "direction": "USER_INITIATED",
    "sdpType": "offer",
    "sdp": "<<RFC 4566 SDP>>"
  }
}

Ответ

Подтвердите доставку после успешного и надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Маршрутизируйте событие по type, выполняйте дедупликацию по id и передавайте медленные или подверженные сбоям задачи асинхронному обработчику.

Calling Connect, инициированный компанией

Когда компания инициирует новый вызов пользователю WhatsApp, отправляется Webhook Call Connect с ответом SDP Answer:

Запрос

{
  "id": "evt_676e5a0d7a9cb742d02d7645",
  "type": "whatsapp.call.connect",
  "apiVersion": "v2",
  "createTime": "2024-12-27T07:41:01.554Z",
  "callingConnect": {
    "id": "676e5a0d94c533526d3c5ad5",
    "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABE",
    "phoneId": "461269257068832",
    "from": "+6283138205150",
    "to": "+6281361905133",
    "toUserId": "ID.13491208655302741918",
    "toParentUserId": "ID.11815799212886844830",
    "direction": "BUSINESS_INITIATED",
    "sdpType": "answer",
    "sdp": "<<RFC 4566 SDP>>",
    "dialTime": 1735283452000
  }
}

Ответ

Подтвердите доставку после успешного и надежного сохранения события.

HTTP/1.1 200 OK

Начало работы

Руководства

Конечные точки

Webhooks

Примеры Webhook для соединения вызовов WhatsApp Calling Connect

Что это такое

Перед началом работы

Как это работает

Запрос

Ответ

Calling Connect, инициированный пользователем

Запрос

Ответ

Пояснение

Calling Connect, инициированный компанией

Запрос

Ответ

Пояснение

​Что это такое

​Перед началом работы

​Как это работает

​Запрос

​Ответ

​Calling Connect, инициированный пользователем

​Запрос

​Ответ

​Пояснение

​Calling Connect, инициированный компанией

​Запрос

​Ответ

​Пояснение

Что это такое

Перед началом работы

Как это работает

Запрос

Ответ

Calling Connect, инициированный пользователем

Запрос

Ответ

Пояснение

Calling Connect, инициированный компанией

Запрос

Ответ

Пояснение