借助 Google Chat API,您可以构建 Chat 扩展应用以将您的服务与 Google Chat 集成,并管理聊天室、成员和消息等 Chat 资源。
- REST 资源:v1.customEmojis
- REST 资源:v1.media
- REST 资源:v1.spaces
- REST 资源:v1.spaces.members
- REST 资源:v1.spaces.messages
- REST 资源:v1.spaces.messages.attachments
- REST 资源:v1.spaces.messages.reactions
- REST 资源:v1.spaces.spaceEvents
- REST 资源:v1.users.spaces
- REST 资源:v1.users.spaces.spaceNotificationSetting
- REST 资源:v1.users.spaces.threads
服务:chat.googleapis.com
如要调用此服务,我们建议您使用 Google 提供的客户端库。如果您的应用需要使用您自己的库来调用此服务,则在发出 API 请求时应使用以下信息。
发现文档
发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。此服务提供了以下发现文档:
服务端点
服务端点是一个基础网址,指定了 API 服务的网络地址。一项服务可能有多个服务端点。此服务具有以下服务端点,下面的所有 URI 都与此服务端点相关:
- https://chat.googleapis.com
REST 资源:v1.customEmojis
| 方法 | |
|---|---|
| create | POST /v1/customEmojis创建自定义表情符号。 | 
| delete | DELETE /v1/{name=customEmojis/*}删除自定义表情符号。 | 
| get | GET /v1/{name=customEmojis/*}返回有关自定义表情符号的详细信息。 | 
| list | GET /v1/customEmojis列出已通过身份验证的用户可看到的自定义表情符号。 | 
REST 资源:v1.media
| 方法 | |
|---|---|
| download | GET /v1/media/{resourceName=**}下载媒体。 | 
| 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返回与指定用户的现有私信。 | 
| findGroupChats | GET /v1/spaces:findGroupChats返回所有具有 spaceType == GROUP_CHAT的聊天室,这些聊天室的人员成员中仅包含调用用户和FindGroupChatsRequest.memberships中指定的用户。 | 
| get | GET /v1/{name=spaces/*}返回有关空间的详细信息。 | 
| list | GET /v1/spaces列出调用方所属的聊天室。 | 
| patch | PATCH /v1/{space.name=spaces/*}更新空间。 | 
| search | GET /v1/spaces:search根据管理员的搜索返回 Google Workspace 组织中的空间列表。 | 
| 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.spaceNotificationSetting
| 方法 | |
|---|---|
| get | GET /v1/{name=users/*/spaces/*/spaceNotificationSetting}获取聊天室通知设置。 | 
| patch | PATCH /v1/{spaceNotificationSetting.name=users/*/spaces/*/spaceNotificationSetting}更新聊天室通知设置。 | 
REST 资源:v1.users.spaces.threads
| 方法 | |
|---|---|
| getThreadReadState | GET /v1/{name=users/*/spaces/*/threads/*/threadReadState}返回有关用户在线程中的已读状态的详细信息,用于标识已读和未读消息。 |