Отправка уведомлений в заглушки
Отправка telegram-уведомлений общего вида в webhook заглушку
Отправляет telegram-уведомления общего вида в webhook заглушку. Для отправки уведомлений в заглушку используются данные запроса и не применяется база пользователей центра уведомлений.
Запрос
Swagger
POST
/v1/systems/{systemId}/stub/webhook-telegramПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
flag | string | Код приоритета уведомлений | |
sendAfter | string | date-time | Дата и время отложенной отправки с привязкой к часовому поясу |
sendBefore | string | date-time | Дата и время актуальности (отправить до) с привязкой к часовому поясу |
content | string | Сообщение | |
reportForm | ReportForm | Параметры шаблона печати | |
chatId | string | Уникальный идентификатор целевого чата или имя пользователя целевого канала (в формате @channelusername). | |
messageThreadId | integer | int32 | Уникальный идентификатор целевой ветки сообщений (темы) чата. Только для супергрупп. |
replyToMessageId | integer | int32 | Если сообщение является ответом, указать ID исходного сообщения. |
parseMode | string | Режим парсинга сущностей в тексте сообщения. Дополнительные сведения см. в параметрах форматирования. | |
disableWebPagePreview | boolean | Отключить предварительный просмотр ссылок в этом сообщении. | |
disableNotification | boolean | Отправить уведомление без оповещения. | |
protectContent | boolean | Защитить содержимое отправленного сообщения от пересылки и сохранения. | |
allowSendingWithoutReply | boolean | Указать True, если сообщение должно быть отправлено, даже если указанное сообщение с ответом не найдено. | |
entities | WebHookTelegramNotificationEntity[] | Сериализованный в формате JSON список специальных сущностей, которые появляются в тексте сообщения, который можно указать вместо parseMode. | |
replyMarkup | object | Дополнительные возможности интерфейса. Сериализованный объект JSON для встроенной клавиатуры, настраиваемой клавиатуры для ответов, инструкций по удалению клавиатуры для ответов или принудительному ответу пользователя. |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
incomingId | string | uuid | |
notificationResponses | NotificationResponse[] |
Отправка mattermost-уведомлений общего вида в webhook заглушку
Отправляет mattermost-уведомления общего вида в webhook заглушку. Для отправки уведомлений в заглушку используются данные запроса и не применяется база пользователей центра уведомлений.
Запрос
Swagger
POST
/v1/systems/{systemId}/stub/webhook-mattermostПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
flag | string | Код приоритета уведомлений | |
sendAfter | string | date-time | Дата и время отложенной отправки с привязкой к часовому поясу |
sendBefore | string | date-time | Дата и время актуальности (отправить до) с привязкой к часовому поясу |
content | string | Сообщение | |
channel | string | Переопределяет канал, в котором публикуется сообщение. Используйте имя канала, а не отображаемое имя, например, используйте town-square, а не Town Square. Используйте «@», за которым следует имя пользователя, чтобы отправить в личное сообщение. По умолчанию используется канал, установленный при создании веб-хука. | |
username | string | Переопределяет имя пользователя, под которым публикуется сообщение. По умолчанию используется имя пользователя, заданное при создании веб-хука. | |
iconUrl | string | Переопределяет изображение профиля, с которым публикуется сообщение. | |
iconEmoji | string | Переопределяет изображение и icon_url параметр профиля. По умолчанию нет и не задается при создании веб-перехватчика. Ожидаемое значение — это имя эмодзи, введенное в сообщении, с двоеточием или без него ( :) | |
type | string | Устанавливает тип сообщения, в основном для использования плагинами. Если не пусто, должно начинаться с custom_. | |
attachments | WebHookMattermostAttachment[] | Вложения сообщений, используемые для более широких возможностей форматирования. | |
props | object | Пакет свойств JSON для хранения дополнительных или метаданных в сообщении. | |
reportForm | ReportForm | Параметры шаблона печати |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
incomingId | string | uuid | |
notificationResponses | NotificationResponse[] |
Отправка sms общего вида в заглушку
Отправляет sms общего вида в заглушку. Для отправки уведомлений в заглушку используются данные запроса и не применяется база пользователей центра уведомлений.
Запрос
Swagger
POST
/v1/systems/{systemId}/stub/smsПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
flag | string | Код приоритета уведомлений | |
sendAfter | string | date-time | Дата и время отложенной отправки с привязкой к часовому поясу |
sendBefore | string | date-time | Дата и время актуальности (отправить до) с привязкой к часовому поясу |
phoneNumbers | string[] | Номера телефонов получателей | |
text | string | Текст сообщения | |
reportForm | ReportForm | Параметры шаблона печати |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
incomingId | string | uuid | |
notificationResponses | NotificationResponse[] |
Отправка push общего вида в заглушку
Отправляет push общего вида в заглушку. Для отправки уведомлений в заглушку используются данные запроса и не применяется база пользователей центра уведомлений.
Запрос
Swagger
POST
/v1/systems/{systemId}/stub/pushПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
flag | string | Код приоритета уведомлений | |
sendAfter | string | date-time | Дата и время отложенной отправки с привязкой к часовому поясу |
sendBefore | string | date-time | Дата и время актуальности (отправить до) с привязкой к часовому поясу |
title | string | Заголовок | |
body | string | Текст сообщения | |
image | string | URL картинки, в одном из доступных форматов: JPEG, PNG или BMP | |
data | object | Дополнительная информация | |
reportForm | ReportForm | Параметры шаблона печати | |
deviceTokens | string[] | Идентификаторы устройств для отправки уведомлений | |
topic | string | Топик, на который переданные устройства должны быть подписаны для доставки уведомления | |
condition | string | Условие выбора устройств из топика |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
incomingId | string | uuid | |
notificationResponses | NotificationResponse[] |
Отправка gaps общего вида в заглушку
Отправляет gaps общего вида в заглушку. Для отправки уведомлений в заглушку используются данные запроса и не применяется база пользователей центра уведомлений.
Запрос
Swagger
POST
/v1/systems/{systemId}/stub/gapsПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
flag | string | Код приоритета уведомлений | |
sendAfter | string | date-time | Дата и время отложенной отправки с привязкой к часовому поясу |
sendBefore | string | date-time | Дата и время актуальности (отправить до) с привязкой к часовому поясу |
from | string | Отправитель сообщения | |
sendTime | string | date-time | Дата и время отправки уведомления |
gapsRequest | EpguGapsRequestDto | Данные от смэва содержащие вложения, настройки и документы, по которым будет осуществлена отправка | |
useSystemSettings | boolean | Поднятый флаг говорит о том, что для уведомления будут использованы пользовательские системные настройки |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
incomingId | string | uuid | |
notificationResponses | NotificationResponse[] |
Отправка email общего вида в заглушку
Отправляет email общего вида в заглушку. Для отправки уведомлений в заглушку используются данные запроса и не применяется база пользователей центра уведомлений.
Запрос
Swagger
POST
/v1/systems/{systemId}/stub/emailПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
flag | string | Код приоритета уведомлений | |
sendAfter | string | date-time | Дата и время отложенной отправки с привязкой к часовому поясу |
sendBefore | string | date-time | Дата и время актуальности (отправить до) с привязкой к часовому поясу |
to | string[] | Адреса получателей | |
cc | string[] | Адреса получателей | |
bcc | string[] | Адреса получателей скрытой копии | |
fileGroupId | string | uuid | Идентификатор группы загруженных файлов для отправки |
from | string | Адрес отправителя | |
displayName | string | Отображаемое имя отправителя | |
subject | string | Тема | |
importance | HIGH | NORMAL | LOW | Важность | |
contentType | HTML | TEXT | Тип содержимого письма | |
content | string | Содержимое письма | |
reportForm | ReportForm | Параметры шаблона печати | |
sendSeparate | boolean | Отправлять каждому адресату отдельное письмо |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
incomingId | string | uuid | |
notificationResponses | NotificationResponse[] |
Модели
ReportForm
WebHookTelegramNotificationUser
WebHookTelegramNotificationEntity
WebHookTelegramNotificationDto
NotificationResponse
NotificationChainResponse
ResponseError
Field
WebHookMattermostAttachment
WebHookMattermostNotificationDto
SmsDto
PushDto
AttachmentUploadInfoDto
EpguGapsRegistryReNoticeDto
EpguGapsRegistrySettingsDto
EpguGapsGeneralDataRequestDto
EpguGapsForeignPersonDocumentDto
EpguGapsInnDto
EpguGapsAddressDto
EpguGapsLegalPersonDto
EpguGapsPhysicalPersonDto
EpguGapsUserDto
EpguGapsNameAddressDto
EpguGapsParamsDto
EpguGapsPersonDocumentDto
EpguGapsRequestRecordContentDto
EpguGapsRequestRecordDto
EpguGapsRequestMessageDto
EpguGapsRequestDto
GapsDto
EmailDto
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки