whatsapp.smb.history

Используйте whatsapp.smb.history для обработки этого события на вашей конечной точке webhook.

Триггеры

Происходит при синхронизации истории сообщений WhatsApp Business App. Подпишитесь на whatsapp.smb.history, когда будете настраивать свою конечную точку webhook. Событие истории может содержать whatsappInboundMessage для входящего сообщения, whatsappMessage для исходящего сообщения или только метаданные фрагмента (chunk). phase и progress включаются, когда событие поступает из фрагмента истории Meta. Не делайте наличие объекта сообщения обязательным в каждом событии истории.

Синтаксис

YCloud отправляет HTTP-запрос POST на настроенный вами URL webhook. Следующая структура демонстрирует один из вариантов полезной нагрузки. Значения в угловых скобках являются заполнителями; их типы перечислены в разделе Параметры. Необязательные поля и другие варианты описаны ниже.

{
  "id": "<ID>",
  "type": "whatsapp.smb.history",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "phase": "<PHASE_VALUE>",
  "progress": "<PROGRESS_VALUE>",
  "whatsappInboundMessage": {
    "id": "<ID>",
    "wamid": "<WAMID>",
    "wabaId": "<WABA_ID>",
    "from": "<FROM>",
    "to": "<TO>",
    "type": "<TYPE>",
    "text": {
      "body": "<BODY>"
    },
    "customerProfile": {
      "name": "<NAME>"
    },
    "sendTime": "<SEND_TIME>"
  }
}

Параметры

Проверьте HTTP-заголовок YCloud-Signature перед обработкой тела JSON. См. раздел проверка подписи.

Конверт события (envelope)

Параметр	Тип	Обязательный	Описание
`id`	string	Да	Уникальный ID события. Минимальная длина: `6`. Максимальная длина: `128`.
`type`	string	Да	Всегда `whatsapp.smb.history`.
`apiVersion`	string	Да	Версия API, использованная для формирования этого события.
`createTime`	string (date-time)	Да	Время создания этого события в формате RFC 3339. Например, `2022-06-01T12:00:00.000Z`.

Полезная нагрузка события

Параметр	Тип	Обязательный	Описание
`phase`	integer (int32)	Нет	Включается, когда `type` имеет значение `whatsapp.smb.history` и событие было создано из фрагмента истории Meta. Определяет фазу синхронизации фрагмента.
`progress`	integer (int32)	Нет	Включается, когда `type` имеет значение `whatsapp.smb.history` и событие было создано из фрагмента истории Meta. Сообщает о прогрессе синхронизации фрагмента.
`whatsappInboundMessage`	object	Нет	Полезная нагрузка `whatsappInboundMessage`, специфичная для события.
`whatsappMessage`	object	Нет	Полезная нагрузка `whatsappMessage`, специфичная для события.

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

whatsappInboundMessage

Параметр	Тип	Обязательный	Описание
`id`	string	Да	Уникальный ID объекта.
`wamid`	string	Нет	Исходный ID сообщения на платформе WhatsApp.
`wabaId`	string	Нет	ID WhatsApp Business Account.
`from`	string	Нет	Номер телефона клиента, отправившего сообщение бизнесу, в формате E.164.
`fromUserId`	string	Нет	ID пользователя клиента в контексте WhatsApp Business (BSUID).
`fromParentUserId`	string	Нет	Родительский ID пользователя клиента в контексте WhatsApp Business.
`customerProfile`	object	Нет	Данные профиля клиента.
`to`	string	Нет	Номер телефона получателя в формате E.164.
`sendTime`	string (date-time)	Нет	Время отправки этого сообщения в формате RFC 3339. Например, `2022-06-01T12:00:00.000Z`.
`type`	string	Нет	Тип входящего сообщения WhatsApp. См. также объект сообщений webhook WhatsApp. Значения: `text`, `image`, `video`, `audio`, `document`, `sticker`, `contacts`, `location`, `interactive`, `button`, `reaction`, `request_welcome`, `order`, `system`, `unsupported`.
`text`	object	Нет	Когда уведомление описывает текстовое сообщение, объект text содержит текст этого сообщения.
`image`	object	Нет	При получении сообщения с медиафайлом (`image` \| `document` \| `audio` \| `video` \| `sticker`) клиент WhatsApp Business API скачивает этот медиафайл. После скачивания медиафайла на ваш Webhook отправляется уведомление. Это сообщение содержит информацию, идентифицирующую медиаобъект и позволяющую найти и скачать его.
`video`	object	Нет	При получении сообщения с медиафайлом (`image` \| `document` \| `audio` \| `video` \| `sticker`) клиент WhatsApp Business API скачивает этот медиафайл. После скачивания медиафайла на ваш Webhook отправляется уведомление. Это сообщение содержит информацию, идентифицирующую медиаобъект и позволяющую найти и скачать его.
`audio`	object	Нет	При получении сообщения с медиафайлом (`image` \| `document` \| `audio` \| `video` \| `sticker`) клиент WhatsApp Business API скачивает этот медиафайл. После скачивания медиафайла на ваш Webhook отправляется уведомление. Это сообщение содержит информацию, идентифицирующую медиаобъект и позволяющую найти и скачать его.
`document`	object	Нет	При получении сообщения с медиафайлом (`image` \| `document` \| `audio` \| `video` \| `sticker`) клиент WhatsApp Business API скачивает этот медиафайл. После скачивания медиафайла на ваш Webhook отправляется уведомление. Это сообщение содержит информацию, идентифицирующую медиаобъект и позволяющую найти и скачать его.
`sticker`	object	Нет	При получении сообщения с медиафайлом (`image` \| `document` \| `audio` \| `video` \| `sticker`) клиент WhatsApp Business API скачивает этот медиафайл. После скачивания медиафайла на ваш Webhook отправляется уведомление. Это сообщение содержит информацию, идентифицирующую медиаобъект и позволяющую найти и скачать его.
`interactive`	object	Нет	Когда клиент взаимодействует с вашим сообщением, этот объект включается в объект message.
`location`	object	Нет	При получении уведомления со статическим местоположением пользователя объект location предоставляет сведения о местоположении.
`button`	object	Нет	Когда поле типа сообщения имеет значение `button`, этот объект включается в объект message.
`contacts`	object[]	Нет	Элементы массива описаны ниже.
`reaction`	object	Нет	Когда пользователь реагирует на сообщения с помощью эмодзи, типу сообщения присваивается значение `reaction`, и это поле включается в объект.
`order`	object	Нет	Когда клиент оформляет заказ, типу сообщения присваивается значение `order`, и это поле включается в объект.
`system`	object	Нет	Когда тип сообщения установлен в `system`, это поле включается в объект. Этот объект описывает смену номера телефона пользователя, смену BSUID или возможное изменение учетных данных в WhatsApp.
`errors`	object[]	Нет	Элементы массива описаны ниже.
`context`	object	Нет	Контекст сообщения.
`referral`	object	Нет	Когда пользователь отправляет сообщение компании с помощью кнопок с призывом к действию в Ads that Click to WhatsApp или кнопок призыва к действию на странице Facebook, это поле передается как вложение.
`groupId`	string	Нет	ID группы WhatsApp. Это поле передается, если входящее сообщение отправлено в группу WhatsApp.

whatsappInboundMessage.customerProfile

Параметр	Тип	Обязательный	Описание
`name`	string	Нет	Имя аккаунта WhatsApp.
`username`	string	Нет	Имя пользователя WhatsApp.

whatsappInboundMessage.text

Параметр	Тип	Обязательный	Описание
`body`	string	Нет	Текст сообщения.

whatsappInboundMessage.image

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	ID медиафайла. Может использоваться для удаления медиафайла, если он сохранен локально на клиенте.
`link`	string	Нет	URL для скачивания медиафайла. Обратите внимание: эта ссылка доступна напрямую в течение нескольких минут для удобства пользователя, но для скачивания этого файла в течение месяца всегда следует передавать заголовок `X-API-Key`.
`caption`	string	Нет	Переданная подпись к медиафайлу. Присутствует, только если была указана.
`filename`	string	Нет	Имя файла на устройстве отправителя. Присутствует только в медиасообщениях типа `document`.
`metadata`	object	Нет	Метаданные, относящиеся к медиафайлу `sticker`.
`mime_type`	string	Нет	MIME-тип медиафайла.
`sha256`	string	Нет	Контрольная сумма.

whatsappInboundMessage.video

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	ID медиафайла. Может использоваться для удаления медиафайла, если он сохранен локально на клиенте.
`link`	string	Нет	URL для скачивания медиафайла. Обратите внимание: эта ссылка доступна напрямую в течение нескольких минут для удобства пользователя, но для скачивания этого файла в течение месяца всегда следует передавать заголовок `X-API-Key`.
`caption`	string	Нет	Переданная подпись к медиафайлу. Присутствует, только если была указана.
`filename`	string	Нет	Имя файла на устройстве отправителя. Присутствует только в медиасообщениях типа `document`.
`metadata`	object	Нет	Метаданные, относящиеся к медиафайлу `sticker`.
`mime_type`	string	Нет	MIME-тип медиафайла.
`sha256`	string	Нет	Контрольная сумма.

whatsappInboundMessage.audio

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	ID медиафайла. Может использоваться для удаления медиафайла, если он сохранен локально на клиенте.
`link`	string	Нет	URL для скачивания медиафайла. Обратите внимание: эта ссылка доступна напрямую в течение нескольких минут для удобства пользователя, но для скачивания этого файла в течение месяца всегда следует передавать заголовок `X-API-Key`.
`caption`	string	Нет	Переданная подпись к медиафайлу. Присутствует, только если была указана.
`filename`	string	Нет	Имя файла на устройстве отправителя. Присутствует только в медиасообщениях типа `document`.
`metadata`	object	Нет	Метаданные, относящиеся к медиафайлу `sticker`.
`mime_type`	string	Нет	MIME-тип медиафайла.
`sha256`	string	Нет	Контрольная сумма.

whatsappInboundMessage.document

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Идентификатор медиафайла. Может использоваться для удаления медиафайла, если он сохранен локально на стороне клиента.
`link`	string	Нет	URL-адрес для скачивания медиафайла. Обратите внимание, что для удобства пользователя к этой ссылке можно обращаться напрямую в течение нескольких минут, однако для скачивания этого файла в течение месяца всегда следует передавать заголовок `X-API-Key`.
`caption`	string	Нет	Переданная подпись к медиафайлу. Присутствует только в том случае, если была указана.
`filename`	string	Нет	Имя файла на устройстве отправителя. Присутствует только в сообщениях с медиатипом `document`.
`metadata`	object	Нет	Метаданные, относящиеся к медиафайлам `sticker`.
`mime_type`	string	Нет	MIME-тип медиафайла.
`sha256`	string	Нет	Контрольная сумма.

whatsappInboundMessage.sticker

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Идентификатор медиафайла. Может использоваться для удаления медиафайла, если он сохранен локально на стороне клиента.
`link`	string	Нет	URL-адрес для скачивания медиафайла. Обратите внимание, что для удобства пользователя к этой ссылке можно обращаться напрямую в течение нескольких минут, однако для скачивания этого файла в течение месяца всегда следует передавать заголовок `X-API-Key`.
`caption`	string	Нет	Переданная подпись к медиафайлу. Присутствует только в том случае, если была указана.
`filename`	string	Нет	Имя файла на устройстве отправителя. Присутствует только в сообщениях с медиатипом `document`.
`metadata`	object	Нет	Метаданные, относящиеся к медиафайлам `sticker`.
`mime_type`	string	Нет	MIME-тип медиафайла.
`sha256`	string	Нет	Контрольная сумма.

whatsappInboundMessage.interactive

Параметр	Тип	Обязательный	Описание
`type`	string	Нет	Тип полученного интерактивного сообщения. `button_reply`: Отправляется, когда клиент нажимает кнопку. `list_reply`: Отправляется, когда клиент выбирает элемент из списка. `nfm_reply`: Отправляется, когда клиент отвечает на WhatsApp Flow (Next Feature Messaging). `call_permission_reply`: Отправляется, когда клиент отвечает на запрос разрешения звонка.
`button_reply`	object	Нет	Отправляется, когда клиент нажимает кнопку. Возвращается, когда `type` имеет значение `button_reply`.
`list_reply`	object	Нет	Отправляется, когда клиент выбирает элемент из списка. Возвращается, когда `type` имеет значение `list_reply`.
`nfm_reply`	object	Нет	Отправляется, когда клиент отвечает на WhatsApp Flow (Next Feature Messaging). Возвращается, когда `type` имеет значение `nfm_reply`.
`call_permission_reply`	object	Нет	Отправляется, когда клиент отвечает на запрос разрешения звонка. Возвращается, когда `type` имеет значение `call_permission_reply`. Это происходит, когда WhatsApp предлагает пользователям предоставить разрешение на обратный звонок после того, как они позвонили в вашу компанию.

whatsappInboundMessage.interactive.button_reply

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Уникальный идентификатор нажатой кнопки.
`title`	string	Нет	Заголовок кнопки.

whatsappInboundMessage.interactive.list_reply

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Уникальный идентификатор выбранного элемента списка.
`title`	string	Нет	Заголовок выбранного элемента списка.
`description`	string	Нет	Описание выбранной строки.

whatsappInboundMessage.interactive.nfm_reply

Параметр	Тип	Обязательный	Описание
`name`	string	Нет	Название потока или формы, на которые отправлен ответ.
`response_json`	string	Нет	Строка JSON, содержащая ответы пользователя в потоке. Содержит значения полей формы и токен потока.
`body`	string	Нет	Содержимое тела сообщения-ответа потока.

whatsappInboundMessage.interactive.call_permission_reply

Параметр	Тип	Обязательный	Описание
`response`	string	Нет	Ответ клиента на запрос разрешения на звонок. `accept`: пользователь разрешил компании перезвонить `reject`: пользователь отклонил разрешение компании перезвонить
`expiration_timestamp`	integer (int64)	Нет	Временная метка (в секундах), когда истекает срок действия разрешения на звонок. Присутствует, только если значение ответа — “accept”, а is_permanent равно false.
`is_permanent`	boolean	Нет	Является ли разрешение постоянным или временным. `true`: постоянное разрешение (без срока действия) `false`: временное разрешение (истекает в момент времени expiration_timestamp)

whatsappInboundMessage.location

Параметр	Тип	Обязательный	Описание
`latitude`	number (double)	Нет	Широта отправляемого местоположения.
`longitude`	number (double)	Нет	Долгота отправляемого местоположения.
`address`	string	Нет	Адрес местоположения.
`name`	string	Нет	Название местоположения.
`url`	string	Нет	URL веб-сайта, с которого пользователь загрузил информацию о местоположении.

whatsappInboundMessage.button

Параметр	Тип	Обязательный	Описание
`payload`	string	Нет	Полезная нагрузка (payload) кнопки, настроенной компанией, которую клиент нажал в интерактивном сообщении.
`text`	string	Нет	Текст кнопки.

whatsappInboundMessage.contacts[]

Параметр	Тип	Обязательный	Описание
`addresses`	object[]	Нет	Элементы массива описаны ниже.
`birthday`	string	Нет	Строка в формате `YYYY-MM-DD`.
`emails`	object[]	Нет	Элементы массива описаны ниже.
`name`	object	Да	Полное имя контакта в формате объекта name.
`org`	object	Нет	Сведения об организации контакта в формате объекта org.
`phones`	object[]	Нет	Номер(а) телефона контакта в формате объекта phone.
`urls`	object[]	Нет	URL контакта в формате объекта urls.
`vcard`	string	Нет	Необязательный vCard, переданный вместе с полезной нагрузкой отправленного контакта.
`origin`	string	Нет	Принимает значение `contact_request`, если пользователь поделился контактом в ответ на сообщение с запросом контактных данных.

whatsappInboundMessage.contacts[].addresses[]

Параметр	Тип	Обязательный	Описание
`street`	string	Нет	Название улицы и номер дома.
`city`	string	Нет	Название города.
`state`	string	Нет	Аббревиатура штата/региона.
`zip`	string	Нет	Почтовый индекс.
`country`	string	Нет	Полное название страны.
`country_code`	string	Нет	Двухбуквенный код страны.
`type`	string	Нет	Стандартные значения: `HOME` и `WORK`.

whatsappInboundMessage.contacts[].emails[]

Параметр	Тип	Обязательный	Описание
`email`	string	Нет	Адрес электронной почты.
`type`	string	Нет	Стандартные значения: `HOME` и `WORK`.

whatsappInboundMessage.contacts[].name

Параметр	Тип	Обязательный	Описание
`formatted_name`	string	Да	Полное имя в привычном формате.
`first_name`	string	Нет	Имя.
`last_name`	string	Нет	Фамилия.
`middle_name`	string	Нет	Отчество или второе имя.
`suffix`	string	Нет	Суффикс имени.
`prefix`	string	Нет	Префикс имени.

whatsappInboundMessage.contacts[].org

Параметр	Тип	Обязательный	Описание
`company`	string	Нет	Название компании контакта.
`department`	string	Нет	Название отдела контакта.
`title`	string	Нет	Должность контакта.

whatsappInboundMessage.contacts[].phones[]

Параметр	Тип	Обязательный	Описание
`phone`	string	Нет	Автоматически заполняется значением `wa_id` в виде отформатированного номера телефона.
`type`	string	Нет	Стандартные значения: `CELL`, `MAIN`, `IPHONE`, `HOME` и `WORK`.
`wa_id`	string	Нет	WhatsApp ID.

whatsappInboundMessage.contacts[].urls[]

Параметр	Тип	Обязательный	Описание
`url`	string	Нет	URL.
`type`	string	Нет	Стандартные значения: `HOME` и `WORK`.

whatsappInboundMessage.reaction

Параметр	Тип	Обязательный	Описание
`message_id`	string	Да	Указывает `wamid` полученного сообщения, содержащего реакцию.
`emoji`	string	Нет	Обязательный при отправке сообщения `reaction`. Укажите `""`, если хотите удалить эмодзи. Необязательный при получении сообщения от пользователя. Это поле передается, когда пользователь реагирует на сообщения с помощью эмодзи. В противном случае оно указывает на то, что пользователь удалил эмодзи.

whatsappInboundMessage.order

Параметр	Тип	Обязательно	Описание
`catalog_id`	string	Нет	ID каталога.
`product_items`	object[]	Нет	Элементы массива описаны ниже.
`text`	string	Нет	Текстовое сообщение, отправленное вместе с заказом.

whatsappInboundMessage.order.product_items[]

Параметр	Тип	Обязательно	Описание
`product_retailer_id`	string	Нет	Идентификатор SKU товара.
`quantity`	integer (int32)	Нет	Количество элементов.
`item_price`	number (double)	Нет	Цена единицы товара.
`currency`	string	Нет	Валюта цены. Код валюты по ISO 4217.

whatsappInboundMessage.system

Параметр	Тип	Обязательно	Описание
`body`	string	Нет	Описывает событие системного сообщения. Поддерживаемые сценарии использования: Обновление номера телефона: когда пользователь переходит со старого номера на новый. Обновление идентификационных данных: когда идентификационные данные пользователя изменились.
`wa_id`	string	Нет	Номер телефона, предоставленный Meta, без префикса `+`. Он может оставаться неизменным или быть опущен при изменении BSUID.
`user_id`	string	Нет	Новый идентификатор пользователя в контексте компании (business-scoped user ID), предоставленный Meta при смене номера телефона или BSUID. Это поле сохраняет исходное имя в формате snake_case.
`parent_user_id`	string	Нет	Новый родительский BSUID для изменения номера телефона или BSUID, только если эта функция включена и предоставлена Meta. Это поле сохраняет исходное имя в snake_case.
`previous_user_id`	string	Нет	Предыдущий идентификатор пользователя в области бизнеса (business-scoped user ID), предоставленный Meta.
`previous_parent_user_id`	string	Нет	Предыдущий родительский BSUID, только если включено и предоставлено Meta.
`type`	string	Нет	Поддерживаемые типы: `user_changed_user_id`: уведомление о том, что пользователь изменил свой BSUID. Номер телефона может оставаться без изменений. `user_changed_number`: для уведомления об изменении номера пользователем. `user_identity_changed`: для уведомления об изменении удостоверения личности пользователя.
`user`	string	Нет	Добавлено в Webhook для обновлений идентификационных данных. Новый идентификатор пользователя WhatsApp клиента.
`new_wa_id`	string	Нет	Добавляется в Webhook при обновлении номера телефона. Новый WhatsApp ID клиента.

whatsappInboundMessage.errors[]

Параметр	Тип	Обязательный	Описание
`code`	string	Нет	Код ошибки.
`title`	string	Нет	Заголовок ошибки.
`message`	string	Нет	Сообщение об ошибке.
`error_data`	object	Нет	Объект данных об ошибке со следующими свойствами: `details`: Строка с описанием причины ошибки. Пример: `Message type is currently not supported.`.

whatsappInboundMessage.context

Параметр	Тип	Обязательно	Описание
`forwarded`	boolean	Нет	Добавляется в Webhook, если сообщение было переслано. Устанавливается в значение `true`, если полученное сообщение было переслано.
`frequently_forwarded`	boolean	Нет	Добавляется в Webhook, если сообщение часто пересылалось. Устанавливается в значение `true`, если полученное сообщение было переслано более пяти раз.
`from`	string	Нет	Добавляется в Webhook, если сообщение является входящим ответом на отправленное сообщение. WhatsApp ID (номер телефона без префикса «+») отправителя отправленного сообщения.
`id`	string	Нет	Необязательно. Идентификатор `wamid` отправленного сообщения для входящего ответа. `wamid` — это исходный идентификатор сообщения на платформе WhatsApp.
`referred_product`	object	Нет	Обязательно для сообщений с запросом о товаре. Указывает товар, информацию о котором запрашивает пользователь. См. также Sell Products & Services.

whatsappInboundMessage.context.referred_product

Параметр	Тип	Обязательно	Описание
`catalog_id`	string	Нет	Идентификатор каталога.
`product_retailer_id`	string	Нет	Идентификатор артикула (SKU) товара.

whatsappInboundMessage.referral

Параметр	Тип	Обязательно	Описание
`source_url`	string	Нет	Задает URL, ведущий на рекламу или публикацию, по которой кликнул пользователь. Переход по этому URL открывает рекламу, просмотренную вашим пользователем.
`source_type`	string	Нет	Задает тип источника рекламы. Поддерживаемые значения: “ad” или “post”.
`source_id`	string	Нет	Задает Meta ID для рекламы или публикации.
`headline`	string	Нет	Задает заголовок, используемый в рекламе или публикации, сгенерировавшей сообщение.
`body`	string	Нет	Описание или текст рекламы либо публикации, сгенерировавшей сообщение.
`media_type`	string	Нет	Медиаматериалы, присутствующие в рекламе или публикации, по которой кликнул пользователь. Поддерживаемые значения: “image” или “video”.
`image_url`	string	Нет	Добавляется, если media_type имеет значение “image”. Содержит URL исходного изображения.
`video_url`	string	Нет	Добавляется, если media_type имеет значение “video”. Содержит URL видео.
`thumbnail_url`	string	Нет	Добавляется, если media_type имеет значение “video”. Содержит URL миниатюры видео, по которому был совершен клик.
`ctwa_clid`	string	Нет	Идентификатор клика, созданный Meta для объявлений с переходом в WhatsApp.

whatsappMessage

Параметр	Тип	Обязательно	Описание
`id`	string	Да	Уникальный идентификатор сообщения.
`wamid`	string	Нет	Исходный идентификатор сообщения на платформе WhatsApp.
`wabaId`	string	Да	Идентификатор WhatsApp Business Account.
`from`	string	Да	Номер телефона отправителя в формате E.164.
`to`	string	Нет	Номер телефона получателя в формате E.164.
`recipient`	string	Нет	Значение получателя, переданное в запросе, когда использовался BSUID или родительский BSUID.
`recipientUserId`	string	Нет	Идентификатор пользователя получателя в рамках WhatsApp Business (BSUID).
`toUserId`	string	Нет	Псевдоним для `recipientUserId`, сохранённый для совместимости.
`parentRecipientUserId`	string	Нет	Родительский идентификатор пользователя получателя в рамках WhatsApp Business.
`toParentUserId`	string	Нет	Псевдоним для `parentRecipientUserId`, сохранённый для совместимости.
`customerProfile`	object	Нет	Сведения профиля получателя, включая имя пользователя WhatsApp, если оно доступно.
`conversation`	object	Нет	WhatsApp определяет переписку как 24-часовую сессию обмена сообщениями между пользователем и компанией. Это поле появляется после того, как статус сообщения изменяется на `sent`. См. также Conversation-Based Pricing.
`type`	string	Нет	Тип исходящего сообщения WhatsApp. См. также WhatsApp messages. Значения: `template`, `text`, `image`, `audio`, `video`, `document`, `sticker`, `location`, `interactive`, `contacts`, `reaction`.
`template`	object	Нет	Используется для отправки сообщения WhatsApp типа `template`.
`text`	object	Нет	Объект текста сообщения WhatsApp.
`image`	object	Нет	Используется для сообщений `image`, `gif`, `video`, `audio`, `document` или `sticker`. См. также Supported Media Types.
`video`	object	Нет	Используется для сообщений `image`, `gif`, `video`, `audio`, `document` или `sticker`. См. также Supported Media Types.
`audio`	object	Нет	Используется для сообщений `image`, `gif`, `video`, `audio`, `document` или `sticker`. См. также Supported Media Types.
`document`	object	Нет	Используется для сообщений `image`, `gif`, `video`, `audio`, `document` или `sticker`. См. также Supported Media Types.
`sticker`	object	Нет	Используется для сообщений `image`, `gif`, `video`, `audio`, `document` или `sticker`. См. также Supported Media Types.
`location`	object	Нет	Используется для сообщений `location`.
`interactive`	object	Нет	Используется для сообщений `interactive`.
`contacts`	object[]	Нет	Элементы массива описаны ниже.
`reaction`	object	Нет	Когда пользователь реагирует на сообщения эмодзи, тип сообщения устанавливается в `reaction`, и включается это поле.
`context`	object	Нет	Используется для указания конкретного сообщения, на которое вы отвечаете. Ответ может быть сообщением любого типа.
`externalId`	string	Нет	Уникальная (рекомендуется) строка для идентификации объекта. Это может быть номер заказа или аналогичное значение, которое можно использовать для сопоставления объекта с вашими внутренними системами.
`category`	string	Нет	Категория Direct Send, например `utility` или `authentication`, если применимо.
`ttlSeconds`	integer	Нет	Настроенное время жизни сообщения Direct Send в секундах, если применимо.
`status`	string	Нет	Статус сообщения WhatsApp. Одно из значений: `accepted`, `failed`, `sent`, `delivered`, `read`. `accepted`: запрос на отправку сообщения принят нашей системой. `failed`: сообщение, отправленное вашей компанией, не удалось отправить. `sent`: сообщение, отправленное вашей компанией, находится в процессе передачи в системах WhatsApp. `delivered`: сообщение, отправленное вашей компанией, доставлено на устройство пользователя. `read`: сообщение, отправленное вашей компанией, прочитано пользователем.
`errorCode`	string	Нет	Код ошибки, если статус сообщения — `failed`.
`errorMessage`	string	Нет	Текст ошибки, если статус сообщения — `failed`.
`createTime`	string (date-time)	Нет	Время создания этого сообщения в формате RFC 3339, например, `2022-06-01T12:00:00.000Z`.
`updateTime`	string (date-time)	Нет	Время обновления этого сообщения в формате RFC 3339, например, `2022-06-01T12:00:00.000Z`.
`sendTime`	string (date-time)	Нет	Время, когда статус этого сообщения `status` изменился на `sent`, в формате RFC 3339, например, `2022-06-01T12:00:00.000Z`.
`deliverTime`	string (date-time)	Нет	Время, когда статус этого сообщения `status` изменился на `delivered`, в формате RFC 3339, например, `2022-06-01T12:00:00.000Z`.
`readTime`	string (date-time)	Нет	Время, когда статус этого сообщения `status` изменился на `read`, в формате RFC 3339, например, `2022-06-01T12:00:00.000Z`.
`totalPrice`	number (double)	Нет	Общая стоимость этого сообщения. Примечание: цена является ориентировочной, пока значение `status` равно `accepted` или `sent`. Она становится окончательной после доставки сообщения, то есть когда поле `status` принимает значение `delivered` или `read`. Для сообщений с максимальной ценой сумма на момент отправки является ориентировочной. Для получения окончательной суммы списания используйте событие whatsapp.message.updated со статусом delivered/read; maxBid не является окончательной суммой списания.
`currency`	string	Нет	Валюта цены. Код валюты по ISO 4217.
`regionCode`	string	Нет	Код региона номера телефона получателя.
`pricingCategory`	string	Нет	Тарифная категория сообщения. Примечание: категория тарификации является предварительной, пока поле `status` имеет значение `accepted` или `sent`. Она становится окончательной после доставки сообщения, то есть когда значение `status` равно `delivered` или `read`. Значения: `referral_conversion`, `authentication`, `authentication_international`, `marketing`, `marketing_lite`, `utility`, `service`, `marketing_lite_bidding`.
`pricingModel`	string	Нет	Модель ценообразования для сообщения. `PMP`: применяется оплата за каждое сообщение. `CBP`: применяется оплата за переписку.
`pricingType`	string	Нет	Тип тарификации сообщения. Это поле доступно только в режиме PMP (Per-Message Pricing). `regular`: Указывает, что сообщение подлежит оплате. `free_customer_service`: Указывает, что сообщение бесплатно, так как оно представляет собой шаблонное сервисное сообщение (utility) либо нешаблонное сообщение, отправленное в рамках окна обслуживания клиентов. `free_entry_point`: Указывает, что сообщение бесплатно, так как оно является частью переписки через бесплатную точку входа.
`whatsappApiError`	object	Нет	Исходный объект ошибки, возвращенный WhatsApp. См. Handling Errors, Cloud API Error Codes.
`bizType`	string	Нет	Может быть пустым или иметь одно из значений: `whatsapp` либо `verify`. По умолчанию — `whatsapp`. `whatsapp`: Указывает, что сообщение отправлено через продукт WhatsApp. `verify`: Указывает, что сообщение отправлено через продукт Verify.
`verificationId`	string	Нет	Идентификатор верификации. Включается только в том случае, если `bizType` имеет значение `verify`.
`bidPricingFlag`	boolean	Нет	Значение True, если сообщение идентифицировано как аукционное сообщение Marketing Lite. Его pricingCategory имеет значение marketing_lite_bidding.

whatsappMessage.customerProfile

Параметр	Тип	Обязательный	Описание
`name`	string	Нет	Название аккаунта WhatsApp.
`username`	string	Нет	Имя пользователя WhatsApp.

whatsappMessage.conversation

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Уникальный идентификатор объекта.
`type`	string	Нет	Тип переписки. Плата взимается при доставке первого бизнес-сообщения этой переписки, которое инициирует 24-часовую сессию переписки. Таким образом, до доставки первого сообщения тип переписки может иметь значение `null`. `FREE_ENTRY`: Переписки, начатые через бесплатную точку входа. `FREE_TIER`: Переписки в рамках ежемесячного бесплатного пакета. `REGULAR`: Любые переписки, которые не были начаты через бесплатную точку входа или превышают ежемесячный лимит бесплатного пакета.
`originType`	string	Нет	Указывает на категорию переписки. Это также может называться точкой входа в переписку. `referral_conversion`: указывает на переписку с бесплатной точкой входа. `authentication`: указывает, что переписка была начата бизнесом путем отправки клиенту шаблона категории `AUTHENTICATION`. Это применимо в любое время, если с момента последнего сообщения клиента прошло более 24 часов. `marketing`: указывает, что переписка была начата бизнесом путем отправки клиенту шаблона категории `MARKETING`. Это применимо в любое время, если с момента последнего сообщения клиента прошло более 24 часов. `utility`: указывает, что переписка была начата бизнесом путем отправки клиенту шаблона категории `UTILITY`. Это применимо в любое время, если с момента последнего сообщения клиента прошло более 24 часов. `service`: указывает, что переписка была открыта бизнесом, ответившим клиенту в рамках окна обслуживания клиентов.
`expireTime`	string (date-time)	Нет	Дата истечения срока действия переписки, отформатированная в соответствии с RFC 3339, например `2022-06-01T12:00:00.000Z`.

whatsappMessage.template

Параметр	Тип	Обязательный	Описание
`name`	string	Да	Название шаблона.
`language`	object	Да	Содержит объект языка. Указывает язык, на котором может отображаться шаблон.
`components`	object[]	Нет	Обязательно, если указанный шаблон содержит переменные или медиафайлы. Массив объектов компонентов, содержащих параметры сообщения.

whatsappMessage.template.language

Параметр	Тип	Обязательный	Описание
`code`	string	Да	Код используемого языка или регионального стандарта (locale). Поддерживает форматы языка и языка_локали (например, en и en_US). См. Поддерживаемые языки для списка всех кодов.
`policy`	string	Нет	Языковая политика, которой должно следовать сообщение. По умолчанию (и единственный поддерживаемый вариант): `deterministic`, что означает, что WhatsApp доставляет шаблон сообщения именно на том языке и с той локалью, которые были запрошены.

whatsappMessage.template.components[]

Параметр	Тип	Обязательный	Описание
`type`	string	Да	Тип компонента. Значения: `header`, `body`, `button`, `limited_time_offer`, `carousel`, `order_status`.
`sub_type`	string	Нет	Обязательно, если type имеет значение `button`. Тип кнопки. `quick_reply`: относится к ранее созданной кнопке быстрого ответа, которая позволяет клиенту отправить предварительно заданное сообщение. `url`: относится к ранее созданной кнопке с URL-адресом, которая позволяет клиенту перейти по URL, сформированному путем добавления параметра text к заданному в шаблоне префиксу URL. `copy_code`: относится к ранее созданной кнопке копирования кода, которая позволяет клиенту при нажатии копировать текстовую строку (определяемую при отправке шаблона в шаблонном сообщении) в буфер обмена устройства. `catalog`: относится к ранее созданной кнопке каталога, которая позволяет клиенту просматривать ваш каталог товаров. `mpm`: относится к ранее созданной кнопке MPM (сообщение с несколькими товарами), которая позволяет клиенту просматривать товары и разделы. `flow`: относится к ранее созданной кнопке потока, которая позволяет клиенту взаимодействовать с flow. `order_details`: относится к ранее созданной кнопке сведений о заказе, которая позволяет клиенту просматривать детали заказа.
`index`	integer (int32)	Нет	Обязательно, если `type` = `button`. Для остальных типов не используется. Указывает порядок отображения кнопки, если в шаблоне используется несколько кнопок. Кнопки индексируются с нуля, поэтому значение 0 приведет к тому, что кнопка отобразится первой, кнопка с индексом 1 — следующей и т. д. Минимум: `0`. Максимум: `9`.
`parameters`	object[]	Нет	Обязательно, если `type` = `button`, либо в соответствующем компоненте шаблона есть переменные, либо формат шаблона `HEADER` относится к медиа (`IMAGE`, `VIDEO` или `DOCUMENT`). Массив объектов параметров с содержимым сообщения.
`cards`	object[]	Нет	Используется для компонентов `carousel`. Предоставляет компоненты карточек, содержащие параметры сообщения.

whatsappMessage.template.components[].parameters[]

Параметр	Тип	Обязательно	Описание
`type`	string	Нет	Обязательно. Тип параметра компонента. `text`: используется, когда тип компонента шаблона — `BODY`, либо формат компонента `HEADER` — `TEXT`. `image`: используется, когда компонент шаблона `HEADER` имеет тип `IMAGE`. `gif`: используется, когда компонент шаблона `HEADER` имеет тип `GIF`. `video`: используется, когда компонент шаблона `HEADER` имеет тип `VIDEO`. `document`: используется, когда компонент шаблона `HEADER` имеет тип `DOCUMENT`. `payload`: используется, когда тип кнопки в компоненте шаблона — `QUICK_REPLY`. `coupon_code`: используется, когда тип кнопки в компоненте шаблона — `COPY_CODE`. `limited_time_offer`: используется, когда тип компонента шаблона — `LIMITED_TIME_OFFER`. `action`: используется, когда тип кнопки в компоненте шаблона — `CATALOG`, `MPM`, `FLOW` или `ORDER_DETAILS`. `order_status`: используется, когда подкатегория шаблона — `ORDER_STATUS`. `location`: используется, когда компонент шаблона `HEADER` имеет тип `LOCATION`.
`text`	string	Нет	Обязательно, если `type` = `text`. Текст сообщения. Для компонента заголовка ограничение составляет 60 символов. Для компонента тела — 1024 символа. Для кнопок со ссылкой указывает предоставленный разработчиком суффикс, который добавляется к заранее заданному префиксу URL в шаблоне.
`payload`	string	Нет	Обязательно для кнопок `quick_reply`. Задаваемые разработчиком полезные данные (payload), возвращаемые при нажатии кнопки в дополнение к отображаемому на ней тексту.
`coupon_code`	string	Нет	Обязательно, если `type` = `coupon_code`. Код купона, копируемый при нажатии кнопки клиентом.
`image`	object	Нет	Обязательно, когда формат `HEADER` шаблона — `IMAGE`.
`gif`	object	Нет	Обязательно, когда формат `HEADER` шаблона — `GIF`.
`video`	object	Нет	Обязательно, когда формат `HEADER` шаблона — `VIDEO`.
`document`	object	Нет	Обязательно, когда формат `HEADER` шаблона — `DOCUMENT`.
`limited_time_offer`	object	Нет	Обязательно, если в шаблоне используются сведения об истечении срока действия предложения.
`action`	object	Нет	Обязательно, если в шаблоне используются кнопки каталога или MPM (многотоварных сообщений).
`order_status`	object	Нет	Поля объекта перечислены ниже.
`location`	object	Нет	Обязательно, если `type` = `location`.

whatsappMessage.template.components[].parameters[].image

Параметр	Тип	Обязательное	Описание
`id`	string	Нет	Используйте это, когда медиафайл загружен на серверы WhatsApp. Укажите идентификатор медиаобъекта, полученный из API загрузки медиа WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только с URL HTTP/HTTPS. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать актуальность контента, добавьте к URL случайные параметры строки запроса. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применяется в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для указанного документа. Используйте только с медиафайлами `document`.

whatsappMessage.template.components[].parameters[].gif

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте это, когда медиафайл загружен на серверы WhatsApp. Укажите идентификатор медиаобъекта, полученный из API загрузки медиа WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только с URL HTTP/HTTPS. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать актуальность контента, добавьте к URL случайные параметры строки запроса. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применяется в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для указанного документа. Используйте только с медиафайлами `document`.

whatsappMessage.template.components[].parameters[].video

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте это, когда медиафайл загружен на серверы WhatsApp. Укажите идентификатор медиаобъекта, полученный из API загрузки медиа WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только с URL HTTP/HTTPS. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать актуальность контента, добавьте к URL случайные параметры строки запроса. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл: `image`, `gif`, `video` или `document`. Неприменимо в `header` для сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для конкретного документа. Используется только с медиафайлами `document`.

whatsappMessage.template.components[].parameters[].document

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте это, когда медиафайл загружен на серверы WhatsApp. Укажите идентификатор медиаобъекта, полученный из WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайлов напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только с URL-адресами HTTP/HTTPS. Примечание: WhatsApp Cloud API кеширует медиаресурсы на 10 минут. Чтобы обеспечить актуальность контента, добавьте случайные параметры запроса к URL. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл: `image`, `gif`, `video` или `document`. Неприменимо в `header` для сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для конкретного документа. Используется только с медиафайлами `document`.

whatsappMessage.template.components[].parameters[].limited_time_offer

Параметр	Тип	Обязательный	Описание
`expiration_time_ms`	integer (int64)	Нет	Обязательный параметр. Время истечения срока действия промокода в формате временной метки UNIX в миллисекундах.

whatsappMessage.template.components[].parameters[].action

Параметр	Тип	Обязательный	Описание
`thumbnail_product_retailer_id`	string	Нет	Необязательный параметр. Используется для шаблонных сообщений каталога и MPM. Артикул (SKU) товара. Обозначается как Content ID в Commerce Manager. Миниатюра этого товара будет использоваться в качестве изображения заголовка сообщения. Если объект `parameters` опущен, будет использовано изображение первого товара из вашего каталога.
`sections`	object[]	Нет	Используется для шаблонов MPM. Разделы товаров. Можно указать до 10 разделов.
`flow_token`	string	Нет	Используется для кнопок `FLOW`. Токен Flow, созданный компанией для использования в качестве идентификатора. По умолчанию `unused`.
`flow_action_data`	object	Нет	Используется для кнопок `FLOW`. Объект JSON с полезной нагрузкой данных для первого экрана.
`order_details`	object	Нет	Обязательно для кнопок `order_details`.

whatsappMessage.template.components[].parameters[].action.sections[]

Параметр	Тип	Обязательный	Описание
`title`	string	Нет	Текст заголовка раздела. Максимум 24 символа. Markdown не поддерживается. Максимальная длина: `24`.
`product_items`	object[]	Нет	Массив артикулов (SKU) товаров. Минимум 1 товар в разделе и максимум 30 товаров во всех разделах.

whatsappMessage.template.components[].parameters[].action.sections[].product_items[]

Параметр	Тип	Обязательный	Описание
`product_retailer_id`	string	Нет	Номер SKU товара, который должен отображаться в этом разделе. Номера SKU обозначаются как Content ID в Commerce Manager.

whatsappMessage.template.components[].parameters[].action.order_details

Параметр	Тип	Обязательный	Описание
`currency`	string	Да	Валюта для этого заказа. В настоящее время единственным поддерживаемым значением является `INR`.
`order`	object	Да	Предоставляет параметры заказа: `status`, `items`, `subtotal`, `tax` и т. д.
`reference_id`	string	Да	Уникальный идентификатор заказа, предоставленный компанией. Чувствителен к регистру, не может быть пустой строкой, может содержать только буквы латинского алфавита, цифры, знаки подчеркивания, дефисы или точки и не должен превышать 35 символов. `reference_id` должен быть уникальным для каждого сообщения order_details конкретной компании. Если требуется отправить несколько сообщений order_details для одного и того же заказа, рекомендуется включить порядковый номер в reference_id (например, “BM345A-12”), чтобы обеспечить уникальность reference_id.
`total_amount`	object	Да	Общая сумма заказа.
`type`	string	Да	Тип товаров, оплачиваемых в этом заказе. В настоящее время поддерживаются варианты `digital-goods` и `physical-goods`.
`payment_settings`	object[]	Да	Настройки оплаты для заказа.

whatsappMessage.template.components[].parameters[].action.order_details.order

Параметр	Тип	Обязательный	Описание
`status`	string	Нет	Единственным поддерживаемым значением в сообщении `order_details` является `pending`. В сообщении `order_status` значение `status` может быть следующим: `pending`, `processing`, `partially_shipped`, `shipped`, `completed` или `canceled`.
`type`	string	Нет	Единственным поддерживаемым значением является `quick_pay`. Если это поле передано, мы скрываем кнопку “Review and Pay” и показываем только кнопку “Pay Now” в карточке с деталями заказа.
`catalog_id`	string	Нет	Уникальный идентификатор каталога Facebook, используемого компанией. Если вы не указываете это поле, необходимо передать следующие поля внутри объекта items: `country_of_origin`, `importer_name` и `importer_address`.
`items`	object[]	Нет	Массив позиций в заказе.
`subtotal`	object	Нет	Значение должно быть равно сумме `order.amount.value` * `order.amount.quantity`.
`tax`	object	Нет	Информация о налогах для этого заказа.
`shipping`	object	Нет	Стоимость доставки заказа.
`discount`	object	Нет	Сумма скидки для этого заказа.
`expiration`	object	Нет	Срок действия этого заказа.
`description`	string	Нет	Необязательно. Текст для передачи информации, связанной со статусом. Может быть полезен при отправке отмены. Максимальный лимит — 120 символов. Максимальная длина: `120`.

whatsappMessage.template.components[].parameters[].action.order_details.order.items[]

Параметр	Тип	Обязательный	Описание
`retailer_id`	string	Нет	Идентификатор контента для товара в заказе из вашего каталога.
`name`	string	Да	Название товара, отображаемое пользователю. Не может превышать 60 символов. Максимальная длина: `60`.
`image`	object	Нет	Пользовательское изображение товара, отображаемое пользователю.
`amount`	object	Да	Цена за единицу товара.
`sale_amount`	object	Нет	Цена товара со скидкой. Должна быть меньше первоначальной суммы. Если указано, это поле используется для расчета промежуточного итога.
`quantity`	integer (int32)	Да	Количество товаров в заказе.
`country_of_origin`	string	Нет	Обязательно, если не указано `catalog_id`. Страна происхождения товара.
`importer_name`	string	Нет	Обязательно, если не указано `catalog_id`. Название компании-импортера.
`importer_address`	string	Нет	Обязательно, если не указано `catalog_id`. Адрес компании-импортера.

whatsappMessage.template.components[].parameters[].action.order_details.order.items[].image

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте это, когда медиафайл загружен на серверы WhatsApp. Укажите идентификатор медиаобъекта, полученный через WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только с URL HTTP/HTTPS. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать актуальность контента, добавьте к URL случайные параметры строки запроса. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл типа `image`, `gif`, `video` или `document`. Неприменимо в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для конкретного документа. Используйте только для медиафайлов `document`.

whatsappMessage.template.components[].parameters[].action.order_details.order.items[].amount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на коэффициент смещения (offset). Например, значение для ₹12.34 равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальное ограничение — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальное ограничение — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.order.items[].sale_amount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.order.subtotal

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.order.tax

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.order.shipping

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавцу необходимо указать эту информацию. Максимальный лимит — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.order.discount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее значение суммы, умноженное на смещение (offset). Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальный лимит — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавцу необходимо указать эту информацию. Максимальный лимит — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.order.expiration

Параметр	Тип	Обязательный	Описание
`timestamp`	string	Да	Строка с меткой времени UTC в секундах, указывающей, когда истекает срок действия заказа. Минимальный порог — 300 секунд.
`description`	string	Нет	Текстовое пояснение истечения срока действия. Максимальная длина: `120`.

whatsappMessage.template.components[].parameters[].action.order_details.total_amount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее значение суммы, умноженное на смещение (offset). Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальный лимит — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавцу необходимо указать эту информацию. Максимальный лимит — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.payment_settings[]

Параметр	Тип	Обязательный	Описание
`type`	string	Да	Должно быть установлено в `payment_gateway`.
`payment_gateway`	object	Да	Объект, содержащий информацию о платежном счете.

whatsappMessage.template.components[].parameters[].action.order_details.payment_settings[].payment_gateway

Параметр	Тип	Обязательный	Описание
`type`	string	Да	Тип платежа. Необходимо указать `billdesk`, `razorpay`, `payu` или `zaakpay`, если вы подключили платежный шлюз BillDesk, Razorpay, PayU или Zaakpay для приема платежей.
`configuration_name`	string	Да	Имя предварительно настроенной конфигурации платежей для использования в этом заказе; длина не должна превышать 60 символов. Это значение должно совпадать с конфигурацией платежей, настроенной в WhatsApp Business Manager. Максимальная длина: `60`.
`billdesk`	object	Нет	Дополнительная информация для BillDesk. Пользовательские поля (extra) используются для хранения любой информации, относящейся к конкретному заказу. Максимальная длина каждого поля extra составляет 120 символов.
`payu`	object	Нет	Дополнительная информация для PayU. Пользовательские поля (udf) используются для хранения любой информации, относящейся к конкретному заказу. Максимальная длина каждого поля UDF составляет 255 символов.
`razorpay`	object	Нет	Дополнительная информация для Razorpay.
`zaakpay`	object	Нет	Дополнительная информация для Zaakpay. Пользовательские поля (extra) используются для хранения любой информации, относящейся к конкретному заказу. Максимальная длина каждого поля extra составляет 180 символов.

whatsappMessage.template.components[].parameters[].action.order_details.payment_settings[].payment_gateway.billdesk

Параметр	Тип	Обязательный	Описание
`additional_info1`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info2`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info3`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info4`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info5`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info6`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info7`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.

whatsappMessage.template.components[].parameters[].action.order_details.payment_settings[].payment_gateway.payu

Параметр	Тип	Обязательный	Описание
`udf1`	string	Нет	Пользовательская информация об этом заказе для PayU. Максимальная длина: `255` символов.
`udf2`	string	Нет	Пользовательская информация об этом заказе для PayU. Максимальная длина: `255` символов.
`udf3`	string	Нет	Пользовательская информация об этом заказе для PayU. Максимальная длина: `255` символов.
`udf4`	string	Нет	Пользовательская информация об этом заказе для PayU. Максимальная длина: `255` символов.

whatsappMessage.template.components[].parameters[].action.order_details.payment_settings[].payment_gateway.razorpay

Параметр	Тип	Обязательный	Описание
`receipt`	string	Нет	Номер квитанции, соответствующий этому заказу, задаваемый для вашего внутреннего использования. Поддерживается максимальная длина до 40 символов, минимальная длина — более 0 символов.
`notes`	object	Нет	Объект может содержать пары «ключ-значение» максимум с 15 ключами, при этом длина каждого значения ограничена 256 символами.

whatsappMessage.template.components[].parameters[].action.order_details.payment_settings[].payment_gateway.zaakpay

Параметр	Тип	Обязательный	Описание
`extra1`	string	Нет	Пользовательская информация об этом заказе для Zaakpay. Максимальная длина: `180` символов.
`extra2`	string	Нет	Пользовательская информация об этом заказе для Zaakpay. Максимальная длина: `180` символов.

whatsappMessage.template.components[].parameters[].order_status

Параметр	Тип	Обязательный	Описание
`reference_id`	string	Нет	Уникальный идентификатор заказа, предоставленный компанией.
`order`	object	Нет	Предоставляет только `status` и `description` этого заказа для сообщений `order_status`.

whatsappMessage.template.components[].parameters[].order_status.order

Параметр	Тип	Обязательный	Описание
`status`	string	Нет	Единственное поддерживаемое значение в сообщении `order_details` — `pending`. В сообщении `order_status` значением `status` может быть: `pending`, `processing`, `partially_shipped`, `shipped`, `completed` или `canceled`.
`type`	string	Нет	Единственное поддерживаемое значение — `quick_pay`. При передаче этого поля мы скрываем кнопку «Review and Pay» и отображаем в карточке с деталями заказа только кнопку «Pay Now».
`catalog_id`	string	Нет	Уникальный идентификатор каталога Facebook, используемого компанией. Если вы не указываете это поле, необходимо передать следующие поля внутри объекта items: `country_of_origin`, `importer_name` и `importer_address`.
`items`	object[]	Нет	Массив позиций в заказе.
`subtotal`	object	Нет	Значение должно быть равно сумме `order.amount.value` * `order.amount.quantity`.
`tax`	object	Нет	Информация о налогах для этого заказа.
`shipping`	object	Нет	Стоимость доставки заказа.
`discount`	object	Нет	Сумма скидки для этого заказа.
`expiration`	object	Нет	Срок действия этого заказа.
`description`	string	Нет	Необязательно. Текст для передачи информации о статусе. Может быть полезен при отправке отмены. Максимальный лимит составляет 120 символов. Максимальная длина: `120`.

whatsappMessage.template.components[].parameters[].order_status.order.items[]

Параметр	Тип	Обязательный	Описание
`retailer_id`	string	Нет	Идентификатор контента (Content ID) для позиции в заказе из вашего каталога.
`name`	string	Да	Название товара, отображаемое пользователю. Не может превышать 60 символов. Максимальная длина: `60`.
`image`	object	Нет	Пользовательское изображение товара, отображаемое пользователю.
`amount`	object	Да	Цена за единицу товара.
`sale_amount`	object	Нет	Цена за единицу товара со скидкой. Значение должно быть меньше исходной суммы. Если указано, это поле используется для расчета промежуточного итога.
`quantity`	integer (int32)	Да	Количество товаров в заказе.
`country_of_origin`	string	Нет	Обязательно, если не указано поле `catalog_id`. Страна происхождения товара.
`importer_name`	string	Нет	Обязательно, если не указано поле `catalog_id`. Название компании-импортера.
`importer_address`	string	Нет	Обязательно, если не указано поле `catalog_id`. Адрес компании-импортера.

whatsappMessage.template.components[].parameters[].order_status.order.items[].image

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте это, когда медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный из WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайлов напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только с URL HTTP/HTTPS. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать актуальность содержимого, добавьте случайные параметры запроса к URL. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применяется в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для конкретного документа. Используйте только с медиафайлами `document`.

whatsappMessage.template.components[].parameters[].order_status.order.items[].amount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее значение суммы, умноженное на offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавцу необходимо указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].parameters[].order_status.order.items[].sale_amount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальное количество символов — 60. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для обозначения поощрительных заказов. Если заказ поощрительный, продавцу необходимо указать эту информацию. Максимальное количество символов — 60. Максимальная длина: `60`.

whatsappMessage.template.components[].parameters[].order_status.order.subtotal

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальное количество символов — 60. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для обозначения поощрительных заказов. Если заказ поощрительный, продавцу необходимо указать эту информацию. Максимальное количество символов — 60. Максимальная длина: `60`.

whatsappMessage.template.components[].parameters[].order_status.order.tax

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальное количество символов — 60. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для обозначения поощрительных заказов. Если заказ поощрительный, продавцу необходимо указать эту информацию. Максимальное количество символов — 60. Максимальная длина: `60`.

whatsappMessage.template.components[].parameters[].order_status.order.shipping

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальное количество символов — 60. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для описания заказов со скидками и бонусами. Если заказ содержит поощрения, продавцу необходимо указать эту информацию. Максимальный лимит — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].parameters[].order_status.order.discount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на коэффициент смещения (offset). Например, значение ₹12.34 передается как 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальный лимит — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для описания заказов со скидками и бонусами. Если заказ содержит поощрения, продавцу необходимо указать эту информацию. Максимальный лимит — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].parameters[].order_status.order.expiration

Параметр	Тип	Обязательный	Описание
`timestamp`	string	Да	Строка с меткой времени UTC в секундах, указывающая время истечения срока действия заказа. Минимальный порог — 300 секунд.
`description`	string	Нет	Текстовое пояснение срока действия. Максимальная длина: `120`.

whatsappMessage.template.components[].parameters[].location

Параметр	Тип	Обязательный	Описание
`latitude`	number (double)	Да	Широта местоположения.
`longitude`	number (double)	Да	Долгота местоположения.
`name`	string	Нет	Название местоположения.
`address`	string	Нет	Адрес местоположения. Отображается только при наличии `name`.

whatsappMessage.template.components[].cards[]

Параметр	Тип	Обязательный	Описание
`card_index`	integer (int32)	Нет	Обязательный. Порядковый номер карточки в карусели с отсчетом от нуля. 0 означает первую карточку, 1 — вторую и т. д. Минимум: `0`. Максимум: `9`.
`components`	object[]	Нет	Компонент карточки.

whatsappMessage.template.components[].cards[].components[]

Параметр	Тип	Обязательный	Описание
`type`	string	Да	Тип компонента. Значения: `header`, `body`, `button`.
`sub_type`	string	Нет	Обязательно, если type имеет значение `button`. Тип кнопки. `quick_reply`: относится к ранее созданной кнопке быстрого ответа, позволяющей клиенту отправить предопределенное сообщение. `url`: относится к ранее созданной кнопке URL, позволяющей клиенту перейти по URL, созданному путем добавления текстового параметра к предопределенному префиксу URL в шаблоне.
`index`	integer (int32)	Нет	Обязательно, если `type` = `button`. Не используется для других типов. Указывает порядок отображения кнопки, если шаблон использует несколько кнопок. Кнопки индексируются с нуля, поэтому значение 0 задаст отображение кнопки первой, кнопка с индексом 1 появится следующей и т. д. Минимум: `0`. Максимум: `9`.
`parameters`	object[]	Нет	Обязательно, если `type` = `button`, либо если в соответствующем компоненте шаблона присутствуют переменные, либо если формат компонента карточки `HEADER` — медиа (`IMAGE`, `VIDEO`). Массив объектов параметров с содержимым сообщения.

whatsappMessage.template.components[].cards[].components[].parameters[]

Параметр	Тип	Обязательно	Описание
`type`	string	Нет	Обязательно. Тип параметра компонента. `text`: используется, если тип компонента шаблона — `BODY`, либо формат компонента `HEADER` — `TEXT`. `image`: используется, если компонент шаблона `HEADER` — `IMAGE`. `gif`: используется, если компонент шаблона `HEADER` — `GIF`. `video`: используется, если компонент шаблона `HEADER` — `VIDEO`. `document`: используется, если компонент шаблона `HEADER` — `DOCUMENT`. `payload`: используется, если тип кнопки компонента шаблона — `QUICK_REPLY`. `coupon_code`: используется, если тип кнопки компонента шаблона — `COPY_CODE`. `limited_time_offer`: используется, если тип компонента шаблона — `LIMITED_TIME_OFFER`. `action`: используется, если тип кнопки компонента шаблона — `CATALOG`, `MPM`, `FLOW` или `ORDER_DETAILS`. `order_status`: используется, если подкатегория шаблона — `ORDER_STATUS`. `location`: используется, если компонент шаблона `HEADER` — `LOCATION`.
`text`	string	Нет	Обязательно, если `type` = `text`. Текст сообщения. Для компонента заголовка лимит составляет 60 символов. Для компонента тела лимит составляет 1024 символа. Для кнопок с URL указывает суффикс, заданный разработчиком, который добавляется к предварительно определенному префиксу URL в шаблоне.
`payload`	string	Нет	Обязательно для кнопок `quick_reply`. Задаваемая разработчиком полезная нагрузка (payload), возвращаемая при нажатии на кнопку в дополнение к отображаемому тексту на кнопке.
`coupon_code`	string	Нет	Обязательно, если `type` = `coupon_code`. Код купона, копируемый при нажатии клиентом на кнопку.
`image`	object	Нет	Обязательно, если формат шаблона `HEADER` — `IMAGE`.
`gif`	object	Нет	Обязательно, если формат шаблона `HEADER` — `GIF`.
`video`	object	Нет	Обязательно, если формат шаблона `HEADER` — `VIDEO`.
`document`	object	Нет	Обязательно, если формат шаблона `HEADER` — `DOCUMENT`.
`limited_time_offer`	object	Нет	Обязательно, если шаблон использует сведения об истечении срока действия предложения.
`action`	object	Нет	Обязательно, если шаблон использует кнопки каталога или MPM (многотоварных сообщений).
`order_status`	object	Нет	Поля объекта перечислены ниже.
`location`	object	Нет	Обязательно, если `type` = `location`.

whatsappMessage.template.components[].cards[].components[].parameters[].image

Параметр	Тип	Обязательно	Описание
`id`	string	Нет	Используйте это, когда медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный из WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только URL-адреса HTTP/HTTPS. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать актуальность контента, добавьте к URL случайные параметры запроса. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применяется в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для указанного документа. Используется только с медиафайлами типа `document`.

whatsappMessage.template.components[].cards[].components[].parameters[].gif

Параметр	Тип	Обязательно	Описание
`id`	string	Нет	Используйте это, когда медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный из WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только URL-адреса HTTP/HTTPS. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать актуальность контента, добавьте к URL случайные параметры запроса. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применяется в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для указанного документа. Используется только с медиафайлами типа `document`.

whatsappMessage.template.components[].cards[].components[].parameters[].video

Параметр	Тип	Обязательно	Описание
`id`	string	Нет	Используйте это, когда медиафайлы загружаются на серверы WhatsApp. Укажите ID медиаобъекта, полученный через WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайлов напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только URL-адреса HTTP/HTTPS. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать получение актуального содержимого, добавьте к URL случайные параметры строки запроса. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применимо в `header` сообщений типа `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для указанного документа. Используется только с медиафайлами `document`.

whatsappMessage.template.components[].cards[].components[].parameters[].document

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте это, когда медиафайлы загружаются на серверы WhatsApp. Укажите ID медиаобъекта, полученный через WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайлов напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только URL-адреса HTTP/HTTPS. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать получение актуального содержимого, добавьте к URL случайные параметры строки запроса. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применимо в `header` сообщений типа `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для указанного документа. Используется только с медиафайлами `document`.

whatsappMessage.template.components[].cards[].components[].parameters[].limited_time_offer

Параметр	Тип	Обязательный	Описание
`expiration_time_ms`	integer (int64)	Нет	Обязательный параметр. Время истечения срока действия промокода в формате UNIX-timestamp в миллисекундах.

whatsappMessage.template.components[].cards[].components[].parameters[].action

Параметр	Тип	Обязательный	Описание
`thumbnail_product_retailer_id`	string	Нет	Необязательный параметр. Используется для шаблонных сообщений каталога и MPM. Артикул товара (SKU). В Commerce Manager обозначается как Content ID. Миниатюра этого товара будет использоваться в качестве изображения заголовка сообщения. Если объект `parameters` опущен, будет использовано изображение первого товара из вашего каталога.
`sections`	object[]	Нет	Используется для MPM-шаблонов. Секции товаров. Можно указать до 10 секций.
`flow_token`	string	Нет	Используется для кнопок `FLOW`. Токен Flow, генерируемый компанией для использования в качестве идентификатора. По умолчанию: `unused`.
`flow_action_data`	object	Нет	Используется для кнопок `FLOW`. JSON-объект с полезной нагрузкой данных для первого экрана.
`order_details`	object	Нет	Обязательно для кнопок `order_details`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.sections[]

Параметр	Тип	Обязательный	Описание
`title`	string	Нет	Текст заголовка раздела. Максимум 24 символа. Markdown не поддерживается. Максимальная длина: `24`.
`product_items`	object[]	Нет	Массив SKU товаров. Минимум 1 товар на раздел и максимум 30 товаров во всех разделах.

whatsappMessage.template.components[].cards[].components[].parameters[].action.sections[].product_items[]

Параметр	Тип	Обязательный	Описание
`product_retailer_id`	string	Нет	SKU товара, который должен отображаться в разделе. SKU товаров обозначаются как Content ID в Commerce Manager.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details

Параметр	Тип	Обязательный	Описание
`currency`	string	Да	Валюта для этого заказа. В настоящее время единственным поддерживаемым значением является `INR`.
`order`	object	Да	Предоставляет `status`, `items`, `subtotal`, `tax` заказа и т. д.
`reference_id`	string	Да	Уникальный идентификатор заказа, предоставленный компанией. Чувствителен к регистру, не может быть пустой строкой, может содержать только латинские буквы, цифры, знаки подчеркивания, дефисы или точки и не должен превышать 35 символов. `reference_id` должен быть уникальным для каждого сообщения order_details определенной компании. Если необходимо отправить несколько сообщений order_details для одного и того же заказа, рекомендуется включить порядковый номер в reference_id (например, “BM345A-12”), чтобы обеспечить уникальность reference_id.
`total_amount`	object	Да	Общая сумма заказа.
`type`	string	Да	Тип товаров, оплачиваемых в этом заказе. В настоящее время поддерживаются варианты `digital-goods` и `physical-goods`.
`payment_settings`	object[]	Да	Настройки оплаты для заказа.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order

Параметр	Тип	Обязательный	Описание
`status`	string	Нет	Единственным поддерживаемым значением в сообщении `order_details` является `pending`. В сообщении `order_status` поле `status` может иметь значения: `pending`, `processing`, `partially_shipped`, `shipped`, `completed` или `canceled`.
`type`	string	Нет	Единственное поддерживаемое значение: `quick_pay`. При передаче этого поля мы скрываем кнопку “Review and Pay” и показываем только кнопку “Pay Now” во всплывающем сообщении с деталями заказа.
`catalog_id`	string	Нет	Уникальный идентификатор каталога Facebook, используемого компанией. Если вы не укажете это поле, необходимо предоставить следующие поля внутри объекта items: `country_of_origin`, `importer_name` и `importer_address`.
`items`	object[]	Нет	Массив позиций в заказе.
`subtotal`	object	Нет	Значение должно быть равно сумме `order.amount.value` * `order.amount.quantity`.
`tax`	object	Нет	Информация о налогах для этого заказа.
`shipping`	object	Нет	Стоимость доставки заказа.
`discount`	object	Нет	Сумма скидки для этого заказа.
`expiration`	object	Нет	Срок действия этого заказа.
`description`	string	Нет	Необязательно. Текст для передачи информации о статусе. Может быть полезен при отправке отмены. Максимальный лимит — 120 символов. Максимальная длина: `120`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.items[]

Параметр	Тип	Обязательный	Описание
`retailer_id`	string	Нет	Content ID для товара в заказе из вашего каталога.
`name`	string	Да	Название товара, отображаемое пользователю. Не может превышать 60 символов. Максимальная длина: `60`.
`image`	object	Нет	Пользовательское изображение товара для отображения пользователю.
`amount`	object	Да	Цена за единицу товара.
`sale_amount`	object	Нет	Цена со скидкой за единицу товара. Должна быть меньше исходной суммы. При указании это поле используется для расчета промежуточного итога.
`quantity`	integer (int32)	Да	Количество единиц товара в заказе.
`country_of_origin`	string	Нет	Обязательно, если не указано `catalog_id`. Страна происхождения товара.
`importer_name`	string	Нет	Обязательно, если не указано `catalog_id`. Название компании-импортера.
`importer_address`	string	Нет	Обязательно, если не указано `catalog_id`. Адрес компании-импортера.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.items[].image

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте это, когда медиафайл загружен на серверы WhatsApp. Укажите идентификатор медиаобъекта, полученный через WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только URL с протоколами HTTP/HTTPS. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать получение актуального содержимого, добавьте к URL случайные параметры запроса. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл: `image`, `gif`, `video` или `document`. Неприменимо для сообщений `header` типа `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для указанного документа. Используйте только с медиафайлами `document`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.items[].amount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используется только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используется только для `discount`. Текст, определяющий стимулированные заказы. Если заказ стимулированный, продавцу необходимо указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.items[].sale_amount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используется только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используется только для `discount`. Текст, определяющий стимулированные заказы. Если заказ стимулированный, продавцу необходимо указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.subtotal

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используется только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используется только для `discount`. Текст, определяющий стимулированные заказы. Если заказ стимулированный, продавцу необходимо указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.tax

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на коэффициент offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст для обозначения поощрительных заказов (со скидкой). Если заказ содержит поощрение, продавцу необходимо указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.shipping

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на коэффициент offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст для обозначения поощрительных заказов (со скидкой). Если заказ содержит поощрение, продавцу необходимо указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.discount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на коэффициент offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст для обозначения поощрительных заказов (со скидкой). Если заказ содержит поощрение, продавцу необходимо указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.expiration

Параметр	Тип	Обязательный	Описание
`timestamp`	string	Да	Строка с временной меткой UTC в секундах, указывающая время, когда истекает срок действия заказа. Минимальный порог — 300 секунд.
`description`	string	Нет	Текстовое пояснение истечения срока действия. Максимальная длина: `120`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.total_amount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее значение суммы, умноженное на смещение (offset). Например, ₹12.34 соответствует значению 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения стимулированных заказов. Если заказ поощрительный (со скидкой/бонусом), продавцу необходимо указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.payment_settings[]

Параметр	Тип	Обязательный	Описание
`type`	string	Да	Должно быть установлено значение `payment_gateway`.
`payment_gateway`	object	Да	Объект, описывающий данные платежного аккаунта.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.payment_settings[].payment_gateway

Параметр	Тип	Обязательный	Описание
`type`	string	Да	Тип платежа. Необходимо указать `billdesk`, `razorpay`, `payu` или `zaakpay`, если вы подключили платежный шлюз BillDesk, Razorpay, PayU или Zaakpay для приема платежей.
`configuration_name`	string	Да	Имя предварительно настроенной конфигурации платежей для этого заказа; длина не должна превышать 60 символов. Это значение должно совпадать с конфигурацией платежей, настроенной в WhatsApp Business Manager. Максимальная длина: `60`.
`billdesk`	object	Нет	Дополнительная информация для BillDesk. Пользовательские поля (extra) используются для сохранения любых сведений, относящихся к конкретному заказу. Максимальная длина каждого поля extra составляет 120 символов.
`payu`	object	Нет	Дополнительная информация для PayU. Пользовательские поля (udf) используются для сохранения любых сведений, относящихся к конкретному заказу. Максимальная длина каждого поля UDF составляет 255 символов.
`razorpay`	object	Нет	Дополнительная информация для Razorpay.
`zaakpay`	object	Нет	Дополнительная информация для Zaakpay. Пользовательские поля (extra) используются для сохранения любых сведений, относящихся к конкретному заказу. Максимальная длина каждого поля extra составляет 180 символов.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.payment_settings[].payment_gateway.billdesk

Параметр	Тип	Обязательный	Описание
`additional_info1`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info2`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info3`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info4`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info5`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info6`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info7`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.payment_settings[].payment_gateway.payu

Параметр	Тип	Обязательный	Описание
`udf1`	string	Нет	Пользовательская информация об этом заказе для PayU. Максимальная длина: `255` символов.
`udf2`	string	Нет	Пользовательская информация об этом заказе для PayU. Максимальная длина: `255` символов.
`udf3`	string	Нет	Пользовательская информация об этом заказе для PayU. Максимальная длина: `255` символов.
`udf4`	string	Нет	Пользовательская информация об этом заказе для PayU. Максимальная длина: `255` символов.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.payment_settings[].payment_gateway.razorpay

Параметр	Тип	Обязательный	Описание
`receipt`	string	Нет	Номер квитанции, соответствующий этому заказу, заданный для внутреннего использования. Поддерживается максимальная длина до 40 символов, минимальная длина должна быть больше 0 символов.
`notes`	object	Нет	Объект может содержать пары «ключ-значение» максимум с 15 ключами, при этом длина каждого значения ограничена 256 символами.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.payment_settings[].payment_gateway.zaakpay

Параметр	Тип	Обязательный	Описание
`extra1`	string	Нет	Пользовательская информация об этом заказе для Zaakpay. Максимальная длина: `180` символов.
`extra2`	string	Нет	Пользовательская информация об этом заказе для Zaakpay. Максимальная длина: `180` символов.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status

Параметр	Тип	Обязательный	Описание
`reference_id`	string	Нет	Уникальный идентификатор заказа, предоставленный компанией.
`order`	object	Нет	Предоставляет только `status` и `description` этого заказа для сообщений `order_status`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order

Параметр	Тип	Обязательный	Описание
`status`	string	Нет	Единственное поддерживаемое значение в сообщении `order_details` — `pending`. В сообщении `order_status` поле `status` может быть: `pending`, `processing`, `partially_shipped`, `shipped`, `completed` или `canceled`.
`type`	string	Нет	Единственное поддерживаемое значение — `quick_pay`. Когда это поле передано, мы скрываем кнопку «Review and Pay» и отображаем только кнопку «Pay Now» во всплывающем блоке сведений о заказе.
`catalog_id`	string	Нет	Уникальный идентификатор каталога Facebook, используемого бизнесом. Если вы не укажете это поле, вы должны указать следующие поля внутри объекта items: `country_of_origin`, `importer_name` и `importer_address`.
`items`	object[]	Нет	Массив позиций в заказе.
`subtotal`	object	Нет	Значение должно быть равно сумме `order.amount.value` * `order.amount.quantity`.
`tax`	object	Нет	Информация о налогах для этого заказа.
`shipping`	object	Нет	Стоимость доставки заказа.
`discount`	object	Нет	Сумма скидки для этого заказа.
`expiration`	object	Нет	Срок действия этого заказа.
`description`	string	Нет	Необязательно. Текст для передачи информации, связанной со статусом. Может быть полезен при отправке отмены. Максимальный лимит составляет 120 символов. Максимальная длина: `120`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.items[]

Параметр	Тип	Обязательный	Описание
`retailer_id`	string	Нет	Идентификатор контента (Content ID) для позиции в заказе из вашего каталога.
`name`	string	Да	Название позиции для отображения пользователю. Не может превышать 60 символов. Максимальная длина: `60`.
`image`	object	Нет	Пользовательское изображение позиции для отображения пользователю.
`amount`	object	Да	Цена за единицу товара.
`sale_amount`	object	Нет	Цена со скидкой за единицу товара. Она должна быть меньше исходной суммы. Если указано, это поле используется для расчета промежуточного итога.
`quantity`	integer (int32)	Да	Количество позиций в заказе.
`country_of_origin`	string	Нет	Обязательно, если не указано поле `catalog_id`. Страна происхождения товара.
`importer_name`	string	Нет	Обязательно, если не указано поле `catalog_id`. Название компании-импортера.
`importer_address`	string	Нет	Обязательно, если не указано поле `catalog_id`. Адрес компании-импортера.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.items[].image

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте это, когда медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный через WhatsApp API загрузки медиафайлов (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`.
`link`	string	Нет	Используйте это поле при отправке медиафайлов напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только с URL-адресами HTTP/HTTPS. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать получение самого актуального контента, добавляйте к URL случайные параметры запроса. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применяется в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для конкретного документа. Используется только с медиафайлами `document`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.items[].amount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на смещение (offset). Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.items[].sale_amount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на смещение (offset). Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.subtotal

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на смещение (offset). Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальный лимит — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.tax

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее значение суммы, умноженное на смещение (offset). Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальный лимит — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальный лимит — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.shipping

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее значение суммы, умноженное на смещение (offset). Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальный лимит — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальный лимит — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.discount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее значение суммы, умноженное на смещение (offset). Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальный лимит — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальный лимит — 60 символов. Максимальная длина: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.expiration

Параметр	Тип	Обязательный	Описание
`timestamp`	string	Да	Строка с меткой времени UTC в секундах, указывающая время истечения срока действия заказа. Минимальный порог составляет 300 секунд.
`description`	string	Нет	Текстовое объяснение причины истечения срока действия. Максимальная длина: `120`.

whatsappMessage.template.components[].cards[].components[].parameters[].location

Параметр	Тип	Обязательный	Описание
`latitude`	number (double)	Да	Широта местоположения.
`longitude`	number (double)	Да	Долгота местоположения.
`name`	string	Нет	Название местоположения.
`address`	string	Нет	Адрес местоположения. Отображается только при наличии `name`.

whatsappMessage.text

Параметр	Тип	Обязательный	Описание
`body`	string	Да	Обязательно для текстовых сообщений. Текст текстового сообщения, который может содержать URL-адреса, начинающиеся с http:// или https://, а также форматирование. Ознакомьтесь с доступными вариантами форматирования здесь. Если вы включаете URL-адреса в текст и хотите добавить блок предварительного просмотра в текстовые сообщения (preview_url: true), убедитесь, что URL-адрес начинается с http:// или https:// — предпочтительны адреса с https://. Необходимо указать имя хоста, так как IP-адреса не распознаются. Максимальная длина: 4096 символов. Максимальная длина: `4096`.
`preview_url`	boolean	Нет	По умолчанию WhatsApp распознает URL-адреса и делает их кликабельными, но вы также можете включить блок предварительного просмотра с дополнительной информацией о ссылке. Установите для этого поля значение true, если хотите включить блок предварительного просмотра URL. В большинстве случаев получатель увидит URL-адрес, по которому можно перейти, когда вы отправляете URL, устанавливаете для preview_url значение true и передаете объект body со ссылкой http или https. Предварительный просмотр URL отображается только после выполнения одного из следующих условий: Бизнес отправил пользователю шаблон сообщения. Пользователь начинает переписку по ссылке «чат в один клик». Пользователь добавляет номер телефона бизнеса в свою адресную книгу и начинает переписку. По умолчанию: `false`.

whatsappMessage.image

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте это, когда медиафайл загружен на серверы WhatsApp. Укажите идентификатор медиаобъекта, полученный через WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайлов напрямую со своего сервера. Протокол и URL отправляемого медиафайла. Используйте только с HTTP/HTTPS URL. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать получение актуального содержимого, добавьте к URL случайные параметры строки запроса. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, `id` имеет приоритет, а `link` игнорируется.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применяется в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для указанного документа. Используется только с медиафайлами `document`.

whatsappMessage.video

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте этот параметр, если медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный из WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание. Необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте этот параметр при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только с URL-адресами HTTP/HTTPS. Примечание. WhatsApp Cloud API кеширует медиаресурсы на 10 минут. Чтобы гарантировать получение актуального содержимого, добавьте к URL случайные параметры запроса. Примечание. Необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применяется в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Задает имя файла для конкретного документа. Используйте только для медиафайлов `document`.

whatsappMessage.audio

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте этот параметр, если медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный из WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание. Необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте этот параметр при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только с URL-адресами HTTP/HTTPS. Примечание. WhatsApp Cloud API кеширует медиаресурсы на 10 минут. Чтобы гарантировать получение актуального содержимого, добавьте к URL случайные параметры запроса. Примечание. Необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применяется в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Задает имя файла для конкретного документа. Используйте только для медиафайлов `document`.

whatsappMessage.document

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте этот параметр, если медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный из WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание. Необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте этот параметр при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только с URL-адресами HTTP/HTTPS. Примечание. WhatsApp Cloud API кеширует медиаресурсы на 10 минут. Чтобы гарантировать получение актуального содержимого, добавьте к URL случайные параметры запроса. Примечание. Необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл: `image`, `gif`, `video` или `document`. Не применимо в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для конкретного документа. Используется только с медиафайлами `document`.

whatsappMessage.sticker

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте это, когда медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный из WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только с URL HTTP/HTTPS. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать актуальность контента, добавьте к URL случайные параметры запроса. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл: `image`, `gif`, `video` или `document`. Не применимо в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для конкретного документа. Используется только с медиафайлами `document`.

whatsappMessage.location

Параметр	Тип	Обязательный	Описание
`latitude`	number (double)	Да	Широта местоположения.
`longitude`	number (double)	Да	Долгота местоположения.
`name`	string	Нет	Название местоположения.
`address`	string	Нет	Адрес местоположения. Отображается только в том случае, если присутствует `name`.

whatsappMessage.interactive

Параметр	Тип	Обязательный	Описание
`type`	string	Нет	Обязательный. Тип интерактивного сообщения, которое вы хотите отправить. `button`: используется для Reply Buttons. `list`: используется для List Messages. `cta_url`: используется для Call-To-Action (CTA) URL Button Messages. `product`: используется для Single Product Messages. `product_list`: используется для Multi-Product Messages. `catalog_message`: используется для Catalog Messages. `location_request_message`: используется для Location Request Messages. `order_details`: используется для Order Details Messages. `order_status`: используется для Order Status Messages. `voice_call`: используется для Voice Call Messages. `flow`: используется для Flow Messages.
`action`	object	Нет	Обязательный. Действие, которое должен выполнить пользователь после прочтения сообщения `interactive`.
`body`	object	Нет	Необязательно для типа `product`. Обязательно для других типов сообщений.
`header`	object	Нет	Обязательно для типа `product_list`. Необязательно для других типов.
`footer`	object	Нет	Необязательно. Объект с нижним колонтитулом (footer) сообщения.

whatsappMessage.interactive.action

Параметр	Тип	Обязательный	Описание
`buttons`	object[]	Нет	Обязательно для кнопок ответа (Reply Buttons). Можно добавить до 3 кнопок.
`button`	string	Нет	Обязательно для сообщений со списком (List Messages). Текст кнопки. Не может быть пустой строкой и должен быть уникальным в пределах сообщения. Эмодзи поддерживаются, форматирование markdown — нет. Максимальная длина: 20 символов. Максимальная длина: `20`.
`catalog_id`	string	Нет	Обязательно для сообщений с одним товаром (Single Product Messages) и несколькими товарами (Multi-Product Messages). Уникальный идентификатор каталога Facebook, привязанного к вашему WhatsApp Business Account. Этот ID можно получить через Meta Commerce Manager.
`product_retailer_id`	string	Нет	Обязательно для сообщений с одним товаром (Single Product Messages) и несколькими товарами (Multi-Product Messages). Уникальный идентификатор товара в каталоге.
`sections`	object[]	Нет	Обязательно для сообщений со списком (List Messages) и сообщений с несколькими товарами (Multi-Product Messages). Массив объектов разделов. Минимум 1, максимум 10.
`name`	string	Нет	Название действия. Обязательно для кнопок с призывом к действию (CTA). `cta_url`: используется для кнопок-ссылок с призывом к действию (CTA URL). `catalog_message`: используется для сообщений каталога (Catalog Messages). `send_location`: используется для кнопок запроса геопозиции (Location Request). `flow`: используется для кнопок Flow. `review_and_pay`: используется для кнопок деталей заказа (Order Details). `review_order`: используется для кнопок статуса заказа (Order Status). `voice_call`: используется для кнопок голосового вызова (Voice Call).
`parameters`	object	Нет	Параметры действия. Обязательно для кнопок с призывом к действию (CTA).

whatsappMessage.interactive.action.buttons[]

Параметр	Тип	Обязательный	Описание
`type`	string	Нет	Единственный поддерживаемый тип — `reply` (для кнопки ответа Reply Button).
`reply`	object	Нет	Поля объекта перечислены ниже.

whatsappMessage.interactive.action.buttons[].reply

Параметр	Тип	Обязательный	Описание
`title`	string	Нет	Заголовок кнопки. Не может быть пустой строкой и должен быть уникальным в пределах сообщения. Эмодзи поддерживаются, форматирование markdown — нет. Максимальная длина: 20 символов. Максимальная длина: `20`.
`id`	string	Нет	Уникальный идентификатор кнопки. Этот ID возвращается в Webhook при нажатии кнопки пользователем. Максимальная длина: 256 символов. Пробелы в начале или конце идентификатора не допускаются. Максимальная длина: `256`.

whatsappMessage.interactive.action.sections[]

Параметр	Тип	Обязательный	Описание
`title`	string	Нет	Обязательно, если сообщение содержит более одного раздела. Заголовок раздела. Максимальная длина: 24 символа. Максимальная длина: `24`.
`rows`	object[]	Нет	Содержит список строк. Во всех разделах в сумме может быть до 10 строк. У каждой строки должен быть заголовок (максимальная длина: 24 символа) и ID (максимальная длина: 200 символов). Вы можете добавить описание (максимальная длина: 72 символа), но оно необязательно.
`product_items`	object[]	Нет	Обязательно для сообщений с несколькими товарами (Multi-Product Messages). Массив объектов товаров. Минимум 1 товар на секцию и максимум 30 товаров во всех секциях.

whatsappMessage.interactive.action.sections[].rows[]

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Уникальный идентификатор строки. Максимальная длина: 200 символов. Максимальная длина: `200`.
`title`	string	Нет	Текст заголовка строки. Максимальная длина: 24 символа. Максимальная длина: `24`.
`description`	string	Нет	Текст описания строки. Максимальная длина: 72 символа. Максимальная длина: `72`.

whatsappMessage.interactive.action.sections[].product_items[]

Параметр	Тип	Обязательный	Описание
`product_retailer_id`	string	Нет	Обязательно для сообщений с несколькими товарами (Multi-Product Messages). Уникальный идентификатор товара в каталоге.

whatsappMessage.interactive.action.parameters

Параметр	Тип	Обязательный	Описание
`display_text`	string	Нет	Текст кнопки CTA URL. Максимальная длина: 20 байт. Максимальная длина: `20`.
`url`	string	Нет	URL кнопки CTA URL.
`thumbnail_product_retailer_id`	string	Нет	Артикул (SKU) товара. Имеет метку Content ID в Commerce Manager. Миниатюра этого товара будет использоваться в качестве изображения заголовка сообщения.
`flow_message_version`	string	Нет	Используется для кнопок `flow`. Значение должно быть “3”.
`flow_token`	string	Нет	Используется для кнопок `flow`. Токен Flow, создаваемый компанией для использования в качестве идентификатора. По умолчанию: `unused`.
`flow_id`	string	Нет	Условно обязательно для кнопок `flow`. Уникальный идентификатор Flow, предоставленный WhatsApp. Не может использоваться вместе с параметром `flow_name`.
`flow_name`	string	Нет	Условно обязательно для кнопок `flow`. Название созданного вами Flow. Не может использоваться вместе с параметром `flow_id`. При изменении названия Flow потребуется обновить этот параметр в соответствии с новым названием.
`flow_cta`	string	Нет	Обязательно для кнопок `flow`. Текст на кнопке CTA. Например: “Open flow!”. Максимальная длина: 20 символов. Максимальная длина: `20`.
`flow_action`	string	Нет	Используется для кнопок `flow`. Либо `navigate`, либо `data_exchange`. По умолчанию: `navigate`.
`flow_action_payload`	object	Нет	Обязательно, если `flow_action` имеет значение `navigate`. В противном случае параметр должен быть опущен.
`reference_id`	string	Нет	Обязательно для кнопок `review_ и _pay`. Уникальный идентификатор заказа, предоставляемый компанией. Чувствителен к регистру, не может быть пустой строкой, может содержать только латинские буквы, цифры, знаки подчеркивания, дефисы или точки и не должен превышать 35 символов. Параметр `reference_id` должен быть уникальным для каждого сообщения order_details для данной компании. Если необходимо отправить несколько сообщений order_details для одного и того же заказа, рекомендуется включить порядковый номер в reference_id (например, “BM345A-12”) для обеспечения уникальности reference_id.
`type`	string	Нет	Обязательно для кнопок `review_and_pay`. Тип товаров, оплачиваемых в этом заказе. В настоящее время поддерживаются варианты `digital-goods` и `physical-goods`.
`beneficiaries`	object[]	Нет	Обязательно для кнопок `review_and_pay`. Массив получателей (бенефициаров) для этого заказа. Получатель — это предполагаемый адресат для доставки физических товаров из заказа. Информация о получателе не отображается пользователям, но требуется по юридическим причинам и требованиям комплаенса.
`currency`	string	Нет	Обязательно для кнопок `review_and_pay`. Валюта для этого заказа. В настоящее время единственным поддерживаемым значением является `INR`.
`total_amount`	object	Нет	Обязательно для кнопок `review_and_pay`. Общая сумма для этого заказа.
`order`	object	Нет	Обязательно для кнопок `review_and_pay` или `review_order`. Для кнопок `review_and_pay` предоставляет сведения о заказе: `status`, `items`, `subtotal`, `tax` и т. д. Для кнопок `review_order` предоставляет только `status` и `description` заказа.
`payment_settings`	object[]	Нет	Обязательно для кнопок `review_and_pay`. Параметры оплаты заказа.

whatsappMessage.interactive.action.parameters.flow_action_payload

Параметр	Тип	Обязательный	Описание
`screen`	string	Нет	Идентификатор экрана, отображаемого первым. Он должен быть экраном типа entry .
`data`	object	Нет	Необязательные входные данные для первого экрана Flow. Если указан, этот объект не должен быть пустым.

whatsappMessage.interactive.action.parameters.beneficiaries[]

Параметр	Тип	Обязательный	Описание
`name`	string	Да	Имя физического лица или название компании, получающей физические товары. Длина не может превышать 200 символов. Максимальная длина: `200`.
`address_line1`	string	Да	Адрес доставки (номер дома/корпуса, название улицы и т. д.). Длина не может превышать 100 символов. Максимальная длина: `100`.
`address_line2`	string	Нет	Адрес доставки (ориентир, район и т. д.). Длина не может превышать 100 символов. Максимальная длина: `100`.
`city`	string	Да	Название города.
`state`	string	Да	Название штата/региона.
`country`	string	Да	Название страны. В настоящее время единственным поддерживаемым значением является `India`.
`postal_code`	string	Да	6-значный почтовый индекс адреса доставки. Минимальная длина: `6`. Максимальная длина: `6`.

whatsappMessage.interactive.action.parameters.total_amount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее значение суммы, умноженное на смещение. Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальный лимит символов — 60. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для описания поощрительных заказов. Если заказ поощрительный, продавцу необходимо указать эту информацию. Максимальный лимит символов — 60. Максимальная длина: `60`.

whatsappMessage.interactive.action.parameters.order

Параметр	Тип	Обязательный	Описание
`status`	string	Нет	Единственное поддерживаемое значение в сообщении `order_details` — `pending`. В сообщении `order_status` значение `status` может быть: `pending`, `processing`, `partially_shipped`, `shipped`, `completed` или `canceled`.
`type`	string	Нет	Единственное поддерживаемое значение — `quick_pay`. При передаче этого поля кнопка «Review and Pay» скрывается, и в блоке с деталями заказа отображается только кнопка «Pay Now».
`catalog_id`	string	Нет	Уникальный идентификатор каталога Facebook, используемого компанией. Если вы не укажете это поле, необходимо передать следующие поля внутри объекта items: `country_of_origin`, `importer_name` и `importer_address`.
`items`	object[]	Нет	Массив позиций в заказе.
`subtotal`	object	Нет	Значение должно быть равно сумме `order.amount.value` * `order.amount.quantity`.
`tax`	object	Нет	Информация о налогах для этого заказа.
`shipping`	object	Нет	Стоимость доставки заказа.
`discount`	object	Нет	Сумма скидки для этого заказа.
`expiration`	object	Нет	Срок действия этого заказа.
`description`	string	Нет	Необязательно. Текст для передачи информации о статусе. Может быть полезен при отправке отмены. Максимальный лимит символов — 120. Максимальная длина: `120`.

whatsappMessage.interactive.action.parameters.order.items[]

Параметр	Тип	Обязательный	Описание
`retailer_id`	string	Нет	Идентификатор контента для позиции в заказе из вашего каталога.
`name`	string	Да	Название позиции, отображаемое пользователю. Не может превышать 60 символов. Максимальная длина: `60`.
`image`	object	Нет	Пользовательское изображение для позиции, отображаемое пользователю.
`amount`	object	Да	Цена за единицу товара.
`sale_amount`	object	Нет	Цена за единицу товара со скидкой. Должна быть меньше исходной стоимости. Если поле указано, оно используется для расчета промежуточного итога.
`quantity`	integer (int32)	Да	Количество позиций в заказе.
`country_of_origin`	string	Нет	Обязательно, если `catalog_id` отсутствует. Страна происхождения продукта.
`importer_name`	string	Нет	Обязательно, если `catalog_id` отсутствует. Название компании-импортера.
`importer_address`	string	Нет	Обязательно, если `catalog_id` отсутствует. Адрес компании-импортера.

whatsappMessage.interactive.action.parameters.order.items[].image

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте это, когда медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный из WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте это при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только с URL HTTP/HTTPS. Примечание: WhatsApp Cloud API кэширует медиаресурсы на 10 минут. Чтобы гарантировать получение актуального контента, добавляйте случайные строки параметров запроса (query strings) к URL. Примечание: необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применяется в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для конкретного документа. Используйте только для медиафайлов типа `document`.

whatsappMessage.interactive.action.parameters.order.items[].amount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, значение для ₹12.34 равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальный лимит — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения стимулированных заказов. Если заказ является стимулированным, продавцу необходимо указать эту информацию. Максимальный лимит — 60 символов. Максимальная длина: `60`.

whatsappMessage.interactive.action.parameters.order.items[].sale_amount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, значение для ₹12.34 равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальный лимит — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения стимулированных заказов. Если заказ является стимулированным, продавцу необходимо указать эту информацию. Максимальный лимит — 60 символов. Максимальная длина: `60`.

whatsappMessage.interactive.action.parameters.order.subtotal

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, значение для ₹12.34 равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для обозначения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.interactive.action.parameters.order.tax

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для обозначения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.interactive.action.parameters.order.shipping

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для обозначения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.interactive.action.parameters.order.discount

Параметр	Тип	Обязательный	Описание
`offset`	integer (int32)	Да	Должно быть `100` для `INR`.
`value`	integer (int32)	Да	Положительное целое число, представляющее сумму, умноженную на offset. Например, для ₹12.34 значение равно 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для обозначения поощрительных заказов. Если заказ поощрительный, продавец должен указать эту информацию. Максимальная длина — 60 символов. Максимальная длина: `60`.

whatsappMessage.interactive.action.parameters.order.expiration

Параметр	Тип	Обязательный	Описание
`timestamp`	string	Да	Строка с меткой времени UTC в секундах, указывающая время истечения срока действия заказа. Минимальный порог — 300 секунд.
`description`	string	Нет	Текстовое пояснение истечения срока действия. Максимальная длина: `120`.

whatsappMessage.interactive.action.parameters.payment_settings[]

Параметр	Тип	Обязательный	Описание
`type`	string	Да	Должно иметь значение `payment_gateway`.
`payment_gateway`	object	Да	Объект, содержащий информацию о платежном аккаунте.

whatsappMessage.interactive.action.parameters.payment_settings[].payment_gateway

Параметр	Тип	Обязательный	Описание
`type`	string	Да	Тип платежа. Необходимо указать `billdesk`, `razorpay`, `payu` или `zaakpay`, если вы подключили платежный шлюз BillDesk, Razorpay, PayU или Zaakpay для приема платежей.
`configuration_name`	string	Да	Название предварительно настроенной конфигурации платежей, используемой для этого заказа; длина не должна превышать 60 символов. Это значение должно совпадать с конфигурацией платежей, настроенной в WhatsApp Business Manager. Максимальная длина: `60`.
`billdesk`	object	Нет	Дополнительная информация для BillDesk. Пользовательские поля (extra) используются для хранения любой информации, относящейся к конкретному заказу. Каждое поле extra может содержать не более 120 символов.
`payu`	object	Нет	Дополнительная информация для PayU. Пользовательские поля (udf) используются для хранения любой информации, относящейся к конкретному заказу. Каждое поле UDF может содержать не более 255 символов.
`razorpay`	object	Нет	Дополнительная информация для Razorpay.
`zaakpay`	object	Нет	Дополнительная информация для Zaakpay. Пользовательские поля (extra) используются для хранения любой информации, относящейся к конкретному заказу. Каждое поле extra может содержать не более 180 символов.

whatsappMessage.interactive.action.parameters.payment_settings[].payment_gateway.billdesk

Параметр	Тип	Обязательный	Описание
`additional_info1`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info2`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info3`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info4`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info5`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info6`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.
`additional_info7`	string	Нет	Пользовательская информация об этом заказе для BillDesk. Максимальная длина: `120` символов.

whatsappMessage.interactive.action.parameters.payment_settings[].payment_gateway.payu

Параметр	Тип	Обязательный	Описание
`udf1`	string	Нет	Пользовательская информация об этом заказе для PayU. Максимальная длина: `255` символов.
`udf2`	string	Нет	Пользовательская информация об этом заказе для PayU. Максимальная длина: `255` символов.
`udf3`	string	Нет	Пользовательская информация об этом заказе для PayU. Максимальная длина: `255` символов.
`udf4`	string	Нет	Пользовательская информация об этом заказе для PayU. Максимальная длина: `255` символов.

whatsappMessage.interactive.action.parameters.payment_settings[].payment_gateway.razorpay

Параметр	Тип	Обязательный	Описание
`receipt`	string	Нет	Номер квитанции, соответствующий этому заказу, задаваемый для вашей внутренней отчетности. Поддерживается максимальная длина 40 символов при минимальной длине более 0 символов.
`notes`	object	Нет	Объект может представлять собой пары «ключ-значение» максимум с 15 ключами, при этом длина каждого значения ограничена 256 символами.

whatsappMessage.interactive.action.parameters.payment_settings[].payment_gateway.zaakpay

Параметр	Тип	Обязательный	Описание
`extra1`	string	Нет	Пользовательская информация об этом заказе для Zaakpay. Максимальная длина: `180` символов.
`extra2`	string	Нет	Пользовательская информация об этом заказе для Zaakpay. Максимальная длина: `180` символов.

whatsappMessage.interactive.body

Параметр	Тип	Обязательный	Описание
`text`	string	Нет	Основной текст сообщения. Поддерживаются эмодзи и markdown. Максимальная длина: 1024 символа. Максимальная длина: `1024`.

whatsappMessage.interactive.header

Параметр	Тип	Обязательный	Описание
`type`	string	Нет	Обязательно. Тип заголовка, который вы хотите использовать. `text`: используется для сообщений со списком (List Messages), кнопок ответа (Reply Buttons) и сообщений с несколькими товарами (Multi-Product Messages). `video`: используется для кнопок ответа (Reply Buttons). `image`: используется для кнопок ответа (Reply Buttons). `document`: используется для кнопок ответа (Reply Buttons).
`text`	string	Нет	Текст для заголовка. Форматирование поддерживает эмодзи, но не markdown. Максимальная длина: `60`.
`image`	object	Нет	Используется для сообщений типа `image`, `gif`, `video`, `audio`, `document` или `sticker`. См. также Поддерживаемые типы медиафайлов.
`video`	object	Нет	Используется для сообщений типа `image`, `gif`, `video`, `audio`, `document` или `sticker`. См. также Поддерживаемые типы медиафайлов.
`document`	object	Нет	Используется для сообщений типа `image`, `gif`, `video`, `audio`, `document` или `sticker`. См. также Поддерживаемые типы медиафайлов.

whatsappMessage.interactive.header.image

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте этот параметр, если медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный из WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание. Необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте этот параметр при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только URL-адреса HTTP/HTTPS. Примечание. WhatsApp Cloud API кеширует медиаресурсы на 10 минут. Чтобы гарантировать получение актуального контента, добавляйте к URL случайные параметры запроса. Примечание. Необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применяется в `header` сообщений типа `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для конкретного документа. Используется только с медиафайлами типа `document`.

whatsappMessage.interactive.header.video

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте этот параметр, если медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный из WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание. Необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте этот параметр при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только URL-адреса HTTP/HTTPS. Примечание. WhatsApp Cloud API кеширует медиаресурсы на 10 минут. Чтобы гарантировать получение актуального контента, добавляйте к URL случайные параметры запроса. Примечание. Необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применяется в `header` сообщений типа `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для конкретного документа. Используется только с медиафайлами типа `document`.

whatsappMessage.interactive.header.document

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте этот параметр, если медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный из WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Примечание. Необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`.
`link`	string	Нет	Используйте этот параметр при отправке медиафайла напрямую с вашего сервера. Протокол и URL отправляемого медиафайла. Используйте только URL-адреса HTTP/HTTPS. Примечание. WhatsApp Cloud API кеширует медиаресурсы на 10 минут. Чтобы гарантировать получение актуального контента, добавляйте к URL случайные параметры запроса. Примечание. Необходимо указать либо `id`, либо `link`. Если указаны оба параметра, приоритет имеет `id`, а `link` будет проигнорирован.
`caption`	string	Нет	Описывает указанный медиафайл `image`, `gif`, `video` или `document`. Не применимо в `header` сообщений `template` или `interactive`.
`filename`	string	Нет	Описывает имя файла для конкретного документа. Используется только с медиафайлами `document`.

whatsappMessage.interactive.footer

Параметр	Тип	Обязательный	Описание
`text`	string	Нет	Содержимое нижнего колонтитула (footer). Поддерживаются эмодзи и markdown. Поддерживаются ссылки. Максимальная длина: 60 символов. Максимальная длина: `60`.

whatsappMessage.contacts[]

Параметр	Тип	Обязательный	Описание
`addresses`	object[]	Нет	Элементы массива описаны ниже.
`birthday`	string	Нет	Строка в формате `YYYY-MM-DD`.
`emails`	object[]	Нет	Элементы массива описаны ниже.
`name`	object	Да	Полное имя контакта, отформатированное как объект name.
`org`	object	Нет	Информация об организации контакта, отформатированная как объект org.
`phones`	object[]	Нет	Номер(а) телефона контакта, отформатированные как объект phone.
`urls`	object[]	Нет	URL-адрес(а) контакта, отформатированные как объект urls.
`vcard`	string	Нет	Необязательная визитная карточка vCard, переданная вместе с полезной нагрузкой общего контакта.
`origin`	string	Нет	Устанавливается в `contact_request`, когда пользователь поделился контактом в ответ на сообщение с запросом контактных данных.

whatsappMessage.contacts[].addresses[]

Параметр	Тип	Обязательный	Описание
`street`	string	Нет	Номер дома и название улицы.
`city`	string	Нет	Название города.
`state`	string	Нет	Аббревиатура штата/региона.
`zip`	string	Нет	Почтовый индекс.
`country`	string	Нет	Полное название страны.
`country_code`	string	Нет	Двухбуквенный код страны.
`type`	string	Нет	Стандартные значения: `HOME` и `WORK`.

whatsappMessage.contacts[].emails[]

Параметр	Тип	Обязательный	Описание
`email`	string	Нет	Адрес электронной почты.
`type`	string	Нет	Стандартные значения: `HOME` и `WORK`.

whatsappMessage.contacts[].name

Параметр	Тип	Обязательный	Описание
`formatted_name`	string	Да	Полное имя в его обычном виде.
`first_name`	string	Нет	Имя.
`last_name`	string	Нет	Фамилия.
`middle_name`	string	Нет	Второе имя (отчество).
`suffix`	string	Нет	Суффикс имени.
`prefix`	string	Нет	Префикс имени.

whatsappMessage.contacts[].org

Параметр	Тип	Обязательный	Описание
`company`	string	Нет	Название компании контакта.
`department`	string	Нет	Название отдела контакта.
`title`	string	Нет	Должность контакта в компании.

whatsappMessage.contacts[].phones[]

Параметр	Тип	Обязательный	Описание
`phone`	string	Нет	Автоматически заполняется значением `wa_id` в виде отформатированного номера телефона.
`type`	string	Нет	Стандартные значения: `CELL`, `MAIN`, `IPHONE`, `HOME` и `WORK`.
`wa_id`	string	Нет	WhatsApp ID.

whatsappMessage.contacts[].urls[]

Параметр	Тип	Обязательный	Описание
`url`	string	Нет	URL.
`type`	string	Нет	Стандартные значения: `HOME` и `WORK`.

whatsappMessage.reaction

Параметр	Тип	Обязательный	Описание
`message_id`	string	Да	Задает `wamid` полученного сообщения, содержавшего реакцию.
`emoji`	string	Нет	Обязательно при отправке сообщения `reaction`. Установите значение `""`, если хотите удалить эмодзи. Необязательно при получении сообщения от пользователя. Это поле передается, когда пользователь реагирует на сообщения с помощью эмодзи. В противном случае это указывает на то, что пользователь удалил эмодзи.

whatsappMessage.context

Параметр	Тип	Обязательный	Описание
`message_id`	string	Нет	Задает `wamid` сообщения, на которое вы отвечаете. `wamid` — это исходный идентификатор сообщения на платформе WhatsApp.

whatsappMessage.whatsappApiError

Параметр	Тип	Обязательный	Описание
`message`	string	Да	Удобочитаемое описание ошибки.
`code`	string	Да	Код ошибки.
`type`	string	Нет	Тип ошибки.
`error_subcode`	string	Нет	Дополнительный код ошибки.
`error_user_msg`	string	Нет	Сообщение для отображения пользователю. Язык сообщения определяется локалью API-запроса.
`error_user_title`	string	Нет	Заголовок диалогового окна, если оно отображается. Язык сообщения определяется локалью API-запроса.
`fbtrace_id`	string	Нет	Внутренний идентификатор службы поддержки. При сообщении об ошибке, связанной с вызовом Graph API, укажите fbtrace_id, чтобы помочь нам найти данные в логах для отладки.
`error_data`	string or object	Нет	Дополнительные данные об ошибке. Строка или ассоциативный массив (map). Для API шаблонов это поле представляет собой строку с описанием причины ошибки. Для API сообщений это поле представляет собой map со свойством `details`, описывающим причину ошибки.

Пример

Следующий фрагмент JSON представляет собой тело, доставленное вашему получателю. Идентификаторы, номера телефонов и другие значения аккаунта приведены в качестве примера.

Входящее сообщение из истории

Входящее сообщение из истории использует whatsappInboundMessage. phase и progress сообщают о синхронизации фрагмента истории.

{
  "id": "evt_example_smb_history_inbound",
  "type": "whatsapp.smb.history",
  "apiVersion": "v2",
  "createTime": "2026-10-09T08:00:00.000Z",
  "phase": 1,
  "progress": 40,
  "whatsappInboundMessage": {
    "id": "INBOUND_MESSAGE_ID",
    "wamid": "wamid.INBOUND_EXAMPLE",
    "wabaId": "WABA_ID",
    "from": "+12025550124",
    "to": "+12025550123",
    "type": "text",
    "text": {
      "body": "What time can I collect my order?"
    },
    "customerProfile": {
      "name": "Example customer"
    },
    "sendTime": "2026-10-08T12:00:00.000Z"
  }
}

Исходящее сообщение из истории

Исходящее сообщение из истории использует whatsappMessage. Не маршрутизируйте его как входящее сообщение.

{
  "id": "evt_example_smb_history_outbound",
  "type": "whatsapp.smb.history",
  "apiVersion": "v2",
  "createTime": "2026-10-09T08:00:00.000Z",
  "phase": 1,
  "progress": 60,
  "whatsappMessage": {
    "id": "MESSAGE_ID",
    "wamid": "wamid.EXAMPLE",
    "wabaId": "WABA_ID",
    "from": "+12025550124",
    "to": "+12025550123",
    "type": "text",
    "text": {
      "body": "Your order is ready for pickup."
    },
    "status": "sent",
    "createTime": "2026-10-08T12:00:00.000Z",
    "sendTime": "2026-10-08T12:00:00.000Z"
  }
}

Ход синхронизации истории

Фрагмент истории, содержащий только метаданные, сообщает о phase и progress без какого-либо объекта сообщения. Не обрабатывайте эту структуру данных как полезную нагрузку создания или дублирования (эха) сообщения.

{
  "id": "evt_example_smb_history_progress",
  "type": "whatsapp.smb.history",
  "apiVersion": "v2",
  "createTime": "2026-10-09T08:00:00.000Z",
  "phase": 1,
  "progress": 73
}

Входящее текстовое сообщение

{
  "id": "evt_eEkn26qar3nOB8md",
  "type": "whatsapp.smb.history",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "phase": 1,
  "progress": 40,
  "whatsappInboundMessage": {
    "id": "63f872f6741c165b4342a751",
    "wamid": "wamid.HBgNODi...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId": "US.13491208655302741918",
    "fromParentUserId": "US.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeWick"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "text",
    "text": {
      "body": "OK"
    },
    "context": {
      "from": "+12025550124",
      "id": "wamid.HBgNODr..."
    }
  }
}

Исходящее текстовое сообщение

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.history",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "phase": 1,
  "progress": 40,
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.11815799212886844830",
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "text",
    "text": {
      "body": "Hi there! How can we help?"
    },
    "context": {
      "message_id": "wamid.BgNODYxN..."
    }
  }
}

Фрагмент истории только с ходом выполнения

{
  "id": "evt_progressOnly73",
  "type": "whatsapp.smb.history",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:02.000Z",
  "phase": 1,
  "progress": 73
}

После проверки подписи и надежного приема события верните ответ 2xx. Медленные задачи выполняйте асинхронно.

HTTP/1.1 200 OK

Пошаговые разборы сценариев см. в разделе примеров с пояснениями.

Начало работы

Руководства

Конечные точки

Webhook reference

Триггеры

Синтаксис

Параметры

Конверт события (envelope)

Полезная нагрузка события

whatsappInboundMessage

whatsappMessage

Пример

​Триггеры

​Синтаксис

​Параметры

​Конверт события (envelope)

​Полезная нагрузка события

​whatsappInboundMessage

​whatsappMessage

​Пример

Триггеры

Синтаксис

Параметры

Конверт события (envelope)

Полезная нагрузка события

whatsappInboundMessage

whatsappMessage

Пример