LiveChatBans: insert

Prohíbe que un usuario específico participe en el chat en vivo. El propietario del canal o un moderador del chat en vivo asociado con la prohibición deben autorizar la solicitud a la API.

Casos de uso habituales

Solicitud

Solicitud HTTP

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

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes alcances. Para obtener más información sobre la autenticación y la autorización, consulta Cómo implementar la autenticación de OAuth 2.0.

Alcance
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parámetros

En la siguiente tabla, se enumeran los parámetros que admite esta consulta. Todos los parámetros mencionados son parámetros de consulta.

Parámetros
Parámetros obligatorios
part string
El parámetro part tiene dos propósitos en esta operación. Identifica las propiedades que la operación de escritura establecerá, así como las propiedades que muestra la respuesta de la API. Establece el valor del parámetro en snippet.

Cuerpo de la solicitud

Proporciona un recurso liveChatBan en el cuerpo de la solicitud. Para ese recurso:

  • Debes especificar un valor para estas propiedades:

    • snippet.liveChatId
    • snippet.type : Elige una de las siguientes opciones: permanent o temporary.
    • snippet.bannedUserDetails.channelId

  • Puedes establecer los valores de las siguientes propiedades:

    • snippet.banDurationSeconds

Respuesta

Si se aplica correctamente, este método muestra un recurso liveChatBan en el cuerpo de la respuesta.

Errores

En la siguiente tabla, se identifican los mensajes de error que la API podría mostrar en respuesta a una llamada a este método. Para obtener más detalles, consulta API de YouTube Live Streaming: Errores.

Tipo de error Detalle del error Descripción
forbidden (403) insufficientPermissions No tienes los permisos necesarios para prohibir que un usuario participe en el chat en vivo especificado.
forbidden (403) liveChatBanInsertionNotAllowed No se puede crear la prohibición especificada. Este error puede ocurrir si la solicitud intenta prohibir al propietario del chat o a otro moderador.
invalidValue (400) invalidChannelId No se puede encontrar el ID del canal especificado.
invalidValue (400) invalidLiveChatId El valor snippet.liveChatId especificado en la solicitud no es válido. Revisa el recurso liveBroadcast asociado para asegurarte de tener el valor correcto.
notFound (404) liveChatNotFound No se puede encontrar el chat en vivo especificado. Revisa el recurso liveBroadcast asociado para asegurarte de establecer la propiedad snippet.liveChatId en el valor correcto.
notFound (404) liveChatUserNotFound No se puede encontrar el usuario del chat en vivo que intentas prohibir.
required (400) bannedUserChannelIdRequired El recurso liveChatBan enviado en el cuerpo de la solicitud debe especificar un valor para la propiedad snippet.bannedUserDetails.channelId.
required (400) liveChatIdRequired El recurso liveChatBan enviado en el cuerpo de la solicitud debe especificar un valor para la propiedad snippet.liveChatId.

Pruébalo

Usa el APIs Explorer para llamar a esta API y ver la solicitud a la API y la respuesta.