Получение списка сообщений из канала
Запрос
POST /pub/v1/channel/{channel}/message/list
Параметры пути (path)
| Имя параметра | Тип | Описание | Дополнительно |
|---|---|---|---|
| channel | uuid | Идентификатор канала |
Обязательный |
Тело запроса (body)
Тело запроса принимает ресурс Запрос на получение списка сообщений из канала. Содержит следующие доступные для записи свойства:
{
"filter": {
"author": [
"uuid"
],
"bodyKeywords": [
"string"
],
"createdFrom": "date-time",
"createdTo": "date-time",
"files": [
"uuid"
],
"hasComments": "boolean",
"titleKeywords": [
"string"
]
},
"from": "int32",
"size": "int32"
}Свойства
| Имя | Тип | Описание | Дополнительно |
|---|---|---|---|
| filter | object | Фильтр сообщений | Опциональное |
| filter.author[] | array of uuid | Опциональное | |
| filter.bodyKeywords[] | array of string | Опциональное | |
| filter.createdFrom | date-time | Начало диапазона дат создания (включительно) | Опциональное |
| filter.createdTo | date-time | Конец диапазона дат создания (включительно) | Опциональное |
| filter.files[] | array of uuid | Опциональное | |
| filter.hasComments | boolean | Флаг наличия/отсутствия комментариев | Опциональное |
| filter.titleKeywords[] | array of string | Опциональное | |
| from | int32 | Смещение (по умолчанию 0) | Опциональное |
| size | int32 | Ограничения по количеству (по умолчанию 10) | Опциональное |
Авторизация
Запрос обязательно должен использовать один из следующих методов авторизации:
API key
Ответ
Могут быть возвращены следующие коды состояния HTTP:
| HTTP-статус | Описание | Модель ответа |
|---|---|---|
| 200 | OK Успешный ответ |
Ответ на получение списка сообщений из канала |
| 400 | Bad Request Ошибка в запросе |
Ответ, содержащий информацию об ошибке |
| 403 | Forbidden Доступ запрещен |
Ответ, содержащий информацию об ошибке |
| 429 | Слишком много запросов |
Слишком много запросов (Получение списка сообщений из канала) |