SearchChatsResponse

Результаты поиска чатов

chats object[]required

Массив найденных чатов

Array [

chatIdstringrequired

Id чата

Example: w:AIQffAsGia

workspaceIdstringrequired

Id рабочего пространства, в котором находится чат

Example: w:AIQffAsGi8

metadata objectrequired

Содержит специфичную для типа чата информацию. Заполняется одно из полей в зависимости от типа чата

personal object

Содержит информацию о персональном чате

otherMembershipIdstringrequired

MembershipId собеседника

Example: aIQffAsGia

workspace object

Информация о чате в рабочем пространстве

namestringrequired

Название чата

Example: Новости

announcebooleanrequired

Является ли чат анонсным

Example: true

chatTypeWorkspaceChatType (string)required

Тип чата

Possible values: [PRIVATE, PUBLIC, GENERAL]

Example: PUBLIC

autoJoinNewMembersbooleanrequired

Добавляются ли автоматически новые участники рабочего пространства в чат

Example: true

descriptionstring

Описание чата

Example: Новости компании

memberCountintegerrequired

Число участников

Example: 5

thread object

Информация об обсуждении

parentChatIdstringrequired

ChatId родительского чата, где расположено родительское сообщение

Example: w:aIQffAsGia

parentMessageIdstringrequired

MessageId родительского сообщения, к которому относится обсуждение

Example: bIQffAsGia

conference object

Информация о чате конференции

conferenceIdstringrequired

Идентификатор конференции, к которой относится чат

Example: dIQffAsGia

userEvents object

Информация о чате с персональными нотификациями

ownerstringrequired

MembershipId владельца

Example: aIQffAsGia

createdAtstring<date-time>required

Дата и время создания чата

Example: 2023-02-26T18:58:36.154+03:00

updatedAtstring<date-time>required

Дата и время последнего изменения чата. Поле используется только для Workspace чатов

Example: 2023-02-26T18:58:36.154+03:00

archivedAtstring<date-time>

Дата и время архивации чата. Поле используется только для Workspace чатов

Example: 2023-02-26T18:58:36.154+03:00

archivedBystring

MembershipId участника, который заархивировал чат

Example: fIQffAsGi8

chatRoleChatRole (string)

Роль бота в чате. Поле используется только для Workspace чатов

Possible values: [MEMBER, ADMIN, OWNER]

Example: ADMIN

chatPermissionsChatPermission (string)[]

Массив из ChatPermission бота в этом чате. Поле используется только для Workspace чатов

Possible values: [CHANGE_ROLE, ARCHIVE_CHAT, RENAME_CHAT, UPDATE_CONFIG, KICK_FROM_CHAT, SEND_MESSAGES_TO_ANNOUNCE_CHANNEL, PIN_CHAT_MESSAGE, SCHEDULE_CONFERENCE, DELETE_CHAT_MESSAGE, UPDATE_PERMISSIONS, FORWARD_MESSAGES]

]

nextPageTokenstring

Токен следующей страницы

prevPageTokenstring

Токен предыдущей страницы

allResultCountinteger<int64>required

Общее количество найденных результатов

SearchChatsResponse

{
  "chats": [
    {
      "chatId": "w:AIQffAsGia",
      "workspaceId": "w:AIQffAsGi8",
      "metadata": {
        "personal": {
          "otherMembershipId": "aIQffAsGia"
        },
        "workspace": {
          "name": "Новости",
          "announce": "true",
          "chatType": "PUBLIC",
          "autoJoinNewMembers": "true",
          "description": "Новости компании",
          "memberCount": "5"
        },
        "thread": {
          "parentChatId": "w:aIQffAsGia",
          "parentMessageId": "bIQffAsGia"
        },
        "conference": {
          "conferenceId": "dIQffAsGia"
        },
        "userEvents": {
          "owner": "aIQffAsGia"
        }
      },
      "createdAt": "2023-02-26T18:58:36.154+03:00",
      "updatedAt": "2023-02-26T18:58:36.154+03:00",
      "archivedAt": "2023-02-26T18:58:36.154+03:00",
      "archivedBy": "fIQffAsGi8",
      "chatRole": "ADMIN",
      "chatPermissions": [
        "CHANGE_ROLE"
      ]
    }
  ],
  "nextPageToken": "string",
  "prevPageToken": "string",
  "allResultCount": 0
}