Channel

/api/channel/new

Создать новый канал

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

параметры нового канала сообщений

Название поля	Тип поля	Описание	Обязательное	Возможные значения
name	string		нет
description	string		нет
providers	string[]		нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поля	Тип поля	Описание	Обязательное	Возможные значения
message	string	Сообщение ошибки.	да
exceptionType	string	Тип исключения.	да
code	string	Код ошибки.	да
source	string	Имя источника.	да
inners	InnerInfo[]	Элементы исключений.	да
extra	string	Трейс стека.	да
isError	boolean	Флаг ошибки.	да
id	string	Идентификатор ошибки.	да
type	ErrorTypes		да

/api/channel/addprovider

Добавить провайдеры каналу

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

параметры привязки провайдеров каналу

Название поля	Тип поля	Описание	Обязательное	Возможные значения
channelName	string		нет
providers	string[]		нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поля	Тип поля	Описание	Обязательное	Возможные значения
message	string	Сообщение ошибки.	да
exceptionType	string	Тип исключения.	да
code	string	Код ошибки.	да
source	string	Имя источника.	да
inners	InnerInfo[]	Элементы исключений.	да
extra	string	Трейс стека.	да
isError	boolean	Флаг ошибки.	да
id	string	Идентификатор ошибки.	да
type	ErrorTypes		да

/api/channel/removeprovider

Удалить провайдер

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

параметры удаления провайдеров у канала

Название поля	Тип поля	Описание	Обязательное	Возможные значения
channelName	string		нет
providers	string[]		нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поля	Тип поля	Описание	Обязательное	Возможные значения
message	string	Сообщение ошибки.	да
exceptionType	string	Тип исключения.	да
code	string	Код ошибки.	да
source	string	Имя источника.	да
inners	InnerInfo[]	Элементы исключений.	да
extra	string	Трейс стека.	да
isError	boolean	Флаг ошибки.	да
id	string	Идентификатор ошибки.	да
type	ErrorTypes		да

/api/channel/delete/{name}

Удалить канал

Тип HTTP запроса: get

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
name	string	имя канала	path	да

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поля	Тип поля	Описание	Обязательное	Возможные значения
message	string	Сообщение ошибки.	да
exceptionType	string	Тип исключения.	да
code	string	Код ошибки.	да
source	string	Имя источника.	да
inners	InnerInfo[]	Элементы исключений.	да
extra	string	Трейс стека.	да
isError	boolean	Флаг ошибки.	да
id	string	Идентификатор ошибки.	да
type	ErrorTypes		да

/api/channel/get/{name}

Получить информацию по каналу

Тип HTTP запроса: get

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
name	string	имя канала	path	да

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	ChannelInfo
error	Info

/api/channel/list

Получить список каналов

Тип HTTP запроса: get

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	ChannelInfo[]	Результат метода API.	нет
error	Info

/api/channel/messagelist/{channelName}

Получить сообщения по имени канала

Тип HTTP запроса: get

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
channelName	string	имя канала	path	да

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	MessageInfo[]	Результат метода API.	нет
error	Info

/api/channel/message/{extId}

Получить сообщение с аудитом по идентификатору

Тип HTTP запроса: get

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
extId	string	идентификатор сообщения	path	да

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	MessageWithAudit
error	Info

/api/channel/updatetemplatechannelprovider

Изменить шаблон сообщений связки канал-провайдер

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

параметры обновления шаблона сообщений для связки канал-провайдер

Название поля	Тип поля	Описание	Обязательное	Возможные значения
channelName	string		нет
providerName	string		нет
templateName	string		нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поля	Тип поля	Описание	Обязательное	Возможные значения
message	string	Сообщение ошибки.	да
exceptionType	string	Тип исключения.	да
code	string	Код ошибки.	да
source	string	Имя источника.	да
inners	InnerInfo[]	Элементы исключений.	да
extra	string	Трейс стека.	да
isError	boolean	Флаг ошибки.	да
id	string	Идентификатор ошибки.	да
type	ErrorTypes		да