Перейти к основному содержанию

Что это такое

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

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

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

Запрос

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

Ответ

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

Каталог полезных нагрузок

Используйте messengerInboundMessage.id для корреляции повторных сообщений клиента; сохраняйте пробельные символы в тексте.
То же сохраненное сообщение теперь содержит актуальный текст и совокупные сведения о редактировании.
Используйте идентификатор сообщения для корреляции снимков; неизвестное промежуточное время получения опускается.
Целевое сообщение Meta не обязательно должно иметь локальную запись сообщения в YCloud.
При отзыве название реакции и эмодзи могут отсутствовать.
Сохраняйте текст из whatsappMessage.text.body. id и wamid связывают последующие события статуса.
Содержимое сообщения зависит от типа. Считайте медиа-ID идентификаторами провайдера, а не публичными URL для скачивания.
Коррелируйте с событием создания по id или wamid. В событиях обновления отсутствуют содержимое и тип сообщения.
Коррелируйте с событием создания по id или wamid. В событиях обновления отсутствуют содержимое и тип сообщения.
Исходный статус с более низким приоритетом может поступить после прочтения. Зафиксируйте событие без понижения текущего статуса сообщения.
Это отдельное неудавшееся сообщение, а не переход из статуса прочтения. Обновления с ошибкой содержат сведения об исходной ошибке при их наличии.
APP_CONTROL_TAKEN сообщает о передаче управления, а не о назначении сотрудника Inbox или доставке кастомного сообщения о передаче. actor в данном примере — это ID предыдущего приложения-владельца.
Считайте whatsappBusinessAccount.id для идентификации аккаунта. При наличии поля removedReason, removedInitiatedBy и removedTime описывают удаление. Сохраняйте неизвестные значения причины и инициатора.
Считайте qualityRating и qualityUpdateEvent из whatsappPhoneNumber. messagingLimit указывает лимит уровня номера телефона; whatsappBusinessManagerMessagingLimit указывает лимит владеющего бизнес-портфолио.
Пример полезной нагрузки при изменении атрибутов контакта
Пример полезной нагрузки при создании нового контакта
Пример полезной нагрузки при удалении контакта
Отправляется только при самостоятельном удалении заметки, а не при каскадном удалении контакта.
Пример полезной нагрузки при отмене подписки клиентом
Пример полезной нагрузки при возобновлении подписки клиентом
Пример полезной нагрузки при активации 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
Считывайте исходящее сообщение из whatsappMessage. Тип сообщения определяет его объект контента; этот пример содержит текст.
Это событие синхронизирует сообщение, отправленное из приложения WhatsApp Business или поддерживаемого сопряженного устройства. Считывайте его контент из whatsappMessage.
Входящее сообщение из истории использует whatsappInboundMessage. phase и progress сообщают о ходе синхронизации фрагмента истории.
Исходящее сообщение из истории использует whatsappMessage. Не маршрутизируйте его как входящее сообщение.
Фрагмент истории, содержащий только метаданные, сообщает о phase и progress без каких-либо объектов сообщений. Не обрабатывайте такую структуру как полезную нагрузку message-created или message-echoes.