Запросы API

Push API
post
https://api.cardsmobile.ru/push
/delivery
Отправка одиночного сообщения
Описание объектов Payload, QoS и UTM см. в разделе Объекты API.
В случае отказа от отправки сообщения при превышении разрешенной частоты следует повторить попытку отправки позже.
Пример тела запроса:
Отправка транзакционного сообщения
1
{
2
    "pushType": "TRANSACTION",
3
    "msisdn": 71234567890,
4
    "payload": {
5
        "title": "Списание баллов",
6
        "message": "С вашей карты списано 10 баллов",
7
        "image": "http://partnerdomain/logo.jpg",
8
        "deeplink": {
9
            "target": "card"
10
        }
11
    },
12
    "qos": {
13
        "deliverDue": "2020-01-29T23:41:11.64Z",
14
        "deliveryStatusNotifications": true
15
    },
16
    "utm": {
17
        "utmSource": "cardsmobile",
18
        "utmMiddle": "cpc",
19
        "utmCampaign": "campaign_name"
20
  }
21
}
Copied!
post
https://api.cardsmobile.ru/push
/bulk/single
Массовая отправка одиночного сообщения
Пример тела запроса:
1
{
2
  "pushType": "TRANSACTION",
3
  "msisdn": [
4
    79001234567,
5
    79001234578,
6
    79001234589,
7
    79001234590
8
  ],
9
  "payload": {
10
    "title": "Списание баллов",
11
    "message": "С вашей карты списано 10 баллов",
12
    "image": "http://partnerdomain/logo.jpg",
13
    "deeplink": {
14
      "target": "card"
15
    }
16
  },
17
  "qos": {
18
    "deliverDue": "2020-01-29T23:41:11.64Z",
19
    "deliveryStatusNotifications": true
20
  },
21
  "utm": {
22
    "utmSource": "cardsmobile",
23
    "utmMiddle": "cpc",
24
    "utmCampaign": "campaign_name"
25
  }
26
}
Copied!
post
https://api.cardsmobile.ru/push
/bulk/multi
Массовая отправка сообщений
Пример тела запроса:
1
[
2
  {
3
    "pushType": "TRANSACTION",
4
    "msisdn": 71234567890,
5
    "payload": {
6
        "title": "Списание баллов",
7
        "message": "С вашей карты списано 10 баллов",
8
        "image": "http://partnerdomain/logo.jpg",
9
        "deeplink": {
10
            "target": "card"
11
        }
12
    },
13
    "qos": {
14
        "deliverDue": "2020-01-29T23:41:11.64Z",
15
        "deliveryStatusNotifications": true
16
    },
17
    "utm": {
18
        "utmSource": "cardsmobile",
19
        "utmMiddle": "cpc",
20
        "utmCampaign": "campaign_name"
21
    }
22
  }
23
]
Copied!
get
https://api.cardsmobile.ru
/promos
Получение списка акций из Личного кабинета
Тело запроса пустое.
get
https://api.cardsmobile.ru/push
/{messageId}/transactional-state
Получение статуса доставки одиночного сообщения
Callback API
post
https://<partner-base-url>
/<callback-endpoint>
Информирование об изменении статуса доставки
Пример тела запроса:
1
{
2
    "msisdn": 79051234567,
3
    "messageId": "c506b550-a309-11e9-a2a3-2a2ae2dbcce4",
4
    "state": "DELIVERED",
5
    "time": "2019-11-29T17:11:42.739Z",
6
    "utm": {
7
            "utmSource": "cardsmobile",
8
            "utmMiddle": "cpc",
9
            "utmCampaign": "campaign_name"
10
  }
11
}
Copied!