LiveChatMessages: list

Liệt kê các 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 số 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 tin nhắn trong câu 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ã 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 cần truy xuất.
  • Thuộc tính pollingIntervalMillis cho biết ứng dụng API của bạn cần phải đợi trong bao lâu trước khi yêu cầu thêm kết quả.
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ó). Xin nhắc lại, trong nhóm 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

Thông 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.

Thông số
Tham số bắt buộc
liveChatId string
Tham số liveChatId chỉ định ID 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 mà phản hồi của API sẽ đưa vào. Các giá trị được hỗ trợ: id, snippet và authorDetails.
Tham 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ệ đã 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 do phương thức i18nLanguages.list trả về.
maxResults unsigned integer
Tham số maxResults chỉ định số lượng tin nhắn tối đa cần được trả về trong nhóm kết quả. Giá trị có thể chấp nhận là từ 200 đến 2000. 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ả cần được trả về. Trong phản hồi của API, thuộc tính nextPageToken xác định các trang khác có thể truy xuất.
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ả. Hình ảnh là hình vuông. Giá trị mặc định là 88, nghĩa là hình ảnh sẽ có kích thước 88 px x 88 px. Giá trị có thể chấp nhận nằm trong khoảng từ 16 đến 720.

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 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
  ],
  "activePollItem": 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 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à máy khách sẽ đợi trước khi thăm dò lại để tìm 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ỉ xuất hiện 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 nhóm 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 của API.
items[] list
Danh sách tin nhắn. Mỗi mục trong danh sách là một tài nguyên liveChatMessage.
activePollItem object
Dữ liệu về cuộc thăm dò ý kiến trong thông báo. Mỗi cuộc thăm dò ý kiến là một tài nguyên liveChatMessage thuộc loại pollEvent, đại diện cho một cuộc thăm dò ý kiến đang hoạt động. Mỗi cuộc trò chuyện chỉ được có một cuộc thăm dò ý kiến.

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. Hãy 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 Chi tiết về lỗi Mô tả
forbidden (403) forbidden Bạn không có cá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 Tính năng trò chuyện trực tiếp chưa được bật cho chương trình phát sóng đã chỉ định.
forbidden (403) liveChatEnded Cuộc trò chuyện trực tiếp được chỉ định không còn trực tiếp nữa.
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ị 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 này đã được gửi quá nhanh sau yêu cầu trước đó. Lỗi này xảy ra khi các yêu cầu API truy xuất tin nhắn đang được gửi thường xuyên hơn tốc độ làm mới của YouTube, gây lãng phí băng thông một cách không cần thiết.

Hãy dùng thử!

Sử 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.