Объекты API

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

1. Объект Payload

Объект содержит сведения о передаваемом сообщении. Содержит следующие поля:

Поле

Тип

Описание

title

String

Заголовок сообщения (не более 50 символов).

message

String

Текст сообщения (не более 150 символов).

image

String

URL изображения в сообщении (разрешение 1024×512 px, формат JPG или PNG). Необязательный параметр.

deeplink

Object

Внутренняя ссылка для перехода к коннкретному экрану в приложении «Кошелёк». JSON-объект DeepLink.

Объект содержит сведения о внутренней ссылке в приложении. Содержит следующие поля:

Поле

Тип

Описание

target

String

Определяет экран Кошелька, к которому должен быть осуществлен переход при нажатии на сообщение:

  • card — к экрану выпущенной карты;

  • campaign — к конкретной акции по выпущенной карте;

  • campaigns — к полному списку акций по выпущенной карте.

campaignId

String

Идентификатор промо-акции для перехода. Обязателен, если target=campaign.

Указывается ID акции в системе партнера или в Личном кабинете партнера в системе «Кошелёк для бизнеса».

3. Объект QoS

Объект содержит сведения о параметрах отправки сообщения. Содержит следующие поля:

Поле

Тип

Описание

deliverDue

String

Время ("yyyy.mm.ddThh:mm:ssZ"), до наступления которого отправка должна быть завершена. По истечении этого времени не доставлять оставшиеся сообщения.

Необязательный параметр.

deliveryStatusNotifications

Boolean

Указывает, следует ли сообщать через Callback API об изменениях статуса отправки сообщения:

  • true — сообщать,

  • false — не сообщать.

Необязательный параметр.

4. Объект UTM

Объект содержит дополнительные настройки отправки сообщения. Содержит следующие поля:

Поле

Тип

Описание

utmSource

String

Источник рассылки.

Необязательный параметр.

utmMiddle

String

Тип трафика.

Необязательный параметр.

utmCampaign

String

Название кампании.

Необязательный параметр.