Method: spaces.list

列出调用方所属的聊天室。群聊和私信只有在发送第一条消息后才会列出。如需查看示例，请参阅列出聊天室。

支持以下类型的身份验证：

  • 使用授权范围进行应用身份验证：

    • https://www.googleapis.com/auth/chat.bot

  • 使用以下某个授权范围进行用户身份验证：

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces

如需按 Google Workspace 组织列出所有命名聊天室，请改用 Workspace 管理员权限使用 spaces.search() 方法。

HTTP 请求

GET https://chat.googleapis.com/v1/spaces

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

可选。要返回的空格数量上限。服务返回的值可能小于此值。

如果未指定，则最多返回 100 个聊天室。

最大值为 1000。如果您使用的值大于 1000，系统会自动将其更改为 1000。

负值会返回 INVALID_ARGUMENT 错误。
pageToken

string

可选。从之前的列出聊天室调用接收的页面令牌。提供此参数以检索后续页面。

进行分页时，过滤条件值应与提供页面令牌的调用相一致。传递其他值可能会导致意外结果。
filter

string

可选。查询过滤条件。

您可以按聊天室类型 (spaceType) 过滤聊天室。

如需按聊天室类型过滤，您必须指定有效的枚举值，例如 SPACE 或 GROUP_CHAT（spaceType 不能为 SPACE_TYPE_UNSPECIFIED）。如需查询多个聊天室类型，请使用 OR 运算符。

例如，以下查询有效：

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

服务器会拒绝无效查询，并返回 INVALID_ARGUMENT 错误。

请求正文

请求正文必须为空。

响应正文

列出聊天室请求的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
字段
spaces[]

object (Space)

请求的（或第一个）页面中的聊天室列表。注意：对于列表请求，Space 对象中不会返回 permissionSettings 字段。
nextPageToken

string

您可以发送 pageToken 令牌来检索下一页结果。如果为空，则表示没有后续页面。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

如需了解详情，请参阅授权指南。