Method: spaces.list

列出调用者所属的聊天室。系统不会在发送第一条消息之前列出群聊和私信。有关示例，请查看列出聊天室。

需要身份验证。完全支持服务帐号身份验证，并且用户身份验证需要 chat.spaces 或 chat.spaces.readonly 授权范围。

列出调用方或经过身份验证的用户可见的聊天室。系统不会在发送第一条消息之前列出群聊和私信。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

可选。要返回的聊天室数量上限。服务返回的值可能会低于此值。

如果未指定，则最多返回 100 个空格。

最大值为 1,000。如果您使用的值大于 1,000，则会自动更改为 1,000。

负值会返回 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 错误。

使用服务帐号身份验证时，系统会忽略此字段，并且查询始终返回所有空格。不过，Chat API 仍会使用服务帐号验证查询语法，因此无效查询仍会被拒绝。

请求正文

请求正文必须为空。

响应正文

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

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

object (Space)

所请求的页面（或第一个页面）中的聊天室列表。
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

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