此页面由 Cloud Translation API 翻译。

LiveChatBans: insert

禁止特定用户参与实时聊天。API 请求必须获得频道所有者或与禁令相关联的实时聊天管理员的授权。

常见使用场景

POST https://www.googleapis.com/youtube/v3/liveChat/bans

此请求需要获得以下至少一个范围的授权（详细了解身份验证和授权）。

范围
`https://www.googleapis.com/auth/youtube`
`https://www.googleapis.com/auth/youtube.force-ssl`

下表列出了此查询支持的参数。列出的所有参数都是查询参数。

参数
必需参数
`part`	`string` `part` 参数在此操作中有两个目的。它标识写入操作将设置的属性以及 API 响应返回的属性。将参数值设为 `snippet`。

在请求正文中提供 liveChatBan 资源。对于相应资源：

您必须为以下属性指定值：
- snippet.liveChatId
- snippet.type
- snippet.bannedUserDetails.channelId
您可以为以下属性设置值：
- snippet.banDurationSeconds

如果成功，此方法将在响应正文中返回 liveChatBan 资源。

下表列出了该 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 请求和响应。