PUSH WALLET¶

Отправка¶

Для отправки push-уведомления от приложения Кошелёк необходимо:

Получить ID отправителя и доступ к Push WALLET API. Для этого необходимо обратиться в техническую поддержку.
Вызвать POST /wallet/message, передавая параметры сообщения в теле запроса и данные авторизации в заголовке.

Параметры запроса¶

Параметр	Тип данных	Описание
from	string	Согласованный ID отправителя.
to	string	Номер телефона в международном формате, согласно стандарту E.164.
payload	PushPayload	Настройки контента сообщения.
callbackUrl (optional)	string	URL, на который система будет отправлять уведомления об изменениях статуса сообщения. Любой валидный URL со схемой `HTTP` или `HTTPS`.
callbackData (optional)	object	Данные, которые будут указаны в коллбэке со статусом сообщения. Любой массив вида `"key"`: `{ "key1": "value1", "key2": "value2" }`
scheduledTime (optional)	string	Запланированное UTC время отправки сообщения.
mergeKey (optional)	string	Ключ для объединения запроса и ответа.
validity (optional)	integer	Срок жизни уведомления в секундах.

PushPayload¶

Параметр	Тип данных	Описание
title (optional)	string	Заголовок сообщения. Максимальная длина - 50 символов.
message (optional)	string	Текст сообщения. Максимальная длина - 2048 символов.
image (optional)	string	URL-адрес изображения. Максимальная длина - 512 символов.
deeplink (optional)	Deeplink	Параметры перехода в приложение Кошелёк.

Deeplink¶

Параметр Тип данных Описание

target
(optional)

string

Экран, на который переходит пользователь при нажатии на уведомление.

card - экран выпущенной карты.
campaign - конкретная акция по выпущенной карте.
campaigns - полный список всех акций по выпущенной карте.

campaignId
(optional)

string

ID конкретной акции для перехода.

Обязателен, если "target": "campaign".
Максимальная длина - 512 символов.

Пример запроса¶

[
  {
    "from": "Company",
    "payload": {
        "deeplink": {
        "campaignId": "q123456",
        "target": "campaign"
      },
      "image": "http://ya.ru/image234323.jpg",
      "message": "Покупайте все, что хотите!",
      "title": "Распродажи и скидки"
    },
    "to": "74886035511"
  }
]

Параметры ответа¶

Параметр	Тип данных	Описание
code	string	Указывает на результат обработки уведомления. 1. `OK` - успешно обработано. 2. `REJECTED` - произошла ошибка во время валидации уведомления.
result	string	ID сообщения. Указывается только при `"code": "OK"`.
reasons	array	Массив ошибок, произошедших во время обработки сообщения. Указывается только при `"code": "REJECTED"`.
reasons.key	string	Сообщение с описанием ошибки.
mergeKey	string	Ключ для объединения запроса и ответа.

Примеры ответов¶

OK

{
  "result": [
    {
      "code": "OK",
      "result": 3670367897656669056,
      "mergeKey": "key"
    }
  ]
}

REJECTED

{
  "result": [
    {
      "code": "REJECTED",
      "result": null,
      "reasons": [
        {
          "key": "invalid.image.url"
        }
      ],
      "mergeKey": "key"
    }
  ]
}