列出特定聊天消息的实时聊天消息。
当您发出第一个检索检索消息的请求时,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 网站支持的特定应用语言的本地化货币显示字符串。例如,英语中,货币会显示为 $1.50 ,但法语中则会显示为 1,50$ 。参数值必须是 i18nLanguages.list 方法返回的列表中包含的语言代码。 |
|
maxResults |
unsigned integer maxResults 参数用于指定应在结果集中返回的消息数量上限。可接受的值包括200 到2000 (含 0 和 5000)。默认值为 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 资源。 |
错误
下表列出了该 API 为响应对此方法的调用可能返回的错误消息。如需了解详情,请参阅错误消息文档。
错误类型 | 错误详情 | 说明 |
---|---|---|
forbidden (403) |
forbidden |
您没有检索指定实时聊天消息的权限。 |
forbidden (403) |
liveChatDisabled |
指定的直播未启用实时聊天功能。 |
forbidden (403) |
liveChatEnded |
指定的实时聊天消息已失效。 |
notFound (404) |
liveChatNotFound |
未找到您尝试检索的实时聊天。请检查请求的 liveChatId 参数的值,确保其正确无误。 |
rateLimitExceeded |
rateLimitExceeded |
该请求在上一个请求之后发送过快。当 API 检索消息的发送频率高于 YouTube 的更新频率时,就会发生此错误,而这会不必要地浪费带宽。 |
试试看!
使用 APIs Explorer 调用此 API,并查看 API 请求和响应。