Отправка push-сообщений
Отправляет одно или несколько push-сообщений на указанные устройства.
Операция позволяет отправить сообщения с разными свойствами (например, текст, медиа вложение) за один запрос. В каждом запросе может быть указано до 250 000 устройств на которые будут отправлены сообщения.
Примечание
Рекомендуем использовать данную операцию вместо устаревшей POST /push/v1/send.
Формат запроса
POST https://push.api.appmetrica.yandex.net/push/v1/send-batch
Тело запроса
{
"push_batch_request": {
"group_id": 1,
"client_transfer_id": long,
"tag": "string",
"batch": [
{
"messages": {
"android": {
"silent": false,
"content": {
"title": "string",
"text": "string",
"icon": "string",
"icon_background": "#AARRGGBB",
"image": "https://example.com/picture.jpg",
"banner": "https://example.com/picture.jpg",
"data": "string",
"channel_id": "string",
"priority": -2,
"collapse_key": 2001,
"vibration": [0, 500],
"led_color": "#RRGGBB",
"led_interval": 50,
"led_pause_interval": 50,
"time_to_live": 180,
"visibility": "public",
"urgency": "high"
},
"open_action": {
"deeplink": "yandexmaps://?"
}
},
"iOS": {
"silent": false,
"content": {
"title": "string",
"text": "string",
"badge": 1,
"sound": "disable",
"thread_id": "string",
"category": "string",
"mutable_content": 1,
"expiration": 3600,
"data": "string",
"collapse_id": "string",
"attachments": [
{
"id": "string",
"file_url": "string",
"file_type": "string"
},
...
]
},
"open_action": {
"url": "https://ya.ru"
}
}
},
"devices": [
{
"id_type": "appmetrica_device_id",
"id_values": ["123456789", "42"]
},
{
"id_type": "ios_ifa",
"id_values": ["8A690667-6204-4A6A-9B38-85DE016....."]
},
{
"id_type": "google_aid",
"id_values": ["eb5f3ec8-2e3e-492f-b15b-d21860b....."]
},
{
"id_type": "android_push_token",
"id_values": ["eFfxdO7uCMw:APA91bF1tN3X3BAbiJXsQhk-..."]
},
{
"id_type": "ios_push_token",
"id_values": ["F6A79E9F844A24C5FBED5C58A4C71561C180F........."]
},
{
"id_type": "huawei_push_token",
"id_values": ["0866422030....."]
},
{
"id_type": "huawei_oaid",
"id_values": ["ecef47f7-fcce-ad....."]
}
]
},
{
"messages": {
...
}
}
]
}
}
|
|
Запрос на отправку группы push-сообщений |
|
|
|
Идентификатор (ID) группы. |
|
|
|
Идентификатор отправки, заданный пользователем. Используется для проверки статуса отправки. Внимание Значение поля |
|
|
|
Тег отправки. |
|
|
|
Массив объектов |
|
|
|
Push-сообщение. |
|
|
|
Платформа устройства. |
|
|
|
Признак отправки silent push-сообщений. Допустимые значения: `true |
false`. |
|
|
Содержание push-сообщения. |
|
|
|
Заголовок push-сообщения. Обязателен для не silent push-сообщений. |
|
|
|
Текст сообщения. Обязателен для не silent push-сообщений. |
|
|
|
Иконка в строке уведомлений. По умолчанию отображается стандартная иконка приложения. Чтобы поменять иконку задайте идентификатор ресурса иконки в стандартном каталоге |
|
|
|
Цвет иконки сообщения. Задается в виде строки в формате шестандцатиричного кода |
|
|
|
URL картинки, которая будет отображаться в push-уведомлении рядом с текстом уведомления. |
|
|
|
Ссылка на баннер, отображаемый в push-сообщении. |
|
|
|
Произвольная строка данных. Вы можете передавать любые данные приложению в виде строкового значения. Обработать строку данных можно с помощью соответствующих методов AppMetrica Push SDK. |
|
|
|
Идентификатор канала уведомлений. Если идентификатор не задан — используется канал по умолчанию. Доступно только для Android 8 и выше. Подробнее о каналах в документации Android. |
|
|
|
Приоритет уведомления. Допустимые значения: диапазон |
|
|
|
Идентификатор нотификации. Значение по умолчанию — 0. Не влияет, если нет текущих отображаемых нотификаций данного приложения. Если отображена одна или несколько нотификации, то при совпадении id содержимое нотификации будет обновлено. При отличном от имеющихся id, будет показана новая нотификация. |
|
|
|
Паттерн вибрации при получении сообщения. Формат записи: |
|
|
|
Цвет LED-индикатора. Задается в виде строки в формате шестандцатиричного кода |
|
|
|
Время загорания LED-индикатора в мс. |
|
|
|
Перерыв между загораниями LED-индикатора в мс. |
|
|
|
Время в секундах, в течение которого FireBase будет хранить push-сообщение, если устройство вне зоны доступа. |
|
|
|
Отображаемость push-сообщения на лок-скрине. Игнорируется с Android 8 и выше (API level 26+), где задаётся на уровне канала. Допустимые значения: |
|
|
|
Срочность (приоритет) доставки push-сообщения. Допустимые значения: |
|
|
|
Действие, которое будет произведено при клике на push-сообщение. При отсутствии этого поля нажатие на push-сообщение приведет к открытию приложения. |
|
|
|
Deeplink по которому будет осуществлен переход при клике на push-сообщение. |
|
|
|
Платформа устройства. |
|
|
|
Признак отправки silent push-сообщений. Допустимые значения: `true |
false`. |
|
|
Содержание push-сообщения. |
|
|
|
Заголовок push-сообщения. Обязателен для не silent push-сообщений. |
|
|
|
Текст сообщения. Обязателен для не silent push-сообщений. |
|
|
|
Число, которое отобразится на иконке приложения при получении сообщения. |
|
|
|
Звук сообщения. Допустимые значения `default |
disable`. |
|
|
Идентификатор для группировки push-уведомлений. Значение указывается в свойстве threadIdentifier объекта UNNotificationContent. |
|
|
|
Категория push-уведомления. Значение указывается в свойстве identifier объекта |
|
|
|
Признак расширения Notification Service Extension. Если указано значение Чтобы отслеживать доставку, настройте сбор статистики push-уведомлений и передайте в поле значение |
|
|
|
Время, в течение которого будут предприниматься попытки доставить сообщение на устройство пользователя. Задается в секундах. Если по истечении указанного времени устройство будет недоступно (например, не подключено к интернету), сообщение не будет доставлено. По умолчанию время не ограничено. |
|
|
|
Произвольная строка данных. Вы можете передавать любые данные приложению в виде строкового значения. Обработать строку данных можно с помощью соответствующих методов AppMetrica Push SDK. |
|
|
|
Идентификатор сворачивания apns-collapse-id. Несколько уведомлений с одним и тем же идентификатором отображаются пользователю как одно уведомление. |
|
|
|
Массив вложений, которые необходимо прикрепить в push-сообщении. Подробности настройки можно прочитать в статье Шаг 6. (Опционально) Настройте загрузку прикрепленных файлов. |
|
|
|
Идентификатор содержимого в push-сообщении. |
|
|
|
URL файла из push-сообщения. |
|
|
|
Тип вложенного файла в push-сообщении. Допустимые типы можно посмотреть в разделе Типы файлов в push-сообщениях. |
|
|
|
Действие, которое будет произведено при клике на push-сообщение. При отсутствии этого поля нажатие на push-сообщение приведет к открытию приложения. |
|
|
|
URL по которому будет осуществлен переход при клике на push-сообщение. |
|
|
|
Устройства, на которые необходимо отправить push-уведомления. Одна отправка может содержать до 250 000 устройств.
Устройства группируются по |
|
|
|
Тип идентификатора устройства. Допустимые значения: Примечание При использовании push-токена в качестве идентификатора, AppMetrica проверяет перед отправкой наличие токена и информации об устройстве в базе. Если информации об устройстве нет, то push-сообщение не будет отправлено. Это необходимо для контроля отправки сообщений нужным адресатам и отображения информации в отчетах после отправки. |
|
Формат ответа
{
"push_response": {
"transfer_id": 1,
"client_transfer_id": long
}
}
|
|
Ответ об отправке push-сообщений. |
|
|
Идентификатор (ID) отправки. Используется для проверки статуса отправки. |
|
|
Идентификатор (ID) отправки, заданный пользователем в теле запроса. Используется для проверки статуса отправки. Примечание Поле будет возвращено только если оно было указано в теле запроса. |
Если вы не нашли ответ на свой вопрос, то вы можете задать его через форму обратной связи. Пожалуйста, опишите возникшую проблему как можно подробнее. Если возможно, приложите скриншот.
Тег — это произвольная строка, маркирующая каждую отправку push-сообщений через API. Одним тегом может быть промаркировано произвольное количество отправок. В отчете отображается на втором уровне.
Сообщение, которое обрабатывается приложением в фоновом режиме без отображения пользователю. С помощью silent push можно передать дополнительные данные, либо проверить доставляемость уведомлений.