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

Отправка пушей

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

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

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

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

Тело запроса

{
"ttl": <time_to_live>,
"ttd": <time_to_delivery>,
"payload": "My push",
"cascadingSMS": true,
"cascadingMailRU": false,
"SMSpayload": {
"body": null
},
"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
},
"pushedNotification": {
"title": null,
"body": null,
"image": null,
"logo": null,
"url": null,
"utm": null
},
"templateId": null
}

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

clientTokenКлиентский токен устройстваОбязательное поле
accessTokenТокен мобильного приложения (из системы управления Pushed)Обязательное поле
ttlВремя жизни сообщения в секундах (по умолчанию 24 часа)Необязательное поле
ttdВремя доставки пуша. Если в сервисе включен каскад, например, на СМС, то при неуспешной доставке через время TTD будет отправлена СМС (по умолчанию 24 часа)Необязательное поле
payloadТело сообщения (До клиента будет доставлено в том виде, в котором передано)Обязательное поле
cascadingSMSВключить каскадную отправку через смс(по умолчанию true, если cascadingSMS = false при неудачной отправке пуш сообщения через все включенные транспорты отправка смс не произойдёт)Необязательное поле
cascadingMailRUВключить каскадную отправку через ВК/одноклассникиНеобязательное поле
SMSpayloadТекст, который будет отправлен в СМС (payload идет в пуш, а SMSPayload в СМС, если передан только payload, то он отправляется по всем каналам) Необязательное поле
apnsНастройки для отправки через APNsНеобязательное поле
pushedNotificationКонфигурация отображения пушаНеобязательное поле, но если его заполнить, то поле pushedNotification.Body будет обязательным
titleЗаголовокНеобязательное поле
bodyТело пуш-уведомленияНеобязательное поле
imageСсылка на картинку, доступно только на androidНеобязательное поле
logoИмя графического ресурса внутри приложения, которое содержит иконку. Если оно не указано или ресурс не найден, будет использована стандартная иконка приложенияНеобязательное поле
urlUrl, на который пользователь будет перенаправлен при нажатии на пушНеобязательное поле
utmUtm меткаНеобязательное поле
templateIdИдентификатор шаблонаНеобязательное поле

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

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

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

{
"model": {
"id": "66d5a0bb6a1dc7d467d1adee",
"createdAt": "2024-09-02T11:25:47.8329958Z",
"sentAt": null,
"messageStatus": "InProcess"
},
"success": true/false,
"message": string/null,
"errCode": int/null
}
modelданные ответа, будет заполнено в случае успешного выполнения
successрезультат выполнения запроса
errCodeкод ошибки, будет заполнено в случае ошибки
messageтекстовое описание ошибки, будет заполнено в случае ошибки