Перейти к содержанию

PUSH

Отправка

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

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

Параметр Тип данных Описание
from integer Согласованный ID отправителя.
to string Токен устройства получателя.
title string Заголовок уведомления. Максимальная длина - 200 символов.
text string Текст уведомления. Максимальная длина - 1024 символа.
badge
(optional)
integer

Ключ, устанавливающий значение для бейджа приложения - значка с цифрой в верхнем углу иконки приложения. Цифра обозначает количество непрочитанных уведомлений в приложении.

Можно задать любое целое число.
Чтобы бейдж не отображался, нужно установить значение параметра 0 либо удалить данный параметр.

validity
(optional)
integer Срок жизни уведомления в секундах.
Минимальное значение: 30
Максимальное значение: 86400, 1 сутки
По умолчанию: 86400, 1 сутки
platform
(optional)
string

Платформа или операционная система устройств, на которые будет прислано уведомление.

Доступны значения:
ANDROID - устройства с ОС Android.
IOS - устройства с ОС iOS.

priority string

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

LOW и MEDIUM - низкий и средний приоритеты, используются для рекламных сообщений.
HIGH - высокий приоритет, используется для сервисного трафика.
REALTIME - максимально возможный приоритет, используется для транзакционного трафика.
При использовании любого другого значения сообщение будет отклонено.

silentPush
(optional)
boolean Если true, уведомление не будет отображаться на устройстве получателя. По умолчанию false.
options
(optional)
string

Данные, которые будут указаны в коллбэке со статусом сообщения.

Любой массив вида "key":
{ "key1": "value1", "key2": "value2" }

apns
(optional)
ApnsDto Специфические поля для устройств Apple.
android
(optional)
AndroidDto Специфические поля для устройств Android.

Внимание

Для отправки уведомления необходимо использовать один из объектов: ApnsDto или AndroidDto.

ApnsDto

Параметр Тип данных Описание
sound
(optional)
string

Звук push-уведомления на iOS.

Поддерживает значение default или имя файла. Звуковой файл должен входить в основной пакет приложения или в папку Library/Sounds в контейнере приложения.

Поддерживаемые форматы: AIF, AIFF, WAV, MP3, MP4
Максимальный размер: 5 МБ

buttons
(optional)
array[ActionButtons] Включает в себя максимум 3 объекта кнопок.
linkToMedia
(optional)
string

URL на файл, прикрепляемый к уведомлению.

Поддерживаемые форматы:
Аудио: AIFF, WAV, MP3, MPEG-4. 5 MB
Видео: MPEG, MPEG-2, AVI. 50 MB
Изображение: JPEG. PNG, GIF. Разрешение: 1024x1024 или соотношение сторон 1:1, 10 МБ

image
(optional)
string

Имя файла изображения в комплекте приложения: с расширением имени файла или без него. Изображение отображается напрямую в уведомлении. Если параметр не указан, система использует изображение с ключом UILaunchImageFile в файле Info.plist в приложении, или Default.png.

Поддерживаемые форматы: JPEG, GIF, PNG
Размеры:
○ Минимальный - 512х256
○ Оптимальный - 1440x720
○ Максимальный - 2880х1440
Разрешение: 1440x720 или соотношение сторон 2:1

action
(optional)
string URL/deep link для перехода при нажатии на уведомление.

AndroidDto

Параметр Тип данных Описание
smallIcon
(optional)
string Ссылка на иконку уведомления. Иконка будет отображаться в качестве превью в панели уведомления. Ссылка должна вести на иконку в основном пакете приложения.
iconColor
(optional)
string Цвет иконки уведомлений в формате #RRGGBB.
sound
(optional)
string

Звук push-уведомления на Android.

Поддерживает значение default или имя файла звукового ресурса, входящего в состав приложения. Звуковые файлы должны находиться в /res/raw/.

Поддерживаемые форматы: AIF/AIFF, WAV, MP3, MP4
Максимальный размер: 5 MB

buttons
(optional)
array[ActionButtons] Включает в себя максимум 3 объекта кнопок.
image
(optional)
string

Имя файла изображения в комплекте приложения: с расширением имени файла или без него. Изображение отображается напрямую в уведомлении. Если параметр не указан, система использует изображение, идентифицированное ключом UILaunchImageFile в файле Info.plist приложения, или Default.png.

Поддерживаемые форматы: JPEG, GIF, PNG
Размеры:
○ Минимальный - 512х256
○ Оптимальный - 1440x720
○ Максимальный - 2880х1440
Разрешение: 1440x720 или соотношение сторон 2:1

androidChannelId
(optional)
string ID канала уведомления.
tag
(optional)
string ID для отбора пользователей. Используется для тегирования абонентов в базах клиентов в FireBase.
collapseKey
(optional)
string При получении сообщений с одинаковым collapseKey, Firebase Cloud Messaging (FCM) заменяет более старое сообщение на новое.
icon
(optional)
string

URL иконки уведомления.

Поддерживаются форматы иконок: 24x24, 36x36, 48x48, 72x72, 96x96

action
(optional)
string URL/deep link для перехода при нажатии на уведомление.

ActionButtons

Параметр Тип данных Описание
icon
(optional)
string

URL иконки уведомления. Используется только для Android.

Поддерживаются форматы иконок: 24x24, 36x36, 48x48, 72x72, 96x96

caption
(optional)
string Название кнопки. Максимальная длина - 30 символов.
action
(optional)
string URL/deep link для перехода при нажатии на кнопку в уведомлении.

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

[
  {
    "from":400,
    "to":"r0Fo0EjfqKjTeZZpPW4s63PpMEYpgKIj55DT",
    "title":"title",
    "text":"Hello",
    "badge":1,
    "validity":86400,
    "priority":"MEDIUM",
    "options":{
       "name":"Иван",
       "phone":"79169492211"
    },
    "apns":{
       "linkToMedia":"Default.png",
       "sound":"hi.mp3",
       "action":"https://test.com/apple-app-site-association"
    },
    "android":{
       "icon":"Default.png",
       "iconColor":"#FF4500",
       "sound":"hi.mp3",
       "action":"https://test.com/android-app-site-association"
    }
  }
]

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

Параметр Тип данных Описание
index integer Порядковый номер получателя из массива сообщений.
pushToken string Токен устройства получателя.
pushId integer ID уведомления. Указывается только при "code": "ok".
code string Указывает на результат обработки сообщения.
1. ok - успешно обработано.
2. validation_error - ошибка валидации уведомления.
description array Массив ошибок, произошедших во время обработки сообщения. Указывается только при "code": "validation_error".
description.errorMessage string Сообщение с описанием ошибки.

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

{
  "result": [
    {
      "index": 0,
      "pushToken": "IOvpeJ0ECENA3WrrRHG1ghopWkVgiFNLSWWZoqLAUgIllcDF3j19ay9-0-Nanfo-0VjrnA1G6CGSvE_TyRUaea7mXmDUapY3YA",
      "pushId": 3703545281276230700,
      "code": "ok"
    }
  ]
}
{
  "result": [
    {
      "index": 0,
      "pushToken": "IOvpeJ0ECENA3WrrRHG1ghopWkVgiFNLSWWZoqLAUgIllcDF3j19ay9-0-Nanfo-0VjrnA1G6CGSvE_TyRUaea7mXmDUapY3YA",
      "code": "validation_error",
      "description": [
        {
          "errorMessage": "Неизвестный from"
        }
      ]
    }
  ]
}

Коллбэки

Как подключить

Для настройки коллбэков со статусами push-уведомлений необходимо обратиться к менеджеру компании или в техническую поддержку.

Возможные статусы

Статус Описание
accepted Уведомление было принято на доставку.
send Уведомление отправлено в службу уведомлений устройства.
delivered Уведомление доставлено до устройства.
opened Был переход по ссылке из уведомления.
rejected Уведомление отклонено.
canceled Получатель смахнул уведомление с экрана.
expired Уведомление не было доставлено за отведенное время.
unsubscribed Пользователь отключил уведомления.