创建聊天室并向其中添加指定用户。系统会自动将发起调用的用户添加到聊天室,因此不应在请求中将其指定为成员。如需查看示例,请参阅设置包含初始成员的聊天室。
如需指定要添加的真人成员,请使用适当的 membership.member.name
添加成员资格。如需添加真人用户,请使用 users/{user}
,其中 {user}
可以是用户的电子邮件地址。对于同一 Workspace 组织中的用户,{user}
也可以是 People API 中人员的 id
,或 Directory API 中用户的 id
。例如,如果 user@example.com
的 People API 人员个人资料 ID 为 123456789
,您可以将 membership.member.name
设置为 users/user@example.com
或 users/123456789
,将该用户添加到聊天室。
如需指定要添加的 Google 群组,请使用适当的 membership.group_member.name
添加成员资格。如需添加或邀请 Google 群组,请使用 groups/{group}
,其中 {group}
是 Cloud Identity Groups API 中相应群组的 id
。例如,您可以使用 Cloud Identity Groups lookup API 检索群组电子邮件地址 group@example.com
的 ID 123456789
,然后将 membership.group_member.name
设为 groups/123456789
,将该群组添加到聊天室。系统不支持群组电子邮件地址,且 Google 群组只能添加为已命名聊天室的成员。
对于已命名的聊天室或群聊,如果调用方屏蔽/被部分成员屏蔽,或无权添加部分成员,系统不会将这些成员添加到已创建的聊天室中。
如需在发起调用的用户与另一位真人用户之间创建私信 (DM),请仅指定一个成员资格来代表真人用户。如果其中一位用户屏蔽了另一位用户,则对方的请求会失败,系统将不会创建私信。
如需在发起通话的用户和发起通话的应用之间创建私信,请将 Space.singleUserBotDm
设为 true
,并勿指定任何成员资格。您只能使用此方法,为发起通话的应用设置私信。如要将发起通话的应用添加为聊天室成员,或两名真人用户之间的现有私信,请参阅邀请用户/应用或向聊天室添加用户/应用。
如果两位用户之间已经有私信,即使对方在发出请求时屏蔽了对方,系统也会返回现有的私信。
不支持使用“话题式回复”的聊天室。如果您在设置聊天室时收到错误消息 ALREADY_EXISTS
,请尝试使用其他 displayName
。Google Workspace 组织中的现有聊天室可能已经在使用此显示名称。
需要用户身份验证。
HTTP 请求
POST https://chat.googleapis.com/v1/spaces:setup
网址采用 gRPC 转码语法。
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "space": { object ( |
字段 | |
---|---|
space |
必需。 如需创建聊天室,请将 如要创建群聊,请将 如需创建人与人之间的 1 对 1 对话,请将 如需在用户与发起通话的 Chat 应用之间创建 1 对 1 对话,请将 如果“ |
request |
可选。此请求的唯一标识符。建议使用随机 UUID。指定现有请求 ID 会返回使用该 ID 创建的聊天室,而不是创建新的聊天室。使用其他经过身份验证的用户指定同一 Chat 应用中的现有请求 ID 会返回错误。 |
memberships[] |
可选。要邀请加入聊天室的 Google Chat 用户或群组。请忽略发起通话的用户,因为系统会自动添加该用户。 该集合目前最多支持 20 个成员(除了调用方之外)。 对于人类成员资格, 对于 Google 群组成员资格, 将 将 如果将某个真人用户的 在创建人工与发起 Chat 应用对话的 1 对 1 对话时(将 |
响应正文
如果成功,则响应正文包含一个 Space
实例。
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.create
如需了解详情,请参阅授权指南。