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

Что это такое

Отправляйте шаблонные, медиа-, интерактивные, торговые сообщения, сообщения Flow и вызовы с примерами запросов с пояснениями.

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

  • Сохраните ключ API YCloud в секрете на стороне сервера.
  • Подключите WhatsApp Business Account и номер телефона, используемые в запросе.
  • Создайте и подтвердите любой шаблон, на который ссылается запрос на отправку сообщений.
  • Замените каждый плейсхолдер значением из своего аккаунта.

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

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

Запрос

Каждый сценарий содержит полный запрос сообщения. В примерах используется прямая отправка для быстрого получения отклика, но те же объекты сообщений можно ставить в очередь.

Ответ

Успешный ответ на отправку подтверждает, что YCloud принял запрос сообщения; используйте получение сообщений или Webhook whatsapp.message.updated, чтобы узнать окончательный статус доставки.
Ознакомьтесь с руководством по обмену сообщениями в WhatsApp для получения сведений о жизненном цикле и со справочником API для полной схемы.

Выберите пример

Шаблонные сообщения

Отправляйте одобренные шаблоны для аутентификации, маркетинга, служебных уведомлений и сценариев электронной коммерции.

Сообщения произвольного формата

Отправляйте текстовые, медиа-, геопозиционные сообщения, контакты и реакции в рамках открытого окна обслуживания клиентов.

Интерактивные сообщения

Добавляйте списки, кнопки, Flows, товары, звонки и карусели.

Торговые сообщения

Отправляйте товары, детали заказа, статус заказа и интерфейс оформления покупки.
Приведенные ниже примеры применимы как к API Send a WhatsApp message directly, так и к API Enqueue a WhatsApp message. Начало работы с шаблонными сообщениями — простой способ инициировать диалог. Как только клиент ответит на шаблонное сообщение компании, компания сможет отправлять клиенту сообщения любого типа в течение 24 часов.

Примеры шаблонных сообщений

Ниже приведены примеры шаблонных сообщений WhatsApp. Каждый шаблон необходимо создать и одобрить, прежде чем его можно будет использовать для отправки сообщений.

Шаблонное сообщение аутентификации с кнопками одноразового пароля

В этом случае у вас есть шаблон аутентификации с кнопкой копирования кода, шаблон аутентификации с кнопкой в одно касание или шаблон аутентификации без касания (zero-tap), и вы отправляете шаблонное сообщение, которое:
  • Содержит одноразовый пароль или код подтверждения для доставки клиенту.
  • Содержит кнопку копирования кода , кнопку автозаполнения в одно касание или вовсе не содержит кнопок при использовании zero-tap.
example-messaging-otp.webp

ZERO-TAP

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку запроса, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Объяснение

  • Текст тела сообщения будет содержать проверочный код из компонента body. С другой стороны, код, который фактически используется при нажатии пользователем кнопки автозаполнения в одно касание или кнопки копирования кода, находится в компоненте button. В большинстве случаев они должны совпадать.

Шаблонное сообщение с переменными

В этом случае у вас есть сервисный шаблон с переменными в теле, и вы отправляете шаблонное сообщение, которое:
  • Содержит текст с 3 переменными в теле.
example-template-body.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку запроса, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Объяснение

  • Убедитесь, что соответствующий шаблон был одобрен.
  • Установите правильный type для отправляемых сообщений. В данном случае type установлен на template, а components и parameters запроса на отправку сообщений должны соответствовать шаблону.

Шаблонное сообщение с изображением и кнопками Quick Reply

В этом случае у вас есть маркетинговый шаблон с изображением и кнопками Quick Reply, и вы отправляете шаблонное сообщение, которое:
  • Содержит изображение в заголовке.
  • Содержит текст с 1 переменной в теле.
  • Содержит текст в нижнем колонтитуле.
  • Содержит 2 кнопки Quick Reply. Максимальное количество кнопок Quick Reply — 3.
example-template-quickreply.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку запроса, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Объяснение

  • Параметр caption (используется для описания указанного медиафайла image, video или document) не поддерживается в сообщениях template или interactive.
  • Дополнительные сведения об ограничениях для медиафайлов в заголовке см. в разделе Поддерживаемые типы медиа.
  • Используйте payload для отслеживания кликов пользователей по кнопкам. Полезная нагрузка (payload) кнопки не видна, но будет передана при нажатии пользователем на кнопку; см. также Входящее сообщение по нажатию кнопки шаблона.

Шаблонное сообщение с видео и кнопками с призывом к действию (Call To Action)

В этом случае у вас есть маркетинговый шаблон с видео и кнопками с призывом к действию, и вы отправляете шаблонное сообщение:
  • Содержит видео в заголовке.
  • Содержит текст с 1 переменной в основном тексте.
  • Содержит текст в нижнем колонтитуле (footer).
  • Содержит 2 кнопки с призывом к действию: 1 кнопку PHONE_NUMBER и 1 кнопку URL. Кнопка URL может содержать не более 1 переменной в конце URL.
example-template-calltoaction.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id для последующего сопоставления с событиями whatsapp.message.updated.

Пояснение

  • Параметр caption (используется для описания указанного медиафайла image, video или document) не поддерживается в сообщениях template или interactive.

Шаблонное сообщение с купоном

В этом случае у вас есть шаблон купона, и вы отправляете шаблонное сообщение:
  • Содержит текст с 2 переменными в основном тексте.
  • Содержит 1 кнопку «Копировать код».
example-messaging-coupon.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id для последующего сопоставления с событиями whatsapp.message.updated.

Пояснение

  • Длина кода купона ограничена 20 символами.
  • Текст кнопки нельзя изменить.

Шаблонное сообщение с геопозицией

В этом случае у вас есть шаблон с геопозицией, и вы отправляете шаблонное сообщение с геопозицией:

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id для последующего сопоставления с событиями whatsapp.message.updated.

Пояснение

  • latitude и longitude являются обязательными.

Шаблонное сообщение с ограниченным по времени предложением

В этом случае у вас есть шаблон с ограниченным по времени предложением, и вы отправляете шаблонное сообщение с ограниченным по времени предложением (LTO):
  • Содержит изображение в заголовке.
  • Отображает дату окончания действия и обратный отсчет таймера для промокода.
  • Содержит текст с 2 переменными в основном тексте.
  • Содержит 2 кнопки: 1 кнопку COPY_CODE и 1 кнопку URL.
example-messaging-carousel.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id для последующего сопоставления с событиями whatsapp.message.updated.

Пояснение

Сопоставьте поля запроса с выбранным типом сообщения и используйте возвращенный ID сообщения для отслеживания статуса.

Шаблонное сообщение с каруселью

В этом случае у вас есть шаблон карусели, и вы отправляете шаблонное сообщение с каруселью:
  • Содержит текст с 2 переменными в основном тексте.
  • Содержит 2 карточки карусели с возможностью горизонтальной прокрутки.
example-messaging-carousel.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id для последующего сопоставления с событиями whatsapp.message.updated.

Пояснение

  • Пузыри сообщений (message bubbles) содержат только текст и поддерживают переменные. Максимальное количество символов для переменных не ограничено, но они учитываются в общем лимите сообщения в 1024 символа.
  • Основной текст карточки поддерживает переменные. Максимальное количество символов для переменных не ограничено, но они учитываются в общем лимите текста карточки в 160 символов.

Шаблонное сообщение с каталогом

В этом случае у вас есть шаблон каталога, и вы отправляете сообщение, чтобы поделиться каталогом товаров с клиентами. example-messaging-catalog.webp

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id для последующего сопоставления с событиями whatsapp.message.updated.

Пояснение

  • Параметр thumbnail_product_retailer_id является необязательным. Номер SKU обозначается как Content ID в Commerce Manager. Миниатюра этого товара будет использоваться в качестве изображения в заголовке сообщения. Если объект parameters опущен, будет использовано изображение первого товара из вашего каталога.

Шаблонное сообщение MPM

В этом случае у вас есть шаблон MPM, и вы отправляете сообщение, чтобы поделиться товарами с клиентами. В этом примере отправляется утвержденный шаблон с именем «abandoned_cart», а также подставляются переменная (имя клиента) в заголовок шаблона и промокод в тело шаблона. Он также определяет два раздела («Popular Bundles» и «Premium Packages») и указывает товары (всего 3), которые должны быть добавлены в эти разделы. example-messaging-mpm.webp

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • Клиенты должны использовать WhatsApp версии 2.22.24 или выше.
  • Шаблонные сообщения MPM нельзя пересылать другим клиентам.
  • Когда клиент добавляет один или несколько товаров в корзину и оформляет заказ, мы отправляем вам вебхук с описанием заказа. См. также Входящее сообщение с заказом.

Шаблонное сообщение Flow

WhatsApp Flows — это способ создания структурированных сценариев взаимодействия для бизнес-коммуникаций. С помощью Flows компании могут определять, настраивать и персонализировать сообщения с интерактивными элементами, обеспечивающими клиентам более удобную структуру общения. example-flow-intro.webp В этом случае вы отправляете сообщение с использованием шаблона Flow:

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

Шаблонное сообщение с деталями заказа

Шаблонное сообщение с деталями заказа позволяет компаниям отправлять информацию о заказе в виде предварительно настроенных параметров компонента кнопки с призывом к действию Open order details. Оно позволяет бизнесу передавать любую интеграцию платежей (например, UPI Intent, Payment Gateway или Payment Links) в параметрах кнопки. Ниже приведен пример отправки Payment Gateway в параметрах шаблонного сообщения с деталями заказа для предложения клиенту совершить оплату.

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

Шаблонное сообщение со статусом заказа

Шаблон статуса заказа — один из интерактивных шаблонов сообщений, который расширяет возможности кнопки с призывом к действию для поддержки обновления статуса заказа через шаблон. Он позволяет компаниям обновлять статус заказа за пределами 24-часового окна сессии клиента в таких сценариях, как списание средств по ранее оформленному заказу или информирование об отправке ранее созданного заказа. После получения платежных сигналов компания должна обновить статус заказа, чтобы держать пользователя в курсе. В настоящее время поддерживаются следующие значения статуса заказа.

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение




Примеры сообщений в свободной форме

Следующие примеры представляют собой сообщения в свободной форме. Для этих сообщений не требуется предварительно утвержденный шаблон, и их можно отправлять напрямую. Однако их можно отправлять только в пределах 24-часового окна обслуживания клиентов, которое начинается с момента последнего сообщения клиента.

Текстовое сообщение

В этом случае вы отправляете текстовое сообщение, которое:
  • Содержит только обычный текст.
  • Содержит URL и включает окно предпросмотра в текстовых сообщениях за счет установки preview_url в значение true.
  • Указывает сообщение (context.message_id), на которое вы отвечаете.
example-messaging-text.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • До того, как клиент ответит на ваше сообщение, вы можете отправлять только шаблонные сообщения.
  • Используйте context.message_id, чтобы указать сообщение, на которое вы отвечаете. Обратите внимание, что это исходный идентификатор сообщения на платформе WhatsApp, начинающийся с wamid., а не идентификатор сообщения в YCloud. wamid можно найти как в объекте YCloud whatsappMessage (когда статус меняется на sent), так и в объекте whatsappInboundMessage. Эта функция также применима к другим типам сообщений, за исключением сообщений template и sticker.
  • Текст сообщения WhatsApp поддерживает форматирование текста, такое как курсив, полужирный, зачеркнутый, моноширинный, маркированный список, нумерованный список, цитата и встроенный код. См. также Как форматировать сообщения.

Сообщение с изображением

В этом случае вы отправляете сообщение с изображением:
  • Содержит URL-адрес изображения.
  • Содержит подпись с описанием изображения.
example-messaging-image.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

Видеосообщение

В этом случае вы отправляете видеосообщение:
  • Содержит URL-адрес видео.
  • Содержит подпись с описанием видео.
example-messaging-video.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • Поддерживаемые типы видео: video/mp4, video/3gpp.
    • Поддерживаются только видеокодек H.264 и аудиокодек AAC.
    • Мы поддерживаем видео с одной аудиодорожкой или без звука.
    • Формат файлов MP4 основан на базовом медиаформате ISO, который напрямую произошел от формата файлов QuickTime, разработанного компанией Apple. Однако видеофайлы QuickTime не поддерживаются, даже если вы изменили расширение файла с.mov на .mp4.
  • Ограничение размера видео: 16 МБ.
  • См. также Поддерживаемые типы медиафайлов.

Аудиосообщение

В этом случае вы отправляете аудиосообщение:
  • Содержит URL-адрес аудио.
example-messaging-audio.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • Поддерживаемые типы аудио: audio/aac, audio/mp4, audio/mpeg, audio/amr, audio/ogg (только кодеки opus, базовый audio/ogg не поддерживается).
  • Ограничение размера аудио: 16 МБ.
  • См. также Поддерживаемые типы медиафайлов.
  • caption можно использовать для медиасообщений типа image, video и document, но параметр не поддерживается для аудиосообщений.

Сообщение с документом

В этом случае вы отправляете сообщение с документом:
  • Содержит URL-адрес документа.
  • Содержит подпись с описанием документа.
  • Задает имя файла документа.
example-messaging-document.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • Поддерживаемые типы документов: text/plain, application/pdf, application/vnd.ms-powerpoint, application/msword, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.
  • Ограничение размера документа: 100 МБ.
  • См. также Поддерживаемые типы медиафайлов.
  • filename поддерживается только для сообщений с документами и не поддерживается для любых других медиасообщений.

Сообщение со стикером

В этом случае вы отправляете сообщение со стикером:
  • Содержит URL-адрес стикера.
example-messaging-sticker.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • Поддерживаемые типы стикеров: image/webp. Ожидаемое разрешение: 512x512.
  • Ограничение размера стикера: 100 КБ для статичных стикеров и 500 КБ для анимированных стикеров.
  • См. также Поддерживаемые типы медиафайлов.

Сообщение с контактами

В этом случае вы отправляете сообщение с контактами:
  • Содержит 1 контакт с адресами, днем рождения, адресами электронной почты, именем, номерами телефонов и т. д.
example-messaging-contacts.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • Поле contacts[].name.formatted_name обязательно.

Сообщение с геопозицией

В этом случае вы отправляете сообщение с геопозицией:
  • Содержит широту и долготу места.
  • Содержит название и адрес места.
example-messaging-location.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • Поля latitude и longitude обязательны.

Сообщение-реакция

В этом случае вы отправляете сообщение-реакцию в виде эмодзи:
  • Содержит ID упоминаемого сообщения.
  • Содержит эмодзи.

Ставит отметку «нравится» ранее отправленному или полученному сообщению.

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • Поле message_id — это исходный ID сообщения на платформе WhatsApp, начинающийся с wamid..
  • Установите для emoji значение "", если хотите удалить эмодзи.
  • Сообщения-реакции не поддерживают уведомления о прочтении.

Интерактивное сообщение со списком

В этом случае вы отправляете интерактивное сообщение со списком:
  • Содержит текст заголовка, текст основного тела и текст нижнего колонтитула.
  • Устанавливает для interactive.type значение list, а также содержит кнопку с 2 разделами, где в каждом разделе по 2 строки.
example-messaging-interactivelist.png Получатель может выбрать пункт из списка, нажав на кнопку:

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • Для интерактивных сообщений типа list необходимо задать кнопку и от 1 до 10 разделов. Суммарно во всех разделах может быть до 10 строк.

Интерактивное сообщение с кнопками

В этом случае вы отправляете интерактивное сообщение с кнопками:
  • Содержит основной текст.
  • Устанавливает для interactive.type значение button, а также содержит 2 кнопки быстрого ответа.

Получатель может нажать любую из кнопок, чтобы отправить вам ответное сообщение.

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • Для интерактивных сообщений типа buttons можно задать не более 3 кнопок быстрого ответа.

Интерактивное сообщение с CTA URL

В этом случае вы отправляете интерактивное сообщение с кнопкой-призывом к действию (CTA URL):
  • Содержит заголовок, основной текст и нижний колонтитул.
  • Содержит кнопку со ссылкой (URL).
example-messaging-interactiveurl.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • Текст кнопки должен быть длиной не более 20 байт.
  • Поля body и action обязательны. Поля header и footer необязательны.

Интерактивное сообщение с одним товаром

В этом случае вы отправляете интерактивное сообщение с товаром:
  • Содержит основной текст и текст нижнего колонтитула.
  • Устанавливает для interactive.type значение product, а также содержит действие с информацией о товаре.
example-messaging-product.png

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

Интерактивное сообщение с несколькими товарами

В этом случае вы отправляете интерактивное сообщение со списком товаров:
  • Содержит основной текст и текст нижнего колонтитула.
  • Устанавливает для interactive.type значение product_list, а также содержит несколько товаров.

Запрос

Ответ

Успешный запрос возвращает объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • Чтобы получить ID товара и каталога, перейдите в Meta Commerce Manager.

Интерактивное сообщение с каталогом

Сообщения с каталогом — это сообщения произвольной формы, позволяющие продемонстрировать каталог товаров непосредственно в WhatsApp. Сообщения с каталогом содержат миниатюру товара в заголовке по вашему выбору, произвольный основной текст, фиксированный текстовый заголовок, фиксированный текстовый подзаголовок и кнопку View catalog . example-messaging-interactivecatalog.png Когда клиент нажимает кнопку View catalog , ваш каталог товаров открывается прямо в WhatsApp. example-messaging-catalog-view.webp

Запрос

Ответ

При успешном запросе возвращается объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • У вас должны быть товары, загруженные в Meta, в каталоге электронной коммерции, подключенном к вашему WhatsApp Business Account.
  • Включите корзину покупок и каталог товаров отдельно для каждого бизнес-номера телефона. По умолчанию корзина покупок включена, а значок витрины скрыт для всех бизнес-номеров телефонов, связанных с WhatsApp Business Account. Используйте эндпоинт Update commerce settings, чтобы включить или отключить эти функции.

Интерактивное сообщение с запросом местоположения (Location Request)

Сообщения с запросом местоположения представляют собой сообщения свободной формы, содержащие основной текст и кнопку отправки местоположения. Когда пользователь WhatsApp нажимает кнопку, открывается экран отправки геопозиции, с помощью которого он может поделиться своим местоположением. example-messaging-location-request-sharing-response.png

Запрос

Ответ

При успешном запросе возвращается объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

  • Основной текст (т. е. interactive.body) обязателен и не должен превышать 1024 символов. Заголовок (header) и нижний колонтитул (footer) не поддерживаются.
  • Как только пользователь поделится своим местоположением, срабатывает вебхук whatsapp.inbound_message.received, содержащий данные о местоположении пользователя. См. также Входящее сообщение с местоположением.

Интерактивное сообщение Flow

Вы можете отправить сообщение с Flow в диалоге, инициированном пользователем, используя сообщение с призывом к действию (CTA):

Запрос

Ответ

При успешном запросе возвращается объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

Интерактивное сообщение с деталями заказа (Order Details)

Сообщение типа order_details — это новый вид сообщения interactive, который всегда содержит одни и те же 4 основных компонента: header, body, footer и action. В компоненте action компания указывает всю информацию, необходимую клиенту для совершения оплаты.

Запрос

Ответ

При успешном запросе возвращается объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

Интерактивное сообщение со статусом заказа (Order Status)

Чтобы уведомить клиента об обновлениях заказа, вы можете отправить интерактивное сообщение типа order_status, как показано ниже.

Запрос

Ответ

При успешном запросе возвращается объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

Интерактивное сообщение с голосовым звонком (Voice Call)

Бизнес вызывает этот API для отправки сообщения клиентам, чтобы сообщить о возможности звонка в службу поддержки с помощью встроенной кнопки внутри сообщения. Когда пользователь нажимает эту кнопку, инициируется звонок в WhatsApp на бизнес-номер, отправивший это сообщение. Это поведение аналогично нажатию значка телефона/звонка в заголовке чата. Кнопка не поддерживает звонки в WhatsApp на другой номер телефона.

Запрос

Ответ

При успешном запросе возвращается объект сообщения YCloud. Начальный статус accepted подтверждает отправку, а не окончательную доставку.
Сохраните id и сопоставляйте последующие события whatsapp.message.updated.

Пояснение

Сопоставьте поля запроса с выбранным типом сообщения и используйте возвращенный ID сообщения для сопоставления статусов.

Интерактивные сообщения-карусели с медиа

Интерактивное медиасообщение-карусель позволяет компаниям отправлять карточки с изображениями или видео, прокручиваемые по горизонтали, каждая из которых содержит кнопку с призывом к действию, прямо в чатах WhatsApp. Этот формат дает пользователям возможность просматривать несколько предложений или материалов в одном сообщении, обеспечивая богатый и вовлекающий опыт взаимодействия через WhatsApp Business API и мобильные клиенты.
  • interactive.type должно быть carousel
  • interactive.action.cards необходимо добавить в сообщение как минимум 2 объекта карточек и не более 10.
  • Тип каждой карточки должен быть установлен на cta_url
  • все карточки должны иметь одинаковый тип заголовка (image или video)
  • необходимо добавить тело сообщения (interactive.body) в сообщение (максимум 1024 символа). Заголовок, подвал или кнопки вне карточек не допускаются.
  • все карточки должны иметь одинаковую структуру (заголовок, тело, действие).
  • тело карточки необязательно, но содержит максимум 160 символов и до 2 переносов строк.
f657ef005148593d05cc1ded201de7731d11b51200fd4900ad2584533ddd282d-interactive_media_carousel_message.jpg

Запрос

Ответ

При успешном запросе возвращается объект сообщения YCloud. Начальный статус accepted подтверждает отправку, но не окончательную доставку.
Сохраните id для последующего сопоставления с событиями whatsapp.message.updated.

Пояснение

Сопоставьте поля запроса с выбранным типом сообщения и используйте возвращенный ID сообщения для отслеживания статуса.

Интерактивные медиасообщения-карусели с кнопками быстрого ответа

  • Карточки должны содержать либо одну кнопку URL, либо одну или несколько кнопок быстрого ответа. Типы и количество кнопок должны совпадать во всех карточках (например, если вы определили карточку с 2 кнопками быстрого ответа, все карточки должны содержать ровно по 2 кнопки быстрого ответа).
a604f0105ba6b8dfa01f317ce10c2cb3961f1564a6cf12c9bede2eac57a11808-carousel_quick_reply.png

Запрос

Ответ

При успешном запросе возвращается объект сообщения YCloud. Начальный статус accepted подтверждает отправку, но не окончательную доставку.
Сохраните id для последующего сопоставления с событиями whatsapp.message.updated.

Пояснение

Сопоставьте поля запроса с выбранным типом сообщения и используйте возвращенный ID сообщения для отслеживания статуса.

Сообщение с кнопкой оформления заказа

После одобрения шаблона кнопки оформления заказа вы можете отправить его в шаблонном сообщении

Запрос

Ответ

При успешном запросе возвращается объект сообщения YCloud. Начальный статус accepted подтверждает отправку, но не окончательную доставку.
Сохраните id для последующего сопоставления с событиями whatsapp.message.updated.

Пояснение

Сопоставьте поля запроса с выбранным типом сообщения и используйте возвращенный ID сообщения для отслеживания статуса.

Шаблонное сообщение с GIF

В этом случае вы отправляете шаблонное сообщение с GIF:
  • Содержит URL GIF-анимации.
d29ea20d56e36017614121fc2079e5c513d6f922c3713a2c963e3dfca7570c0c-Feishu20260128-162503.gif

Запрос

Ответ

При успешном запросе возвращается объект сообщения YCloud. Начальный статус accepted подтверждает отправку, но не окончательную доставку.
Сохраните id для последующего сопоставления с событиями whatsapp.message.updated.

Пояснение

Сопоставьте поля запроса с выбранным типом сообщения и используйте возвращенный ID сообщения для отслеживания статуса.