Google Chat API

L'API Google Chat vous permet de créer des applications Chat pour intégrer vos services à Google Chat et gérer les ressources Chat comme les espaces, les membres et les messages.

Service : chat.googleapis.com

Pour appeler ce service, nous vous recommandons d'utiliser les bibliothèques clientes fournies par Google. Si votre application doit utiliser vos propres bibliothèques pour appeler ce service, conformez-vous aux informations suivantes lorsque vous effectuez les requêtes API.

Document de découverte

Un document de découverte est une spécification lisible par machine qui permet de décrire et d'utiliser les API REST. Ce document permet de créer des bibliothèques clientes, des plug-ins IDE et d'autres outils qui interagissent avec les API Google. Un même service peut fournir plusieurs documents de découverte. Ce service fournit le document de découverte suivant :

Point de terminaison de service

Un point de terminaison de service est une URL de base qui spécifie l'adresse réseau d'un service d'API. Un service peut posséder plusieurs points de terminaison de service. Ce service possède le point de terminaison de service suivant, et tous les URI ci-dessous sont relatifs à ce point de terminaison de service :

  • https://chat.googleapis.com

Ressource REST : v1.customEmojis

Méthodes
create POST /v1/customEmojis
Crée un emoji personnalisé.
delete DELETE /v1/{name=customEmojis/*}
Supprime un emoji personnalisé.
get GET /v1/{name=customEmojis/*}
Renvoie des informations sur un emoji personnalisé.
list GET /v1/customEmojis
Liste les emoji personnalisés visibles par l'utilisateur authentifié.

Ressource REST : v1.media

Méthodes
download GET /v1/media/{resourceName=**}
Télécharge des contenus multimédias.
upload POST /upload/v1/{parent=spaces/*}/attachments:upload
Importe une pièce jointe.

Ressource REST : v1.spaces

Méthodes
completeImport POST /v1/{name=spaces/*}:completeImport
Termine le processus d'importation pour l'espace spécifié et le rend visible pour les utilisateurs.
create POST /v1/spaces
Crée un espace.
delete DELETE /v1/{name=spaces/*}
Supprime un espace nommé.
findDirectMessage GET /v1/spaces:findDirectMessage
Renvoie le message privé existant avec l'utilisateur spécifié.
findGroupChats GET /v1/spaces:findGroupChats
Renvoie tous les espaces avec spaceType == GROUP_CHAT, dont les membres humains contiennent exactement l'utilisateur appelant et les utilisateurs spécifiés dans FindGroupChatsRequest.users.
get GET /v1/{name=spaces/*}
Renvoie des informations sur un espace.
list GET /v1/spaces
Répertorie les espaces dont l'appelant est membre.
patch PATCH /v1/{space.name=spaces/*}
Met à jour un espace.
search GET /v1/spaces:search
Renvoie la liste des espaces d'une organisation Google Workspace.
setup POST /v1/spaces:setup
Crée un espace et y ajoute les utilisateurs spécifiés.

Ressource REST : v1.spaces.members

Méthodes
create POST /v1/{parent=spaces/*}/members
Crée une appartenance pour l'application Chat appelante, un utilisateur ou un groupe Google.
delete DELETE /v1/{name=spaces/*/members/*}
Supprime une ressource Membership.
get GET /v1/{name=spaces/*/members/*}
Renvoie les détails d'une ressource Membership.
list GET /v1/{parent=spaces/*}/members
Répertorie les membres d'un espace.
patch PATCH /v1/{membership.name=spaces/*/members/*}
Met à jour une ressource Membership.

Ressource REST : v1.spaces.messagePins

Méthodes
create POST /v1/{parent=spaces/*}/messagePins
Crée une épingle de message.
delete DELETE /v1/{name=spaces/*/messagePins/*}
Supprime un message épinglé.
list GET /v1/{parent=spaces/*}/messagePins
Répertorie les messages épinglés dans un espace.

Ressource REST : v1.spaces.messages

Méthodes
create POST /v1/{parent=spaces/*}/messages
Crée un message dans un espace Google Chat.
delete DELETE /v1/{name=spaces/*/messages/*}
Supprime un message.
get GET /v1/{name=spaces/*/messages/*}
Renvoie des informations sur un message.
list GET /v1/{parent=spaces/*}/messages
Répertorie les messages d'un espace dont l'appelant est membre, y compris les messages des membres et des espaces bloqués.
patch PATCH /v1/{message.name=spaces/*/messages/*}
Met à jour un message.
replaceCards POST /v1/{name=spaces/*/messages/*}:replaceCards
Remplace les fiches incluses dans un message.
search POST /v1/{parent=spaces/*}/messages:search
Recherche les messages dans Google Chat auxquels l'utilisateur appelant a accès.
update PUT /v1/{message.name=spaces/*/messages/*}
Met à jour un message.

Ressource REST : v1.spaces.messages.attachments

Méthodes
get GET /v1/{name=spaces/*/messages/*/attachments/*}
Récupère les métadonnées d'une pièce jointe de message.

Ressource REST : v1.spaces.messages.reactions

Méthodes
create POST /v1/{parent=spaces/*/messages/*}/reactions
Crée une réaction et l'ajoute à un message.
delete DELETE /v1/{name=spaces/*/messages/*/reactions/*}
Supprime une réaction à un message.
list GET /v1/{parent=spaces/*/messages/*}/reactions
Liste les réactions à un message.

Ressource REST : v1.spaces.spaceEvents

Méthodes
get GET /v1/{name=spaces/*/spaceEvents/*}
Renvoie un événement d'un espace Google Chat.
list GET /v1/{parent=spaces/*}/spaceEvents
Répertorie les événements d'un espace Google Chat.

Ressource REST : v1.users.availability

Méthodes
get GET /v1/{name=users/*/availability}
Renvoie des informations sur la disponibilité d'un utilisateur humain dans Google Chat.
markAsActive POST /v1/{name=users/*/availability}:markAsActive
Marque l'utilisateur comme ACTIVE dans Google Chat.
markAsAway POST /v1/{name=users/*/availability}:markAsAway
Marque l'utilisateur comme AWAY dans Google Chat.
markAsDoNotDisturb POST /v1/{name=users/*/availability}:markAsDoNotDisturb
Marque l'utilisateur comme DO_NOT_DISTURB dans Google Chat.
patch PATCH /v1/{availability.name=users/*/availability}
Met à jour les informations de disponibilité d'un utilisateur humain.

Ressource REST : v1.users.sections

Méthodes
create POST /v1/{parent=users/*}/sections
Crée une section dans Google Chat.
delete DELETE /v1/{name=users/*/sections/*}
Supprime une section de type CUSTOM_SECTION.
list GET /v1/{parent=users/*}/sections
Répertorie les sections disponibles pour l'utilisateur Chat.
patch PATCH /v1/{section.name=users/*/sections/*}
Met à jour une section.
position POST /v1/{name=users/*/sections/*}:position
Modifie l'ordre de tri d'une section.

Ressource REST : v1.users.sections.items

Méthodes
list GET /v1/{parent=users/*/sections/*}/items
Répertorie les articles d'une section.
move POST /v1/{name=users/*/sections/*/items/*}:move
Déplace un élément d'une section à une autre.

Ressource REST : v1.users.spaces

Méthodes
getSpaceReadState GET /v1/{name=users/*/spaces/*/spaceReadState}
Renvoie des détails sur l'état de lecture d'un utilisateur dans un espace, utilisé pour identifier les messages lus et non lus.
updateSpaceReadState PATCH /v1/{spaceReadState.name=users/*/spaces/*/spaceReadState}
Met à jour l'état de lecture d'un utilisateur dans un espace, utilisé pour identifier les messages lus et non lus.

Ressource REST : v1.users.spaces.spaceNotificationSetting

Méthodes
get GET /v1/{name=users/*/spaces/*/spaceNotificationSetting}
Récupère le paramètre de notification de l'espace.
patch PATCH /v1/{spaceNotificationSetting.name=users/*/spaces/*/spaceNotificationSetting}
Met à jour le paramètre de notification de l'espace.

Ressource REST : v1.users.spaces.threads

Méthodes
getThreadReadState GET /v1/{name=users/*/spaces/*/threads/*/threadReadState}
Renvoie des détails sur l'état de lecture d'un utilisateur dans un fil de discussion, utilisé pour identifier les messages lus et non lus.