Как отправить пуш в приложение «Кошелек»

«Кошелёк» — это мобильное приложение для управления картами лояльности.
Также его можно использовать без подключения модуля лояльности для отправки пушей в приложение. О настройке интеграции можно почитать в инструкции.

Для отправки пуша создается вебхук, который вызывается шагом сценария.

Пример использования в механике: Как настроить каскадную рассылку с отправкой пуша в «Кошелек».

Создаем вебхук

Создаем точку интеграции для вебхуков «Кошелька»:

Снимок экрана 2023-07-05 в 11.34.26.png

Создаем вебхук:

Снимок экрана 2023-06-08 в 07.19.29.png

Пример настройки:

Снимок экрана 2023-07-05 в 11.47.40.png

Снимок экрана 2023-07-05 в 11.47.53.png

URL

POST — https://api.cardsmobile.ru/push/delivery

Заголовки

Берем из точки интеграции:

Content-Type — application/json
Accept — application/json
Authorization — Basic

Тело запроса

Пример:

{
    "pushType": "TRANSACTION",
    "msisdn": ${Recipient.MobilePhone},
    "payload": {
        "title": "Списание баллов",
        "message": "С вашей карты списано 10 баллов",
        "image": "http://partnerdomain/logo.jpg",
        "deeplink": {
            "target": "card"
        }
    },
    "qos": {
        "deliverDue": "2021-01-29T23:41:11.64Z",
        "deliveryStatusNotifications": true
    },
    "utm": {
        "utmSource": "mindbox",
        "utmMiddle": "card",
        "utmCampaign": "spisanie10"
  }
}

pushType

Тип передаваемого сообщения.

Транзакционное сообщение (TRANSACTION) — сообщение, информирующее клиента о конкретной совершённой операции (транзакции) в рамках программы лояльности. Например: начисление или списание бонусных баллов с персонального счета клиента при покупке товара или услуги.

Частота отправки транзакционных push-сообщений ограничена. По умолчанию может отправить не более 1000 сообщений в минуту (частота не может превышать одно сообщение в 0,06 секунд)

Рекламное сообщение (PROMO) — сообщение, информирующее клиента о проведении партнером маркетингового мероприятия (например, о проведении специальной акции или предоставлении персональной скидки) и направленное на повышение лояльности.

Изображение может быть включено только в рекламные сообщения. Если изображение задано для транзакционных сообщений, оно игнорируется

msisdn

Номер мобильного номера.

payload

Передаваемое сообщение.

title — заголовок сообщения (не более 50 символов). Обязательно.
message — текст сообщения (не более 150 символов). Обязательно.
image — URL изображения в сообщении (разрешение 1024×512 px, формат JPG или PNG). Необязательно. Если задано для транзакционных сообщений, то игнорируется.
deeplink — внутренняя ссылка для перехода к конкретному экрану в приложении «Кошелёк». Обязательно.
- target — определяет экран Кошелька, к которому должен быть осуществлен переход при нажатии на сообщение. Обязательно. Возможные значения:
  - card — к экрану выпущенной карты;
  - campaign — к конкретной акции по выпущенной карте; при его использовании обязательно поле campaignId - идентификатор промо-акции для перехода. Указывается ID акции в системе партнера или в Личном кабинете партнера в системе «Кошелёк для бизнеса».
  - campaigns — к полному списку акций по выпущенной карте.

qos

Параметры отправки сообщения.

deliverDue — время ("yyyy.mm.ddThh:mm:ssZ"), до наступления которого отправка должна быть завершена. По истечении этого времени не доставлять оставшиеся сообщения. Необязательно.
deliveryStatusNotifications — указывает, следует ли сообщать через Callback API об изменениях статуса отправки сообщения. Необязательно. Возможные значения:
- true — сообщать,
- false — не сообщать.