Статус web пуш-сообщений

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

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

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

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

Статусы сообщения (messageStatus)

• InProcess — новое пуш-сообщение, ожидает отправки,
• Undelivered — не доставлено,
• Delivered — доставлено.

Статус по id

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

curl -v -X POST https://pub.multipushed.ru/v2/messages/<messageId>
        -H "Content-Type: application/json"     
        -H "Authorization: Bearer <websiteAccessToken>"

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

websiteAccessToken	Токен веб сайта (из системы управления MULTIPUSHED)	Обязательное поле
id	Идентификатор пуш-сообщения	Обязательное поле

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

{
    "model": {
        "id": "66d5a6586a1dc7d467d1adef",
        "createdAt": "2024-09-02T11:49:44.508Z",
        "sentAt": "2024-09-02T11:49:51.083Z",
        "messageStatus": "Delivered"
    },
    "success": true,
    "message": null,
    "errCode": null
}

id	Идентификатор пуш-сообщения
createdAt	Дата создания
sentAt	Дата отправки
messageStatus	Статус отправки

Статус по clientToken

Тело запроса

{
  "clientToken": "string",
  "dateFrom": "2024-08-27T07:43:08.946Z",
  "dateTo": "2024-08-27T07:43:08.946Z",
  "limit": 0,
  "offset": 0
}

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

clientToken	Клиентский токен, по котору осуществляется поиск	Обязательное поле
dateFrom	Дата в формате UTC, от которой осуществляется поиск (если параметр не задан, выгрузка будет от первого сообщения по клиентскому токену)	Необязательное поле
dateTo	Дата в формате UTC, до которой осуществляется поиск (если параметр не задан, выгрузка будет до последнего сообщения по клиентскому токену)	Необязательное поле
limit	Количество элементов, которое будет возвращено при запросе (по умолчанию - 100)	Необязательное поле
offset	Смещение при поиске сообщений (по умолчанию - 0)	Необязательное поле

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

curl -v -X POST https://pub.multipushed.ru/v2/messages
        -H "Content-Type: application/json"
        -H "Authorization: Bearer <websiteAccessToken>"
    -d '{"clientToken":"<clientToken>","dateFrom":"2024-08-27T07:43:08.946Z","dateTo":"2024-08-27T07:43:08.946Z"}'

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

{
    "model": {
        "limit": 100,
        "offset": 0,
        "totalElements": 2,
        "data": [
            {
                "id": "66d5a0bb6a1dc7d467d1adee",
                "createdAt": "2024-09-02T11:25:47.832Z",
                "sentAt": null,
                "messageStatus": "InProcess"
            },
            {
                "id": "66d5a6586a1dc7d467d1adef",
                "createdAt": "2024-09-02T11:49:44.508Z",
                "sentAt": "2024-09-02T11:49:51.083Z",
                "messageStatus": "Delivered"
            }
        ]
    },
    "success": true,
    "message": null,
    "errCode": null
}

totalElements	Количество найденных сообщений
messageStatus	Статус отправки