禁止特定用户参与实时聊天。API 请求必须获得频道所有者或与禁止相关联的实时聊天版主的授权。
常见应用场景
请求
HTTP 请求
POST https://www.googleapis.com/youtube/v3/liveChat/bans
授权
此请求需要使用至少以下一个范围进行授权。如需详细了解身份验证和授权,请参阅实现 OAuth 2.0 身份验证。
| 范围 |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
| 参数 | ||
|---|---|---|
| 必需参数 | ||
part |
stringpart 参数在此操作中有两个用途。它用于标识写入操作将设置的属性以及 API 响应返回的属性。将参数值设置为
snippet。 |
|
请求正文
在请求正文中提供 liveChatBan 资源。 对于该资源:
-
您必须为以下属性指定值:
snippet.liveChatIdsnippet.type- 选择以下选项之一:permanent或temporarysnippet.bannedUserDetails.channelId
-
您可以为以下属性设置值:
snippet.banDurationSeconds
响应
如果成功,此方法会在响应正文中返回 liveChatBan 资源。
错误
下表列出了 API 在响应对此方法的调用时可能会返回的出错提示。如需了解详情,请参阅 YouTube Live Streaming API - 错误。
| 错误类型 | 错误详情 | 说明 |
|---|---|---|
forbidden (403) |
insufficientPermissions |
您没有禁止用户参与指定实时聊天所需的权限。 |
forbidden (403) |
liveChatBanInsertionNotAllowed |
无法创建指定的禁止。如果请求尝试禁止聊天所有者或其他版主,则可能会发生此错误。 |
invalidValue (400) |
invalidChannelId |
找不到指定的频道 ID。 |
invalidValue (400) |
invalidLiveChatId |
请求中指定的 snippet.liveChatId 值无效。检查关联的 liveBroadcast 资源,确保您拥有正确的值。 |
notFound (404) |
liveChatNotFound |
找不到指定的实时聊天。检查关联的 liveBroadcast 资源,确保您将 snippet.liveChatId 属性设置为正确的值。 |
notFound (404) |
liveChatUserNotFound |
找不到您要禁止的实时聊天用户。 |
required (400) |
bannedUserChannelIdRequired |
在请求正文中提交的 liveChatBan 资源必须为 snippet.bannedUserDetails.channelId 属性指定值。 |
required (400) |
liveChatIdRequired |
在请求正文中提交的 liveChatBan 资源必须为 snippet.liveChatId 属性指定值。 |
试试看!
使用 APIs Explorer 调用此 API,查看 API 请求和响应。