Method: spaces.messages.list

Elenca i messaggi presenti in uno spazio di cui il chiamante è membro, inclusi i messaggi provenienti da spazi e membri bloccati. Se elenchi i messaggi provenienti da uno spazio senza messaggi, la risposta è un oggetto vuoto. Quando utilizzi un'interfaccia REST/HTTP, la risposta contiene un oggetto JSON vuoto, {}. Per un esempio, vedi Elenca messaggi.

Richiede l'autenticazione dell'utente.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa dello spazio da cui elencare i messaggi.

Formato: spaces/{space}

Parametri di query

Parametri
pageSize

integer

Il numero massimo di messaggi restituiti. Il servizio potrebbe restituire meno messaggi di questo valore.

Se non specificato, vengono restituiti al massimo 25.

Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, questo viene modificato automaticamente in 1000.

I valori negativi restituiscono un errore INVALID_ARGUMENT.
pageToken

string

Facoltativo, se riprendi da una query precedente.

Un token di pagina ricevuto da una precedente chiamata dell'elenco dei messaggi. Fornisci questo parametro per recuperare la pagina successiva.

Quando viene applicata la paginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token pagina. Se passi valori diversi agli altri parametri, potresti ottenere risultati imprevisti.
filter

string

Un filtro per query.

Puoi filtrare i messaggi per data (createTime) e thread (thread.name).

Per filtrare i messaggi in base alla data di creazione, specifica createTime con un timestamp nel formato RFC-3339 e le virgolette doppie. Ad esempio: "2023-04-21T11:30:00-04:00". Puoi utilizzare l'operatore maggiore di > per elencare i messaggi creati dopo un timestamp o l'operatore minore di < per elencare i messaggi creati prima di un timestamp. Per filtrare i messaggi in un intervallo di tempo, utilizza l'operatore AND tra due timestamp.

Per filtrare in base al thread, specifica il valore thread.name, nel formato spaces/{space}/threads/{thread}. Puoi specificare un solo thread.name per query.

Per filtrare sia in base al thread che alla data, utilizza l'operatore AND nella query.

Ad esempio, le seguenti query sono valide:

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

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.
orderBy

string

Facoltativo, se riprendi da una query precedente.

Ordinamento dell'elenco dei messaggi. Specifica un valore da ordinare tramite un'operazione di ordinamento. I valori validi per l'operazione di ordinamento sono:

  • ASC per l'ordine crescente.

  • DESC per la modalità discendente.

L'ordinamento predefinito è createTime ASC.
showDeleted

boolean

Se includere i messaggi eliminati. I messaggi eliminati includono l'ora di eliminazione e i metadati relativi all'eliminazione, ma i contenuti dei messaggi non sono disponibili.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta relativo ai messaggi dell'elenco.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Campi
messages[]

object (Message)

Elenco di messaggi.
nextPageToken

string

Puoi inviare un token come pageToken per recuperare la pagina successiva di risultati. Se è vuoto, non ci sono pagine successive.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.