Message
/services/messagedispatcherservice/api/message/send
Отправить сообщение в канал
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры сообщения
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| body | string | Текст сообщения | нет | |
| subject | string | Тема сообщения | нет | |
| channelName | string | Имя канала | нет | |
| recipients | string[] | Получатели сообщения | нет | |
| from | string | Посылатель | нет | |
| file | MessageFile | |||
| useTemplate | boolean | Флаг - использование шаблона сообщений | нет | |
| templateData | object | Данные для заполнения шаблона сообщений | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/messagedispatcherservice/api/message/update
Обновить статус сообщения
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры обновления статуса
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| externalId | string | Внешний идентификатор сообщения | нет | |
| recipient | string | Получатель сообщения | нет | |
| isError | boolean | Флаг - наличие ошибки | нет | |
| info | string | Информация об ошибке | нет | |
| provider | 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 | да |
/services/messagedispatcherservice/api/message/resend
Переотправка сообщения
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры переотправки сообщения
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| externalId | string | Внешний идентификатор | нет | |
| from | 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 | да |
/services/messagedispatcherservice/api/message/sendex
Отправить сообщение в канал (расширенная информация об отправке)
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры сообщения
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| body | string | Текст сообщения | нет | |
| subject | string | Тема сообщения | нет | |
| channelName | string | Имя канала | нет | |
| recipients | object | Получатели сообщения (ключ - провайдер, значение - список адресатов) | нет | |
| from | string | Посылатель | нет | |
| files | MessageFile[] | Вложенный файл | нет | |
| useTemplate | boolean | Флаг - использование шаблона сообщений | нет | |
| templateData | object | Данные для заполнения шаблона сообщений | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | SendResult[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |