- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- Hãy làm thử!
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 |
Bắt buộc. Tên tài nguyên của không gian để liệt kê tin nhắn. Định dạng |
Tham số truy vấn
Tham số | |
---|---|
pageSize |
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 |
pageToken |
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 |
Bộ lọc truy vấn. Bạn có thể lọc thư theo ngày ( Để lọc thư theo ngày tạo, hãy chỉ định Để lọc theo chuỗi, hãy chỉ định Để lọc theo cả chuỗi và ngày, hãy sử dụng toán tử Ví dụ: các truy vấn sau đây là hợp lệ:
Máy chủ có lỗi |
orderBy |
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ệ:
Thứ tự mặc định là |
showDeleted |
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 ( |
Trường | |
---|---|
messages[] |
Danh sách tin nhắn. |
nextPageToken |
Bạn có thể gửi mã thông báo dưới dạng |
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.