Chats

Список чатов

По умолчанию — беседы, каналы и личные переписки, где состоит владелец токена. С availability=public метод отдаёт вместо этого все открытые чаты пространства, включая те, куда вызывающий не вступал.

Треды в списке не приходят никогда, для них есть [Список тредов](GET /threads).

archived=true не переключает выдачу на архив, а добавляет архивные чаты к активным.

get/chats

Request

  • Base URL: https://api.pachca.com/api/shared/v1
  • URL: https://api.pachca.com/api/shared/v1/chats
  • Auth: HTTP bearer

Query parameters

sort'id' | 'last_message_at'

Поле сортировки чатов

Поле сортировки

order'asc' | 'desc'

Порядок сортировки

Направление сортировки

availability'is_member' | 'public'

Доступность чатов для пользователя

Параметр, который отвечает за доступность и выборку чатов для пользователя

archivedboolean
Example:true

Добавляет к выдаче архивные чаты. По умолчанию возвращаются только активные. Работает при любом значении availability.

last_message_at_afterstring date-time
Example:2025-01-01T00:00:00.000Z

Фильтрация по времени создания последнего сообщения: вернутся чаты, где оно позже указанного. Значение в ISO-8601, смещение вида +03:00 учитывается, время без смещения считается UTC.

last_message_at_beforestring date-time
Example:2025-02-01T00:00:00.000Z

Фильтрация по времени создания последнего сообщения: вернутся чаты, где оно раньше указанного. Значение в ISO-8601, смещение вида +03:00 учитывается, время без смещения считается UTC.

personalboolean

Фильтрация по личным и групповым чатам. Если параметр не указан, возвращаются любые чаты.

limitinteger
Example:1

Количество возвращаемых сущностей за один запрос

cursorstring
Example:eyJpZCI6MTAsImRpciI6ImFzYyJ9

Курсор для пагинации (из meta.paginate.next_page или meta.paginate.prev_page)

Response

The request has succeeded.

Example response

{
  "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,
      "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
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.