本部分介绍 Google Chat 应用如何调用 Chat API,此 API 可让 Chat 应用执行创建聊天室、向聊天室添加人员和发送消息等操作,而不会收到 Chat 应用互动事件提示。
身份验证
异步调用 Chat API 需要进行身份验证。每种 Chat API 方法都需要用户身份验证(以代表用户执行操作或访问数据)或应用身份验证(以 Chat 应用的形式执行操作或访问数据)。某些方法同时支持用户身份验证和应用身份验证。
如需详细了解 Chat 中的身份验证,请参阅身份验证概览。
API 资源和方法
REST 资源和方法可授予对 Chat 聊天室、聊天室成员、消息、消息回应和消息附件的异步访问权限。
- 聊天室
聊天室是用户和应用相互交流和共享文件的地方。聊天室有多种类型。私信 (DM) 是指两位用户或一位用户与 Chat 应用之间的 1 对 1 对话。群聊是三位或多位用户与 Chat 应用之间的对话。已命名的聊天室是用户持续 发送消息、共享文件和开展协作的地方。
spaces
资源表示一个空间。聊天室支持以下方法:
- 成员
成员是指已加入或受邀加入聊天室的用户和 Chat 应用。
spaces.members
资源代表一个成员。成员支持以下方法:
- 信息
spaces.messages
资源表示一条消息。“信息”应用支持以下方法:
- 回应
回应表示用户用于回应信息的表情符号,例如 👍?、🚲? 和 🌞?。
spaces.messages.reactions
资源表示一个反应。回应支持以下方法:
- 媒体和附件
“媒体”表示上传到 Google Chat 的文件,例如图片、视频和文档。
media
资源表示附加到消息的媒体。附件是指邮件中附加的媒体(文件)实例。
spaces.messages.attachments
资源表示一个连接。附件包含附加到消息的媒体内容和关联元数据。媒体和附件支持以下方法:
- 以附件形式上传媒体内容,将媒体内容上传到 Google Chat,然后将其附加到消息中。
- 将媒体内容下载为附件,以将 Google Chat 中的媒体内容下载为二进制文件。
- 获取附件,以检索有关消息附件的元数据。
- 聊天室事件
聊天室事件表示对聊天室或其子资源(包括成员、消息和回应)的更改。
spaces.spaceEvent
资源表示太空活动。聊天室事件支持以下方法:
- 用户读取状态
用户读取状态是单例资源,表示指定用户上次在 Google Chat 聊天室或消息线程中读取的消息的详细信息。
users.spaces
资源表示用户在空间中的读取状态。users.spaces.threads
资源表示用户在消息线程中的读取状态。用户读取状态支持以下方法: