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 đư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 tin nhắn trong phản hồi được sắp xếp 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. Trong yêu cầu tiếp theo, mã thông báo này 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 mà ứng dụng API của bạn nên đợi trước khi yêu cầu thêm kết quả.
Khi bạn yêu cầu thêm kết quả, hãy đặt tham số pageToken thành giá trị nextPageToken và máy chủ API sẽ trả về thêm tin nhắn trò chuyện (nếu có). Trong nhóm kết quả đó, các tin nhắn được sắp xếp từ cũ nhất đến mới nhất.

Tác động đến hạn mức: Mỗi lệnh gọi đến phương thức này sẽ tiêu tốn 5 đơn vị hạn mức.

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 mã nhận dạng của cuộc trò chuyện có tin nhắn sẽ được trả về. Mã Trò chuyện trong sự kiện phát trực tiếp liên kết với một sự kiện 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ẽ bao gồm. Các giá trị được hỗ trợ: id, snippet và authorDetails.
Thông số tuỳ chọn
hl string
Tham số hl hướng dẫn API truy xuất chuỗi hiển thị đơn vị 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ụ: 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ị 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 tối đa các thông báo sẽ được trả về trong tập kết quả. Giá trị được chấp nhận là từ 200 đến 2000. Giá trị mặc định là 500.

Yêu cầu ban đầu được thực hiện mà không có mã thông báo tiếp tục sẽ chỉ chứa những thông báo gần đây nhất. Giá trị này có thể nhỏ hơn maxResults, nếu được cung cấp.

API không truy xuất những tin nhắn cũ hơn những tin nhắn được trả về theo yêu cầu ban đầu được thực hiện mà không có mã thông báo tiếp tục.
pageToken string
Tham số pageToken xác định một trang cụ thể trong tậ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ể được truy xuất.
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 kết quả. Hình ảnh có dạng hình vuông. Giá trị mặc định là 88, tức là hình ảnh sẽ có kích thước 88 px x 88 px. Giá trị được chấp nhận nằm trong khoảng từ 16 đến 720.

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
  ],
  "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 của 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 kết quả.
pollingIntervalMillis unsigned integer
Khoảng thời gian (tính bằng mili giây) mà ứng dụng nên chờ 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 cơ bản chuyển sang chế độ ngoại tuyến. Thuộc tính này chỉ xuất hiện nếu sự kiện phát trực tiếp đã ngoại tuyến. Giá trị đượ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 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 của cuộc thăm dò ý kiến trong tin nhắn. Mỗi cuộc thăm dò ý kiến là một tài nguyên liveChatMessage 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ó thể 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 một 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 Thông tin 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 được chỉ định.
forbidden (403) liveChatDisabled Trò chuyện trong sự kiện phát trực tiếp không được bật cho chương trình phát sóng đã chỉ định.
forbidden (403) liveChatEnded Cuộc trò chuyện qua Live được chỉ định không còn diễn ra nữa.
notFound (404) liveChatNotFound Không tìm thấy cuộc trò chuyện qua Live mà bạn đang cố gắng truy xuất. Hãy kiểm tra giá trị của tham số liveChatId trong yêu cầu để đảm bảo 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 các 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ử!

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