Skip to main content

Что это такое

Подпишитесь на whatsapp.echo_message.created. Вы получаете это событие, когда YCloud регистрирует исходящее эхо для Meta Business Agent, подключенного через Public REST API. Считывайте содержимое стандартного формата сообщения из whatsappMessage; не используйте это событие для входящих сообщений клиентов. Текущий контракт сохраняет имя события без изменений, предоставляя эхо в виде стандартного сообщения WhatsApp. Поля агента, передачи диалога (handover) и маршрутизации Inbox не входят в эту полезную нагрузку.

Перед началом работы

  1. Подключите Agent через Public REST API.
  2. Подпишите активную конечную точку Webhook в том же аккаунте на whatsapp.echo_message.created.
  3. Проверяйте YCloud-Signature по исходному телу запроса, надежно принимайте каждое событие и обрабатывайте его идемпотентно.
Агенты, созданные в Console, не отправляют этот Webhook для клиентов. Синхронизация их Inbox выполняется отдельным потоком.
Информацию о настройке конечной точки см. в разделе Настройка Webhook.

Принцип работы

Во всех примерах используются подстановочные идентификаторы. Маршрутизируйте по внешнему type и считывайте whatsappMessage, а не whatsappMetaBusinessAgent, whatsappEchoMessage или data. Дедуплицируйте повторные доставки с помощью внешнего id. Внешнее поле createTime — это время события Webhook; вложенные поля времени сообщения содержат исходное время в формате RFC 3339.
  • Используйте id или wamid для сопоставления последующих событий статуса.
  • Считывайте текст из text.body. Для медиафайлов проверяйте type и соответствующий объект содержимого. Идентификаторы медиафайлов не являются общедоступными URL для скачивания.
  • Номер телефона клиента и BSUID независимы. Когда исходный обратный вызов содержит оба значения, событие включает to вместе с recipientUserId или parentRecipientUserId. Отсутствующие идентификаторы опускаются и не выводятся друг из друга.
  • from — это отображаемый номер телефона компании, если исходный обратный вызов содержит действительный номер телефона. Он не формируется на основе phoneNumberId.
  • Контекст ответа нормализуется в соответствии со стандартным контрактом сообщений. Например, исходный context.id передается как context.message_id.
  • Поля агента, передачи диалога (handover), маршрутизации, тарификации и переписки не включаются.
  • status — это сохраненный статус на момент обработки эха; не гарантируется, что он будет равен sent.
  • Для входящих сообщений клиентов используется whatsapp.inbound_message.received. Для эхо-сообщений Business App используется whatsapp.smb.message.echoes.

Запрос

YCloud отправляет эти тела JSON в HTTP-запросах POST на настроенный вами URL Webhook.

Ответ

Возвращайте ответ 2xx после надежного принятия каждого события. Длительные операции обрабатывайте асинхронно.

Исходящее текстовое эхо

Запрос

Сохраняйте текст из whatsappMessage.text.body. id и wamid связывают последующие события статуса.

Ответ

Пояснение

Считывайте текст эха из whatsappMessage.text.body. Используйте id или wamid для сопоставления последующих событий статуса.

Исходящее эхо изображения

Запрос

Содержимое сообщения зависит от типа. Относитесь к идентификаторам медиафайлов как к ссылкам провайдера, а не к общедоступным URL для скачивания.

Ответ

Пояснение

Используйте type, чтобы выбрать соответствующий объект содержимого. Рассматривайте медиа-значение id как ссылку поставщика.

Похожие примеры