Method: spaces.messages.list

Lista as mensagens em um espaço de que o usuário é participante, incluindo mensagens de participantes e espaços bloqueados. As mensagens do sistema, como as que anunciam novos participantes do espaço, não são incluídas. 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.

Aceita os seguintes tipos de autenticação:

  • Autenticação de app com aprovação do administrador no Pré-lançamento para desenvolvedores com o escopo de autorização:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. Ao usar esse escopo de autenticação, esse método retorna apenas mensagens públicas em um espaço. Ele não inclui mensagens particulares.

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)

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

Opcional. 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 serão retornados.

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

Valores negativos retornam um erro INVALID_ARGUMENT.
pageToken

string

Opcional. Um token de página recebido de uma chamada "list messages" anterior. Forneça esse parâmetro para recuperar a página seguinte.

Na paginação, todos os outros parâmetros enviados precisam corresponder à chamada que proporcionou o token da página. Transmitir valores diferentes para os outros parâmetros pode gerar resultados inesperados.
filter

string

Opcional. Um filtro de consulta.

É possível filtrar mensagens por data (createTime) e conversa (thread.name).

Para filtrar mensagens pela data de criação, especifique o createTime com um carimbo de data/hora no formato RFC-3339 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 mensagens criadas antes de um carimbo de data/hora. Para filtrar mensagens em um intervalo de tempo, use o operador AND entre dois carimbos de data/hora.

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

Para filtrar por conversa e data, use o operador AND na consulta.

Por exemplo, as consultas a seguir 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

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

string

Opcional. Como a lista de mensagens é ordenada. Especifique um valor para ordenar por uma operação de ordenação. Estes são os valores válidos para a operação de ordenação:

  • ASC para crescente.

  • DESC para ordem decrescente.

A ordem padrão é createTime ASC.
showDeleted

boolean

Opcional. Se as mensagens excluídas devem ser incluídas. As mensagens excluídas incluem a hora e os metadados da 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
  • https://www.googleapis.com/auth/chat.app.messages.readonly

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