本指南将介绍如何使用
list()
方法,以查看分页、Message
聊天室中可过滤的消息列表。
在 Chat API 中,Chat 消息由
Message
资源。
Chat 用户只能发送包含文字的消息,
聊天应用可以使用许多其他即时通讯功能,包括
显示静态或交互式界面,从
以及以私密方式传递消息。详细了解消息功能
功能的详细信息,请参阅
Google Chat 消息概览。
前提条件
Node.js
- Business 或 Enterprise 有权访问以下内容的 Google Workspace 账号: Google Chat。
- 设置环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用并配置 Google Chat API,指定一个名称, 图标和说明。
- 安装 Node.js Cloud 客户端库。
- <ph type="x-smartling-placeholder"></ph>
为桌面应用创建 OAuth 客户端 ID 凭据。如需运行本指南中的示例,请将凭据保存为名为
client_secrets.json
的 JSON 文件,并保存到本地目录。
- 选择支持用户身份验证的授权范围。
Python
- 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。
- 设置环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用并配置 Google Chat API,指定一个名称, 图标和说明。
- 安装 Python Cloud 客户端库。
- 为桌面应用
创建 OAuth 客户端 ID 凭据。为了运行此示例中的示例,
指南中,将凭据保存为名为
client_secrets.json
的 JSON 文件, 本地目录中。
- 选择支持用户身份验证的授权范围。
Java
- 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。
- 设置您的环境:
<ph type="x-smartling-placeholder">
- </ph>
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用和配置 Google Chat API,为 Chat 应用提供名称、图标和说明。
- 安装 Java Cloud 客户端库。
- 为桌面应用
创建 OAuth 客户端 ID 凭据。如需运行本指南中的示例,请将凭据保存为名为
client_secrets.json
的 JSON 文件,并保存到本地目录。
- <ph type="x-smartling-placeholder"></ph> 选择支持用户身份验证的授权范围。
Apps 脚本
- 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。
- 设置您的环境:
<ph type="x-smartling-placeholder">
- </ph>
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用并配置 Google Chat API,指定一个名称, 图标和说明。
- 创建一个独立的 Apps 脚本项目, 然后启用高级聊天服务。
- <ph type="x-smartling-placeholder"></ph> 选择支持用户身份验证的授权范围。
<ph type="x-smartling-placeholder">
列出消息
如需列出需要用户身份验证的消息,请在请求中传递以下内容:
- 指定
chat.messages.readonly
或chat.messages
授权范围。 - 调用
ListMessages()
方法。
以下示例列出了 Chat 聊天室中的消息:
Node.js
Python
Java
Apps 脚本
如需运行此示例,请将 SPACE_NAME
替换为聊天室的 name
字段中的 ID。可通过调用
ListSpaces()
方法或聊天室的网址来执行此操作。
Chat API 会返回在指定聊天室中发送的消息列表。如果请求中没有消息,
Chat API 响应会返回一个空对象。使用 REST/HTTP 接口时,响应包含一个空 JSON 对象 {}
。