Method: spaces.setup

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

建立聊天室並加入使用者。如果無法直接加入使用者,請傳送邀請給對方。系統不支援有討論串式回覆的聊天室和開放訪客加入的聊天室。

需要使用者驗證chat.spaces.create 範圍。

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.SPACESpace.displayName

如要建立群組通訊,請設定Space.spaceType.GROUP_CHAT。不要設定 Space.displayName

如要在人與人之間進行 1:1 對話,請將 Space.spaceType.DIRECT_MESSAGE 設為 Space.singleUserBotDm,並將 false 設為 false。不要設定 Space.displayNameSpace.spaceDetails

如要在人類與即時通訊應用程式之間建立 1:1 對話,請將 Space.spaceType.DIRECT_MESSAGESpace.singleUserBotDm 設為 true。不要設定 Space.displayNameSpace.spaceDetails

requestId

string

選用,這個要求的專屬 ID。建議使用隨機的 UUID。只有在提供 requestId 或 DM 已存在時,此要求才是冪等的。透過不同已驗證使用者的同一個即時通訊應用程式指定 requestId 現有的值,就會傳回錯誤。

memberships[]

object (Membership)

選用,受邀加入聊天室的網域內使用者或群組初始組合。

目前最多只能設定 20 個會員。

Membership.member 欄位必須包含填入 nameUser.Type.HUMAN 的使用者。系統會忽略所有其他欄位。

必須選取「Space.spaceType.SPACE」以及至少 1 個會員資格。

使用 Space.spaceType.GROUP_CHAT 時,以及至少兩個會員資格。

如為真人使用者,則只能加入Space.spaceType.DIRECT_MESSAGE,而且只能有一個成員。

不支援:邀請網域使用者,或新增其他即時通訊應用程式。

回應主體

如果成功,回應主體會包含 Space 的執行例項。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱授權指南