Перейти к основному содержимому

Трансляция пуш-сообщений

Базовый адрес API https://api.multipushed.ru

Попробуйте в Swagger

Трансляция пуш-сообщений (broadcast)

Массовая отправка пуш-сообщений.

Формат запроса

POST https://pub.multipushed.ru/v2/broadcast-publish

Тело запроса

{
"ttl": <time_to_live>,
"groupId": <group_id>,
"payload": "My push",
"apns": {
"alert": {
"title": null,
"subtitle": null,
"body": null,
"launch-image": null,
"title-loc-key": null,
"title-loc-args": null,
"subtitle-loc-key": null,
"subtitle-loc-args": null,
"loc-key": null,
"loc-args": null
},
"badge": null,
"sound": {
"critical": null,
"name": null,
"volume": null
},
"thread-id": null,
"category": null,
"content-available": 1,
"mutable-available": null,
"target-content-id": null,
"interruption-level": null,
"relevance-score": null,
"filter-criteria": null,
"stale-date": null,
"timestamp": null,
"event": null,
"dismissal-date": null,
"attributes-type": null
},
"hpk": {
"notificationTitle": "My title",
"notificationBody": "My body",
"notificationButtons": [
{
"buttonId": "string",
"buttonName": "string"
}
]
}
}

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

ttlВремя жизни сообщения в секундах (По умолчанию 24 часа)Необязательное поле
payloadТело сообщения (До клиента будет доставлено в том виде, в котором передано)Обязательное поле
groupIdИдентификатор группы (Если поле не задано, то отправка будет производиться по всем устройствам приложения)Необязательное поле
apnsНастройки для отправки через APNsНеобязательное поле
hpkНастройки для отправки через HPKНеобязательное поле

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

curl -v -X POST https://pub.multipushed.ru/v2/broadcast-publish
-H 'Content-Type: application/json'
-H 'Authorization: Bearer <accessToken>'
-d '{"payload": "My payload"}'

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

{
"success": true/false,
"errCode": int/null,
"message": string/null
}
successрезультат выполнения запроса
errCodeкод ошибки, будет заполнено в случае ошибки
messageтекстовое описание ошибки, будет заполнено в случае ошибки