LiveChatMessages: list

Liệt kê các tin nhắn trò chuyện trực tiếp cho một cuộc trò chuyện cụ thể.

Khi bạn gửi yêu cầu truy xuất tin nhắn trò chuyện đầu tiên, API sẽ trả về một số hoặc tất cả lịch sử trò chuyện, tùy thuộc vào độ dài của nhật ký trò chuyện đó. Thư trong thư trả lời được sắp xếp theo thứ tự từ cũ nhất đến mới nhất.
  • nextPageToken trong phản hồi cung cấp một mã thông báo mà trong yêu cầu tiếp theo sẽ xác định tập hợp kết quả tiếp theo mà ứng dụng API của bạn sẽ truy xuất.
  • Thuộc tính pollingIntervalMillis cho biết thời gian cần chờ ứng dụng API của bạn trước khi yêu cầu kết quả bổ sung.
Khi yêu cầu thêm kết quả, bạn đặt thông số pageToken thành giá trị nextPageToken và máy chủ API trả về các tin nhắn trò chuyện bổ sung (nếu có). Xin nhắc lại, trong tập hợp kết quả đó, thư được sắp xếp theo thứ tự từ cũ nhất đến mới nhất.

Các trường hợp sử dụng phổ biến

Yêu cầu

Yêu cầu HTTP

GET https://www.googleapis.com/youtube/v3/liveChat/messages

Các tham số

Bảng sau trình bày các tham số mà truy vấn này hỗ trợ. Tất cả thông số được liệt kê đều là thông số truy vấn.

Các tham số
Các thông số bắt buộc
liveChatId string
Thông số liveChatId sẽ chỉ định mã nhận dạng của cuộc trò chuyện có tin nhắn sẽ được trả về. Mã cuộc trò chuyện trực tiếp liên kết với một thông báo được trả về trong tài sản snippet.liveChatId của tài nguyên liveBroadcast.
part string
Tham số part chỉ định các phần tài nguyên liveChatMessage mà phản hồi API sẽ đưa vào. Giá trị được hỗ trợ là id, snippetauthorDetails.
Tham số không bắt buộc
hl string
Thông số hl hướng dẫn API truy xuất chuỗi hiển thị nội dung được bản địa hóa cho một ngôn ngữ ứng dụng cụ thể mà trang web YouTube hỗ trợ. Ví dụ: bằng tiếng Anh, đơn vị tiền tệ sẽ hiển thị là $1.50, nhưng bằng tiếng Pháp, đơn vị tiền tệ sẽ hiển thị là 1,50$.

Giá trị thông số phải là mã ngôn ngữ có trong danh sách được phương thức i18nLanguages.list trả về.
maxResults unsigned integer
Thông số maxResults chỉ định số lượng thông báo tối đa sẽ được trả về trong tập hợp kết quả. Giá trị được chấp nhận là từ 200 đến 2000, bao gồm cả hai giá trị này. Giá trị mặc định là 500.
pageToken string
Tham số pageToken xác định một trang cụ thể trong tập hợp kết quả nên được trả về. Trong phản hồi API, thuộc tính nextPageToken xác định các trang khác có thể truy xuất được.
profileImageSize unsigned integer
Tham số profileImageSize chỉ định kích thước của ảnh hồ sơ người dùng sẽ được trả về trong tập hợp kết quả. Những hình ảnh này có dạng hình vuông. Giá trị mặc định là 88, nghĩa là ảnh sẽ có kích thước 88px x 88px. Các giá trị được chấp nhận nằm trong khoảng từ 16 đến 720, bao gồm cả hai giá trị đó.

Nội dung yêu cầu

Không cung cấp nội dung yêu cầu khi gọi phương thức này.

Phản hồi

Nếu thành công, phương thức này sẽ trả về nội dung phản hồi với cấu trúc sau:

{
  "kind": "youtube#liveChatMessageListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pollingIntervalMillis": unsigned integer,
  "offlineAt": datetime,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatMessage Resource
  ]
}

Thuộc tính

Bảng sau đây xác định các thuộc tính xuất hiện trong tài nguyên này:

Thuộc tính
kind string
Xác định loại tài nguyên API. Giá trị sẽ là youtube#liveChatMessageListResponse.
etag etag
Etag của tài nguyên này.
nextPageToken string
Mã thông báo có thể được dùng làm giá trị của thông số pageToken để truy xuất trang tiếp theo trong tập hợp kết quả.
pollingIntervalMillis unsigned integer
Khoảng thời gian (tính bằng mili giây) mà khách hàng phải chờ trước khi thăm dò lại để nhận tin nhắn trò chuyện trực tiếp mới.
offlineAt datetime
Ngày và giờ mà luồng trực tiếp cơ bản chuyển sang chế độ ngoại tuyến. Bạn chỉ có thể xem tài sản này nếu luồng đã ngoại tuyến. Giá trị này được chỉ định ở định dạng ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
pageInfo object
Đối tượng pageInfo đóng gói thông tin phân trang cho tập hợp kết quả.
pageInfo.totalResults integer
Tổng số kết quả trong tập hợp kết quả.
pageInfo.resultsPerPage integer
Số lượng kết quả có trong phản hồi API.
items[] list
Danh sách các tin nhắn trò chuyện trực tiếp. Mỗi mục trong danh sách này là một tài nguyên liveChatMessage.

Lỗi

Bảng sau đây xác định các thông báo lỗi mà API có thể trả về khi một lệnh gọi đến phương thức này. Vui lòng xem tài liệu về thông báo lỗi để biết thêm thông tin chi tiết.

Loại lỗi Thông tin chi tiết về lỗi Mô tả
forbidden (403) forbidden Bạn không có quyền cần thiết để truy xuất tin nhắn cho cuộc trò chuyện trực tiếp được chỉ định.
forbidden (403) liveChatDisabled Trò chuyện trực tiếp không được bật cho chương trình phát đã chỉ định.
forbidden (403) liveChatEnded Cuộc trò chuyện trực tiếp mà bạn chỉ định không còn tồn tại.
notFound (404) liveChatNotFound Không tìm thấy cuộc trò chuyện trực tiếp mà bạn đang cố gắng truy xuất. Hãy kiểm tra giá trị của tham số liveChatId của yêu cầu để đảm bảo rằng tham số này là chính xác.
rateLimitExceeded rateLimitExceeded Yêu cầu được gửi quá nhanh sau yêu cầu trước đó. Lỗi này xảy ra khi API yêu cầu truy xuất thông báo được gửi thường xuyên hơn tốc độ làm mới của YouTube, điều này gây lãng phí băng thông không cần thiết.

Hãy dùng thử!

Hãy dùng APIs Explorer để gọi API này cũng như xem yêu cầu và phản hồi của API.