Method: spaces.messages.list

Muestra una lista de los mensajes de un espacio al que pertenece el emisor, incluidos los mensajes de los miembros y espacios bloqueados. Para ver un ejemplo, consulta Enumerar mensajes. Requiere la autenticación de usuarios y el permiso de autorización chat.messages o chat.messages.readonly.

Este método solo se admite en espacios que no permiten que se unan usuarios ajenos a la organización de Workspace.

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

string

Obligatorio. El nombre del recurso del espacio desde el que se enumeran los mensajes.

Formato: spaces/{space}

Parámetros de consulta

Parámetros
pageSize

integer

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, se cambia automáticamente a 1,000.

Los valores negativos muestran un error INVALID_ARGUMENT.
pageToken

string

Opcional, si se reanuda desde una consulta anterior.

Un token de página recibido de una llamada de mensajes de lista anterior. Proporciona este parámetro para recuperar la página siguiente.

Cuando realizas 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

string

Un filtro de consulta

Puedes filtrar los mensajes por fecha (createTime) y conversación (thread.name).

Para filtrar los mensajes según la fecha en que se crearon, especifica createTime con una marca de tiempo en formato RFC-3339 y comillas dobles. Por ejemplo, "2023-04-21T11:30:00-04:00". Puedes usar el operador mayor que > para enumerar los mensajes que se crearon después de una marca de tiempo o el operador menor que < para enumerar los mensajes que se crearon antes de una marca de tiempo. Para filtrar mensajes dentro de un intervalo de tiempo, usa el operador AND entre dos marcas de tiempo.

Para filtrar por subproceso, especifica thread.name, que tiene el formato spaces/{space}/threads/{thread}. Solo puedes especificar un thread.name por consulta.

Para filtrar por subproceso y fecha, usa el operador AND en la consulta.

Por ejemplo, las siguientes consultas son válidas:

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.
orderBy

string

Opcional, si se reanuda desde una consulta anterior.

Cómo se ordena la lista de mensajes Especifica un valor para pedir por operación de ordenamiento. Los valores válidos de las operaciones de ordenamiento son los siguientes:

  • ASC (ascendente).

  • DESC para el orden descendente.

El orden predeterminado es createTime ASC.
showDeleted

boolean

Indica si se deben incluir o no mensajes borrados. Los mensajes borrados incluyen la hora y los metadatos borrados, pero el contenido del mensaje no está disponible.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Campos
messages[]

object (Message)

Lista de mensajes.
nextPageToken

string

Puedes enviar un token como pageToken para recuperar la página siguiente de resultados. Si está vacío, no hay páginas posteriores.

Permisos de autorización

Se necesita uno de los siguientes alcances 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.