Полный каталог, сформированный на основе схемы, см. в разделе все примеры.
Что это такое
Ознакомьтесь с пошаговыми руководствами по конкретным событиям webhook, предварительными требованиями и примерами полезной нагрузки.Перед началом работы
- Создайте публичную конечную точку HTTPS в своем приложении.
- Настройте конечную точку Webhook YCloud для необходимых типов событий.
- Надежно сохраните секретный ключ подписи конечной точки.
- Обеспечьте идемпотентность обработки событий.
Как это работает
YCloud отправляет HTTP-запросPOST при возникновении события. Проверьте подпись, надежно сохраните событие, верните ответ 2xx и выполняйте длительные операции асинхронно.
Запрос
В приведенных ниже сценариях показаны запросы, отправляемые на ваш URL Webhook. Используйте событиеid в качестве идентификатора доставки, а type — для маршрутизации полезной нагрузки.
Ответ
Возвращайте статус2xx после успешного принятия события.
Информацию о настройке конечной точки, проверке подписи и логике повторных попыток см. в разделе Настройка webhook.
События сообщений и шаблонов
Проверка шаблона
Обработка статусов шаблона: одобрен, отклонен, приостановлен, отключен и архивирован.
Статус сообщения
Обработка отправленных, доставленных, прочитанных и недоставленных исходящих сообщений.
Входящие сообщения
Разбор текстовых, мультимедийных, геолокационных, контактных, интерактивных, коммерческих и системных сообщений.
Обновления платежей
Обработка изменений платежных транзакций WhatsApp.
События Echo и передачи оператору
Для операторов (Agents), подключенных через публичный REST API, используйте эти пошаговые руководства по конкретным событиям. Для операторов, созданных через консоль, используется отдельный процесс синхронизации папки «Входящие».Создано эхо-сообщение (Echo message created)
Сохранение эхо-копий исходящих текстовых и мультимедийных сообщений.
Обновлено эхо-сообщение (Echo message updated)
Обработка обновлений статусов: доставлено, прочитано, отправлено с задержкой и произошел сбой.
Обновлена передача оператору (Agent handover updated)
Отслеживайте передачу управления и учитывайте ограничения ее корреляции.
События аккаунта, приложения и Flow
Обновления бизнес-аккаунта
Обработка соответствия требованиям, локации, нарушений, ограничений и изменений состояния аккаунта.
История Business App
Синхронизация истории входящих и исходящих сообщений.
Эхо-сообщения Business App
Синхронизация сообщений, отправленных из WhatsApp Business App.
Статус Flow
Обработка изменений статуса жизненного цикла Flow.
События звонков и групп
Подключение звонка
Обработка предложений (offer) и ответов (answer) SDP для звонков в WhatsApp.
Статус звонка
Обработка состояний звонка: вызов, принят и отклонен.
Завершение звонка
Обработка успешного и неудавшегося завершения звонка.
Жизненный цикл группы
Обработка создания и удаления групп.
Участники группы
Обработка изменений списка участников и запросов на вступление.
Настройки группы
Обработка изменений темы и описания группы.
Статус группы
Обработка блокировки и восстановления группы.
События контактов
Контакт создан
Обработка вновь созданных контактов.
Контакт удален
Удаление или сверка удаленных контактов.
Атрибуты контакта изменены
Обработка изменений профиля, пользовательских атрибутов и тегов.
Контакт отписался
Обработка новых записей об отказе от рассылки (opt-out).
Контакт повторно подписался
Обработка удаленных записей об отказе от рассылки (opt-out).
Открыть полный каталог полезных нагрузок
Ознакомьтесь со всеми типами событий и именованными примерами полезной нагрузки из спецификации OpenAPI.