Method: spaces.messages.list

Muestra una lista de los mensajes de un espacio del que el emisor es miembro, incluidos los mensajes de miembros y espacios bloqueados. Si enumeras mensajes de un espacio sin mensajes, la respuesta será un objeto vacío. Cuando se usa una interfaz REST/HTTP, la respuesta contiene un objeto JSON vacío, {}. Para ver un ejemplo, consulta Cómo mostrar mensajes en una lista.

Requiere 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

string

Obligatorio. Es el nombre del recurso del espacio desde el que se mostrarán los mensajes.

Formato: spaces/{space}

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Es la cantidad máxima de mensajes que se devuelven. Es posible que el servicio devuelva menos mensajes que este valor.

Si no se especifica, se mostrarán como máximo 25.

El valor máximo es 1,000. Si usas un valor superior a 1,000, se cambiará automáticamente a 1,000.

Los valores negativos muestran un error INVALID_ARGUMENT.
pageToken

string

Opcional. Un token de página recibido de una llamada a listMessages anterior. Proporciona este parámetro para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de página. Pasar diferentes valores a los otros parámetros puede generar resultados inesperados.
filter

string

Opcional. Un filtro de consulta

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

Para filtrar mensajes por la fecha en que se crearon, especifica el 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 el thread.name con el formato spaces/{space}/threads/{thread}. Solo puedes especificar una thread.name por consulta.

Para filtrar por subproceso y fecha, usa el operador AND en tu 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. 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 la operación de ordenamiento son los siguientes:

  • ASC para ascendente.

  • DESC para descendente.

El orden predeterminado es createTime ASC.
showDeleted

boolean

Opcional. Si se incluyen 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 mensajes.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá 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 siguiente página de resultados. Si está vacío, no hay páginas posteriores.

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.