Method: spaces.messages.create

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

Il est compatible avec les types d'authentification suivants :

  • Authentification par l'application avec le champ d'application d'autorisation :
    • 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 par application. Chat affiche l'application Chat comme expéditeur du message. Le contenu du message peut inclure du texte (text), des fiches (cardsV2) et des widgets d'accessoires (accessoryWidgets).

Message envoyé avec l'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 d'un 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 thread.thread_key à la place. ID du fil de discussion. 4 000 caractères maximum. 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 une conversation ou y répondre.

requestId

string

Facultatif. Identifiant unique de cette requête. Nous vous recommandons d'utiliser un UUID aléatoire. La spécification d'un ID de requête rend la requête idempotente, ce qui garantit que plusieurs requêtes identiques avec le même ID de requête n'entraînent la création que d'un seul message. Les requêtes ultérieures avec le même ID de requête renvoient le message existant et ne le mettent pas à jour, même si les détails demandés diffèrent de l'état actuel.

Pour utiliser ce champ efficacement :

  • Assurez-vous que les requêtes suivantes sont identiques et utilisent les mêmes identifiants d'authentification que la requête d'origine.
  • Si un message a déjà été créé avec l'ID de requête fourni, la requête renvoie ce message. Notez que le message renvoyé peut ne pas être entièrement renseigné. L'API renvoie le message de votre requête avec les noms de ressources attribués par le système. Pour récupérer les dernières métadonnées du message, appelez messages.get.
  • La réutilisation d'un ID de requête existant avec un autre utilisateur authentifié entraîne une erreur.
messageReplyOption

enum (MessageReplyOption)

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

Lors de la réponse 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 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 pas custom-name.
  • Contient jusqu'à 63 caractères et uniquement 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.

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.

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 fil de discussion. Si vous utilisez cette option, les éléments thread ID ou threadKey inclus sont ignorés.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Crée le message en tant que 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 tant que réponse au fil de discussion spécifié par thread ID ou threadKey. Si un nouveau threadKey est utilisé, un fil de discussion est créé. Si la création du message échoue, une erreur NOT_FOUND est renvoyée à la place.

CreateMessageNotificationOptions

Options de 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 notifications pour le message.

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

Une notification (notification push, notification par e-mail, etc.) est envoyée à l'utilisateur qui a créé le message (par exemple, l'utilisateur dont l'authentification a été utilisée pour créer le message), et le message est marqué comme non lu.

Cela ne remplacera pas les paramètres de notification utilisateur existants pour l'espace. Par exemple, si l'utilisateur a choisi de ne pas recevoir de notifications pour un espace, il n'en recevra pas, même si cette option est définie.

Nécessite l'authentification des utilisateurs.

NOTIFICATION_TYPE_FORCE_NOTIFY

Forcer la notification des destinataires. Cela contourne les paramètres de notification des espaces et les paramètres Ne pas déranger de Chat des utilisateurs. Cette option ne permet pas d'ignorer les paramètres "Ne pas déranger" au niveau de l'appareil.

Nécessite l'authentification de l'application.

NOTIFICATION_TYPE_SILENT

Ne pas avertir les destinataires et ne pas marquer le message comme non lu. Le comportement est semblable à celui d'un utilisateur qui coupe le son de la conversation ou qui active le mode Ne pas déranger dans Chat.

Nécessite l'authentification de l'application.