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

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

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

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

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

Создает группу для отправок push-сообщений.

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

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

Тело запроса

{
"ttl": <time_to_live>,
"ttd": <time_to_delivery>,
"payload": "My push",
"groupId": <group_id>,
"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
},
"hpk": {
"notificationTitle": "My title",
"notificationBody": "My body",
"notificationButtons": [
{
"buttonId": "string",
"buttonName": "string"
}
]
}
}

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

clientTokenКлиентский токен устройстваОбязательное поле
accessTokenТокен мобильного приложения (из системы управления Pushed)Обязательное поле
ttlВремя жизни сообщения в секундах (по умолчанию 24 часа)Необязательное поле
ttdВремя доставки пуша. Если в сервисе включен каскад, например, на СМС, то при неуспешной доставке через время TTD будет отправлена СМС (по умолчанию 24 часа)Необязательное поле
payloadТело сообщения (До клиента будет доставлено в том виде, в котором передано)Обязательное поле
groupIdОтправить только определенной группеНеобязательное поле
cascadingSMSВключить каскадную отправку через смсНеобязательное поле
cascadingMailRUВключить каскадную отправку через ВК/одноклассникиНеобязательное поле
SMSpayloadТекст, который будет отправлен в СМС (payload идет в пуш, а SMSPayload в СМС, если передан только payload, то он отправляется по всем каналам)Необязательное поле
apnsНастройки для отправки через APNsНеобязательное поле
hpkНастройки для отправки через HPKНеобязательное поле

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

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текстовое описание ошибки, будет заполнено в случае ошибки