Method: spaces.messages.list

Mencantumkan pesan dalam ruang tempat pemanggil anggota, termasuk pesan dari anggota dan ruang yang diblokir. Sebagai contoh, lihat Mencantumkan pesan. Memerlukan autentikasi pengguna dan cakupan otorisasi chat.messages atau chat.messages.readonly.

Metode ini hanya didukung di ruang yang tidak mengizinkan pengguna dari luar organisasi Workspace untuk bergabung.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib diisi. Nama resource ruang untuk mencantumkan pesan.

Format: spaces/{space}

Parameter kueri

Parameter
pageSize

integer

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

Jika tidak ditentukan, maksimal 25 akan ditampilkan.

Nilai maksimum adalah 1.000. Jika Anda menggunakan nilai yang lebih dari 1.000, nilai akan otomatis diubah menjadi 1.000.

Nilai negatif menampilkan error INVALID_ARGUMENT.
pageToken

string

Opsional, jika melanjutkan dari kueri sebelumnya.

Token halaman yang diterima dari panggilan pesan daftar sebelumnya. Berikan parameter ini untuk mengambil halaman berikutnya.

Saat penomoran halaman, semua parameter lain yang diberikan harus cocok dengan panggilan yang memberikan token halaman. Meneruskan nilai yang berbeda ke parameter lain dapat menyebabkan hasil yang tidak terduga.
filter

string

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 lebih besar dari operator > untuk mencantumkan pesan yang dibuat setelah stempel waktu, atau kurang dari operator < 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 thread, tentukan thread.name, dengan format spaces/{space}/threads/{thread}. Anda hanya dapat menentukan satu thread.name per kueri.

Untuk memfilter menurut thread 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 yang memiliki error INVALID_ARGUMENT.
orderBy

string

Opsional, jika melanjutkan dari kueri sebelumnya.

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

  • ASC untuk urutan menaik.

  • DESC untuk menurun.

Pengurutan default-nya adalah createTime ASC.
showDeleted

boolean

Apakah pesan yang dihapus akan disertakan atau tidak. Pesan yang dihapus berisi metadata dan waktu penghapusan yang terkait dengan penghapusan, tetapi konten pesan tidak tersedia.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

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 akan 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 mengetahui informasi selengkapnya, lihat Panduan otorisasi.