Cambia el estado de un mensaje del chat en vivo de YouTube e inicia cualquier proceso asociado con el estado nuevo. Por ejemplo, cuando cambias el estado de una encuesta en vivo a closed, YouTube finaliza la encuesta de ese mensaje. Antes de llamar a este método, debes confirmar que el valor de la propiedad status del mensaje de la encuesta publicado sea active.
Solicitud
Solicitud HTTP
POST https://www.googleapis.com/youtube/v3/liveChatMessages/transition
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 | ||
id |
stringEl parámetro id especifica el ID único del mensaje que está cambiando a otro estado. |
|
status |
enumEl parámetro status identifica el estado al que cambia el mensaje. Para hacer la transición de un mensaje al estado closed, el status debe ser active para la encuesta a la que está vinculado el mensaje.
Solo puedes realizar la transición a closed, lo que significa que la encuesta está cerrada.
|
|
| Parámetros opcionales | ||
part |
stringEl parámetro part especifica las partes del recurso liveChatMessage que incluirá la respuesta de la API. Los valores admitidos son id, snippet y authorDetails.
Establece el valor del parámetro en snippet para obtener el resultado final de la encuesta en el cuerpo de la respuesta.
|
|
Cuerpo de la solicitud
No proporciones un cuerpo de solicitud cuando invoques este método.
Respuesta
Si se aplica correctamente, este método muestra un recurso liveChatMessages 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 información.
| Tipo de error | Detalle del error | Descripción |
|---|---|---|
forbidden (403) |
forbidden |
No tienes los permisos necesarios para realizar la transición del estado del mensaje especificado. |
required (400) |
idRequired |
El parámetro obligatorio id debe identificar el mensaje cuyo estado deseas cambiar. |
required (400) |
statusRequired |
La solicitud a la API debe especificar un valor para el parámetro status. |
notFound (404) |
liveChatMessagesNotFound |
El mensaje especificado por el parámetro id no existe. |
forbidden (403) |
modificationNotAllowed |
No se puede realizar la transición del estado del recurso liveChatMessage especificado. El parámetro id podría identificar un mensaje cuyo estado no se puede cambiar. |
Pruébalo
Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta de la API.