Method: spaces.messages.list

列出呼叫者所屬聊天室中的訊息，包括封鎖成員和聊天室的訊息。如需範例，請參閱「列出訊息」。必須進行使用者驗證。

HTTP 要求

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

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

路徑參數

參數
parent

string

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

格式︰spaces/{space}

查詢參數

參數
pageSize

integer

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

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

最大值為 1,000。如果使用的值超過 1,000，系統會自動將該值變更為 1,000。

負值會傳回 INVALID_ARGUMENT 錯誤。
pageToken

string

選用，繼續執行先前的查詢。

從先前清單訊息呼叫收到的網頁權杖。請提供這個參數以擷取後續頁面。

分頁時，您提供的所有其他參數也都會與提供網頁權杖的呼叫相符。將不同的值傳遞至其他參數，可能會導致非預期的結果。
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

詳情請參閱授權指南。