Полный каталог, сформированный на основе схемы, см. в разделе Все примеры.
Что это такое
Обработка обновлений темы и описания группы WhatsApp.Перед началом работы
- Создайте публичный HTTPS-эндпоинт в вашем приложении.
- Настройте эндпоинт вебхука YCloud для необходимых типов событий.
- Обеспечьте безопасное хранение секрета подписи эндпоинта.
- Сделайте обработку событий идемпотентной.
Как это работает
YCloud отправляет HTTP-запросPOST при возникновении события. Проверьте подпись, надежно сохраните событие, верните ответ 2xx и выполняйте длительные операции асинхронно.
Запрос
Ниже приведены сценарии запросов, отправляемых на ваш Webhook URL. Используйте идентификатор событияid как идентификатор доставки, а type — для маршрутизации полезной нагрузки.
Ответ
Возвращайте статус2xx после успешного принятия события.
Информацию о настройке эндпоинта, проверке подписи и механизме повторных попыток см. в разделе Настройка вебхуков.
Настройки обновлены
При успешном обновлении настроек группы WhatsApp вы получите вебхук со следующей структурой полезной нагрузки:Запрос
Ответ
Подтверждайте доставку после надежного сохранения события.Пояснение
Маршрутизируйте событие поtype, устраняйте дубликаты с помощью id и передавайте медленные или потенциально сбойные задачи в асинхронный обработчик.
Не удалось обновить настройки
Если обновление настроек группы WhatsApp завершилось ошибкой или частичной ошибкой, вы получите вебхук со следующей структурой полезной нагрузки:Запрос
Ответ
Подтверждайте доставку после надежного сохранения события.Пояснение
- type: Всегда
whatsapp.group.settings_updateдля событий настроек группы - whatsappGroup: Содержит сведения о результате обновления настроек группы
- field: Всегда
group_settings_update - type: Всегда
group_settings_update - requestId: Идентификатор запроса, возвращенный асинхронной операцией API настроек группы
- status: Нормализованный статус обновления настроек, либо
updated, либоfailed - groupId: Идентификатор группы WhatsApp
- subject и description: Текстовые настройки группы, если они указаны
- settings: Результаты обновления по каждой настройке.
nameможет принимать значенияprofile_picture,group_subjectилиgroup_description - settings[].updateSuccessful: Указывает, успешно ли прошло обновление отдельной настройки
- settings[].errors: Ошибки, возвращенные WhatsApp для отдельной настройки
- field: Всегда

