Skip to main content

Что это такое

Этот каталог охватывает все 43 типа событий webhook из спецификации OpenAPI и содержит каждый именованный пример полезной нагрузки.

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

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

Запрос

Каждый пример представляет собой тело JSON HTTP-запроса POST, отправленного YCloud. Запрос также содержит заголовок YCloud-Signature, который необходимо проверить перед обработкой полезной нагрузки.

Ответ

Возвращайте ответ 2xx после того, как ваше приложение надежно приняло событие.
Информацию о предварительных требованиях, логике срабатывания, жизненном цикле и разобранных сценариях можно найти в пошаговых руководствах по примерам webhook.

Каталог полезной нагрузки

Сохраняйте текст из whatsappMessage.text.body. id и wamid связывают последующие события статуса.
Содержимое сообщения зависит от типа. Рассматривайте идентификаторы медиа как ссылки провайдера, а не как публичные URL-адреса для скачивания.
Сопоставляйте с событием создания по id или wamid. События обновления не содержат содержимое и тип сообщения.
Сопоставляйте с событием создания по id или wamid. События обновления не содержат содержимое и тип сообщения.
Исходный статус более низкого приоритета может поступить после прочтения. Зафиксируйте событие без понижения текущего статуса сообщения.
Это отдельное сообщение с ошибкой, а не переход из статуса прочитанного. При наличии обновления со сбоем содержат подробности ошибки от источника.
APP_CONTROL_TAKEN сообщает о передаче управления, а не о назначении сотрудника Inbox или доставке кастомного сообщения о передаче. В этом примере actor — это ID приложения предыдущего владельца.
Пример полезной нагрузки при изменении атрибутов контакта
Пример полезной нагрузки при создании нового контакта
Пример полезной нагрузки при удалении контакта
Отправляется только при самостоятельном удалении заметки, но не при каскадном удалении контакта.
Пример полезной нагрузки при отмене подписки клиентом
Пример полезной нагрузки при возобновлении подписки клиентом
Пример полезной нагрузки при активации Business Username для номера телефона WhatsApp
Пример полезной нагрузки при наличии запроса на резервирование Business Username для номера телефона WhatsApp
Meta обнаружила маркетинговый контент в сообщении Utility Direct Send. Подпишитесь на это событие через API эндпоинта webhook.
Meta ограничила Utility Direct Send на 7 дней после повторного неправомерного использования категории.
Пример полезной нагрузки при архивации шаблона WhatsApp
Пример полезной нагрузки при разархивации шаблона WhatsApp. Статус шаблона — это текущий статус, возвращенный Meta, и он не означает повторную проверку на одобрение.
Пример полезной нагрузки при установлении соединения вызова WhatsApp
Пример полезной нагрузки при завершении вызова WhatsApp
Пример полезной нагрузки при обновлении статуса вызова WhatsApp
Пример полезной нагрузки, когда становится доступна запись вызова, полученная через API
Пример полезной нагрузки при окончательном сбое транскрипции вызова, полученной через API
Пример полезной нагрузки при создании группы WhatsApp
Пример полезной нагрузки при добавлении участников в группу WhatsApp
Пример полезной нагрузки при обновлении настроек группы WhatsApp
Пример полезной нагрузки при изменении статуса блокировки группы WhatsApp