Message
/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 | да |
/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 | да |
/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 | да |
/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 |