列出调用者所属聊天室中的消息,包括来自被屏蔽的成员和聊天室的消息。系统消息(例如宣布有新聊天室成员加入的消息)不包括在内。如果您列出没有消息的聊天室中的消息,则响应为空对象。使用 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 |
必需。要列出消息的会议室的资源名称。 格式: |
查询参数
参数 | |
---|---|
pageSize |
可选。返回的消息数量上限。服务返回的消息数量可能小于此值。 如果未指定,则最多返回 25 个。 最大值为 1000。如果您使用的值超过 1000,系统会自动将其更改为 1000。 如果值为负数,则返回 |
pageToken |
可选。从之前的 list messages 调用接收的页面令牌。提供此参数以检索后续页面。 进行分页时,提供的所有其他参数应与提供页面令牌的调用相一致。向其他参数传递不同的值可能会导致意外结果。 |
filter |
可选。查询过滤条件。 您可以按日期 ( 如需按消息的创建日期过滤消息,请使用 RFC-3339 格式的时间戳和英文双引号指定 如需按线程过滤,请指定 如需同时按主题和日期进行过滤,请在查询中使用 例如,以下查询有效:
服务器会拒绝无效查询,并返回 |
orderBy |
可选。消息列表的排序方式。指定一个值,以便按排序操作进行排序。有效的排序操作值如下:
默认排序为 |
showDeleted |
可选。是否包含已删除的邮件。已删除的邮件包括删除时间和有关删除的元数据,但邮件内容不可用。 |
请求正文
请求正文必须为空。
响应正文
用于列出消息的响应消息。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"messages": [
{
object ( |
字段 | |
---|---|
messages[] |
消息列表。 |
nextPageToken |
您可以发送令牌作为 |
授权范围
需要以下 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
如需了解详情,请参阅授权指南。