Google Chat API

借助 Google Chat API,您可以构建 Chat 应用,从而将您的服务与 Google Chat 集成,并管理 Chat 资源(例如聊天室、成员和消息)。

服务:chat.googleapis.com

如要调用此服务,我们建议您使用 Google 提供的客户端库。如果您的应用需要使用您自己的库来调用此服务,则在发出 API 请求时应使用以下信息。

发现文档

发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。此服务提供了以下发现文档:

服务端点

服务端点是指定 API 服务的网络地址的基本网址。一项服务可能有多个服务端点。此服务具有以下服务端点,下面的所有 URI 都与此服务端点相关:

  • https://chat.googleapis.com

REST 资源:v1.media

方法
download GET /v1/media/{resourceName=**}
) 下载媒体。
upload POST /v1/{parent=spaces/*}/attachments:upload

POST /upload/v1/{parent=spaces/*}/attachments:upload 上传附件。

REST 资源:v1.spaces

方法
completeImport POST /v1/{name=spaces/*}:completeImport
) 完成指定聊天室的导入流程,并向用户显示聊天室。
create POST /v1/spaces
) 创建没有任何成员的聊天室。
delete DELETE /v1/{name=spaces/*}
) 删除已命名的聊天室。
findDirectMessage GET /v1/spaces:findDirectMessage
) 返回与指定用户的现有私信。
get GET /v1/{name=spaces/*}
) 返回聊天室的相关详细信息。
list GET /v1/spaces
) 列出调用方所属的聊天室。
patch PATCH /v1/{space.name=spaces/*}
) 更新聊天室。
search GET /v1/spaces:search
setup POST /v1/spaces:setup
) 创建聊天室并向其中添加指定用户。

REST 资源:v1.spaces.members

方法
create POST /v1/{parent=spaces/*}/members
) 为发起调用的 Chat 应用、用户或 Google 群组创建成员资格。
delete DELETE /v1/{name=spaces/*/members/*}
) 删除一个成员资格。
get GET /v1/{name=spaces/*/members/*}
) 返回有关成员资格的详细信息。
list GET /v1/{parent=spaces/*}/members
) 列出聊天室中的成员。
patch PATCH /v1/{membership.name=spaces/*/members/*}
) 更新成员资格。

REST 资源:v1.spaces.messages

方法
create POST /v1/{parent=spaces/*}/messages
) 在 Google Chat 聊天室中创建消息。
delete DELETE /v1/{name=spaces/*/messages/*}
) 删除消息。
get GET /v1/{name=spaces/*/messages/*}
) 返回有关消息的详细信息。
list GET /v1/{parent=spaces/*}/messages
) 列出来电者所属聊天室中的消息,包括来自已屏蔽成员和聊天室的消息。
patch PATCH /v1/{message.name=spaces/*/messages/*}
) 更新消息。
update PUT /v1/{message.name=spaces/*/messages/*}
) 更新消息。

REST 资源:v1.spaces.messages.attachments

方法
get GET /v1/{name=spaces/*/messages/*/attachments/*}
) 获取邮件附件的元数据。

REST 资源:v1.spaces.messages.reactions

方法
create POST /v1/{parent=spaces/*/messages/*}/reactions
) 创建回应并将其添加到邮件中。
delete DELETE /v1/{name=spaces/*/messages/*/reactions/*}
) 删除对消息的回应。
list GET /v1/{parent=spaces/*/messages/*}/reactions
) 列出对消息的回应。

REST 资源:v1.spaces.spaceEvents

方法
get GET /v1/{name=spaces/*/spaceEvents/*}
) 返回 Google Chat 聊天室中的活动。
list GET /v1/{parent=spaces/*}/spaceEvents
) 列出 Google Chat 聊天室中的事件。

REST 资源:v1.users.spaces

方法
getSpaceReadState GET /v1/{name=users/*/spaces/*/spaceReadState}
) 返回有关用户在聊天室中的阅读状态的详细信息,用于标识已读和未读消息。
updateSpaceReadState PATCH /v1/{spaceReadState.name=users/*/spaces/*/spaceReadState}
) 更新用户在聊天室中的读取状态,用于标识已读和未读消息。

REST 资源:v1.users.spaces.threads

方法
getThreadReadState GET /v1/{name=users/*/spaces/*/threads/*/threadReadState}
) 返回有关用户在线程中读取状态的详细信息,用于标识已读和未读邮件。