LiveChatMessages: list

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

Khi bạn đưa ra yêu cầu đầu tiên để truy xuất tin nhắn trò chuyện, API sẽ trả về một phần hoặc toàn bộ nhật ký trò chuyện, tuỳ thuộc vào độ dài của nhật ký đó. Các thư trong phản hồ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 của bạn, sẽ xác định tập hợp kết quả tiếp theo mà ứng dụng API của bạn phải truy xuất.
  • Thuộc tính pollingIntervalMillis cho biết ứng dụng API của bạn phải đợi trong bao lâu trước khi yêu cầu kết quả bổ sung.
Khi yêu cầu kết quả bổ sung, bạn đặt tham số pageToken thành giá trị nextPageToken và máy chủ API sẽ trả về các tin nhắn trò chuyện bổ sung (nếu có). Một lần nữa, trong tập hợp kết quả đó, các tin nhắn đượ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

Tham số

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

Tham số
Tham số bắt buộc
liveChatId string
Tham số liveChatId chỉ định mã 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 chương trình phát sóng được trả về trong thuộc tính 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 sẽ bao gồm phản hồi API. Các giá trị được hỗ trợ: id, snippet và authorDetails.
Thông số không bắt buộc
hl string
Tham số hl hướng dẫn API truy xuất chuỗi hiển thị tiền tệ được bản địa hoá cho một ngôn ngữ ứng dụng cụ thể mà trang web YouTube hỗ trợ. Ví dụ: trong tiếng Anh, đơn vị tiền tệ sẽ hiển thị là $1.50, nhưng trong tiếng Pháp, đơn vị tiền tệ sẽ hiển thị là 1,50$.

Giá trị tham 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
Tham số maxResults chỉ định số lượng thông báo tối đa cần trả về trong tập hợp kết quả. Các 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 nhóm kết quả sẽ được trả về. Trong một 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 cần được trả về trong tập hợp kết quả. Ảnh 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 (tính cả hai giá trị này).

Nội dung yêu cầu

Đừ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 có cấu trúc như 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
Thẻ 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 tham 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à ứng dụng phải chờ trước khi thăm dò lại để xem các tin nhắn trò chuyện trực tiếp mới.
offlineAt datetime
Ngày và giờ mà sự kiện phát trực tiếp ban đầu chuyển sang chế độ ngoại tuyến. Thuộc tính này chỉ hiển thị nếu luồng đã ngoại tuyến. Giá trị được chỉ định theo đị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 nhóm kết quả.
pageInfo.resultsPerPage integer
Số lượng kết quả có trong phản hồi của 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 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ề để phản hồi 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 chi tiết.

Loại lỗi Chi tiết lỗi Nội dung 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 đã chỉ định.
forbidden (403) liveChatDisabled Trò chuyện trực tiếp không được bật cho nội dung phát đã chỉ định.
forbidden (403) liveChatEnded Cuộc trò chuyện trực tiếp đã chỉ định hiện không còn hiển thị trực tiếp.
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. Kiểm tra giá trị của tham số liveChatId của yêu cầu để đảm bảo rằng giá trị đó 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 yêu cầu API 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 một cách không cần thiết.

Hãy dùng thử!

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.