列出呼叫端所屬的聊天室。在傳送第一則訊息之前,系統不會列出群組通訊和即時訊息。如需範例,請參閱「列出聊天室」。
需要驗證。完全支援服務帳戶驗證,使用者驗證需要 chat.spaces
或 chat.spaces.readonly
授權範圍。
列出呼叫端或已驗證使用者看到的聊天室。在傳送第一則訊息之前,系統不會列出群組通訊和即時訊息。
HTTP 要求
GET https://chat.googleapis.com/v1/spaces
這個網址使用 gRPC 轉碼語法。
查詢參數
參數 | |
---|---|
pageSize |
選用設定。要傳回的聊天室數量上限。服務傳回的結果可能會少於這個值。 如果未指定,系統會傳回最多 100 個空格。 最大值為 1,000。如果使用的值超過 1,000,系統會自動將該值變更為 1,000。 負值會傳回 |
pageToken |
選用設定。從先前清單空間呼叫收到的網頁權杖。請提供這個參數以擷取後續頁面。 分頁時,篩選器值應與提供網頁權杖的呼叫相符。如果傳遞不同的值,可能會產生非預期的結果。 |
filter |
選用設定。查詢篩選器。 必須進行使用者驗證。 你可以依聊天室類型 ( 如要依空間類型篩選,您必須指定有效的列舉值,例如 舉例來說,以下查詢有效:
伺服器傳回 使用服務帳戶驗證時,系統會忽略這個欄位,而且查詢一律會傳回所有空格。不過,Chat API 仍會透過服務帳戶驗證查詢語法,因此仍會拒絕無效查詢。 |
要求主體
要求主體必須為空白。
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"spaces": [
{
object ( |
欄位 | |
---|---|
spaces[] |
要求 (或第一個) 頁面中的空格清單。 |
nextPageToken |
您可以傳送符記為 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.readonly
https://www.googleapis.com/auth/chat.bot
詳情請參閱授權指南。