API ГЭПС ГОСУСЛУГИ ГЭПС
Уведомление

Все примеры «персональных данных», представленные на данном портале, являются тестовыми (не реальными)! Примеры представлены разработчикам для тестирования ИТ-систем. Доступ к реальным данным осуществляется в соответствии с законами РФ согласно «Методическим рекомендациям». Подробнее.

Если у вас есть законные основания для подключения к Виду сведения, мы можем проконсультировать по техническим и организационным моментам подключения. Связаться с нами

Получение детальной информации по уведомлению из ГЭПС

epgu api geps-api

Атрибут Значение
Название message-info
Наименование Получение списка уведомления из ГЭПС
Тип Адаптер для API ГЭПС сервиса

Принимаемые параметры

Параметр Описание Обязательное Тип Пример
client_uuid Уникальный идентификатор формата UUID, сформированный соответствующим сервисом ЕСИА в привязке на сотрудника организации и ИС вендора, зарегистрированной в ЕСИА + Строковый ddf21110-3548-44ec-a56a-4d954adff75a
thread_uuid Идентификатор группировки уведомления, полученный в сформированном списке уведомлений + Строковый 6c7a5efd-2a8c-11f0-8080-808080808080
message_uuid Уникальный идентификатор уведомления + Строковый 91160bbb-f997-11ef-8080-808080808080

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

Параметр Описание Обязательное Тип Пример
status Статус обработка запроса. Допустимые значения:
- REJECTED - ошибка валидации
- IN_PROGRESS - ГЭПС еще формирует файлы вложений
- COMPLETED - содержание письма получено полностью
- INCOMPLETE - содержание письма получено, но не удалось загрузить все вложения
- FAILED - ошибка, дальнейшее выполнение невозможно		 + Строковый COMPLETED
thread_uuid Идентификатор группировки уведомления, полученный в сформированном списке уведомлений + Строковый 6c7a5efd-2a8c-11f0-8080-808080808080
message_uuid Уникальный идентификатор уведомления + Строковый 91160bbb-f997-11ef-8080-808080808080
code Код ошибки. Указывается для некоторых ошибок. - Строковый VALIDATION_ERROR
message Текстовое описание ошибки - Строковый Ошибка доступа. Необходимо использовать данные для аутентификации от ролей «Руководитель организации» или «Администратор»
text Текст уведомления, который отображается на ЕПГУ. В тексте имеется html-формат и css-стили, которые применяются на ЕПГУ - Строковый <div class="mail-body-content mini-bottom"><div class="lg-h-title-16-big md-h-title-16-big sm-h-title-16 text-plain"><div></div><div class="all-offset-top-8 mt-8">Найден штраф, выставленный на ИНН / КПП 1233</div><div class="all-offset-top-24 mt-24" style="background-color: #EDF2FE; padding: 8px 20px 20px 20px; border-radius: 8px;"><div class="all-offset-top-8 mt-12"><b>Госномер:</b> А000АА001</div><div class="all-offset-top-8 mt-12"><b>Ваш транспорт:</b> Тест </div></div></div></div>
is_read Признак прочтения уведомления - Логический true
created_date Дата создания уведомления в системе - Строковый 2025-01-01T00:00:00.000+03:00
params Объект параметров, которые передала система-отправителя для уведомления и которые сформированы системой ГЭПС - Объект Составной элемент MessageParams
attachment_list Массив вложений - Массив Последовательность элементов MessageAttachment
status_list История статусов уведомления - Массив Последовательность элементов MessageStatus
stored_attachments Информация о файлах вложениях, сохраненных в ФХ Агредатора - Массив Последовательность элемента StoredAttachment
Готовность вложений

Вложения могут быть готовы не сразу, и в таком случае при выполнении первого запроса в API ГЭПС будут возвращены данные уведомления, без сохраненных в ФХ Агредатора (будут отсутствовать идентификаторы файлов в ФХ и stored_attachments). При этом запрос не будет считаться завершенным, и после готовности вложений (перехода в терминальный статус) будет получен ответ с данными о хранении файлов в ФХ Агредатора.

В случае возникновения ошибки при обработке запроса, в качестве результата может быть возвращено сообщение с следующими полями (возможно наличие дополнительных полей - зависит от ошибки)

Параметр Описание Обязательное Тип Пример
error_group Код группировки ошибки. Возможные значения:
- signer - ошибка связанная с сервисом подписания
- geps - ошибка произошла в результате обращения к API ГЭПС
- esia - ошибка произошла при получении маркера доступа ЕСИА
- async_sign - ошибка при работе с асинхронной подписью
- unknown - неизвестная группа		 + Строковый geps
exception_message Сообщение об ошибке + Строковый Forbidden error

Структура элемента MessageParams

Параметр Описание Обязательное Тип Пример
title Наименование отправителя в деталях уведомления ГЭПС в ЛК ЕПГУ. Наименование произвольное и без формализма, например, «ФССП» вместо «ФССП России» - Строковый МВД
feed_subtitle Наименование темы в деталях уведомления ГЭПС в ЛК ЕПГУ - Строковый Оплатите штраф за нарушение ПДД
inner_title Наименование отправителя в ленте уведомлений в ЛК ЕПГУ. Наименование произвольное и без формализма, например, «ФССП» вместо «ФССП России» - Строковый МВД
inner_subtitle Наименование темы в ленте уведомлений в ЛК ЕПГУ - Строковый Оплатите штраф за нарушение ПДД
<произвольное имя="">1 Любой другой произвольный параметр, который был передан системой, отправившей уведомления. Часть параметров используется для подстановки в текст уведомления. Система, отправляющая уведомления, сама присваивает наименование параметров и узнать их заранее нельзя, например, UIN, fknumber, deloNum, type и т.п. - Строковый или Объект  

1 - подразумевается произвольное количество дополнительных параметров

Структура элемента MessageAttachment

Параметр Описание Обязательное Тип Пример
message_uuid Уникальный идентификатор уведомления + Строковый 91160bbb-f997-11ef-8080-808080808080
attachment_uuid Уникальный идентификатор вложения + Строковый 61d94a0a-66ce-11ef-8080-808080808080
file_name Наименование файла вложения + Строковый attachment.pdf
file_size Размер файла вложения (байты) - Числовой 123
mime_type Тип файла в формате RFC-2046 + Строковый application/pdf
signed Признак наличия отсоединенной электронной подписи файла + Логический true
status_mnemonic Код статуса вложения. Возможные значения:
- DELETED – файл удален в системе. Терминальный статус;
- DOWNLOADING – файл в процессе загрузки (допустим для уведомлений по автоштрафам и копиям бумажным письмам, направляемых от Почты России). Промежуточный статус;
- READY – файл доступен для скачивания, со временем может быть удален;
- UNAVAILABLE – файл недоступен (допустим для уведомлений по автоштрафам направляемых от Почты России). Терминальный статус		 + Строковый READY
status_description Текстовое описание статуса вложения + Строковый Файл готов к использованию
file_storage_uuid Идентификатор файла в ФХ Агредатора - Строковый proxy*db*ea173b330be5316824c814eaa2b807e3ab38fe4fb1d381db7a56a49eef5992d7
sig_storage_uuid Идентификатор файла подписи в ФХ Агредатора - Строковый proxy*db*7d39b9d418c1591414e39a2ace310abc601ebee076baeb005968c9ee10608063

Структура элемента MessageStatus

Параметр Описание Обязательное Тип Пример
mnemonic Обязательный параметр. Код статуса уведомления. Возможные значения:
- ACCEPT_USER_NOT_AGREEMENT – доставлено в систему ГЭПС (альтернативный статус DELIVERED_TO_USER);
- DELIVERED_TO_USER – Доставлено в систему ГЭПС;
- DELIVERED_TO_FEED – Доставлено в ЛК ЕПГУ;
- AUTHORIZE_CONFIRMED – Выполнен вход организацией на ЕПГУ;
- DELIVERY_CONFIRMED – Выполнен переход организаций в ЛК ЕПГУ;
- READ_BY_USER – Выполнено прочтение уведомлений организацией в ЛК ЕПГУ;
- HAND_TO_USER – Уведомление вручено;
- READ_EDS_NEW – Необходимо заверить факт прочтения КЭП (уведомление от КНД). Заверить можно только на портале ЕПГУ;
- READ_EDS_RUNNING – В процессе заверения факта прочтения КЭП (уведомление от КНД);
- READ_EDS_OK – Заверено фактом прочтения КЭП (уведомление от КНД);
- READ_DOWNLOAD - сохранена сотрудником выгрузка уведомлений (архив), которая была сформирована в личном кабинете организации. Статус можно игнорировать		 + Строковый READ_BY_USER
description Текстовое описание статуса уведомления + Строковый Прочитано пользователем
originator_user_name ФИО сотрудника, под которым изменился статус. Формат: «Фамилия И.О.». Если статус сменился системой, то допустимо значение null - Строковый или null Фамилия И. О.
create_date Дата и время присвоения статуса + Строковый 2025-01-01T00:00:00.000+03:00

Структура элемента StoredAttachment

Параметр Описание Обязательное Тип Пример
uuid Идентификатор файла в ФХ Агредатора + Строковый proxy*db*ea173b330be5316824c814eaa2b807e3ab38fe4fb1d381db7a56a49eef5992d7
filename Имя файла + Строковый attachment.pdf
delete_at Дата и время удаления файла из ФХ Агредатора + Строковый 2026-02-28T14:07:49.516+00:00
attachment_uuid Идентификатор вложения в ГЭПС + Строковый 61d94a0a-66ce-11ef-8080-808080808080
attachment_type Тип файла связанного с вложением. Допустимые значения:
- file - файл
- sig - подпись файла		 + Строковый file

Примеры

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

{
  "client_uuid": "22ee1ee3-f62b-4714-a04d-c2acdaff2a5f",
  "thread_uuid": "6c7a5efd-2a8c-11f0-8080-808080808080",
  "message_uuid": "91160bbb-f997-11ef-8080-808080808080"
}

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

{
  "thread_uuid": "6c7a5efd-2a8c-11f0-8080-808080808080",
  "message_uuid": "91160bbb-f997-11ef-8080-808080808080",
  "text": "<div class=\"mail-body-content mini-bottom\"><div class=\"lg-h-title-16-big md-h-title-16-big sm-h-title-16 text-plain\"><div></div><div class=\"all-offset-top-8 mt-8\">Найден штраф, выставленный на&nbsp;ИНН / КПП 1233</div><div class=\"all-offset-top-24 mt-24\" style=\"background-color: #EDF2FE; padding: 8px 20px 20px 20px; border-radius: 8px;\"><div class=\"all-offset-top-8 mt-12\"><b>Госномер:</b> А000АА001</div><div class=\"all-offset-top-8 mt-12\"><b>Ваш транспорт:</b> Тест </div></div></div></div>",
  "params": {
    "feed_title": "МВД",
    "feed_subtitle": "Оплатите штраф за нарушение ПДД",
    "inner_title": "МВД",
    "inner_subtitle": "Оплатите штраф за нарушение ПДД",
    "id ": 123
  },
  "attachment_list": [
    {
      "message_uuid": "91160bbb-f997-11ef-8080-808080808080",
      "attachment_uuid": "61d94a0a-66ce-11ef-8080-808080808080",
      "file_name": "attachment.pdf",
      "file_size": 123,
      "mime_type": "application/pdf",
      "signed": true,
      "status_mnemonic": "READY",
      "status_description": "Файл готов к использованию",
      "file_storage_uuid": "proxy*db*31445f975a6f45aa038e55de7d3a11bbdc2363f288a1618d1555b57a883aaa6e",
      "sig_storage_uuid": "proxy*db*095b4fd8aa7e2744230efae2122e79671ac63c82a695791cc089525b763da305"
    }
  ],
  "status_list": [
    {
      "mnemonic": "READ_BY_USER",
      "description": "Прочитано пользователем",
      "originator_user_name": "Фамилия И. О.",
      "create_date": "2025-01-01T00:00:00.000+03:00"
    }
  ],
  "is_read": true,
  "create_date": "2025-01-01T00:00:00.000+03:00",
  "status": "COMPLETED",
  "stored_attachments": [
    {
      "uuid": "proxy*db*31445f975a6f45aa038e55de7d3a11bbdc2363f288a1618d1555b57a883aaa6e",
      "filename": "attachment.pdf",
      "delete_at": "2026-03-05T14:24:07.398+00:00",
      "attachment_type": "file",
      "attachment_uuid": "61d94a0a-66ce-11ef-8080-808080808080"
    },
    {
      "uuid": "proxy*db*095b4fd8aa7e2744230efae2122e79671ac63c82a695791cc089525b763da305",
      "filename": "attachment.pdf.sig",
      "delete_at": "2026-03-05T14:24:07.487+00:00",
      "attachment_type": "sig",
      "attachment_uuid": "61d94a0a-66ce-11ef-8080-808080808080"
    }
  ]
}

Пример ответа в случае ошибки:

{
  "code": "geps",
  "status": "FAILED",
  "message": "Уведомление недоступно или не найдено",
  "thread_uuid": "6c7a5efd-2a8c-11f0-8080-808080808080",
  "message_uuid": "91160bbb-f997-11ef-8080-808080808080"
}
  • Получение детальной информации по уведомлению из ГЭПС
  • Принимаемые параметры
  • Параметры ответа
  • Структура элемента MessageParams
  • Структура элемента MessageAttachment
  • Структура элемента MessageStatus
  • Структура элемента StoredAttachment
  • Примеры
    • Подавай заявку сейчас

    Оставьте свои контактные данные и наш менеджер свяжется с вами в ближайшее время