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

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

Попробуйте в 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	Статус отправки

Получение информации по клиентским токенам

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

POST /v2/info/web-client-token

Тело запроса

{
  "clientToken": "клиентский токен"
}

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

clientToken

Клиентский токен, по которому осуществляется поиск

Обязательное поле

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

curl https://api.pushed.ru/v2/info/web-client-token \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: YOUR_SECRET_TOKEN' \
  --data '{
  "clientToken": "токен"
}'

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

{
  "success": true,
  "message": null,
  "errCode": null,
  "model": {
    "createDate": "2025-05-26T06:31:41.732Z",
    "websiteId": null,
    "sdkVersion": null,
    "operatingSystem": null,
    "browser": null,
    "browserVersion": null,
    "isPermissionGranted": true,
    "suspended": true,
    "lastUpdateDate": "2025-05-26T06:31:41.732Z",
    "customerInfo": {
      "phone": null
    },
    "geolocationInfo": {
      "region": null,
      "timeZone": null
    }
  }
}

Информация по всем пуш-сообщениям

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

POST /v2/info/message

Тело запроса

{
  "messageId": "Идентификатор сообщения",
  "targetType": 2
}

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

messageId	ID сообщения, по которому осуществляется поиск	Обязательное поле
targetType	1 - мобильный пуш, 2 - web пуш	Обязательное поле

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

curl https://api.pushed.ru/v2/info/message \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjIwMzA2MDQxMjIsImF1ZCI6IjY2MzllOTVhYzQ1YTM5M2U1ZGYzYTI4MyJ9.DD5ailxSD0N56KzYFePxEnxXSSPGuS1o6UGWzlK25oc' \
  --data '{
  "messageId": "683401664030f74a083b6554",
  "targetType": 2
}'

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

{
  "success": true,
  "message": null,
  "errCode": null,
  "model": [
    {
      "messageId": null,
      "transportKind": 1,
      "pushState": 1,
      "incidentMessage": null,
      "processingDate": null
    }
  ]
}

Информация по конкретному пуш-сообщению

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

POST /v2/info/messages

Тело запроса

{
  "clientToken": null,
  "pushTargetType": 2,
  "limit": 1,
  "offset": 1
}

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

messageId	ID сообщения, по которому осуществляется поиск	Обязательное поле
pushTargetType	1 - мобильный пуш, 2 - web пуш	Обязательное поле
limit	Количество элементов, которые будут в выборке, по умолчанию limit = 10	Необязательное поле
offset	Количество элементов, которые будут пропущены, по умолчанию offset = 0	Необязательное поле

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

curl https://api.pushed.ru/v2/info/messages \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: ' \
  --data '{
  "clientToken": null,
  "pushTargetType": 2,
  "limit": 1,
  "offset": 1
}'

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

{
  "success": true,
  "message": null,
  "errCode": null,
  "model": {
    "totalCount": 1,
    "messages": [
      {
        "messageId": null,
        "sendingDate": "2025-05-26T06:37:25.468Z",
        "confirmDate": null,
        "transportSchema": [
          "Pushed"
        ],
        "deliveredTransport": 1,
        "deadlineDate": null,
        "pushState": 1
      }
    ]
  }
}