此页面由 Cloud Translation API 翻译。

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`（含 0 和 50000）。默认值为 `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` 消息中的轮询数据。每个轮询都是一个类型为 `pollEvent` 的 `liveChatMessage` 资源，表示正在进行的轮询。每个聊天只能有一次投票。

错误

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

错误类型	错误详情	说明
`forbidden (403)`	`forbidden`	你无权检索指定实时聊天中的消息。
`forbidden (403)`	`liveChatDisabled`	指定的直播未启用实时聊天功能。
`forbidden (403)`	`liveChatEnded`	指定的实时聊天已下线。
`notFound (404)`	`liveChatNotFound`	找不到你尝试检索的实时聊天消息。请检查请求的 `liveChatId` 参数的值，确保其正确无误。
`rateLimitExceeded`	`rateLimitExceeded`	上一个请求发送后，请求发送得太快。当检索消息的 API 请求的发送频率高于 YouTube 的刷新频率时，就会出现此错误，这会不必要地浪费带宽。

试试看！

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