Method: spaces.messages.list

Liệt kê các 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 từ các thành viên và không gian bị chặn. Tin nhắn hệ thống (chẳng hạn như tin nhắn thông báo thành viên mới trong không gian) không được đưa vào. Nếu bạn liệt kê tin nhắn từ một không gian không có tin nhắn, thì phản hồi sẽ là một đối tượng trống. Khi sử dụng giao diện REST/HTTP, phản hồi sẽ chứa một đối tượng JSON trống, {}. Để xem ví dụ, hãy xem bài viết Liệt kê tin nhắn.

Hỗ trợ các loại xác thực sau:

  • Xác thực ứng dụng có sự phê duyệt của quản trị viên với phạm vi uỷ quyền:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. Khi sử dụng phạm vi xác thực này, phương thức này chỉ trả về các tin nhắn công khai trong một không gian. Phương thức này không bao gồm tin nhắn riêng tư.

  • Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (chỉ không gian ở chế độ nhập)

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

Không bắt buộc. 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ệ thống sẽ trả về tối đa 25 tin nhắn.

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

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

string

Không bắt buộc. Mã thông báo trang nhận được từ lệnh gọi liệt kê tin nhắn 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 tham 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 truyền các giá trị khác nhau cho các tham số khác có thể dẫn đến kết quả không mong muốn.
filter

string

Không bắt buộc. 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 tin nhắn 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ê các tin nhắn được tạo sau một dấu thời gian hoặc toán tử nhỏ hơn < để liệt kê các tin nhắn được tạo trước một 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.

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ủ sẽ từ chối các truy vấn không hợp lệ bằng lỗi INVALID_ARGUMENT.
orderBy

string

Không bắt buộc. Cách sắp xếp danh sách tin nhắn. Chỉ định một giá trị để sắp xếp theo một thao tác sắp xếp. Các giá trị thao tác sắp xếp hợp lệ như sau:

  • ASC để tăng dần.

  • DESC để giảm dần.

Thứ tự sắp xếp mặc định là createTime ASC.
showDeleted

boolean

Không bắt buộc. Có bao gồm tin nhắn đã xoá hay không. Tin nhắn đã xoá bao gồm thời gian xoá và siêu dữ liệu về việc xoá, nhưng nội dung tin nhắn không có sẵ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

Thông báo phản hồi để liệt kê tin nhắn.

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.

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
  • https://www.googleapis.com/auth/chat.app.messages.readonly

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