Запросы API

Для отправки одиночных и пакетных пуш-сообщений
Документация перемещена
Информация на этой странице не обновляется и может быть устаревшей. 
Наиболее полная и актуальная версия документации для разработчиков доступна по новому адресу:
​https://developers.koshelek.app​
Push API
post
https://api.cardsmobile.ru/push
/delivery
Отправка одиночного сообщения
Описание объектов Payload, QoS и UTM см. в разделе Объекты API.
В случае отказа от отправки сообщения при превышении разрешенной частоты следует повторить попытку отправки позже.
Пример тела запроса:
Отправка транзакционного сообщения
{
    "pushType": "TRANSACTION",
    "msisdn": 71234567890,
    "payload": {
        "title": "Списание баллов",
        "message": "С вашей карты списано 10 баллов",
        "image": "http://partnerdomain/logo.jpg",
        "deeplink": {
            "target": "card"
        }
    },
    "qos": {
        "deliveryStatusNotifications": true
    },
    "utm": {
        "utmSource": "cardsmobile",
        "utmMiddle": "cpc",
        "utmCampaign": "campaign_name"
  }
}
post
https://api.cardsmobile.ru/push
/bulk/single
Массовая отправка одиночного сообщения
Пример тела запроса:
{
  "pushType": "TRANSACTION",
  "msisdn": [
    79001234567,
    79001234578,
    79001234589,
    79001234590
  ],
  "payload": {
    "title": "Списание баллов",
    "message": "С вашей карты списано 10 баллов",
    "image": "http://partnerdomain/logo.jpg",
    "deeplink": {
      "target": "card"
    }
  },
  "qos": {
    "deliveryStatusNotifications": true
  },
  "utm": {
    "utmSource": "cardsmobile",
    "utmMiddle": "cpc",
    "utmCampaign": "campaign_name"
  }
}
post
https://api.cardsmobile.ru/push
/bulk/multi
Массовая отправка сообщений
Пример тела запроса:
[
  {
    "pushType": "TRANSACTION",
    "msisdn": 71234567890,
    "payload": {
        "title": "Списание баллов",
        "message": "С вашей карты списано 10 баллов",
        "image": "http://partnerdomain/logo.jpg",
        "deeplink": {
            "target": "card"
        }
    },
    "qos": {
        "deliveryStatusNotifications": true
    },
    "utm": {
        "utmSource": "cardsmobile",
        "utmMiddle": "cpc",
        "utmCampaign": "campaign_name"
    }
  }
]
get
https://api.cardsmobile.ru
/promos
Получение списка акций из Личного кабинета
Тело запроса пустое.
get
https://api.cardsmobile.ru/push
/{messageId}/transactional-state
Получение статуса доставки одиночного сообщения
Callback API
post
https://<partner-base-url>
/<callback-endpoint>
Информирование об изменении статуса доставки
Пример тела запроса:
{
    "msisdn": 79051234567,
    "messageId": "c506b550-a309-11e9-a2a3-2a2ae2dbcce4",
    "state": "DELIVERED",
    "time": "2019-11-29T17:11:42Z",
    "utm": {
            "utmSource": "cardsmobile",
            "utmMiddle": "cpc",
            "utmCampaign": "campaign_name"
  }
}
Cardsmobile Push API - Previous
Передача пуш-сообщений
Next - Cardsmobile Push API
Объекты API
Last modified 26d ago