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

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

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

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

Рекомендуемые ограничения на количество символов

40 символов для заголовка и 80 символов для сообщения

Все уведомления, которые вы отправляете пользователям, отображаются в push-баннере браузера:

web push

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

POST https://pub.multipushed.ru/v2/publish-web-push

Тело запроса

{
"title": "Test Notification",
"payload": "My push",
"url": "https://multipushed.ru/",
"body": "Добрый день",
"image": "https://example.com/image.png",
"placeholderImage": "https://example.com/image.png",
"pushActions": [
{"actionCode": "action1", "title": "Яндекс", "actionUrl": "https://yandex.ru"},
{"actionCode": "action2", "title": "Гугл", "actionUrl": "https://google.com"}
],
"silent": true
}

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

titleТекст заголовка пуш-сообщенияНеобязательное поле
bodyОсновной текст пуш-сообщенияНеобязательное поле
payloadНетипизированное сообщение. До клиента будет доставлено в том же виде, в котором передано. Заполняется ИЛИ payload ИЛИ title + bodyНеобязательное поле
urlURL страницы, которая открывается при нажатии на пуш или на заглавное изображение (если задано)Необязательное поле
imageURL иконки пуш-сообщения, рекомендуемый размер 64 на 64 pxНеобязательное поле
placeholderImageURL заглавного изображения пуш-сообщения, рекомендуемый размер 320 на 160 pxНеобязательное поле
pushActionsКнопки действий, максимум 2. Если будет добавлено больше, отобразятся только 2 первых.
actionCode - уникальный идентификатор действия, задается произвольно;
title - надпись на кнопке, которую видит пользователь при отображении пуша;
actionUrl - URL страницы, которая открывается при нажатии на соответствующую кнопку
Необязательное поле
silentПуш-сообщение не будет отображено пользователю, если параметр равен trueНеобязательное поле

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

curl --request POST \
--url https://pub.multipushed.ru/v2/publish-web-push/<clientToken> \
--header 'Authorization: YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"title": "Test Notification",
"url": "https://multipushed.ru/",
"body": "Добрый день",
"image": "https://example.com/image.png"
}'

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

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