Работа со статусами уведомлений
Получение всех отправленных уведомлений с актуальными статусами по id пользователя
Возвращает все отправленные уведомления с актуальными статусами по id пользователя.
Запрос
Swagger
GET
/v1/systems/{systemId}/statuses-notifications/user/{userId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
userId * (path) | string | Идентификатор пользователя |
creationDateFrom (query) | string | |
creationDateTo (query) | string | |
statuses (query) | array | |
notificationTypes (query) | array | |
pageNumber (query) | integer | |
pageSize (query) | integer | |
sortBy (query) | string | |
order (query) | string |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | NotificationsHistoryDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Получение всех отправленных уведомлений с актуальными статусами по типу уведомления
Возвращает все отправленные уведомления с актуальными статусами по типу уведомления.
Запрос
Swagger
GET
/v1/systems/{systemId}/statuses-notifications/notificationType/{notificationType}Параметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
notificationType * (path) | string | Тип уведомления |
creationDateFrom (query) | string | |
creationDateTo (query) | string | |
statuses (query) | array | |
pageNumber (query) | integer | |
pageSize (query) | integer | |
sortBy (query) | string | |
order (query) | string |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | NotificationsHistoryDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Получение всех отправленных уведомлений с актуальными статусами по incoming id
Возвращает все отправленные уведомления с актуальными статусами по incoming id.
Запрос
Swagger
GET
/v1/systems/{systemId}/statuses-notifications/incomingId/{incomingId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
incomingId * (path) | string | Идентификатор чейна уведомлений |
pageNumber (query) | integer | |
pageSize (query) | integer | |
sortBy (query) | string | |
order (query) | string |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | NotificationsHistoryDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Получение истории уведомления по id уведомления
Возвращает историю уведомления по id уведомления.
Запрос
Swagger
GET
/v1/systems/{systemId}/statuses-notifications/externalId/{externalId}/historyПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
externalId * (path) | string | Идентификатор сообщения |
statuses (query) | array | |
pageNumber (query) | integer | |
pageSize (query) | integer | |
sortBy (query) | string | |
order (query) | string |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | NotificationsHistoryDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Получение актуального статуса
Возвращает актуальный статус уведомления.
Запрос
Swagger
GET
/v1/systems/{systemId}/statuses-notifications/externalId/{externalId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
externalId * (path) | string | Идентификатор уведомления |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
incomingId | string | uuid | Идентификатор чейна (списка входящих уведомлений) |
rn | string | Resource name | |
userId | string | uuid | Идентификатор пользователя |
externalId | string | uuid | Номер уведомления |
profileId | string | Идентификатор профиля пользователя | |
groupId | string | uuid | Идентификатор группы пользователей |
systemId | string | uuid | Идентификатор сервиса (проекта, приложения) - владельца пользователя |
notificationType | string | Тип уведомления | |
title | string | Заголовок уведомления | |
message | string | Тело сообщения | |
templateName | string | Имя шаблона сообщения | |
extraNotificationData | object | Специфичные данные для типа уведомлений | |
processingData | object | processingData | |
error | string | Сообщение с информацией об ошибке | |
errorCode | string | Код ошибки | |
requestData | object | Дополнительная информация об уведомлении | |
isActual | boolean | Статус актуальности записи | |
status | PENDING | PROCESSING | SENDING | SENT | FAILED | CANCELED | OUTDATED | DELIVERED | UNDELIVERED | READ | ATTEMPT_FAILED | CHECKING | Статус состояния уведомления | |
lastAttemptTime | string | date-time | Время последней попытки отправить уведомление |
creationDate | string | date-time | Дата создания уведомления |
flag | string | Признак уведомления | |
priority | HIGH | NORMAL | LOW | Приоритет отправки уведомления | |
forStub | boolean | Уведомление было отправлено в заглушку (если значение true) | |
sendAttempts | integer | int32 | Количество попыток отправки уведомления |
Получение всех отправленных уведомлений с актуальным статусом
Возвращает все отправленные уведомления с актуальным статусом.
Запрос
Swagger
GET
/v1/systems/{systemId}/statuses-notificationsПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
creationDateFrom (query) | string | |
creationDateTo (query) | string | |
statuses (query) | array | |
notificationTypes (query) | array | |
incomingIds (query) | array | |
externalIds (query) | array | |
pageNumber (query) | integer | |
pageSize (query) | integer | |
sortBy (query) | string | |
order (query) | string |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | NotificationsHistoryDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Модели
NotificationsHistoryDto
PageResponseNotificationsHistoryDto
ResponseError
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки