Russian
Объекты API
Объекты, используемые в запросах Cardsmobile Push API

1. Объект Payload

Объект содержит сведения о передаваемом сообщении. Включает в себя следующие поля:
Поле
Тип
Обязательно
Описание
title
String
Да
Заголовок сообщения (не более 50 символов).
message
String
Да
Текст сообщения (не более 150 символов).
image
String
Нет
URL изображения в сообщении (разрешение 1024×512 пикселей, формат JPG или PNG). Необязательный параметр. Если задано для транзакционных и сервисных сообщений, то игнорируется.
deeplink
Object
Да
Внутренняя ссылка для перехода к конкретному экрану в приложении «Кошелёк». JSON-объект DeepLink.
Объект содержит сведения о внутренней ссылке в приложении. Включает в себя следующие поля:
Поле
Тип
Обязательно
Описание
target
String
Да
Определяет экран Кошелька, к которому произойдет переход при нажатии на сообщение:
  • card — к экрану выпущенной карты;
  • campaign — к конкретной акции по выпущенной карте;
  • campaigns — к полному списку акций по выпущенной карте.
campaignId
String
Нет
Идентификатор промоакции для перехода. Обязателен, если target=campaign.
Указывается ID акции в системе партнера или в Личном кабинете партнера в системе «Кошелёк для бизнеса».

3. Объект QoS

Объект содержит сведения о параметрах отправки сообщения. Включает в себя следующие поля:
Поле
Тип
Обязательно
Описание
deliveryStatusNotifications
Boolean
Нет
Определяет, следует ли сообщать через Callback API об изменениях статуса отправки сообщения:
true — сообщать;
false — не сообщать.

4. Объект UTM

Объект содержит дополнительные настройки отправки сообщения. Включает в себя следующие поля:
Поле
Тип
Обязательно
Описание
utmSource
String
Нет
Источник рассылки.
utmMiddle
String
Нет
Тип трафика.
utmCampaign
String
Нет
Название кампании.
Copy link
On this page
1. Объект Payload
2. Объект DeepLink
3. Объект QoS
4. Объект UTM