Agrega un mensaje o una encuesta a un chat en vivo.
Casos de uso habituales
Solicitud
Solicitud HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/messages
Autorización
Esta solicitud requiere autorización con al menos uno de los siguientes alcances (obtén más información acerca de la autenticación y autorización).
Alcance |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Parámetros
En la siguiente tabla, se indican 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. Identifica las propiedades que establecerá la operación de escritura, así como las propiedades que incluirá la respuesta de la API. Establece el valor del parámetro en snippet . |
Cuerpo de la solicitud
Proporciona un recurso liveChatMessage en el cuerpo de la solicitud. En el caso de ese recurso, debes especificar valores para estas propiedades
snippet.liveChatId
snippet.type
. Elige una de las siguientes opciones:textMessageEvent
opollEvent
.- Si el tipo es
textMessageEvent
, incluyesnippet.textMessageDetails.messageText
. - Si el tipo es
pollEvent
, incluyesnippet.pollDetails
con los siguientes valores:snippet.pollDetails.metadata.options.questionText
- Lista de
snippet.pollDetails.metadata.options.optionText
. Debes enumerar al menos dos elementos y no más de cinco. Los elementos se muestran de forma secuencial en el orden en el que se enumeran.
Respuesta
Si se aplica correctamente, este método muestra un recurso liveChatMessage 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. Consulta la documentación sobre mensajes de error para obtener más detalles.
Tipo de error | Detalle del error | Descripción |
---|---|---|
forbidden (403) |
forbidden |
No tienes los permisos necesarios para crear el mensaje especificado. |
forbidden (403) |
liveChatDisabled |
El propietario inhabilitó el chat en vivo especificado, lo que significa que no se pueden agregar mensajes. |
forbidden (403) |
liveChatEnded |
El chat en vivo especificado ya no está en vivo. |
invalidValue (400) |
messageTextInvalid |
El texto del mensaje (snippet.textMessageDetails.messageText ) no es válido. |
notFound (404) |
liveChatNotFound |
El chat en vivo identificado en la solicitud a la API no existe. Este error ocurre si el propietario borró el chat. |
required (400) |
liveChatIdRequired |
El recurso liveChatMessage debe incluir y especificar un valor para la propiedad snippet.liveChatId . |
required (400) |
messageTextRequired |
El recurso liveChatMessage debe incluir y especificar un valor para la propiedad snippet.textMessageDetails.messageText . |
required (400) |
typeRequired |
El recurso liveChatMessage debe incluir y especificar un valor para la propiedad snippet.type . Establece el valor del parámetro en text . |
required (400) |
preconditionCheckFailed |
Ya existe una encuesta activa fijada. |
rateLimitExceeded |
rateLimitExceeded |
El usuario publicó demasiados mensajes de chat en un período determinado. |
Pruébalo
Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta de la API.