Method: spaces.messages.list

列出来电者所属的聊天室中的消息,包括已屏蔽成员和聊天室的消息。如需查看示例,请参阅列出消息。需要用户身份验证

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) 过滤消息。

要按创建日期过滤邮件,请指定 createTime,并附带 RFC-3339 格式的时间戳并加上双引号。例如 "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

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