借助 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
方法 | |
---|---|
complete |
POST /v1/{name=spaces/*}:completeImport 完成指定空间的导入过程,并向用户显示空间。 |
create |
POST /v1/spaces 创建没有成员的聊天室。 |
delete |
DELETE /v1/{name=spaces/*} 删除命名空间。 |
find |
GET /v1/spaces:findDirectMessage 返回与指定用户的现有私信。 |
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/*} Returns an event from a Google Chat space. |
list |
GET /v1/{parent=spaces/*}/spaceEvents 列出 Google Chat 聊天室中的事件。 |
REST 资源:v1.users.spaces
方法 | |
---|---|
get |
GET /v1/{name=users/*/spaces/*/spaceReadState} 返回用户在聊天室中的阅读状态的详细信息,用于识别已读和未读消息。 |
update |
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
方法 | |
---|---|
get |
GET /v1/{name=users/*/spaces/*/threads/*/threadReadState} 返回有关用户在会话中的阅读状态的详细信息,用于识别已读和未读消息。 |