Google Chat API 概览

本部分介绍 Google Chat 应用如何调用 Chat API，此 API 可让 Chat 应用执行创建聊天室、向聊天室添加人员和发送消息等操作，而不会收到 Chat 应用互动事件提示。

身份验证

异步调用 Chat API 需要进行身份验证。每种 Chat API 方法都需要用户身份验证（以代表用户执行操作或访问数据）或应用身份验证（以 Chat 应用的形式执行操作或访问数据）。某些方法同时支持用户身份验证和应用身份验证。

如需详细了解 Chat 中的身份验证，请参阅身份验证概览。

API 资源和方法

REST 资源和方法可授予对 Chat 聊天室、聊天室成员、消息、消息回应和消息附件的异步访问权限。

聊天室

聊天室是用户和应用相互交流和共享文件的地方。聊天室有多种类型。私信 (DM) 是指两位用户或一位用户与 Chat 应用之间的 1 对 1 对话。群聊是三位或多位用户与 Chat 应用之间的对话。已命名的聊天室是用户持续 发送消息、共享文件和开展协作的地方。

spaces 资源表示一个空间。

聊天室支持以下方法：

  • 创建聊天室，这是一个可供用户和应用对话和共享文件的地方。
  • 设置聊天室以创建聊天室，并向该聊天室添加人员和 Chat 应用。
  • 获取聊天室可查看有关聊天室的详细信息。
  • 列出聊天室，查看已分页且可过滤的聊天室列表。
  • 更新聊天室，以更改聊天室的相关属性，例如其用户可见的显示名称、说明和指南。
  • 不再需要聊天室时，请删除聊天室。
  • 查找私信 (DM)，以便在两位用户之间返回私信，或在用户与发起调用的 Chat 应用之间返回私信。
成员

成员是指已加入或受邀加入聊天室的用户和 Chat 应用。

spaces.members 资源代表一个成员。

成员支持以下方法：

  • 创建成员资格以将用户或应用添加到聊天室。
  • 获取会员资格以查看有关会员资格的详细信息。
  • 列出成员，以查看聊天室中可过滤的分页成员列表。
  • 更新成员资格以更改有关成员资格的特性，例如将聊天室成员更改为聊天室管理员，或将聊天室管理员更改为聊天室成员。
  • 删除成员资格可将用户或应用从聊天室中移除。
信息

消息包括在聊天室中发布的短信和卡片通信。信息中可以附加文件。 用户可以通过在消息中附加表情符号来回应消息。

spaces.messages 资源表示一条消息。

“信息”应用支持以下方法：

回应

回应表示用户用于回应信息的表情符号，例如 👍?、🚲? 和 🌞?。

spaces.messages.reactions 资源表示一个反应。

回应支持以下方法：

  • 创建回应，在消息中附加表情符号。
  • 列出回应，以查看对消息的回应（已分页且可过滤）列表。
  • 删除回应即可从消息中移除表情符号。
媒体和附件

“媒体”表示上传到 Google Chat 的文件，例如图片、视频和文档。

media 资源表示附加到消息的媒体。

附件是指邮件中附加的媒体（文件）实例。

spaces.messages.attachments 资源表示一个连接。附件包含附加到消息的媒体内容和关联元数据。

媒体和附件支持以下方法：

聊天室事件

聊天室事件表示对聊天室或其子资源（包括成员、消息和回应）的更改。

spaces.spaceEvent 资源表示太空活动。

聊天室事件支持以下方法：

用户读取状态

用户读取状态是单例资源，表示指定用户上次在 Google Chat 聊天室或消息线程中读取的消息的详细信息。

users.spaces 资源表示用户在空间中的读取状态。

users.spaces.threads 资源表示用户在消息线程中的读取状态。

用户读取状态支持以下方法：