Method: spaces.messages.list

Répertorie les messages d'un espace dont l'appelant est membre, y compris ceux des membres bloqués et des espaces. Pour obtenir un exemple, consultez Lister les messages. Nécessite une authentification utilisateur.

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 de messages inférieur à cette valeur.

Si aucune valeur n'est spécifiée, un maximum de 25 unités est renvoyé.

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

Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.

pageToken

string

Facultatif en cas de reprise d'une requête précédente.

Jeton de page reçu à partir d'un appel de liste précédent. Indiquez 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. La transmission de 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 création, spécifiez createTime avec un code temporel au format RFC-3339 et des guillemets doubles. Exemple :"2023-04-21T11:30:00-04:00" Vous pouvez utiliser l'opérateur supérieur à > pour répertorier les messages qui ont été 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 spécifique, utilisez l'opérateur AND entre deux horodatages.

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 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 en cas de reprise d'une requête précédente.

Comment la liste des messages est-elle triée ? Spécifiez une valeur à trier par 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

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 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

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

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

object (Message)

Liste de 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 de pages suivantes.

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 relatif aux autorisations.