Method: spaces.messages.list

Liệt kê tin nhắn trong một không gian có người gọi, bao gồm cả tin nhắn từ các thành viên và không gian bị chặn. Để biết ví dụ, hãy xem phần Liệt kê thông báo. 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ê các thông báo.

Định dạng spaces/{space}

Tham số truy vấn

Tham số
pageSize

integer

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

Nếu không chỉ định, hệ thống sẽ trả về tối đa 25 thuộc tính.

Giá trị tối đa là 1000. Nếu bạn sử dụng một giá trị lớn hơn 1000 thì 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ừ truy vấn trước đó.

Mã thông báo trang đã nhận được 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 cho các tham số khác có thể dẫn đến kết quả không mong muốn.
filter

string

Bộ lọc cụm từ tìm kiếm.

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

Để lọc thư theo ngày tạo, hãy chỉ định createTime với 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 thông báo được tạo sau dấu thời gian hoặc toán tử nhỏ hơn < để liệt kê các thông báo được tạo trước dấu thời gian. Để lọc cá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 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

Các truy vấn không hợp lệ bị máy chủ từ chối, có lỗi INVALID_ARGUMENT.
orderBy

string

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

Cách sắp xếp danh sách thư. Hãy chỉ định một giá trị cho đơn đặt hàng bằng một thao tác đặt hàng. Sau đây là giá trị của thao tác sắp xếp hợp lệ:

  • ASC để tăng dần.

  • DESC để giảm dần.

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

boolean

Có bao gồm thư đã xoá hay không. Tin nhắn bị xoá có bao gồm thông tin về thời gian bị xoá và siêu dữ liệu về hoạt động xoá, nhưng nội dung tin nhắn sẽ không xuất hiệ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 thông báo liệt kê.

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, 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 đây:

  • 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 bài viết Hướng dẫn uỷ quyền.