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

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

Обработка обновлений статуса блокировки групп WhatsApp.

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

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

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

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

​
Запрос

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

​
Ответ

Возвращайте статус 2xx после успешного приема события.
Инструкции по настройке конечной точки, проверке подписи и логике повторных попыток см. в разделе Настройка Webhook.

​
Группа заблокирована

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

​
Запрос

​
Ответ

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

​
Пояснение

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

​
Блокировка группы снята

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

​
Запрос

​
Ответ

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

​
Пояснение

  • type: всегда whatsapp.group.status_update для событий статуса блокировки группы
  • whatsappGroup: содержит сведения о статусе блокировки группы
    • field: всегда group_status_update
    • type: тип события статуса, либо group_suspend, либо group_suspend_cleared
    • status: нормализованный статус группы, либо suspended, либо suspend_cleared
    • groupId: идентификатор группы WhatsApp
    • webhookTime: время, когда WhatsApp инициировал этот Webhook