Method: spaces.create

创建聊天室。可用于在 Import mode 中创建命名聊天室或群聊。如需查看示例,请参阅创建聊天室

支持以下类型的身份验证

  • 应用身份验证,需要管理员批准,并使用以下授权范围之一:

    • https://www.googleapis.com/auth/chat.app.spaces.create
    • https://www.googleapis.com/auth/chat.app.spaces
  • 用户身份验证,使用以下授权范围之一:

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import(仅限导入模式聊天室)

以应用身份进行身份验证时,必须在请求中设置 space.customer 字段。

以应用身份进行身份验证时,Chat 应用会作为聊天室成员添加。不过,与人工身份验证不同,Chat 应用不会作为聊天室管理员添加。默认情况下,所有聊天室成员都可以从聊天室中移除 Chat 应用。如需仅允许聊天室管理员从聊天室中移除应用,请将 space.permission_settings.manage_apps 设置为 managersAllowed

创建时的聊天室成员资格取决于聊天室是否在 Import mode 中创建:

  • 导入模式: 不会创建任何成员。
  • 所有其他模式: 调用用户会作为成员添加。具体来说:
    • 使用应用身份验证时,应用本身。
    • 使用用户身份验证时,人工用户。

如果在创建聊天室时收到错误消息 ALREADY_EXISTS,请尝试使用其他 displayName。Google Workspace 组织内的现有聊天室可能已使用此显示名称。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
requestId

string

可选。此请求的唯一 ID。建议使用随机 UUID。指定请求 ID 可使请求具有幂等性,确保具有相同请求 ID 的多个相同请求只会创建一个聊天室。具有相同请求 ID 的后续请求会返回现有聊天室,并且不会更新聊天室,即使请求的详细信息与当前状态不同也是如此。

如需有效使用此字段,请执行以下操作:

  • 确保后续请求与原始请求相同,并使用相同的身份验证凭据。
  • 如果已使用提供的请求 ID 创建聊天室,则请求会返回该聊天室。请注意,返回的聊天室可能未完全填充;API 会回显您请求中的聊天室,并填充系统分配的资源名称。如需检索聊天室的最新元数据,请调用 spaces.get
  • 使用不同的经过身份验证的用户重复使用现有请求 ID 会导致错误。

请求正文

请求正文包含一个 Space 实例。

响应正文

如果成功,响应正文将包含一个新创建的 Space 实例。

授权范围

需要以下 OAuth 范围之一:

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

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