- 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 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 |
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 |
Tham số truy vấn
Tham số | |
---|---|
pageSize |
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 |
pageToken |
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 |
Bộ lọc cụm từ tìm kiếm. Bạn có thể lọc tin nhắn 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ệ:
Các truy vấn không hợp lệ bị máy chủ từ chối, có lỗi |
orderBy |
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ệ:
Thứ tự mặc định là |
showDeleted |
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 ( |
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 đâ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.