Method: spaces.list

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

需要身份验证。支持应用身份验证用户身份验证

列出调用者或经过身份验证的用户可以看到的聊天室。只有在发送第一条消息后,系统才会列出群聊和私信。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

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

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

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

负值会返回 INVALID_ARGUMENT 错误。

pageToken

string

可选。从上一个列表聊天室调用收到的页面令牌。提供此参数以检索后续网页。

进行分页时,过滤条件值应与提供页面令牌的调用相匹配。传递不同的值可能会导致意外结果。

filter

string

可选。查询过滤条件。

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

如需按聊天室类型过滤,您必须指定有效的枚举值,例如 SPACEGROUP_CHATspaceType 不能为 SPACE_TYPE_UNSPECIFIED)。如需查询多种聊天室类型,请使用 OR 运算符。

例如,以下查询有效:

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

服务器会拒绝无效查询,并显示 INVALID_ARGUMENT 错误。

请求正文

请求正文必须为空。

响应正文

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

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

有关详情,请参阅授权指南