Method: spaces.messages.list

Liệt kê tin nhắn trong một không gian mà người gọi là thành viên, bao gồm cả tin nhắn của các thành viên và không gian bị chặn. Nếu bạn liệt kê tin nhắn từ một không gian không có tin nhắn nào, thì phản hồi sẽ là đối tượng trống. Khi sử dụng giao diện REST/HTTP, phản hồi chứa đối tượng JSON trống là {}. Để biết ví dụ, hãy xem bài viết Liệt kê tin nhắn. Yêu cầu xác thực người dùng.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
parent

string

Bắt buộc. Tên tài nguyên của không gian để liệt kê tin nhắn.

Định dạng spaces/{space}

Tham số truy vấn

Tham số
pageSize

integer

Số lượng tin nhắn tối đa được trả về. Dịch vụ có thể trả về ít tin nhắn hơn giá trị này.

Nếu không chỉ định, hàm trả về tối đa 25 trường.

Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị này sẽ tự động thay đổi thành 1000.

Giá trị âm trả về lỗi INVALID_ARGUMENT.

pageToken

string

Không bắt buộc, nếu tiếp tục từ một truy vấn trước đó.

Đã nhận được mã thông báo trang từ một lệnh gọi tin nhắn danh sách trước đó. Cung cấp tham số này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các thông số khác được cung cấp phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển các giá trị khác nhau sang các thông số khác có thể dẫn đến kết quả không mong muốn.

filter

string

Bộ lọc truy vấn.

Bạn có thể lọc thư theo ngày (createTime) và chuỗi (thread.name).

Để lọc thư theo ngày tạo, hãy chỉ định createTime kèm theo dấu thời gian ở định dạng RFC-3339 và dùng dấu ngoặc kép. Ví dụ: "2023-04-21T11:30:00-04:00". Bạn có thể sử dụng toán tử lớn hơn > để liệt kê các thông báo được tạo sau một dấu thời gian, hoặc sử dụng toán tử nhỏ hơn < để liệt kê các thông báo được tạo trước một dấu thời gian. Để lọc thông báo trong một khoảng thời gian, hãy sử dụng toán tử AND giữa hai dấu thời gian.

Để lọc theo chuỗi, hãy chỉ định thread.name, có định dạng là spaces/{space}/threads/{thread}. Bạn chỉ có thể chỉ định một thread.name cho mỗi truy vấn.

Để lọc theo cả chuỗi và ngày, hãy sử dụng toán tử AND trong truy vấn của bạn.

Ví dụ: các truy vấn sau đây là hợp lệ:

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

Máy chủ có lỗi INVALID_ARGUMENT từ chối các truy vấn không hợp lệ.

orderBy

string

Không bắt buộc, nếu tiếp tục từ một truy vấn trước đó.

Cách sắp xếp danh sách tin nhắn. Chỉ định giá trị cho đơn đặt hàng bằng một thao tác đặt hàng. Sau đây là các giá trị toán tử có thứ tự hợp lệ:

  • ASC để tăng dần.

  • DESC để giảm dần.

Thứ tự mặc định là createTime ASC.

showDeleted

boolean

Liệu có bao gồm thư đã xoá hay không. Tin nhắn bị xoá bao gồm cả thời gian đã xoá và siêu dữ liệu về việc xoá tin nhắn, nhưng không có nội dung tin nhắn.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Tin nhắn phản hồi cho tin nhắn danh sách.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Trường
messages[]

object (Message)

Danh sách tin nhắn.

nextPageToken

string

Bạn có thể gửi mã thông báo dưới dạng pageToken để truy xuất trang kết quả tiếp theo. Nếu trống thì không có trang tiếp theo nào.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.