whatsapp.message.updated

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

Триггеры

Происходит при обновлении статуса исходящего сообщения WhatsApp, когда статус меняется на sent, failed, delivered или read. Подпишитесь на whatsapp.message.updated, когда будете настраивать свою конечную точку Webhook. Используйте whatsappMessage для обновлений отдельных сообщений. Обновления статуса групповых сообщений могут содержать whatsappGroup. Выполните маршрутизацию полезной нагрузки перед чтением полей конкретного сообщения.

Синтаксис

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

{
  "id": "<ID>",
  "type": "whatsapp.message.updated",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappMessage": {
    "id": "<ID>",
    "wabaId": "<WABA_ID>",
    "from": "<FROM>",
    "to": "<TO>",
    "type": "<TYPE>",
    "status": "<STATUS>",
    "pricingCategory": "<PRICING_CATEGORY>",
    "bidPricingFlag": "<BID_PRICING_FLAG_VALUE>",
    "totalPrice": "<TOTAL_PRICE_VALUE>",
    "currency": "<CURRENCY>"
  }
}

Параметры

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

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

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

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

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

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

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`: применяется тарификация за каждое сообщение (Per-message pricing). `CBP`: применяется тарификация на основе переписок (Conversation-based pricing).
`pricingType`	string	Нет	Тип тарификации сообщения. Это поле доступно только в режиме PMP (Per-Message Pricing). `regular`: указывает, что сообщение подлежит оплате. `free_customer_service`: указывает, что сообщение бесплатное, поскольку оно является либо сервисным шаблонным сообщением (utility), либо нешаблонным сообщением, отправленным в рамках окна обслуживания клиентов. `free_entry_point`: указывает, что сообщение бесплатное, поскольку оно является частью переписки с бесплатной точки входа.
`whatsappApiError`	object	Нет	Исходный объект ошибки, возвращенный WhatsApp. См. Handling Errors, Cloud API Error Codes.
`bizType`	string	Нет	Может быть пустым либо принимать одно из значений: `whatsapp` или `verify`. По умолчанию — `whatsapp`. `whatsapp`: указывает, что сообщение отправлено через продукт WhatsApp. `verify`: указывает, что сообщение отправлено через продукт Verify.
`verificationId`	string	Нет	Идентификатор верификации. Включается только в том случае, если `bizType` имеет значение `verify`.
`bidPricingFlag`	boolean	Нет	Имеет значение true, если сообщение определено как аукционное сообщение Marketing Lite. Его pricingCategory имеет значение marketing_lite_bidding.

whatsappMessage.customerProfile

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

whatsappMessage.conversation

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

whatsappMessage.template

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

whatsappMessage.template.language

Параметр	Тип	Обязательный	Описание
`code`	string	Да	Код используемого языка или локали. Принимает форматы языка и язык_локаль (например, en и en_US). Все коды см. в разделе Supported Languages.
`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	No	Обязательно. Тип параметра компонента. `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	No	Обязательно, если `type` = `text`. Текст сообщения. Для компонента заголовка (header) ограничение составляет 60 символов. Для компонента тела (body) ограничение составляет 1024 символа. Для кнопок с URL указывает предоставляемый разработчиком суффикс, который добавляется к предопределенному префиксу URL в шаблоне.
`payload`	string	No	Обязательно для кнопок `quick_reply`. Задаваемые разработчиком полезные данные (payload), возвращаемые при нажатии на кнопку в дополнение к отображаемому тексту на кнопке.
`coupon_code`	string	No	Обязательно, если `type` = `coupon_code`. Промокод, который будет скопирован при нажатии клиентом на кнопку.
`image`	object	No	Обязательно, когда формат `HEADER` шаблона — `IMAGE`.
`gif`	object	No	Обязательно, когда формат `HEADER` шаблона — `GIF`.
`video`	object	No	Обязательно, когда формат `HEADER` шаблона — `VIDEO`.
`document`	object	No	Обязательно, когда формат `HEADER` шаблона — `DOCUMENT`.
`limited_time_offer`	object	No	Обязательно, если шаблон использует сведения об истечении срока действия предложения.
`action`	object	No	Обязательно, если шаблон использует кнопки каталога или MPM (многопродуктовые сообщения).
`order_status`	object	No	Поля объекта перечислены ниже.
`location`	object	No	Обязательно, если `type` = `location`.

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

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

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

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

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

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

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

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Используйте это, если медиафайл загружен на серверы WhatsApp. Укажите 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[].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`. Если это поле передано, мы скрываем кнопку «Проверить и оплатить» и отображаем только кнопку «Оплатить сейчас» в диалоговом окне с деталями заказа.
`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`. При передаче этого поля кнопка «Просмотреть и оплатить» скрывается, и во всплывающем окне с деталями заказа отображается только кнопка «Оплатить сейчас».
`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	Нет	Идентификатор контента для позиции в заказе из вашего каталога.
`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. Укажите идентификатор медиаобъекта, полученный из 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)	Да	Положительное целое число, представляющее сумму, умноженную на смещение. Например, ₹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	Нет	Обязательно, если тип — `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`. Текст сообщения. Для компонента header лимит составляет 60 символов. Для компонента body лимит составляет 1024 символа. Для кнопок URL указывает суффикс, заданный разработчиком, который добавляется к предварительно определенному префиксу URL в шаблоне.
`payload`	string	Нет	Обязательно для кнопок `quick_reply`. Задаваемая разработчиком полезная нагрузка (payload), возвращаемая при нажатии кнопки в дополнение к отображаемому тексту кнопки.
`coupon_code`	string	Нет	Обязательно, если `type` = `coupon_code`. Код купона, копируемый при нажатии клиентом кнопки.
`image`	object	Нет	Обязательно, если формат шаблона `HEADER` — `IMAGE`.
`gif`	object	Нет	Обязательно, если формат шаблона `HEADER` — `GIF`.
`video`	object	Нет	Обязательно, если формат шаблона `HEADER` — `VIDEO`.
`document`	object	Нет	Обязательно, если формат шаблона `HEADER` — `DOCUMENT`.
`limited_time_offer`	object	Нет	Обязательно, если шаблон использует сведения об истечении срока действия предложения.
`action`	object	Нет	Обязательно, если шаблон использует кнопки каталога или MPM (многопродуктовых сообщений).
`order_status`	object	Нет	Поля объекта перечислены ниже.
`location`	object	Нет	Обязательно, когда `type` = `location`.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметр	Тип	Обязательный	Описание
`type`	string	Да	Тип платежа. Установите значение `billdesk`, `razorpay`, `payu` или `zaakpay`, если вы подключили платежный шлюз BillDesk, Razorpay, PayU или Zaakpay для приема платежей.
`configuration_name`	string	Да	Имя предварительно настроенной конфигурации платежей для использования в этом заказе; длина не должна превышать 60 символов. Это значение должно совпадать с конфигурацией платежей, настроенной в WhatsApp Business Manager. Максимальная длина: `60`.
`billdesk`	object	Нет	Дополнительная информация для BillDesk. Пользовательские поля (extra) используются для хранения любой информации, относящейся к конкретному заказу. Каждое дополнительное поле имеет ограничение максимум 120 символов.
`payu`	object	Нет	Дополнительная информация для PayU. Пользовательские поля (udf) используются для хранения любой информации, относящейся к конкретному заказу. Каждое поле UDF имеет ограничение максимум 255 символов.
`razorpay`	object	Нет	Дополнительная информация для Razorpay.
`zaakpay`	object	Нет	Дополнительная информация для Zaakpay. Пользовательские поля (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	Нет	Цена со скидкой за единицу товара. Она должна быть меньше первоначальной суммы. Если указано, это поле используется для расчета промежуточного итога (subtotal amount).
`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:// — URL-адреса 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. Укажите идентификатор медиаобъекта, полученный через 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.video

Параметр	Тип	Обязательный	Описание
`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.audio

Параметр	Тип	Обязательный	Описание
`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.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.sticker

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

whatsappMessage.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 (Flow Messages).
`action`	object	Нет	Обязательный. Действие, которое должен выполнить пользователь после прочтения сообщения `interactive`.
`body`	object	Нет	Необязательный для типа `product`. Обязательный для остальных типов сообщений.
`header`	object	Нет	Обязательный для типа `product_list`. Необязательный для других типов.
`footer`	object	Нет	Необязательно. Объект с нижним колонтитулом (footer) сообщения.

whatsappMessage.interactive.action

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

whatsappMessage.interactive.action.buttons[]

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

whatsappMessage.interactive.action.buttons[].reply

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

whatsappMessage.interactive.action.sections[]

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

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

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

whatsappMessage.interactive.action.parameters.flow_action_payload

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

whatsappMessage.interactive.action.parameters.beneficiaries[]

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

whatsappMessage.interactive.action.parameters.total_amount

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

whatsappMessage.interactive.action.parameters.order

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

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

Параметр	Тип	Обязательный	Описание
`retailer_id`	string	Нет	Идентификатор контента (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) используются для хранения любой информации, относящейся к конкретному заказу. Каждое поле extra имеет ограничение максимум в 120 символов.
`payu`	object	Нет	Дополнительная информация для PayU. Пользовательские поля (udf) используются для хранения любой информации, относящейся к конкретному заказу. Каждое поле UDF имеет ограничение максимум в 255 символов.
`razorpay`	object	Нет	Дополнительная информация для Razorpay.
`zaakpay`	object	Нет	Дополнительная информация для Zaakpay. Пользовательские поля (extra) используются для хранения любой информации, относящейся к конкретному заказу. Каждое поле extra имеет ограничение максимум в 180 символов.

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

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

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

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

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

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

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

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

whatsappMessage.interactive.body

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

whatsappMessage.interactive.header

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

whatsappMessage.interactive.header.image

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

whatsappMessage.interactive.header.video

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

whatsappMessage.interactive.header.document

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

whatsappMessage.interactive.footer

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

whatsappMessage.contacts[]

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

whatsappMessage.contacts[].addresses[]

Параметр	Тип	Обязательный	Описание
`street`	string	Нет	Название улицы и номер дома.
`city`	string	Нет	Название города.
`state`	string	Нет	Сокращенное наименование штата/региона.
`zip`	string	Нет	Почтовый индекс (ZIP code).
`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` — это исходный ID сообщения на платформе WhatsApp.

whatsappMessage.whatsappApiError

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

whatsappGroup

Параметр	Тип	Обязательный	Описание
`wabaId`	string	Нет	WhatsApp Business Account ID.
`displayPhoneNumber`	string	Нет	Отображаемый номер телефона из метаданных Webhook WhatsApp.
`phoneNumberId`	string	Нет	WhatsApp phone number ID.
`field`	string	Нет	Поле Webhook WhatsApp, сгенерировавшее групповое событие. Значения: `group_lifecycle_update`, `group_participants_update`, `group_settings_update`, `group_status_update`, `messages`.
`type`	string	Нет	Конкретный тип события группы WhatsApp. Значения: `group_create`, `group_delete`, `group_participants_add`, `group_participants_remove`, `group_join_request_created`, `group_join_request_revoked`, `group_settings_update`, `group_suspend`, `group_suspend_cleared`, `message_status`.
`requestId`	string	Нет	Идентификатор запроса, возвращаемый асинхронной операцией group API.
`status`	string	Нет	Статус вебхука группы WhatsApp. Значения: `created`, `failed`, `deleted`, `added`, `removed`, `left`, `requested`, `revoked`, `updated`, `suspended`, `suspend_cleared`, `sent`, `delivered`, `read`, `expired`.
`groupId`	string	Нет	Идентификатор группы WhatsApp.
`messageId`	string	Нет	Идентификатор группового сообщения YCloud. Присутствует только в том случае, если событие статуса связано с сохраненным исходящим групповым сообщением.
`inviteLink`	string	Нет	Ссылка-приглашение в группу.
`reason`	string	Нет	Причина события участника, запроса на вступление или удаления.
`initiatedBy`	string	Нет	Указывает, кто инициировал событие удаления участника. Значения: `business`, `participant`.
`joinRequestId`	string	Нет	Идентификатор запроса на вступление.
`waId`	string	Нет	Идентификатор пользователя WhatsApp для события с одним участником.
`recipientUserId`	string	Нет	Идентификатор пользователя в рамках компании (business-scoped user ID) для события с одним участником.
`parentRecipientUserId`	string	Нет	Родительский идентификатор пользователя в рамках компании (parent business-scoped user ID) для события с одним участником.
`customerProfile`	object	Нет	Информация о профиле клиента WhatsApp.
`subject`	string	Нет	Тема группы.
`description`	string	Нет	Описание группы.
`joinApprovalMode`	string	Нет	Режим подтверждения вступления в группу WhatsApp. `approval_required`: новые участники должны быть одобрены перед вступлением. `auto_approve`: новые участники могут вступить без подтверждения.
`addedParticipants`	object[]	Нет	Участники, добавленные в группу.
`removedParticipants`	object[]	Нет	Участники, удаленные из группы.
`failedParticipants`	object[]	Нет	Участники, которых не удалось добавить или удалить.
`settings`	object[]	Нет	Сведения об обновлении настроек группы.
`errors`	object[]	Нет	Ошибки, возвращенные WhatsApp.
`contacts`	object[]	Нет	Контакты, включенные в вебхуки со статусом групповых сообщений.
`statuses`	object[]	Нет	Подробные сведения о статусе группового сообщения.
`webhookTime`	string (date-time)	Нет	Время, когда WhatsApp инициировал этот Webhook.
`dedupeKey`	string	Нет	Ключ идемпотентности для дедупликации событий Webhook группы.

whatsappGroup.customerProfile

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

whatsappGroup.addedParticipants[]

Параметр	Тип	Обязательный	Описание
`input`	string	Нет	Исходные введенные данные участника.
`waId`	string	Нет	ID пользователя WhatsApp.
`recipientUserId`	string	Нет	Идентификатор пользователя в рамках бизнеса (business-scoped user ID).
`parentRecipientUserId`	string	Нет	Идентификатор пользователя родительского бизнеса (parent business-scoped user ID).
`customerProfile`	object	Нет	Информация о профиле клиента WhatsApp.
`errors`	object[]	Нет	Ошибки, возвращенные WhatsApp для этого участника.

whatsappGroup.addedParticipants[].customerProfile

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

whatsappGroup.removedParticipants[]

Параметр	Тип	Обязательный	Описание
`input`	string	Нет	Исходные введенные данные участника.
`waId`	string	Нет	ID пользователя WhatsApp.
`recipientUserId`	string	Нет	Идентификатор пользователя в рамках бизнеса (business-scoped user ID).
`parentRecipientUserId`	string	Нет	Идентификатор пользователя родительского бизнеса (parent business-scoped user ID).
`customerProfile`	object	Нет	Информация о профиле клиента WhatsApp.
`errors`	object[]	Нет	Ошибки, возвращенные WhatsApp для этого участника.

whatsappGroup.removedParticipants[].customerProfile

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

whatsappGroup.failedParticipants[]

Параметр	Тип	Обязательный	Описание
`input`	string	Нет	Исходные введенные данные участника.
`waId`	string	Нет	ID пользователя WhatsApp.
`recipientUserId`	string	Нет	Идентификатор пользователя в рамках бизнеса (business-scoped user ID).
`parentRecipientUserId`	string	Нет	Идентификатор пользователя родительского бизнеса (parent business-scoped user ID).
`customerProfile`	object	Нет	Информация о профиле клиента WhatsApp.
`errors`	object[]	Нет	Ошибки, возвращенные WhatsApp для этого участника.

whatsappGroup.failedParticipants[].customerProfile

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

whatsappGroup.settings[]

Параметр	Тип	Обязательный	Описание
`name`	string	Нет	Имя настройки. Значения: `profile_picture`, `group_subject`, `group_description`.
`text`	string	Нет	Текстовое значение для обновления темы или описания.
`updateSuccessful`	boolean	Нет	Указывает, успешно ли обновлена настройка.
`mimeType`	string	Нет	MIME-тип для обновлений фото профиля.
`sha256`	string	Нет	Хеш SHA-256 для обновлений фото профиля.
`errors`	object[]	Нет	Ошибки, возвращенные WhatsApp для этой настройки.

whatsappGroup.contacts[]

Параметр	Тип	Обязательный	Описание
`customerProfile`	object	Нет	Информация о профиле клиента WhatsApp.
`waId`	string	Нет	Идентификатор пользователя WhatsApp.
`recipientUserId`	string	Нет	Идентификатор пользователя в рамках компании (Business-scoped user ID).
`parentRecipientUserId`	string	Нет	Идентификатор пользователя в рамках родительской компании.

whatsappGroup.contacts[].customerProfile

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

whatsappGroup.statuses[]

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Идентификатор сообщения WhatsApp.
`status`	string	Нет	Статус сообщения. Значения: `sent`, `delivered`, `read`, `failed`, `expired`.
`timestamp`	integer (int64)	Нет	Метка времени Unix, указывающая, когда был обновлен статус сообщения.
`recipientId`	string	Нет	Идентификатор группы получателя.
`recipientType`	string	Нет	Тип получателя. Значения: `group`.
`recipientParticipantId`	string	Нет	Идентификатор пользователя WhatsApp участника-получателя.
`recipientUserId`	string	Нет	Идентификатор пользователя в рамках компании участника-получателя.
`parentRecipientUserId`	string	Нет	Идентификатор пользователя в рамках родительской компании участника-получателя.
`conversation`	object	Нет	Объект переписки WhatsApp, включенный в webhook со статусом группового сообщения.
`pricing`	object	Нет	Информация о тарификации, включенная в webhook со статусом группового сообщения.
`errors`	object[]	Нет	Ошибки, возвращенные WhatsApp.

whatsappGroup.statuses[].conversation

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Идентификатор переписки.
`expirationTimestamp`	integer (int64)	Нет	Метка времени Unix, указывающая, когда истекает срок действия переписки.
`origin`	object	Нет	Поля объекта перечислены ниже.

whatsappGroup.statuses[].conversation.origin

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

whatsappGroup.statuses[].pricing

Параметр	Тип	Обязательный	Описание
`billable`	boolean	Нет	Подлежит ли сообщение тарификации.
`pricingModel`	string	Нет	Модель ценообразования.
`type`	string	Нет	Тип ценообразования.
`category`	string	Нет	Исходная категория группового ценообразования, переданная Meta. YCloud не раскрывает внутреннее сопоставление MM Lite в этом поле Webhook. Значения: `group_marketing`, `group_utility`, `group_service`.

Пример

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

Итоговая стоимость доставленного сообщения с Max Price

{
  "id": "evt_example_max_price_delivery",
  "type": "whatsapp.message.updated",
  "apiVersion": "v2",
  "createTime": "2026-11-03T08:00:00.000Z",
  "whatsappMessage": {
    "id": "message_example_max_price",
    "wabaId": "<WABA_ID>",
    "from": "+12025550124",
    "to": "+12025550123",
    "type": "template",
    "status": "delivered",
    "pricingCategory": "marketing_lite_bidding",
    "bidPricingFlag": true,
    "totalPrice": 0.045,
    "currency": "USD"
  }
}

Доступность международного тарифа на аутентификацию (Authentication-International Rate Eligibility)

{
  "id": "evt_djeIQXaQPQyUcRFi",
  "type": "whatsapp.message.updated",
  "apiVersion": "v2",
  "createTime": "2024-07-01T00:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "wabaId": "whatsapp-business-account-id",
    "from": "+12025550124",
    "to": "+12025550123",
    "status": "sent",
    "type": "template",
    "template": {
      "name": "login_otp",
      "language": {
        "code": "862031",
        "policy": "deterministic"
      }
    },
    "conversation": {
      "id": "8078ed05301c40a08d3d1845c94ca18b",
      "originType": "authentication",
      "expireTime": "2024-07-01T00:00:00.000Z"
    },
    "pricingCategory": "authentication_international",
    "totalPrice": 0.085,
    "currency": "USD",
    "sendTime": "2024-07-01T00:00:00.000Z"
  }
}

Сообщение отправлено

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.message.updated",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "recipientUserId": "US.13491208655302741918",
    "parentRecipientUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Pablo M."
    },
    "status": "sent",
    "pricingCategory": "marketing",
    "totalPrice": 0.0,
    "currency": "USD",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "text",
    "text": {
      "body": "Hi there! How can we help?"
    },
    "externalId": "EXTERNAL-ID",
    "wabaId": "WABA_ID",
    "from": "+12025550123"
  }
}

Сообщение доставлено

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.message.updated",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "recipientUserId": "US.13491208655302741918",
    "parentRecipientUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Pablo M.",
      "username": "@pablomorales"
    },
    "status": "delivered",
    "pricingModel": "PMP",
    "pricingType": "regular",
    "pricingCategory": "marketing",
    "totalPrice": 0.0,
    "currency": "USD",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "deliverTime": "2022-03-01T12:00:02.000Z",
    "bizType": "whatsapp",
    "type": "text",
    "text": {
      "body": "Hi there! How can we help?"
    },
    "externalId": "EXTERNAL-ID",
    "wabaId": "WABA_ID",
    "from": "+12025550123"
  }
}

Сообщение прочитано

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.message.updated",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "recipientUserId": "US.13491208655302741918",
    "parentRecipientUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Pablo M.",
      "username": "@pablomorales"
    },
    "status": "read",
    "pricingModel": "PMP",
    "pricingType": "regular",
    "pricingCategory": "marketing",
    "totalPrice": 0.0,
    "currency": "USD",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "deliverTime": "2022-03-01T12:00:02.000Z",
    "readTime": "2022-03-01T12:00:02.000Z",
    "bizType": "whatsapp",
    "type": "text",
    "text": {
      "body": "Hi there! How can we help?"
    },
    "externalId": "EXTERNAL-ID",
    "wabaId": "WABA_ID",
    "from": "+12025550123"
  }
}

Ошибка отправки сообщения

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.message.updated",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "recipientUserId": "US.13491208655302741918",
    "parentRecipientUserId": "US.ENT.11815799212886844830",
    "status": "failed",
    "errorCode": "100",
    "errorMessage": "Parameter Invalid",
    "whatsappApiError": {
      "message": "(#100) Invalid parameter",
      "type": "OAuthException",
      "code": "100",
      "fbtrace_id": "AwmiSOCojlAkqvjCTjGt37r",
      "error_data": {
        "messaging_product": "whatsapp",
        "details": "Parameter Invalid"
      }
    },
    "pricingCategory": "marketing",
    "totalPrice": 0.0,
    "currency": "USD",
    "bizType": "whatsapp",
    "type": "text",
    "text": {
      "body": "Hi there! How can we help?"
    },
    "externalId": "EXTERNAL-ID",
    "wabaId": "WABA_ID",
    "from": "+12025550123"
  }
}

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

HTTP/1.1 200 OK

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

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

Руководства

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

Webhook reference

whatsapp.message.updated

Триггеры

Синтаксис

Параметры

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

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

whatsappMessage

whatsappGroup

Пример

​Триггеры

​Синтаксис

​Параметры

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

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

​whatsappMessage

​whatsappGroup

​Пример

Триггеры

Синтаксис

Параметры

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

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

whatsappMessage

whatsappGroup

Пример