Method: spaces.messages.list

Liste les messages d'un espace dont l'appelant est membre, y compris les messages des membres et espaces bloqués. Les messages système, comme ceux annonçant l'arrivée de nouveaux membres dans un espace, ne sont pas inclus. Si vous listez les messages d'un espace sans message, 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 Lister les messages.

Il est compatible avec les types d'authentification suivants :

  • Authentification de l'application avec approbation de l'administrateur dans la version Preview pour les développeurs avec le champ d'application de l'autorisation :

    • https://www.googleapis.com/auth/chat.app.messages.readonly. Lorsque vous utilisez ce champ d'application d'authentification, cette méthode ne renvoie que les messages publics d'un espace. Il n'inclut pas les messages privés.

  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)

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 lister les messages.

Format : spaces/{space}

Paramètres de requête

Paramètres
pageSize

integer

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

Si aucune valeur n'est spécifiée, 25 résultats au maximum sont renvoyés.

La valeur maximale est de 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. Jeton de page reçu lors d'un appel de liste des 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 ayant fourni le jeton de page. Transmettre différentes valeurs aux autres paramètres peut entraîner des résultats inattendus.
filter

string

Facultatif. Filtre de requête.

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

Pour filtrer les messages par date de 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 lister les messages créés après un code temporel, ou l'opérateur inférieur à < pour lister les messages créés avant un code temporel. 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 thread.name par requête.

Pour filtrer à la fois 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. Ordre de la liste des messages. Spécifiez une valeur pour trier selon une opération de tri. Les valeurs d'opération de tri valides sont les suivantes :

  • ASC pour l'ordre croissant.

  • DESC pour l'ordre décroissant.

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

boolean

Facultatif. Indique si les messages supprimés doivent être inclus. Les messages supprimés incluent l'heure de suppression et les métadonnées associées, mais le contenu des messages 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, il n'y a pas d'autres pages.

Niveaux d'accès 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
  • https://www.googleapis.com/auth/chat.app.messages.readonly

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