Method: spaces.list

列出呼叫者所屬的聊天室。但必須先傳送第一則訊息，才會列出群組通訊和即時訊息。如需範例，請參閱列出聊天室。

必須完成驗證。支援應用程式驗證和使用者驗證。

列出呼叫端或已驗證使用者能看到的聊天室。但必須先傳送第一則訊息，才會列出群組通訊和即時訊息。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
pageSize

integer

選用設定。要傳回的聊天室數量上限。服務傳回的產品數量可能會少於這個值。

如未指定，最多會傳回 100 個空格。

最大值是 1000。如果您使用的值超過 1000，系統會自動變更為 1000。

負值會傳回 INVALID_ARGUMENT 錯誤。
pageToken

string

選用設定。屬於接收自先前的清單聊天室呼叫的網頁權杖。提供這個參數即可擷取後續網頁。

進行分頁時，篩選器值應與提供網頁權杖的呼叫相符。傳送不同的值可能會導致非預期的結果。
filter

string

選用設定。查詢篩選器。

您可以依聊天室類型 (spaceType) 篩選聊天室。

如要依聊天室類型篩選，您必須指定有效的列舉值，例如 SPACE 或 GROUP_CHAT (spaceType 不能為 SPACE_TYPE_UNSPECIFIED)。如要查詢多種空間類型，請使用 OR 運算子。

舉例來說，以下是有效的查詢：

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

伺服器拒絕無效的查詢，並顯示 INVALID_ARGUMENT 錯誤。

要求主體

要求主體必須為空白。

回應主體

清單聊天室要求的回應。

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
欄位
spaces[]

object (Space)

要求 (或第一個) 頁面中的聊天室清單。
nextPageToken

string

您可以將權杖做為 pageToken 傳送，以擷取下一頁的結果。如果空白，表示沒有後續網頁。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

詳情請參閱授權指南。