Getting a list of messages from the channel
Request
POST /pub/v1/channel/{channel}/message/list
Path parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| channel | uuid | Channel ID |
Required |
Request body
The resource sent in the request body is Запрос на получение списка сообщений из канала. It contains the following writable properties:
{
"filter": {
"author": [
"uuid"
],
"bodyKeywords": [
"string"
],
"createdFrom": "date-time",
"createdTo": "date-time",
"files": [
"uuid"
],
"hasComments": "boolean",
"titleKeywords": [
"string"
]
},
"from": "int32",
"size": "int32"
}Properties
| Name | Type | Description | Additional |
|---|---|---|---|
| filter | object | Фильтр сообщений | Optional |
| filter.author[] | array of uuid | Optional | |
| filter.bodyKeywords[] | array of string | Optional | |
| filter.createdFrom | date-time | Начало диапазона дат создания (включительно) | Optional |
| filter.createdTo | date-time | Конец диапазона дат создания (включительно) | Optional |
| filter.files[] | array of uuid | Optional | |
| filter.hasComments | boolean | Флаг наличия/отсутствия комментариев | Optional |
| filter.titleKeywords[] | array of string | Optional | |
| from | int32 | Смещение (по умолчанию 0) | Optional |
| size | int32 | Ограничения по количеству (по умолчанию 10) | Optional |
Authorization
This request requires the use of one of following authorisation methods:
API key
Response
The following HTTP status codes may be returned:
| Status code | Description | Resource |
|---|---|---|
| 200 | OK Successful response |
Ответ на получение списка сообщений из канала |
| 400 | Bad Request Request error |
Ответ, содержащий информацию об ошибке |
| 403 | Forbidden Access denied |
Ответ, содержащий информацию об ошибке |
| 429 | Too many requests |
Too many requests (Getting a list of messages from the channel) |