列出特定聊天的实时聊天消息。
当您发出第一个检索聊天消息的请求时,API 会根据聊天记录长度返回部分或全部聊天记录。响应中的消息会按从旧到新的顺序排列。
当您发出第一个检索聊天消息的请求时,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 网站支持的特定应用语言检索本地化货币显示字符串。例如,在英语中,currency 会显示为 $1.50 ,但在法语中,它会显示为 1,50$ 。参数值必须是 i18nLanguages.list 方法返回的列表中包含的语言代码。 |
|
maxResults |
unsigned integer maxResults 参数指定结果集中应返回的消息数上限。可接受的值包括200 到2000 (含 0 和 10000)。默认值为 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 ] }
属性
下表定义了此资源中显示的属性:
属性 | |
---|---|
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 请求和响应。