LiveChatMessages: list

列出特定聊天会话的实时聊天消息。

当您首次请求检索聊天消息时，API 会返回部分或全部聊天记录，具体取决于聊天记录的长度。响应中的消息按从旧到新的顺序排列。
  • 响应中的 nextPageToken 提供了一个令牌，在您的下一个请求中，该令牌将标识您的 API 客户端应检索的下一组结果。
  • pollingIntervalMillis 属性表示 API 客户端在请求更多结果之前应等待的时间。
当您请求更多结果时，请将 pageToken 参数设置为 nextPageToken 值，API 服务器会返回更多聊天消息（如果有）。同样，在该结果集中，消息按从旧到新的顺序排列。

常见使用场景

请求

HTTP 请求

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

参数

下表列出了此查询支持的参数。列出的所有参数均为查询参数。

参数
必需参数
liveChatId string
liveChatId 参数用于指定要返回其消息的对话的 ID。与广播相关联的实时聊天 ID 会在 liveBroadcast 资源的 snippet.liveChatId 属性中返回。
part string
part 参数用于指定 API 响应将包含的 liveChatMessage 资源部分。支持的值包括 id、snippet 和 authorDetails。
可选参数
hl string
hl 参数指示 API 检索特定YouTube 网站支持的应用语言的本地化币种显示字符串。例如，在英语中，币种会显示为 $1.50，但在法语中，会显示为 1,50$。

参数值必须是 i18nLanguages.list 方法返回的列表中包含的语言代码。
maxResults unsigned integer
maxResults 参数用于指定结果集中应返回的消息数量上限。可接受的值为 200 到 2000（含）。默认值为 500。
pageToken string
pageToken 参数用于标识应返回的结果集中的特定网页。在 API 响应中，nextPageToken 属性用于标识可检索的其他网页。
profileImageSize unsigned integer
profileImageSize 参数用于指定结果集中应返回的用户个人资料照片的大小。图片为方形。默认值为 88，表示图片尺寸为 88x88 像素。可接受的值范围为 16 到 720（含）。

请求正文

调用此方法时，请勿提供请求正文。

响应

如果成功，此方法将返回采用以下结构的响应正文：

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

属性

下表定义了此资源中显示的属性：

属性
kind string
用于标识 API 资源的类型。该值为 youtube#liveChatMessageListResponse。
etag etag
相应资源的 ETag。
nextPageToken string
可用作 pageToken 参数的值的令牌，用于检索结果集中的下一页。
pollingIntervalMillis unsigned integer
客户端在再次轮询新实时聊天消息之前应等待的时间（以毫秒为单位）。
offlineAt datetime
基础直播变为离线的日期和时间。只有当直播已处于离线状态时，此属性才会存在。该值采用 ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) 格式指定。
pageInfo object
pageInfo 对象封装了结果集的分页信息。
pageInfo.totalResults integer
结果集中的结果总数。
pageInfo.resultsPerPage integer
API 响应中包含的结果数。
items[] list
消息列表。列表中的每项内容都是一个 liveChatMessage 资源。
activePollItem object
消息中的投票数据。每个投票都是一个 liveChatMessage 资源，类型为 pollEvent，表示有效投票。每个对话只能包含一个投票。

错误

下表列出了 API 在响应对此方法的调用时可能会返回的错误消息。如需了解详情，请参阅错误消息文档。

错误类型 错误详情 说明
forbidden (403) forbidden 您没有检索指定实时聊天消息所需的权限。
forbidden (403) liveChatDisabled 指定直播未启用实时聊天功能。
forbidden (403) liveChatEnded 指定的实时聊天已结束。
notFound (404) liveChatNotFound 找不到您尝试检索的实时聊天内容。检查请求的 liveChatId 参数的值，确保其正确无误。
rateLimitExceeded rateLimitExceeded 相应请求是在上一个请求发送后过快发送的。当发送的用于检索消息的 API 请求的频率高于 YouTube 的刷新频率时，就会出现此错误，这会不必要地浪费带宽。

试试看！

使用 APIs Explorer 调用此 API，并查看 API 请求和响应。