Method: spaces.messages.list

Liệt kê tin nhắn trong không gian có người gọi, bao gồm cả tin nhắn của các thành viên và không gian bị chặn. Yêu cầu xác thực người dùng và phạm vi uỷ quyền chat.messages hoặc chat.messages.readonly.

Phương thức này chỉ được hỗ trợ trong những không gian không cho phép người dùng bên ngoài tổ chức Workspace tham gia.

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

Các tham số
parent

string

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

Định dạng: space/{space}

Tham số truy vấn

Các 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 xác định thì tối đa 25 giá trị sẽ được trả về.

Giá trị tối đa là 1000; các giá trị trên 1000 được ép buộc thành 1000.

Các 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 đó.

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

Khi phân trang, tất cả các thông số khá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 tin nhắn theo ngày (createTime) và chuỗi (thread.name).

Để lọc thông báo theo ngày tạo, hãy chỉ định createTime bằng dấu thời gian ở định dạng RFC-3339 và 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ê tin nhắn được tạo sau dấu thời gian hoặc nhỏ hơn toán tử < để liệt kê tin nhắn được tạo trước dấu thời gian. Để lọc tin nhắn 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ủ từ chối những truy vấn không hợp lệ do lỗi INVALID_ARGUMENT.
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 một giá trị để đặt hàng và thực hiện một thao tác đặt hàng. Các giá trị hợp lệ của thao tác đặt hàng 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 đã xoá bao gồm cả thời gian và siêu dữ liệu về tin nhắn đã xoá, nhưng nội dung tin nhắn thì không.

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

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
}
Các trường
messages[]

object (Message)

Danh sách tin nhắn.
nextPageToken

string

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

Phạm vi cấp phép

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

  • 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.