Comment on page

Объекты API

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

Документация перемещена
Информация на этой странице не обновляется и может быть устаревшей. 
Наиболее полная и актуальная версия документации для разработчиков доступна по новому адресу:
​https://developers.koshelek.app​
1. Объект Payload
Объект содержит сведения о передаваемом сообщении. Включает в себя следующие поля:
Поле
Тип
Обязательно
Описание
title
String
Да
Заголовок сообщения (не более 50 символов).
message
String
Да
Текст сообщения (не более 150 символов).
image
String
Нет
URL изображения в сообщении (разрешение 1024×512 пикселей, формат JPG или PNG). Необязательный параметр. Если задано для транзакционных и сервисных сообщений, то игнорируется.
deeplink
Object
Да
Внутренняя ссылка для перехода к конкретному экрану в приложении «Кошелёк». JSON-объект DeepLink.
2. Объект 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
Нет
Название кампании.

Поле	Тип	Обязательно	Описание
`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 акции в системе партнера или в Личном кабинете партнера в системе «Кошелёк для бизнеса».

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

Поле	Тип	Обязательно	Описание
`utmSource`	String	Нет	Источник рассылки.
`utmMiddle`	String	Нет	Тип трафика.
`utmCampaign`	String	Нет	Название кампании.

Cardsmobile Push API - Previous

Запросы API

Next - Cardsmobile Promo API

Общие сведения

Last modified 7mo ago