Method: spaces.messages.list

Mencantumkan pesan dalam ruang tempat pemanggil menjadi anggota, termasuk pesan dari anggota dan ruang yang diblokir. Jika Anda mencantumkan pesan dari ruang tanpa pesan, responsnya adalah objek kosong. Saat menggunakan antarmuka REST/HTTP, respons akan berisi objek JSON kosong, {}. Sebagai contoh, lihat Membuat daftar pesan.

Memerlukan autentikasi pengguna.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource ruang tempat pesan akan dicantumkan.

Format: spaces/{space}

Parameter kueri

Parameter
pageSize

integer

Opsional. Jumlah maksimum pesan yang ditampilkan. Layanan mungkin menampilkan lebih sedikit pesan daripada nilai ini.

Jika tidak ditentukan, maksimal 25 akan ditampilkan.

Nilai maksimumnya adalah 1.000. Jika Anda menggunakan nilai lebih dari 1.000, nilai tersebut akan otomatis diubah menjadi 1.000.

Nilai negatif menampilkan error INVALID_ARGUMENT.
pageToken

string

Opsional. Token halaman yang diterima dari panggilan list messages sebelumnya. Berikan parameter ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, semua parameter lain yang diberikan harus sesuai dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda ke parameter lain dapat memberikan hasil yang tidak diharapkan.
filter

string

Opsional. Filter kueri.

Anda dapat memfilter pesan menurut tanggal (createTime) dan rangkaian pesan (thread.name).

Untuk memfilter pesan menurut tanggal pembuatannya, tentukan createTime dengan stempel waktu dalam format RFC-3339 dan tanda kutip ganda. Misalnya, "2023-04-21T11:30:00-04:00". Anda dapat menggunakan operator lebih besar dari > untuk mencantumkan pesan yang dibuat setelah stempel waktu, atau operator kurang dari < untuk mencantumkan pesan yang dibuat sebelum stempel waktu. Untuk memfilter pesan dalam interval waktu, gunakan operator AND di antara dua stempel waktu.

Untuk memfilter menurut rangkaian pesan, tentukan thread.name, yang diformat sebagai spaces/{space}/threads/{thread}. Anda hanya dapat menentukan satu thread.name per kueri.

Untuk memfilter menurut rangkaian pesan dan tanggal, gunakan operator AND dalam kueri Anda.

Misalnya, kueri berikut valid:

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

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.
orderBy

string

Opsional. Cara pengurutan daftar pesan. Tentukan nilai yang akan diurutkan berdasarkan operasi pengurutan. Nilai operasi pengurutan yang valid adalah sebagai berikut:

  • ASC untuk menaik.

  • DESC untuk menurun.

Pengurutan defaultnya adalah createTime ASC.
showDeleted

boolean

Opsional. Apakah akan menyertakan pesan yang dihapus. Pesan yang dihapus mencakup waktu penghapusan dan metadata tentang penghapusannya, tetapi konten pesan tidak tersedia.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk listingan pesan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Kolom
messages[]

object (Message)

Daftar pesan.
nextPageToken

string

Anda dapat mengirim token sebagai pageToken untuk mengambil halaman hasil berikutnya. Jika kosong, tidak ada halaman berikutnya.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.