Метод для получения списка бесед и каналов по заданным параметрам.
Запрос
|
|||
---|---|---|---|
sort[{field}] | string | Составной параметр сортировки сущностей выборки. Варианты значений: по умолчанию desc (по убыванию) или asc (по возрастанию).На данный момент сортировка доступна только по полю ({field}) id (идентификатор бесед и каналов). | |
per | integer | Количество возвращаемых сущностей за один запрос (по умолчанию 25, максимум 50) | |
page | integer | Страница выборки (по умолчанию 1) | |
availability | string | Параметр, который отвечает за доступность и выборку бесед и каналов для пользователя. Варианты значений: по умолчанию is_member (беседы и каналы, где пользователь является участником) или public (все открытые беседы и каналы компании, вне зависимости от участия в них пользователя). | |
last_message_at_after | string | Фильтрация по времени создания последнего сообщения. Будут возвращены те беседы/каналы, время последнего созданного сообщения в которых не раньше чем указанное (в формате YYYY-MM-DDThh:mm:ss.sssZ). | |
last_message_at_before | string | Фильтрация по времени создания последнего сообщения. Будут возвращены те беседы/каналы, время последнего созданного сообщения в которых не позже чем указанное (в формате YYYY-MM-DDThh:mm:ss.sssZ). | |
Ответ
|
|||
data | array of objects | Массив списка найденных бесед и каналов | |
id | integer | Идентификатор беседы или канала | |
name | string | Название | |
owner_id | integer | Идентификатор пользователя, создавшего беседу или канал | |
created_at | string | Дата и время создания беседы или канала (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ | |
member_ids | array of integers | Массив идентификаторов пользователей, участников | |
group_tag_ids | array of integers | Массив идентификаторов тегов, участников | |
channel | boolean | Тип: беседа (false) или канал (true) | |
public | boolean | Доступ: закрытый (false) или открытый (true) | |
last_message_at | string | Дата и время создания последнего сообщения в беседе/калане (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ | |
meet_room_url | string | Ссылка на Видеочат | |
Возможные ошибки запроса (errors code)
|
|||
too_long | Слишком длинное значение (пояснения вы получите в поле message) | ||
invalid | Параметр не соответствует правилам (пояснения вы получите в поле message) | ||
not_found | Не удалось найти | ||
invalid | Параметр имеет неверный формат (идентификатор параметра вы получите в поле payload) |
{
"data":
[
{
"id": 334,
"name": "🤿 aqua",
"created_at": "2021-08-28T15:56:53.000Z",
"owner_id": 185,
"member_ids": [
185,
186,
187
],
"group_tag_ids": [],
"channel": true,
"public": false,
"last_message_at": "2021-08-28T15:58:13.000Z",
"meet_room_url": "https://meet.pachca.com/aqua-94bb21b5"
},
{
"id": 333,
"name": "development",
"created_at": "2021-08-28T15:54:22.000Z",
"owner_id": 185,
"member_ids": [
185
],
"group_tag_ids": [
22,
24
],
"channel": false,
"public": true,
"last_message_at": "2021-08-28T15:56:12.000Z",
"meet_room_url": "https://meet.pachca.com/development-43sz53n8"
}
]
}