REST Resource: conversations.messages

Ressource: Message

Un message dans une conversation entre un agent et un utilisateur.

Représentation JSON 
{
  "name": string,
  "messageId": string,
  "representative": {
    object (Representative)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "fallback": string,
  "containsRichText": boolean,

  // Union field content can be only one of the following:
  "text": string,
  "image": {
    object (Image)
  },
  "richCard": {
    object (RichCard)
  }
  // End of list of possible types for union field content.
}
Champs
name

string

Nom du message, tel que défini par Business Messages. Renvoie la valeur "conversations/{conversationId}/messages/{messageId}", où {conversationId} correspond à l'ID unique de la conversation et {messageId} à l'ID unique du message.
messageId

string

Obligatoire. Identifiant unique du message, attribué par l'agent. Si un message tente d'utiliser le même messageId qu'un message précédent, sa distribution peut être affectée.
representative

object (Representative)

Des informations sur le représentant (humain ou chatbot) qui a envoyé le message
suggestions[]

object (Suggestion)

Liste de réponses suggérées qui s'affiche sous la forme de chips de suggestion après le message associé. 13 suggestions maximum.

Les chips ne s'affichent que lorsque le message associé est le plus récent de la conversation (y compris les messages d'agent et ceux des utilisateurs). L'utilisateur peut appuyer sur une réponse suggérée pour envoyer la réponse à l'agent.
fallback

string

Facultatif. Texte de remplacement qui s'affiche si l'appareil de l'utilisateur n'est pas compatible avec le type ou le contenu du message. 3 072 caractères au maximum.
containsRichText

boolean

Facultatif. Si la valeur est true, cela signifie que le message contient du texte enrichi. Si le format du message n'est pas valide, Business Messages affiche une erreur.
Champ d'union content. Le contenu d'un message. content ne peut être qu'un des éléments suivants :
text

string

Message 3 072 caractères au maximum.
image

object (Image)

Message avec image.
richCard

object (RichCard)

Message de carte enrichie.

Image

Image.

Représentation JSON 
{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Champs
Champ d'union content. Contenu des images. content ne peut être qu'un des éléments suivants :
contentInfo

object (ContentInfo)

Informations sur une image, y compris l'URL de l'image et l'URL de sa vignette.

ContentInfo

Message contenant des informations sur le contenu.

Représentation JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean,
  "altText": string
}
Champs
fileUrl

string

URL du fichier accessible publiquement. La plate-forme détermine le type MIME du fichier à partir du champ content-type des en-têtes HTTP lorsque la plate-forme récupère le fichier. Le champ content-type doit être présent et précis dans la réponse HTTP provenant de l'URL.

5 Mo maximum.

Types de contenus compatibles: image/jpeg, image/jpg, image/png, image/webp
thumbnailUrl

string

Facultatif. URL de la miniature accessible publiquement.

Si vous ne fournissez pas d'URL de vignette, la plate-forme affiche une vignette d'espace réservé vide jusqu'à ce que l'appareil de l'utilisateur télécharge le fichier.

25 Ko maximum.

Types de contenus compatibles: image/jpeg, image/jpg, image/png, image/webp
forceRefresh

boolean

Si cette valeur est définie, la plate-forme extrait le fichier et la vignette à partir des URL spécifiées, même si la plate-forme a mis en cache des copies du fichier (et/ou de la vignette).
altText

string

Texte décrivant les détails du contenu multimédia pour des raisons d'accessibilité.

RichCard

Carte enrichie autonome ou carrousel de cartes enrichies envoyé par l'agent à l'utilisateur.

Représentation JSON 
{

  // Union field card can be only one of the following:
  "standaloneCard": {
    object (StandaloneCard)
  },
  "carouselCard": {
    object (CarouselCard)
  }
  // End of list of possible types for union field card.
}
Champs
Champ d'union card. Types de cartes enrichies possibles. card ne peut être qu'un des éléments suivants :
standaloneCard

object (StandaloneCard)

Fiche autonome.
carouselCard

object (CarouselCard)

Carrousel de fiches.

StandaloneCard

Fiche autonome.

Représentation JSON 
{
  "cardContent": {
    object (CardContent)
  }
}
Champs
cardContent

object (CardContent)

Contenu de la fiche.

CardContent

Contenu de la fiche.

Représentation JSON 
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
Champs
title

string

Facultatif. Titre de la fiche. 200 caractères maximum.
description

string

Facultatif. Description de la carte. 2 000 caractères maximum.
media

object (Media)

Facultatif. Contenu multimédia à inclure dans la fiche.
suggestions[]

object (Suggestion)

Facultatif. Liste de suggestions à inclure dans la fiche. Quatre suggestions maximum.

Multimédia

Fichier multimédia dans une carte enrichie.

Représentation JSON 
{
  "height": enum (Height),

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Champs
height

enum (Height)

Hauteur du contenu multimédia dans une carte enrichie.
Champ d'union content. Contenu multimédia. content ne peut être qu'un des éléments suivants :
contentInfo

object (ContentInfo)

Informations sur un fichier, y compris son URL et sa vignette.

Taille

Hauteur du support

Enums
HEIGHT_UNSPECIFIED Non spécifié.
SHORT 112 DP.
MEDIUM 168 DP.
TALL 264 DP. Non disponible pour les carrousels de cartes enrichies lorsque la largeur de la fiche est définie sur SMALL.

Suggestion

Suggestion dans une liste de chips.

Représentation JSON 
{

  // Union field option can be only one of the following:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  },
  "liveAgentRequest": {
    object (LiveAgentRequest)
  },
  "authenticationRequest": {
    object (AuthenticationRequest)
  }
  // End of list of possible types for union field option.
}
Champs
Champ d'union option. Une réponse suggérée. option ne peut être qu'un des éléments suivants :
reply

object (SuggestedReply)

Suggestion de réponse de l'utilisateur avec le texte spécifié.
action

object (SuggestedAction)

Action suggérée qui déclenche une action native sur l'appareil.
liveAgentRequest

object (LiveAgentRequest)

Demande permettant à un agent de participer à la conversation.
authenticationRequest

object (AuthenticationRequest)

Requête permettant de lancer le flux d'authentification.

SuggestedReply

Lorsque l'utilisateur appuie dessus, la réponse textuelle est renvoyée à l'agent.

Représentation JSON 
{
  "text": string,
  "postbackData": string
}
Champs
text

string

Texte affiché dans la réponse suggérée et envoyé à l'agent lorsque l'utilisateur appuie dessus. 25 caractères maximum.
postbackData

string

Chaîne que l'agent reçoit lorsqu'un utilisateur appuie sur la réponse suggérée. 2 048 caractères maximum.

SuggestedAction

Lorsque l'utilisateur appuie dessus, l'action native correspondante est déclenchée sur l'appareil.

Représentation JSON 
{
  "text": string,
  "postbackData": string,

  // Union field action can be only one of the following:
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "dialAction": {
    object (DialAction)
  }
  // End of list of possible types for union field action.
}
Champs
text

string

Texte affiché dans l'action suggérée. 25 caractères maximum.
postbackData

string

Chaîne que l'agent reçoit lorsqu'un utilisateur appuie sur l'action suggérée. 2 048 caractères maximum.
Champ d'union action. Action native lancée sur l'appareil lorsque l'utilisateur appuie sur l'action suggérée. action ne peut être qu'un des éléments suivants :
openUrlAction

object (OpenUrlAction)

Ouvre l'URL spécifiée.
dialAction

object (DialAction)

Ouvre l'application Téléphone par défaut de l'utilisateur.

OpenUrlAction

Ouvre l'URL spécifiée.

Représentation JSON 
{
  "url": string
}
Champs
url

string

URL

DialAction

Ouvre l'application Téléphone par défaut de l'utilisateur avec le numéro de téléphone spécifié renseigné.

Représentation JSON 
{
  "phoneNumber": string
}
Champs
phoneNumber

string

Obligatoire. Numéro de téléphone spécifié, au format RFC 3966. Exemple : "+1-201-555-0123".

LiveAgentRequest

Ce type ne comporte aucun champ.

Lorsque l'utilisateur appuie dessus, il envoie une demande à un agent connecté pour rejoindre la conversation.

AuthenticationRequest

Requête d'authentification d'une conversation.

Représentation JSON 
{

  // Union field authentication_type can be only one of the following:
  "oauth": {
    object (Oauth)
  }
  // End of list of possible types for union field authentication_type.
}
Champs
Champ d'union authentication_type. Type d'authentification. authentication_type ne peut être qu'un des éléments suivants :
oauth

object (Oauth)

Détails de l'authentification via OAuth

Oauth

Détails de l'authentification via OAuth

Représentation JSON 
{
  "clientId": string,
  "codeChallenge": string,
  "scopes": [
    string
  ],
  "codeChallengeMethod": string
}
Champs
clientId

string

Obligatoire. ID de l'application qui demande une autorisation.
codeChallenge

string

Obligatoire. La question d'authentification à l'aide du code utilisée pour échanger des jetons d'accès.
scopes[]

string

Obligatoire. Tableau spécifiant les champs d'application de la requête.
codeChallengeMethod

string

Facultatif. La méthode de test de code utilisée pour générer le test de code. Si ce paramètre est omis, le serveur suppose que c'est la valeur plain.

CarouselCard

Carrousel de fiches.

Représentation JSON 
{
  "cardWidth": enum (CardWidth),
  "cardContents": [
    {
      object (CardContent)
    }
  ]
}
Champs
cardWidth

enum (CardWidth)

Largeur des fiches dans le carrousel.
cardContents[]

object (CardContent)

Liste des contenus de chaque fiche du carrousel. Un carrousel peut comporter entre 2 et 10 fiches.

CardWidth

Largeur des fiches dans le carrousel.

Enums
CARD_WIDTH_UNSPECIFIED Non spécifié
SMALL 136 DP. Impossible d'inclure de grands médias.
MEDIUM 280 DP.

Méthodes

create

 Envoie un message d'un agent à un utilisateur.

updateReceipt

 Envoie une confirmation pour un message d'un agent à un utilisateur.