Method: spaces.messages.create

Crée un message dans un espace Google Chat. Pour obtenir un exemple, consultez Envoyer un message.

Compatible avec les types d'authentification suivants:

  • Authentification de l'application avec le champ d'application :
    • https://www.googleapis.com/auth/chat.bot
  • Authentification des utilisateurs avec l'un des champs d'application d'autorisation suivants :
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)

Chat attribue l'expéditeur du message différemment selon le type d'authentification que vous utilisez dans votre requête.

L'image suivante montre comment Chat attribue un message lorsque vous utilisez l'authentification de l'application. Chat affiche l'application Chat comme expéditeur du message. Le contenu du message peut contenir du texte (text), des cartes (cardsV2) et des widgets accessoires (accessoryWidgets).

Message envoyé avec authentification de l'application

L'image suivante montre comment Chat attribue un message lorsque vous utilisez l'authentification des utilisateurs. Chat affiche l'utilisateur comme expéditeur du message et attribue l'application Chat au message en affichant son nom. Le contenu du message ne peut contenir que du texte (text).

Message envoyé avec authentification de l'utilisateur

La taille maximale du message, y compris son contenu, est de 32 000 octets.

Pour les requêtes webhook, la réponse ne contient pas le message complet. La réponse ne renseigne que les champs name et thread.name en plus des informations contenues dans la requête.

Requête HTTP

POST 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 dans lequel créer un message.

Format : spaces/{space}

Paramètres de requête

Paramètres
threadKey
(deprecated)

string

Facultatif. Obsolète: utilisez thread.thread_key à la place. ID du thread. 4 000 caractères maximum. Pour démarrer un fil de discussion ou en ajouter un, créez un message et spécifiez un threadKey ou le thread.name. Pour obtenir un exemple d'utilisation, consultez Démarrer ou répondre à un fil de discussion.
requestId

string

Facultatif. ID de requête unique pour ce message. Spécifier un ID de requête existant renvoie le message créé avec cet ID au lieu d'en créer un autre.
messageReplyOption

enum (MessageReplyOption)

Facultatif. Indique si un message démarre un fil de discussion ou y répond. Compatible uniquement avec les espaces nommés.

Lorsque vous répondez aux interactions utilisateur, ce champ est ignoré. Pour les interactions dans un fil de discussion, la réponse est créée dans le même fil. Sinon, la réponse est créée en tant que nouveau fil de discussion.
messageId

string

Facultatif. ID personnalisé d'un message. Permet aux applications Chat d'obtenir, de mettre à jour ou de supprimer un message sans avoir à stocker l'ID attribué par le système dans le nom de la ressource du message (représenté dans le champ name du message).

La valeur de ce champ doit répondre aux exigences suivantes:

  • Commence par client-. Par exemple, client-custom-name est un ID personnalisé valide, mais custom-name ne l'est pas.
  • Il peut contenir jusqu'à 63 caractères et ne doit contenir que des lettres minuscules, des chiffres et des traits d'union.
  • Il est unique dans un espace. Une application Chat ne peut pas utiliser le même ID personnalisé pour différents messages.

Pour en savoir plus, consultez Nommer un message.

Corps de la requête

Le corps de la requête contient une instance de Message.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une nouvelle instance de Message.

Champs d'application des autorisations

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

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

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

MessageReplyOption

Spécifie comment répondre à un message. D'autres États pourraient être ajoutés à l'avenir.

Enums
MESSAGE_REPLY_OPTION_UNSPECIFIED Par défaut. Démarre un nouveau thread. Cette option ignore tous les thread ID ou threadKey inclus.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Crée le message en réponse au fil de discussion spécifié par thread ID ou threadKey. Si l'opération échoue, le message lance un nouveau thread à la place.
REPLY_MESSAGE_OR_FAIL Crée le message en réponse au fil de discussion spécifié par thread ID ou threadKey. Si un nouveau threadKey est utilisé, un nouveau thread est créé. Si la création du message échoue, une erreur NOT_FOUND est renvoyée.