Message d'accueil présenté aux utilisateurs lorsqu'ils entrent dans une conversation avec l'agent pour la première fois.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union content . Contenu du message de bienvenue. content ne peut être qu'un des éléments suivants : |
|
text |
Message Ne doit pas dépasser 1 000 caractères. |
richText |
Message enrichi dans un format Markdown valide. |
image |
Message avec image. |
richCard |
Message de carte enrichie. Il peut s'agir d'une fiche autonome ou d'un carrousel. |
Image
Image.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union content . Contenu des images. content ne peut être qu'un des éléments suivants : |
|
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 |
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 |
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 |
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 |
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 |
Champs | |
---|---|
Champ d'union card . Types de cartes enrichies possibles. card ne peut être qu'un des éléments suivants : |
|
standaloneCard |
Fiche autonome. |
carouselCard |
Carrousel de fiches. |
StandaloneCard
Fiche autonome.
Représentation JSON |
---|
{
"cardContent": {
object ( |
Champs | |
---|---|
cardContent |
Contenu de la fiche. |
CardContent
Contenu de la fiche.
Représentation JSON |
---|
{ "title": string, "description": string, "media": { object ( |
Champs | |
---|---|
title |
Facultatif. Titre de la fiche. 200 caractères maximum. |
description |
Facultatif. Description de la carte. 2 000 caractères maximum. |
media |
Facultatif. Contenu multimédia à inclure dans la fiche. |
suggestions[] |
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 ( |
Champs | |
---|---|
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 |
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 |
Champs | |
---|---|
Champ d'union option . Une réponse suggérée. option ne peut être qu'un des éléments suivants : |
|
reply |
Suggestion de réponse de l'utilisateur avec le texte spécifié. |
action |
Action suggérée qui déclenche une action native sur l'appareil. |
liveAgentRequest |
Demande permettant à un agent de participer à la conversation. |
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 |
Texte affiché dans la réponse suggérée et envoyé à l'agent lorsque l'utilisateur appuie dessus. 25 caractères maximum. |
postbackData |
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 |
Champs | |
---|---|
text |
Texte affiché dans l'action suggérée. 25 caractères maximum. |
postbackData |
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 |
Ouvre l'URL spécifiée. |
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 |
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 |
Obligatoire. Numéro de téléphone spécifié, au format RFC 3966. Exemple : "+1-201-555-0123". |
LiveAgentRequest
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 |
Champs | |
---|---|
Champ d'union authentication_type . Type d'authentification. authentication_type ne peut être qu'un des éléments suivants : |
|
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 |
Obligatoire. ID de l'application qui demande une autorisation. |
codeChallenge |
Obligatoire. La question d'authentification à l'aide du code utilisée pour échanger des jetons d'accès. |
scopes[] |
Obligatoire. Tableau spécifiant les champs d'application de la requête. |
codeChallengeMethod |
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 |
CarouselCard
Carrousel de fiches.
Représentation JSON |
---|
{ "cardWidth": enum ( |
Champs | |
---|---|
cardWidth |
Largeur des fiches dans le carrousel. |
cardContents[] |
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. |