Method: spaces.messages.list

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

列出來電者所屬聊天室中的訊息，包括已封鎖成員和聊天室中的訊息。需要使用者驗證以及 chat.messages 或 chat.messages.readonly 授權範圍。

只有獲準從 Workspace 機構外的使用者加入的聊天室才支援這種方法。

HTTP 要求

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

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

路徑參數

參數
parent

string

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

格式：空格/{空格}

查詢參數

參數
pageSize

integer

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

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

最大值是 1000； 1000 以上的值被為 1000。

負值會傳回 INVALID_ARGUMENT 錯誤。
pageToken

string

選用，如果從先前的查詢繼續執行，

從先前清單訊息呼叫收到的網頁憑證。請提供這個 ID 以擷取後續網頁。

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

string

查詢篩選器。

您可以依日期 (createTime) 和對話串 (thread.name) 篩選訊息。

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

如要按執行緒篩選，請指定 thread.name，格式為 spaces/{space}/threads/{thread}。每個查詢只能指定一個 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.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

詳情請參閱授權指南。