Method: spaces.messages.list

Liste les messages d'un espace dont l'appelant est membre, y compris les messages des membres et des espaces bloqués. Si vous répertoriez les messages d'un espace sans messages, la réponse est un objet vide. Lorsque vous utilisez une interface REST/HTTP, la réponse contient un objet JSON vide, {}. Pour obtenir un exemple, consultez la section Lister les messages.

Authentification des utilisateurs requise.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource de l'espace à partir duquel répertorier les messages.

Format : spaces/{space}

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximal de messages renvoyés. Le service peut renvoyer un nombre inférieur à cette valeur.

Si aucune valeur n'est spécifiée, 25 valeurs au maximum sont renvoyées.

La valeur maximale est 1 000. Si vous utilisez une valeur supérieure à 1 000, elle est automatiquement remplacée par 1 000.

Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.
pageToken

string

Facultatif, si vous reprenez à partir d'une requête précédente.

Jeton de page reçu lors d'un appel de liste de messages précédent. Fournissez ce paramètre pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel qui a fourni le jeton de page. Transmettre des valeurs différentes aux autres paramètres peut entraîner des résultats inattendus.
filter

string

Un filtre de requête.

Vous pouvez filtrer les messages par date (createTime) et par fil de discussion (thread.name).

Pour filtrer les messages en fonction de la date de leur création, spécifiez createTime avec un code temporel au format RFC-3339 et des guillemets doubles. Par exemple, "2023-04-21T11:30:00-04:00". Vous pouvez utiliser l'opérateur supérieur à > pour répertorier les messages créés après un horodatage, ou l'opérateur inférieur à < pour répertorier les messages créés avant un horodatage. Pour filtrer les messages dans un intervalle de temps, utilisez l'opérateur AND entre deux codes temporels.

Pour filtrer par thread, spécifiez le thread.name, au format spaces/{space}/threads/{thread}. Vous ne pouvez spécifier qu'un seul élément thread.name par requête.

Pour filtrer par fil de discussion et par date, utilisez l'opérateur AND dans votre requête.

Par exemple, les requêtes suivantes sont valides:

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

Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.
orderBy

string

Facultatif, si vous reprenez une requête précédente.

Ordre de la liste des messages. Spécifiez une valeur à trier par une opération de tri. Les valeurs valides pour les opérations de tri sont les suivantes:

  • ASC pour l'ordre croissant.

  • DESC pour l'ordre décroissant.

L'ordre par défaut est createTime ASC.
showDeleted

boolean

Permet d'inclure ou non les messages supprimés. Les messages supprimés incluent l'heure et les métadonnées concernant leur suppression, mais leur contenu n'est pas disponible.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour la liste des messages.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Champs
messages[]

object (Message)

Liste des messages.
nextPageToken

string

Vous pouvez envoyer un jeton en tant que pageToken pour récupérer la page de résultats suivante. Si ce champ est vide, aucune page suivante n'existe.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le guide d'autorisation.