Skip to main content

Что это такое

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

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

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

Запрос

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

Ответ

Возвращайте ответ 2xx после того, как ваше приложение надежно приняло событие.
Триггеры событий, поля полезной нагрузки и примеры приведены в разделе Примеры Webhook.

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

Используйте messengerInboundMessage.id для корреляции повторяющихся сообщений клиента; сохраняйте пробельные символы в тексте.
То же сохраненное сообщение теперь содержит актуальный текст и накопленные факты редактирования.
Используйте идентификатор сообщения для корреляции снимков; неизвестные промежуточные отметки времени получения опущены.
Целевое сообщение Meta не обязательно должно иметь локальную запись сообщения в YCloud.
При отзывах реакции ее название и эмодзи могут отсутствовать.
Сохраняйте текст из whatsappMessage.text.body. id и wamid связывают последующие события статуса.
Содержимое сообщения зависит от типа. Обрабатывайте идентификаторы медиафайлов как ссылки провайдера, а не как общедоступные URL для скачивания.
Связывайте с событием создания по id или wamid. В событиях обновления опущены содержимое и тип сообщения.
Связывайте с событием создания по id или wamid. В событиях обновления опущены содержимое и тип сообщения.
Исходный статус с более низким приоритетом может поступить уже после прочтения. Зафиксируйте событие, не понижая текущий статус сообщения.
Это отдельное сообщение со сбоем, а не переход из статуса прочтения. Обновления со сбоем включают сведения об ошибке источника, если они доступны.
APP_CONTROL_TAKEN сообщает о передаче управления, а не о назначении сотрудника во Входящих или доставке кастомного сообщения о передаче. В этом примере actor указывает на идентификатор приложения предыдущего владельца.
Считайте whatsappBusinessAccount.id для идентификации аккаунта. При наличии поля removedReason, removedInitiatedBy и removedTime описывают причину удаления. Сохраняйте неизвестные значения причины и инициатора.
Считайте qualityRating и qualityUpdateEvent из whatsappPhoneNumber. Поле messagingLimit описывает лимит телефонного номера, а whatsappBusinessManagerMessagingLimit — лимит соответствующего бизнес-портфолио.
Пример полезной нагрузки при изменении атрибутов контакта
Пример полезной нагрузки при создании нового контакта
Пример полезной нагрузки при удалении контакта
Отправляется только при отдельном удалении заметки, а не при каскадном удалении вместе с контактом.
Пример полезной нагрузки при отмене подписки клиентом
Пример полезной нагрузки при возобновлении подписки клиентом
Пример полезной нагрузки при активации бизнес-имени пользователя для телефонного номера WhatsApp
Пример полезной нагрузки при наличии запроса на резервирование Business Username для номера телефона WhatsApp
Meta обнаружила маркетинговый контент в сообщении Utility Direct Send. Подпишитесь на это событие через webhook endpoint API.
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.