Method: spaces.messages.list

列出调用方所属聊天室中的消息，包括来自被屏蔽的成员和聊天室的消息。系统消息（例如宣布有新聊天室成员加入的消息）不包含在内。如果您列出没有消息的聊天室中的消息，响应将是一个空对象。使用 REST/HTTP 接口时，响应包含一个空 JSON 对象，即 {}。如需查看示例，请参阅列出消息。

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

  • 应用身份验证（需要管理员批准），授权范围为：

    • https://www.googleapis.com/auth/chat.app.messages.readonly。使用此授权范围时，此方法仅返回聊天室中的公开消息，不包括私信。

  • 用户身份验证，授权范围为以下其中一项：

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import（仅限导入模式聊天室）

HTTP 请求

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。要列出消息的聊天室的资源名称。

格式：spaces/{space}

查询参数

参数
pageSize

integer

可选。返回的消息数量上限。服务可能会返回少于此值的消息。

如果未指定，则最多返回 25 条消息。

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

负值会返回 INVALID_ARGUMENT 错误。
pageToken

string

可选。从之前的列出消息调用收到的页面令牌。提供此参数可检索后续页面。

进行分页时，提供的所有其他参数应与提供页面令牌的调用匹配。向其他参数传递不同的值可能会导致意外结果。
filter

string

可选。查询过滤条件。

您可以按日期 (createTime) 和会话 (thread.name) 过滤消息。

如需按消息的创建日期过滤消息，请使用 RFC-3339 格式的时间戳和双引号指定 createTime。例如，"2023-04-21T11:30:00-04:00"。您可以使用大于运算符 > 列出在某个时间戳之后创建的消息，也可以使用小于运算符 < 列出在某个时间戳之前创建的消息。如需过滤某个时间间隔内的消息，请在两个时间戳之间使用 AND 运算符。

如需按会话过滤，请指定 thread.name，格式为 spaces/{space}/threads/{thread}。您只能为每个查询指定一个 thread.name。

如需同时按会话和日期过滤，请在查询中使用 AND 运算符。

例如，以下查询是有效的：

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

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

string

可选。消息列表的排序方式。指定一个值，以便按排序操作进行排序。有效的排序操作值如下所示：

  • ASC 表示升序。

  • DESC 表示降序。

默认排序方式为 createTime ASC。
showDeleted

boolean

可选。是否包含已删除的消息。已删除的消息包含删除时间和有关删除的元数据，但消息内容不可用。

请求正文

请求正文必须为空。

响应正文

列出消息的响应消息。

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

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

object (Message)

消息列表。
nextPageToken

string

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

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly

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