转换 YouTube 实时聊天消息的状态,并启动与新状态相关的所有流程。例如,如果您将实时投票的状态转换为 closed
,YouTube 会结束相应消息的投票。在调用此方法之前,您应确认实时投票消息的 status
属性的值为 active
。
请求
HTTP 请求
POST https://www.googleapis.com/youtube/v3/liveChatMessages/transition
授权
此请求需要获得以下至少一个范围的授权(详细了解身份验证和授权)。
范围 |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
参数
下表列出了此查询支持的参数。列出的所有参数均为查询参数。
参数 | ||
---|---|---|
必需参数 | ||
id |
string id 参数用于指定要转换为其他状态的消息的唯一 ID。 |
|
status |
enum status 参数用于标识消息要变为哪种状态。如需将消息转换为 closed 状态,消息绑定到的轮询的 status 必须为 active 。
您只能转换到 closed ,这意味着意见调查已关闭。
|
|
可选参数 | ||
part |
string part 参数指定 API 响应将包含的 liveChatMessage 资源部分。支持的值包括 id 、snippet 和 authorDetails 。
将参数值设为 snippet 可在响应正文中获取最终的轮询结果。
|
请求正文
调用此方法时,请勿提供请求正文。
响应
如果成功,此方法将在响应正文中返回一项 liveChatMessages 资源。
错误
下表列出了 API 在响应此方法调用时可能会返回的错误消息。如需了解详情,请参阅错误消息文档。
错误类型 | 错误详情 | 说明 |
---|---|---|
forbidden (403) |
forbidden |
您没有转换指定邮件状态所需的权限。 |
required (400) |
idRequired |
必需的 id 参数必须标识您想要转换其状态的消息。 |
required (400) |
statusRequired |
API 请求必须指定 status 参数的值。 |
notFound (404) |
liveChatMessagesNotFound |
id 参数指定的消息不存在。 |
forbidden (403) |
modificationNotAllowed |
指定的 liveChatMessage 资源的状态无法转换。id 参数可以标识状态无法转换的消息。 |
试试看!
使用 APIs Explorer 调用此 API 并查看 API 请求和响应。