Method: spaces.messages.list

Lista as mensagens de um espaço de que o autor da chamada participa, inclusive as de participantes e espaços bloqueados. Se você listar mensagens de um espaço sem mensagens, a resposta será um objeto vazio. Ao usar uma interface REST/HTTP, a resposta contém um objeto JSON vazio, {}. Para ver um exemplo, consulte Listar mensagens. Exige a autenticação do usuário.

Solicitação HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso do espaço para listar mensagens.

Formato: spaces/{space}

Parâmetros de consulta

Parâmetros
pageSize

integer

O número máximo de mensagens retornadas. O serviço pode retornar menos mensagens do que esse valor.

Se não for especificado, no máximo 25 são retornados.

O valor máximo é 1.000. Se você usar um valor maior que 1.000, ele será alterado automaticamente para 1.000.

Valores negativos retornam um erro INVALID_ARGUMENT.
pageToken

string

Opcional, se estiver reiniciando de uma consulta anterior.

Um token de página recebido de uma chamada de mensagens de lista anterior. Forneça esse parâmetro para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos devem corresponder à chamada que forneceu o token da página. Passar valores diferentes para outros parâmetros pode levar a resultados inesperados.
filter

string

Um filtro de consulta.

Você pode filtrar as mensagens por data (createTime) e conversa (thread.name).

Para filtrar as mensagens pela data de criação, especifique o createTime com um carimbo de data/hora no formato RFC-3339 (link em inglês) e aspas duplas. Por exemplo, "2023-04-21T11:30:00-04:00". Você pode usar o operador "maior que" > para listar mensagens criadas após um carimbo de data/hora ou o operador "menor que" < para listar as mensagens criadas antes de um carimbo de data/hora. Para filtrar as mensagens de um intervalo de tempo, use o operador AND entre dois carimbos de data/hora.

Para filtrar por linha de execução, especifique o thread.name, formatado como spaces/{space}/threads/{thread}. Só é possível especificar um thread.name por consulta.

Para filtrar por linha de execução e data, use o operador AND na consulta.

Por exemplo, as seguintes consultas são 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

As consultas inválidas são rejeitadas pelo servidor com um erro INVALID_ARGUMENT.
orderBy

string

Opcional, se estiver reiniciando de uma consulta anterior.

Como a lista de mensagens é ordenada. Especifique um valor a ser ordenado por uma operação de ordenação. Os valores de operação de ordenação válidos são os seguintes:

  • ASC para crescente.

  • DESC para decrescente.

A ordem padrão é createTime ASC.
showDeleted

boolean

Define se as mensagens excluídas serão incluídas. As mensagens excluídas incluem o horário da exclusão e os metadados sobre a exclusão, mas o conteúdo da mensagem não está disponível.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para listar mensagens.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Campos
messages[]

object (Message)

Lista de mensagens.
nextPageToken

string

É possível enviar um token como pageToken para recuperar a próxima página de resultados. Se estiver vazio, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

Para mais informações, consulte o Guia de autorização.