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

Что это такое

Обработка результатов создания и удаления групп WhatsApp.

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

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

Принцип работы

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

Запрос

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

Ответ

После принятия события верните статус 2xx.
Сведения о настройке конечной точки, проверке подписи и механизме повторных попыток см. в разделе Настройка Webhook.

Группа создана

При успешном создании группы WhatsApp вы получите Webhook со следующей структурой полезной нагрузки:

Запрос

Ответ

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

Пояснение

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

Группа удалена

При удалении группы WhatsApp вы получите Webhook со следующей структурой полезной нагрузки:

Запрос

Ответ

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

Пояснение

  • type: всегда whatsapp.group.lifecycle_update для событий жизненного цикла групп
  • whatsappGroup: содержит сведения о результатах жизненного цикла группы
    • field: всегда group_lifecycle_update
    • type: действие жизненного цикла, например group_create или group_delete
    • requestId: идентификатор запроса, возвращенный асинхронной операцией API для групп
    • status: нормализованный статус результата, например created, deleted или failed
    • groupId: идентификатор группы WhatsApp
    • inviteLink: ссылка-приглашение в группу, передается при успешном создании группы
    • dedupeKey: ключ идемпотентности для дедупликации событий Webhook жизненного цикла групп