Для разработчиков

Список чатов пространства

GET/company/chats
company_chats:readКорпорация

Метод для получения списка бесед и каналов всего пространства, включая закрытые, где вы не состоите участником. Личные переписки и треды не возвращаются.

По умолчанию отдаются и активные, и архивные чаты. Параметр activity оставляет в выдаче только одно из состояний.

Метод доступен Владельцу пространства. Каждый запрос записывается в журнал аудита событий с типом company_chats_accessed.

Параметры строки запроса

activity
string
Состояние чатов. Если параметр не указан, возвращаются и активные, и архивные чаты.
Возможные значения
Пример:active
limit
integer, (int32)
Количество возвращаемых сущностей за один запрос
Пример:1
По умолчанию:
50
Диапазон:
1 — 50
cursor
string
Курсор для пагинации (из meta.paginate.next_page)
Пример:eyJpZCI6MTAsImRpciI6ImFzYyJ9

Ответ

200OK
The request has succeeded.
data[]
array of objects
*
id
integer, (int32)
*
Идентификатор созданного чата
Пример:334
name
string
*
Название
Пример:🤿 aqua
Длина:
<= 255 символов
created_at
string, (date-time)
*
Дата и время создания чата (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2021-08-28T15:56:53.000Z
owner_id
integer, (int32)
*
Идентификатор пользователя, создавшего чат
Пример:185
member_ids[]
array of integers, (int32)
*
Массив идентификаторов пользователей, участников
Пример:[185,186,187]
group_tag_ids[]
array of integers, (int32)
*
Массив идентификаторов тегов, участников
Пример:[9111]
channel
boolean
*
Является каналом
Пример:true
archived
boolean
*
Находится в архиве
Пример:false
personal
boolean
*
Является личным чатом
Пример:false
public
boolean
*
Открытый доступ
Пример:false
last_message_at
string, (date-time)
*
Дата и время создания последнего сообщения в чате (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2021-08-28T15:56:53.000Z
meet_room_url
string
*
Ссылка на Видеочат
Пример:https://meet.pachca.com/aqua-94bb21b5
meta
object
*
Метаданные пагинации
paginate
object
*
Вспомогательная информация
next_page
string
*
Курсор пагинации следующей страницы
Пример:eyJxZCO2MiwiZGlyIjomSNYjIn3
prev_page
string
Курсор пагинации предыдущей страницы. Используется для polling новых записей «сверху» списка.
Пример:eyJxZCO2MiwiZGlyIjoiYXNjIn0
has_next
boolean
Есть ли ещё данные на следующей странице. На последней странице — false.
Пример:true
has_prev
boolean
Есть ли ещё данные на предыдущей странице. На первом запросе без курсора — false.
Пример:false
Список чатов пространства
# Добавьте --all для автоматической пагинацииpachca chats list-company \  --activity=active \  --limit=1 \  --json \  --token YOUR_ACCESS_TOKEN
Ответ 200
{  "data": [    {      "id": 334,      "name": "🤿 aqua",      "created_at": "2021-08-28T15:56:53.000Z",      "owner_id": 185,      "member_ids": [        185,        186,        187      ],      "group_tag_ids": [        9111      ],      "channel": true,      "archived": false,      "personal": false,      "public": false,      "last_message_at": "2021-08-28T15:56:53.000Z",      "meet_room_url": "https://meet.pachca.com/aqua-94bb21b5"    }  ],  "meta": {    "paginate": {      "next_page": "eyJxZCO2MiwiZGlyIjomSNYjIn3",      "prev_page": "eyJxZCO2MiwiZGlyIjoiYXNjIn0",      "has_next": true,      "has_prev": false    }  }}