Method: spaces.messages.list

列出來電者所屬聊天室中的訊息，包括已封鎖的成員和聊天室的訊息。如果您從沒有訊息的聊天室中列出訊息，回應會是空白物件。使用 REST/HTTP 介面時，回應會包含空白的 JSON 物件 {}。如需範例，請參閱「列出郵件」。需要使用者驗證。

HTTP 要求

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages

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

路徑參數

參數
parent

string

必要欄位。要列出訊息的來源聊天室資源名稱。

格式：spaces/{space}

查詢參數

參數
pageSize

integer

傳回的訊息數量上限。服務傳回的訊息可能會少於這個值。

如未指定，最多會傳回 25 個。

值的數量上限是 1000。如果使用的值超過 1000，系統會自動將值變更為 1000。

負值會傳回 INVALID_ARGUMENT 錯誤。
pageToken

string

如果繼續執行先前的查詢，則為選用項目。

接收自先前 list 訊息呼叫的頁面符記。提供這個參數即可擷取後續網頁。

進行分頁時，提供的所有其他參數應與提供網頁權杖的呼叫相符。將不同的值傳送至其他參數，可能會導致非預期的結果。
filter

string

查詢篩選器。

您可以按照日期 (createTime) 和討論串 (thread.name) 篩選訊息。

如要依建立日期篩選郵件，請指定 createTime 以及 RFC-3339 格式的時間戳記，並加上雙引號。例如 "2023-04-21T11:30:00-04:00"。您可以使用大於運算子 > 列出在時間戳記之後建立的訊息；也可以使用小於運算子 < 列出在時間戳記之前建立的訊息。如要篩選時間間隔內的訊息，請在兩個時間戳記之間使用 AND 運算子。

如要依執行緒篩選，請指定格式為 spaces/{space}/threads/{thread} 的 thread.name。每項查詢只能指定一個 thread.name。

如要同時依執行緒和日期進行篩選，請在查詢中使用 AND 運算子。

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

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

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

string

如果繼續執行先前的查詢，則為選用項目。

訊息清單的排序方式。指定排序作業要排序的值。有效的排序作業值如下：

  • ASC 代表遞增。

  • DESC 代表遞減。

預設順序為 createTime ASC。
showDeleted

boolean

是否包含已刪除的郵件。刪除的郵件會包含刪除時間以及相關刪除時間的中繼資料，但無法取得郵件內容。

要求主體

要求主體必須為空白。

回應主體

列出訊息的回應訊息。

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

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

object (Message)

訊息清單。
nextPageToken

string

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

授權範圍

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

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

詳情請參閱授權指南。