Method: spaces.setup

创建聊天室，并为其添加指定用户。发起通话的用户会自动添加到聊天室，且不应在请求中将他们指定为成员。如需查看示例，请参阅设置聊天室。

如需指定要添加的人工成员，请在 SetUpSpaceRequest 中添加适当的 member.name 成员资格。如需添加真人用户，请使用 users/{user}，其中 {user} 是 People API 中的 person 的 {person_id}，或 Admin SDK Directory API 中的用户的 id。例如，如果 People API Person resourceName 为 people/123456789，您可以通过将 users/123456789 作为 member.name 会员来将用户添加到聊天室。

对于聊天室或群聊，如果来电者屏蔽或屏蔽了部分成员，则这些成员不会被添加到所创建的聊天室中。

要在发起调用的用户与其他人类用户之间创建私信 (DM)，请仅指定一个成员来代表该真人用户。如果其中一个用户屏蔽了另一个用户，则请求会失败，并且系统不会创建私信。

如需在发起调用的用户与发起调用的应用之间创建私信，请将 Space.singleUserBotDm 设置为 true，且不指定任何成员资格。您只能通过通话应用使用这种方法设置私信。如需将发起通话的应用添加为聊天室的成员，或作为两个用户之间的现有私信，请参阅创建会员资格。

如果两个用户之间存在私信，即使一个用户在发出请求时屏蔽了另一个用户，系统也会返回现有的私信。

不支持话题式回复或访客访问权限的聊天室。

需要用户身份验证以及 chat.spaces.create 或 chat.spaces 范围。

HTTP 请求

POST https://chat.googleapis.com/v1/spaces:setup

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
字段
space

object (Space)

必需。Space.spaceType 是必填字段。

如需创建聊天室，请将 Space.spaceType 设置为 SPACE，并设置 Space.displayName。

如要创建群聊，请将 Space.spaceType 设为 GROUP_CHAT。不设置 Space.displayName。

若要在真人之间创建 1 对 1 对话，请将 Space.spaceType 设置为 DIRECT_MESSAGE，并将 Space.singleUserBotDm 设置为 false。请勿设置 Space.displayName 或 Space.spaceDetails。

如需在人工聊天和通话聊天应用之间创建 1 对 1 对话，请将 Space.spaceType 设置为 DIRECT_MESSAGE，并将 Space.singleUserBotDm 设置为 true。请勿设置 Space.displayName 或 Space.spaceDetails。

如果 DIRECT_MESSAGE 聊天室已存在，则返回该聊天室，而不是创建新聊天室。
requestId

string

可选。此请求的唯一标识符。建议使用随机 UUID。指定现有的请求 ID 会返回使用该 ID 创建的聊天室，而不是创建新聊天室。如果同一 Chat 应用中的现有请求 ID 具有通过不同身份验证的用户，则系统将返回错误。
memberships[]

object (Membership)

可选。网域内最初受邀加入聊天室的一组用户。系统会将发起通话的用户自动添加到聊天室，且不应将其指定为成员。

该集合目前最多允许 20 个成员资格条件（来电者信息除外）。

Membership.member 字段必须包含已填充 name 且 User.Type.HUMAN 的用户。其他所有字段均会被忽略。

将 Space.spaceType 设置为 SPACE 时可选。

将 Space.spaceType 设置为 GROUP_CHAT 以及至少两个成员资格时，是必需的。

当具有真人用户将 Space.spaceType 设置为 DIRECT_MESSAGE 且恰好有一个成员资格时，必须指定此参数。

在人工与通话聊天应用之间创建 1 对 1 对话时，必须为空（将 Space.spaceType 设置为 DIRECT_MESSAGE 并将 Space.singleUserBotDm 设置为 true 时）。

不支持：邀请访客用户或添加其他 Chat 应用。

响应正文

如果成功，响应正文将包含一个 Space 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

如需了解详情，请参阅授权指南。