LiveChatBans: insert

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

常见使用场景

请求

HTTP 请求

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 请求和响应。