API Objects
JSON objects used in Push API requests
1. Payload Object
The object contains information on a transmitted message. The object consists of the following fields:
| Field | Type | Mandatory | Description |
|---|---|---|---|
title |
String | Yes | Message title (max 50 characters). |
message |
String | Yes | Message body (max 150 characters). |
image |
String | No | URL of image attached to the message (size 1024×512 px, JPG or PNG format). For transactional and service messages, if specified, ignored. |
deeplink |
String | Yes | Internal application link (“deep link”) to going to a certain screen in the Koshelek app. Presented by JSON object DeepLink. |
2. DeepLink Object
The object contains information on a deep link. Consists of the following fields:
| Field | Type | Mandatory | Description |
|---|---|---|---|
title |
String | Yes | Determines the Koshelek app screen, that must be opened when user taps on the message:card — screen of the issued card;campaign — screen of the certain promotional action related to issued card;campaigns — screen with the full list of actions related to issued card. |
campaignId |
String | No | ID of promotional action to display. Mandatory, if target = campaign. ID of promotional action from partner’s CRM or from partner’s Personal account in Koshelek for Business must be specified here. |
3. QoS Object
The object contains information on settings of a message delivery. Consists of the following fields:
| Field | Type | Mandatory | Description |
|---|---|---|---|
deliveryStatusNotifications |
Boolean | No | Determines whether or not notify the sender about message status changing via the Callback API:true — notify,false — not to notify. |
4. UTM Object
The object contains additional settings for the delivery. Consists of the following fields:
| Field | Type | Mandatory | Description |
|---|---|---|---|
utmSource |
String | No | The source of the delivery. |
utmMiddle |
String | No | Traffic type. |
utmCampaign |
String | No | Campaign name. |