LiveChatMessages: list

Enumera los mensajes del chat en vivo de un chat específico.

Cuando realizas tu primera solicitud para recuperar mensajes de chat, la API muestra todo el historial de chat o parte de este, según la duración de ese historial. Los mensajes de la respuesta se ordenan de los más antiguos a los más recientes.

• El nextPageToken de la respuesta proporciona un token que, en tu próxima solicitud, identificará el siguiente conjunto de resultados que tu cliente de API debería recuperar.
• La propiedad pollingIntervalMillis indica cuánto tiempo debe esperar tu cliente de la API antes de solicitar resultados adicionales.

Cuando solicitas resultados adicionales, estableces el parámetro pageToken en el valor nextPageToken y el servidor de la API muestra mensajes de chat adicionales, si están disponibles. De nuevo, dentro de ese conjunto de resultados, los mensajes se ordenan de la más antigua a la más reciente.

Casos de uso habituales

Solicitud

Solicitud HTTP

GET https://www.googleapis.com/youtube/v3/liveChat/messages

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
liveChatId	string El parámetro liveChatId especifica el ID del chat cuyos mensajes se mostrarán. El ID de chat en vivo asociado con una transmisión se muestra en la propiedad snippet.liveChatId del recurso liveBroadcast.
part	string El parámetro part especifica las partes del recurso liveChatMessage que incluirá la respuesta de la API. Los valores admitidos son id, snippet y authorDetails.
Parámetros opcionales
hl	string El parámetro hl le indica a la API que recupere una cadena de visualización de moneda localizada para un idioma de aplicación específico compatible con el sitio web de YouTube. Por ejemplo, en inglés, la moneda se mostraría como $1.50, pero en francés, como 1,50$. El valor del parámetro debe ser un código de idioma incluido en la lista que muestra el método i18nLanguages.list.
maxResults	unsigned integer El parámetro maxResults especifica la cantidad máxima de mensajes que se deben mostrar en el conjunto de resultados. Los valores aceptables son 200 a 2000, ambos incluidos. El valor predeterminado es 500.
pageToken	string El parámetro pageToken identifica una página específica en el conjunto de resultados que se debe mostrar. En una respuesta de la API, la propiedad nextPageToken identifica otras páginas que se podrían recuperar.
profileImageSize	unsigned integer El parámetro profileImageSize especifica el tamaño de las fotos de perfil del usuario que se deben mostrar en el conjunto de resultados. Las imágenes son cuadradas. El valor predeterminado es 88, lo que significa que las imágenes serán de 88 px por 88 px. Los valores aceptables se encuentran en el rango de 16 a 720, inclusive.

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 cuerpo de respuesta con la siguiente estructura:

{
  "kind": "youtube#liveChatMessageListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pollingIntervalMillis": unsigned integer,
  "offlineAt": datetime,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatMessage Resource
  ],
  "activePollItem": liveChatMessage Resource
}

Propiedades

La siguiente tabla define las propiedades que aparecen en este recurso:

Propiedades
kind	string Identifica el tipo de recurso de la API. El valor será youtube#liveChatMessageListResponse.
etag	etag Etag de este recurso.
nextPageToken	string Token que se puede usar como valor del parámetro pageToken para recuperar la página siguiente del conjunto de resultados.
pollingIntervalMillis	unsigned integer La cantidad de tiempo, en milisegundos, que el cliente debe esperar antes de volver a sondear si hay nuevos mensajes de chat en vivo.
offlineAt	datetime Fecha y hora en que la transmisión en vivo subyacente dejó de estar disponible. Esta propiedad solo está presente si la transmisión ya está sin conexión. El valor se especifica en formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
pageInfo	object El objeto pageInfo encapsula información de paginación para el conjunto de resultados.
pageInfo.totalResults	integer La cantidad total de resultados en el conjunto de resultados.
pageInfo.resultsPerPage	integer La cantidad de resultados incluidos en la respuesta de la API.
items[]	list Una lista de mensajes. Cada elemento de la lista es un recurso liveChatMessage.
activePollItem	object Los datos de la encuesta que aparecen en el mensaje. Cada encuesta es un recurso liveChatMessage con el tipo pollEvent, que representa una encuesta activa. Solo puede haber una encuesta por chat.

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 recuperar mensajes del chat en vivo especificado.
forbidden (403)	liveChatDisabled	El chat en vivo no está habilitado para la transmisión especificada.
forbidden (403)	liveChatEnded	El chat en vivo especificado ya no está en vivo.
notFound (404)	liveChatNotFound	No se puede encontrar el chat en vivo que intentas recuperar. Comprueba el valor del parámetro liveChatId de la solicitud para asegurarte de que sea correcto.
rateLimitExceeded	rateLimitExceeded	La solicitud se envió demasiado rápido después de la solicitud anterior. Este error ocurre cuando las solicitudes de la API para recuperar mensajes se envían con mayor frecuencia que las frecuencias de actualización de YouTube, lo que desperdicia innecesariamente el ancho de banda.

Pruébalo

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