whatsapp.smb.message.echoes

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

Триггеры

Происходит, когда сообщение, отправленное из приложения WhatsApp Business, синхронизируется как эхо-копия. Подпишитесь на whatsapp.smb.message.echoes, когда будете настраивать свою конечную точку Webhook.

Синтаксис

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

{
  "id": "<ID>",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappMessage": {
    "id": "<ID>",
    "wamid": "<WAMID>",
    "wabaId": "<WABA_ID>",
    "from": "<FROM>",
    "to": "<TO>",
    "type": "<TYPE>",
    "text": {
      "body": "<BODY>"
    },
    "status": "<STATUS>",
    "createTime": "<CREATE_TIME>",
    "sendTime": "<SEND_TIME>",
    "toUserId": "<TO_USER_ID>",
    "toParentUserId": "<TO_PARENT_USER_ID>",
    "customerProfile": {
      "username": "<USERNAME>"
    }
  }
}

Параметры

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

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

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

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

Параметр	Тип	Обязательный	Описание
`whatsappMessage`	object	Нет	Специфичная для события полезная нагрузка `whatsappMessage`.

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

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`. См. также Ценообразование на основе переписок.
`type`	string	Нет	Тип исходящего сообщения WhatsApp. См. также Сообщения WhatsApp. Значения: `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`. См. также Поддерживаемые типы медиа.
`video`	object	Нет	Используется для сообщений типа `image`, `gif`, `video`, `audio`, `document` или `sticker`. См. также Поддерживаемые типы медиа.
`audio`	object	Нет	Используется для сообщений типа `image`, `gif`, `video`, `audio`, `document` или `sticker`. См. также Поддерживаемые типы медиа.
`document`	object	Нет	Используется для сообщений типа `image`, `gif`, `video`, `audio`, `document` или `sticker`. См. также Поддерживаемые типы медиа.
`sticker`	object	Нет	Используется для сообщений типа `image`, `gif`, `video`, `audio`, `document` или `sticker`. См. также Поддерживаемые типы медиа.
`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`. Для сообщений с максимальной ценой (Max Price) сумма на момент отправки является расчетной. Используйте событие 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 (Marketing Lite bidding). Его 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	Да	Код используемого языка или локали. Принимает форматы языка и формата язык_локаль (например, 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, которая позволяет клиенту взаимодействовать с 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. Укажите ID медиаобъекта, полученный из 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. Укажите ID медиаобъекта, полученный из 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. Укажите ID медиаобъекта, полученный из 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) товара. В 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[].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	Нет	Идентификатор контента (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[].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-адресу, сформированному путем добавления параметра text к предварительно заданному префиксу 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. Укажите идентификатор медиаобъекта, полученный через 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[].cards[].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[].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 в миллисекундах.

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) позиции, которая должна отображаться в разделе. В Commerce Manager артикулы SKU обозначаются как Content ID .

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`. Текст, определяющий поощряемые заказы (incentivised orders). Если заказ поощряемый, продавец должен указать эту информацию. Максимальная длина — 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`. Текст, определяющий поощряемые заказы (incentivised orders). Если заказ поощряемый, продавец должен указать эту информацию. Максимальная длина — 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`. Текст, определяющий поощряемые заказы (incentivised orders). Если заказ поощряемый, продавец должен указать эту информацию. Максимальная длина — 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 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[].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 отображается только после наступления одного из следующих событий: Компания отправила пользователю шаблон сообщения. Пользователь начал диалог по ссылке «click to chat». Пользователь добавил номер телефона компании в свою адресную книгу и начал диалог. По умолчанию: `false`.

whatsappMessage.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.video

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте этот параметр, если медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный через 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.audio

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте этот параметр, если медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный через 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.document

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте этот параметр, если медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный через 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.sticker

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте этот параметр, когда медиафайл загружен на серверы WhatsApp. Укажите ID медиаобъекта, полученный через 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 минут. Чтобы гарантировать актуальность контента, добавьте случайные строки запроса (query strings) к 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`: используйте для сообщений с кнопкой перехода по ссылке (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.
`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. Этот идентификатор можно получить через 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`: используйте для сообщений каталога. `send_location`: используйте для кнопок запроса геопозиции. `flow`: используйте для кнопок Flow. `review_and_pay`: используйте для кнопок просмотра деталей заказа. `review_order`: используйте для кнопок проверки статуса заказа. `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 символов. Начальные и конечные пробелы при установке ID не допускаются. Максимальная длина: `256`.

whatsappMessage.interactive.action.sections[]

Параметр	Тип	Обязательный	Описание
`title`	string	Нет	Обязательно, если сообщение содержит несколько разделов. Название раздела. Максимальная длина: 24 символа. Максимальная длина: `24`.
`rows`	object[]	Нет	Содержит список строк (rows). Во всех разделах суммарно может быть не более 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`. Массив получателей (beneficiaries) для этого заказа. Получатель — это предполагаемый адресат для доставки физических товаров в заказе. Сведения о получателе не показываются пользователям, но необходимы по юридическим требованиям и правилам соответствия.
`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)	Да	Положительное целое число, представляющее сумму, умноженную на смещение (offset). Например, ₹12.34 имеет значение 1234.
`description`	string	Нет	Используйте только для `tax`, `shipping` или `discount`. Описание суммы. Максимальная длина — 60 символов. Максимальная длина: `60`.
`discount_program_name`	string	Нет	Используйте только для `discount`. Текст, используемый для определения заказов с поощрением (incentivised). Если заказ с поощрением, продавец должен указать эту информацию. Максимальный лимит — 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	Нет	Идентификатор контента (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.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 минут. Чтобы гарантировать получение актуального содержимого, добавьте к 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) используются для хранения любой информации, относящейся к конкретному заказу. Каждое дополнительное поле имеет ограничение максимум 120 символов.
`payu`	object	Нет	Дополнительная информация для PayU. Пользовательские поля (udf) используются для хранения любой информации, относящейся к конкретному заказу. Каждое поле UDF имеет ограничение максимум 255 символов.
`razorpay`	object	Нет	Дополнительная информация для Razorpay.
`zaakpay`	object	Нет	Дополнительная информация для Zaakpay. Пользовательские поля (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	Нет	Содержимое нижнего колонтитула. Поддерживаются эмодзи и разметка 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). Для template API это поле представляет собой строку с описанием причины ошибки. Для message API это поле представляет собой сопоставление (map) со свойством `details`, описывающим причину ошибки.

Пример

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

Текстовое сообщение WhatsApp Business App

Это событие синхронизирует сообщение, отправленное из приложения WhatsApp Business или с поддерживаемого связанного устройства. Получите его содержимое из whatsappMessage.

{
  "id": "evt_example_smb_echoes",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2026-10-09T08:00:00.000Z",
  "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",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "username": "example_customer"
    }
  }
}

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

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.1181579921288684483",
    "customerProfile": {
      "username": "@joee"
    },
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "image",
    "image": {
      "link": "https://example.com/sample",
      "id": "592623615738103"
    }
  }
}

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

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.1181579921288684483",
    "customerProfile": {
      "username": "@joee"
    },
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "video",
    "video": {
      "link": "https://example.com/sample",
      "id": "592623615738103"
    }
  }
}

Исходящее аудиосообщение

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.1181579921288684483",
    "customerProfile": {
      "username": "@joee"
    },
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "audio",
    "audio": {
      "link": "https://example.com/sample",
      "id": "592623615738103"
    }
  }
}

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

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.1181579921288684483",
    "customerProfile": {
      "username": "@joee"
    },
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "document",
    "document": {
      "link": "https://example.com/sample",
      "id": "592623615738103",
      "caption": "图片"
    }
  }
}

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

HTTP/1.1 200 OK

Разбор типовых сценариев см. в примерах с пояснениями.

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

Руководства

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

Webhook reference

whatsapp.smb.message.echoes

Триггеры

Синтаксис

Параметры

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

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

whatsappMessage

Пример

​Триггеры

​Синтаксис

​Параметры

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

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

​whatsappMessage

​Пример

Триггеры

Синтаксис

Параметры

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

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

whatsappMessage

Пример