资源:聊天室
Google Chat 中的聊天室。聊天室是两位或多位用户之间的对话,或是用户与 Chat 应用之间的一对一消息。
JSON 表示法 |
---|
{ "name": string, "type": enum ( |
字段 | |
---|---|
name |
聊天室的资源名称。 格式: |
type |
仅限输出。已废弃:请改用 |
spaceType |
聊天室的类型。创建聊天室或更新聊天室的聊天室类型时必须填写此字段。仅供其他用途的输出。 |
singleUserBotDm |
可选。聊天室是否为 Chat 应用与单人之间的私信。 |
threaded |
仅限输出。已废弃:请改用 |
displayName |
聊天室的显示名称。创建聊天室时必填。如果您在创建聊天室或更新 对于私信,此字段可能为空。 最多包含 128 个字符。 |
externalUserAllowed |
不可变。此聊天室是否允许任何 Google Chat 用户成为成员。在 Google Workspace 组织中创建聊天室时输入。在以下情况下创建空格时,请省略此字段:
对于现有聊天室,系统将仅输出此字段。 |
spaceThreadingState |
仅限输出。Chat 聊天室中的话题状态。 |
spaceDetails |
聊天室的详细信息,包括说明和规则。 |
spaceHistoryState |
此聊天室中消息和话题的消息记录状态。 |
importMode |
可选。此聊天室是否在将数据迁移到 Google Workspace 的过程中在 |
createTime |
可选。不可变。对于在 Chat 中创建的聊天室,显示该聊天室的创建时间。此字段仅输出,但在“导入模式聊天室”中使用时除外。 对于导入模式聊天室,请将此字段设为来源中聊天室创建的历史时间戳,以保留原始创建时间。 仅当 |
lastActiveTime |
仅限输出。聊天室中最后一条消息的时间戳。 |
adminInstalled |
仅限输出。对于包含 Chat 应用的私信 (DM) 聊天室,相应聊天室是否由 Google Workspace 管理员创建。管理员可以代表组织中的用户安装和设置通过 Chat 应用的私信。 如要支持管理员安装,您的 Chat 应用必须提供私信功能。 |
membershipCount |
仅限输出。已加入的成员数量(按成员类型分组)。当 |
accessSettings |
可选。指定聊天室的访问权限设置。仅当 |
spaceUri |
仅限输出。聊天室的 URI。 |
类型
已废弃:请改用 SpaceType
。
枚举 | |
---|---|
TYPE_UNSPECIFIED |
预留。 |
ROOM |
两个或多个人之间的对话。 |
DM |
用户与 Chat 应用之间的一对一私信,所有消息都是平面消息。请注意,这不包括两人之间的私信。 |
SpaceType
聊天室的类型。创建或更新聊天室时必填。仅供其他用途的输出。
枚举 | |
---|---|
SPACE_TYPE_UNSPECIFIED |
预留。 |
SPACE |
可供用户发送消息、共享文件和进行协作的地方。SPACE 可以包含 Chat 应用。 |
GROUP_CHAT |
3 人或更多人之间的群组对话。GROUP_CHAT 可以包含 Chat 应用。 |
DIRECT_MESSAGE |
两个人或一个人与一个 Chat 应用之间的一对一消息。 |
SpaceThreadingState
指定 Chat 聊天室中话题状态的类型。
枚举 | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
预留。 |
THREADED_MESSAGES |
支持消息串的已命名聊天室。用户回复消息后,可以在消息串中回复消息,这样回复就能保持在原始消息的上下文中。 |
GROUPED_MESSAGES |
已命名的聊天室,其中对话按主题整理。主题及其回复会归为一组。 |
UNTHREADED_MESSAGES |
两人之间的私信 (DM),以及 3 人或更多人的群组对话。 |
SpaceDetails
聊天室的详细信息,包括说明和规则。
JSON 表示法 |
---|
{ "description": string, "guidelines": string } |
字段 | |
---|---|
description |
可选。聊天室的说明。例如,说明聊天室的讨论主题、功能用途或参与者。 最多包含 150 个字符。 |
guidelines |
可选。聊天室的规则、期望和礼仪。 最多支持 5,000 个字符。 |
HistoryState
消息和聊天室的聊天记录状态。指定邮件和会话在创建后保留多长时间。
枚举 | |
---|---|
HISTORY_STATE_UNSPECIFIED |
默认值。请勿使用。 |
HISTORY_OFF |
聊天记录功能已关闭。消息和消息串会保留 24 小时。 |
HISTORY_ON |
聊天记录功能已开启。组织的保险柜保留规则规定了消息和会话的保留时长。 |
MembershipCount
JSON 表示法 |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
字段 | |
---|---|
joinedDirectHumanUserCount |
直接加入聊天室的真人用户人数,不计入因拥有已加入某个群组的成员而加入聊天室的用户数。 |
joinedGroupCount |
直接加入聊天室的所有群组的计数。 |
AccessSettings
表示聊天室的访问权限设置。
JSON 表示法 |
---|
{
"accessState": enum ( |
字段 | |
---|---|
accessState |
仅限输出。指示聊天室的访问状态。 |
audience |
可选。可以访问该聊天室的目标对象群组的资源名称。将此字段设为有效的目标对象群组 ID,使聊天室可供搜索,或使用 |
AccessState
表示聊天室的访问状态。
枚举 | |
---|---|
ACCESS_STATE_UNSPECIFIED |
访问状态未知或此 API 不支持。 |
PRIVATE |
添加或受邀的成员或群组可以找到聊天室。 |
DISCOVERABLE |
选定的目标对象群组以及添加或受邀的成员或群组都可以找到聊天室。 |
方法 |
|
---|---|
|
完成指定空间的导入流程,并使其对用户可见。 |
|
创建命名空间。 |
|
删除已命名的聊天室。 |
|
返回与指定用户的现有私信。 |
|
返回聊天室的相关详细信息。 |
|
列出调用者所属的聊天室。 |
|
更新聊天室。 |
|
|
|
创建聊天室并添加指定用户。 |