此页面由 Cloud Translation API 翻译。

LiveChatBans: insert

禁止特定用户参与实时聊天。此 API 请求必须由频道所有者或与禁播相关的直播聊天室的管理员授权。

常见使用场景

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`	`string` 在本操作中，`part` 参数有两个用途。它用于标识写入操作将设置的属性以及 API 响应返回的属性。将参数值设置为 `snippet`。

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

您必须为以下属性指定值：
- snippet.liveChatId
- snippet.type
- snippet.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 请求和响应。