- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de autorización
- Pruébalo
Muestra una lista de los mensajes de un espacio del que pertenece el emisor, incluidos los mensajes de los miembros y espacios bloqueados. Si enumeras mensajes de un espacio sin mensajes, la respuesta es un objeto vacío. Cuando usas una interfaz REST/HTTP, la respuesta contiene un objeto JSON vacío, {}
. Para ver un ejemplo, consulta Enumera mensajes. Se requiere la autenticación del usuario.
Solicitud HTTP
GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
parent |
Obligatorio. El nombre del recurso del espacio del que se enumeran los mensajes. Formato: |
Parámetros de consulta
Parámetros | |
---|---|
pageSize |
La cantidad máxima de mensajes que se muestran. Es posible que el servicio muestre menos mensajes que este valor. Si no se especifica, se muestran 25 como máximo. El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambia automáticamente a 1,000. Los valores negativos muestran un error |
pageToken |
Opcional si se reanuda desde una consulta anterior. Un token de página recibido de una llamada anterior de mensajes de lista. Proporciona este parámetro para recuperar la página siguiente. Durante la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados. |
filter |
Un filtro de consulta Puedes filtrar los mensajes por fecha ( Para filtrar los mensajes por la fecha en que se crearon, especifica Para filtrar por subproceso, especifica Para filtrar por subproceso y fecha, usa el operador Por ejemplo, las siguientes consultas son válidas:
El servidor rechaza las consultas no válidas con un error |
orderBy |
Opcional si se reanuda desde una consulta anterior. Cómo se ordena la lista de mensajes. Especifica un valor para ordenar según una operación de ordenamiento. Los valores válidos de una operación de ordenamiento son los siguientes:
El orden predeterminado es |
showDeleted |
Indica si se deben incluir los mensajes borrados. Los mensajes borrados incluyen la hora de eliminación y los metadatos sobre su eliminación, pero el contenido de los mensajes no está disponible. |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Mensaje de respuesta para enumerar los mensajes.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"messages": [
{
object ( |
Campos | |
---|---|
messages[] |
Lista de mensajes. |
nextPageToken |
Puedes enviar un token como |
Alcances de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.readonly
Para obtener más información, consulta la Guía de autorización.