Method: spaces.messages.create

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

Prend en charge les types d'authentification suivants :

  • Authentification de l'application avec le niveau d'accès des autorisations :
    • https://www.googleapis.com/auth/chat.bot
  • Authentification de l'utilisateur avec l'un des niveaux d'accès des autorisations 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 fiches (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 de l'utilisateur. 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 de 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 plutôt thread.thread_key. ID du fil de discussion. Accepte jusqu'à 4 000 caractères. Pour démarrer un fil de discussion ou y ajouter un message, créez un message et spécifiez un threadKey ou le thread.name. Pour obtenir un exemple d'utilisation, consultez Démarrer un fil de discussion ou y répondre.

requestId

string

Facultatif. ID de requête unique pour ce message. Si vous spécifiez un ID de requête existant, le message créé avec cet ID est renvoyé au lieu d'en créer un.

messageReplyOption

enum (MessageReplyOption)

Facultatif. Indique si un message démarre un fil de discussion ou y répond. N'est compatible qu'avec les espaces nommés.

Ce champ est ignoré lorsque vous répondez aux interactions des utilisateurs. Pour les interactions au sein d'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é pour 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 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.
  • Contient jusqu'à 63 caractères et uniquement des lettres minuscules, des chiffres et des traits d'union.
  • 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 Attribuer un nom à un message.

createMessageNotificationOptions

object (CreateMessageNotificationOptions)

Facultatif. Contrôle le comportement des notifications lorsque le message est publié. Pour en savoir plus, consultez Forcer les notifications ou envoyer des messages silencieux.

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.

Niveaux d'accès 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 pourront être ajoutés à l'avenir.

Enums
MESSAGE_REPLY_OPTION_UNSPECIFIED Valeur par défaut. Démarre un nouveau fil de discussion. Si vous utilisez cette option, tout thread ID ou threadKey inclus est ignoré.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Crée le message en réponse au fil de discussion spécifié par thread ID ou threadKey. En cas d'échec, le message démarre un nouveau fil de discussion.
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 fil de discussion est créé. Si la création du message échoue, une erreur NOT_FOUND est renvoyée.

CreateMessageNotificationOptions

Options pour le comportement des notifications lorsque le message est publié.

Représentation JSON
{
  "notificationType": enum (NotificationType)
}
Champs
notificationType

enum (NotificationType)

Type de notification pour le message.

NotificationType

Options de types de notification pour le message.

Enums
NOTIFICATION_TYPE_NONE Comportement par défaut Le comportement des notifications est semblable à celui qui se produit lorsque l'utilisateur humain envoie le message à l'aide de l'interface utilisateur Chat : aucune notification n'est envoyée à l'expéditeur humain.
NOTIFICATION_TYPE_FORCE_NOTIFY

Force la notification des destinataires. Cette option contourne les paramètres de notification d'espace des utilisateurs et les paramètres Ne pas déranger de Chat. Elle ne contourne pas les paramètres Ne pas déranger au niveau de l'appareil.

Nécessite l'authentification de l'application.

NOTIFICATION_TYPE_SILENT

Ne pas notifier les destinataires et ne pas marquer le message comme non lu. Ce comportement est semblable à celui qui se produit lorsque l'utilisateur désactive le son de la conversation ou active Ne pas déranger dans Chat.

Nécessite l'authentification de l'application.