Google Chat API 概览

本部分中的指南介绍了 Google Chat 应用如何调用 Chat API,该 API 可让 Chat 应用执行创建聊天室、向其中添加人员以及发布消息等操作,而不会收到 Chat 应用互动事件提示。

身份验证

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

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

API 资源和方法

借助 REST 资源和方法,您可以异步访问 Chat 聊天室、聊天室成员、消息、消息回应和消息附件。

聊天室

聊天室是用户与应用对话和共享文件的地方。聊天室分为多种类型。私信 (DM) 是两个用户或用户与一个 Chat 应用之间的一对一对话。群聊是指三个或更多用户与 Chat 应用之间的对话。已命名聊天室是用户发送消息、共享文件和开展协作的永久性位置。

spaces 资源代表一个空格。

聊天室支持以下方法:

成员

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

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

成员支持以下方法:

信息

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

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

消息支持以下方法:

回应

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

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

回应支持以下方法:

媒体和附件

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

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

附件是邮件中附加的媒体(文件)实例。

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

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

用户读取状态(开发者预览版)

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

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

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

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

找到发现文档

此 API 的发现文档位于以下网址: