Method: spaces.messages.list

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

需要使用下列其中一個授權範圍進行使用者驗證：

  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)

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) 篩選訊息。

如要依建立日期篩選訊息，請使用 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.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

詳情請參閱授權指南。