REST Resource: phones.agentMessages

Ressource: AgentMessage

Message envoyé par l'agent à un utilisateur.

Représentation JSON 
{
  "name": string,
  "sendTime": string,
  "contentMessage": {
    object (AgentContentMessage)
  },
  "messageTrafficType": enum (MessageTrafficType),

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
Champs
name

string

Ce champ est défini par la plate-forme RBM. Ne l'incluez pas lorsque vous créez un message d'agent. Le champ résout "phones/{E.164}/agentMessages/{messageId}", où {E.164} est le numéro de téléphone de l'utilisateur au format E.164 et {messageId} est l'ID attribué par l'agent au message de l'agent.
sendTime

string (Timestamp format)

Ce champ est défini par la plate-forme RBM. Ne l'incluez pas lorsque vous créez un message d'agent. Ce champ indique l'heure à laquelle le message est envoyé à l'utilisateur.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
contentMessage

object (AgentContentMessage)

Contenu du message de l'agent.
messageTrafficType

enum (MessageTrafficType)

Type de trafic des messages.

Champ d'union expiration.

expiration ne peut être qu'un des éléments suivants :
expireTime

string (Timestamp format)

Facultatif. Code temporel en UTC du moment où cette ressource est considérée comme expirée. Cette valeur est fournie en sortie si elle est définie ou si le champ TTL est défini.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
ttl

string (Duration format)

Facultatif. Uniquement en entrée. Durée de validité du message avant qu'il ne soit révoqué automatiquement.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

AgentContentMessage

Contenu d'un message envoyé par l'agent à un utilisateur.

Représentation JSON 
{
  "suggestions": [
    {
      object (Suggestion)
    }
  ],

  // Union field content can be only one of the following:
  "text": string,
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "richCard": {
    object (RichCard)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Champs
suggestions[]

object (Suggestion)

Liste de réponses et d'actions suggérées qui s'affichent sous forme de chips de suggestion après le message de l'agent associé. 11 suggestions maximum.

Les chips ne s'affichent que lorsque le message de l'agent associé est le plus récent de la conversation (y compris les messages de l'agent et de l'utilisateur). L'utilisateur peut appuyer sur une suggestion de réponse pour renvoyer la réponse textuelle à l'agent ou sur une suggestion d'action pour lancer une action native sur l'appareil. 11 suggestions maximum.
Champ d'union content. Le contenu du message de l'agent content ne peut être que l'un des éléments suivants:
text

string

Texte encodé en UTF-8. 3 072 caractères maximum.
fileName
(deprecated)

string

Nom unique d'un fichier. La plate-forme RBM renvoie un nom de fichier lorsqu'un agent importe un fichier. Obsolète et remplacé par uploadedRbmFile ci-dessous
uploadedRbmFile

object (UploadedRbmFile)

Contient les identifiants d'un fichier et d'une vignette importés sur le serveur RBM et diffusés par celui-ci
richCard

object (RichCard)

Carte enrichie autonome.
contentInfo

object (ContentInfo)

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

La plate-forme RBM diffuse du contenu à partir d'un cache, mais un agent peut forcer la plate-forme RBM à récupérer une nouvelle version du contenu et à actualiser le cache.

UploadedRbmFile

Message contenant des informations sur le fichier et la vignette

Représentation JSON 
{
  "fileName": string,
  "thumbnailName": string
}
Champs
fileName

string

Nom du fichier, renvoyé par la plate-forme RBM lors de l'importation du fichier.
thumbnailName

string

Nom de la vignette, renvoyé par la plate-forme RBM lors de sa mise en ligne.

RichCard

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

Représentation JSON 
{

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

object (CarouselCard)

Carrousel de cartes.
standaloneCard

object (StandaloneCard)

Fiche autonome.

CarouselCard

Carrousel de cartes.

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

enum (CarouselCard.CardWidth)

Largeur des fiches du carrousel.
cardContents[]

object (CardContent)

Liste du contenu de chaque fiche du carrousel. Un carrousel peut comporter entre deux et 10 fiches.

CarouselCard.CardWidth

Largeur des cartes du carrousel.

Enums
CARD_WIDTH_UNSPECIFIED Non spécifié.
SMALL 120 DP. Notez que les contenus multimédias de grande taille ne peuvent pas être utilisés.
MEDIUM 232 dp.

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 fiche. 2 000 caractères maximum.
media

object (Media)

(Facultatif) Élément multimédia (image, GIF, vidéo) à inclure dans la fiche.
suggestions[]

object (Suggestion)

(Facultatif) Liste des suggestions à inclure dans la fiche. 10 suggestions maximum.

Contenus multimédias

Fichier multimédia dans une fiche enrichie.

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

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

enum (Media.Height)

Hauteur du contenu multimédia dans une fiche enrichie avec une mise en page verticale. Pour une fiche autonome avec mise en page horizontale, la hauteur n'est pas personnalisable et ce champ est ignoré.
Champ d'union content. Le content de contenu multimédia ne peut être que l'un des éléments suivants:
fileName
(deprecated)

string

Nom unique du fichier, renvoyé par la plate-forme RBM lors de l'importation du fichier. Obsolète et remplacé par uploadedRbmFile ci-dessous
uploadedRbmFile

object (UploadedRbmFile)

Contient les identifiants d'un fichier et d'une vignette importés sur le serveur RBM et diffusés par celui-ci
contentInfo

object (ContentInfo)

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

La plate-forme RBM diffuse du contenu à partir d'un cache, mais un agent peut forcer la plate-forme RBM à récupérer une nouvelle version du contenu et à actualiser le cache.

ContentInfo

Message contenant les informations sur le contenu.

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

string

URL publiquement accessible du fichier. La plate-forme RBM détermine le type MIME du fichier à partir du champ "content-type" des en-têtes HTTP lorsqu'elle extrait le fichier. Le champ "content-type" doit être présent et précis dans la réponse HTTP de l'URL. Taille de fichier maximale recommandée : 100 Mo
thumbnailUrl

string

(Facultatif, pour les fichiers image, audio et vidéo uniquement) URL publiquement accessible de la vignette. Taille maximale de 100 ko.

Si vous ne fournissez pas d'URL de vignette, la plate-forme RBM affiche une vignette d'espace réservé vide jusqu'à ce que l'appareil de l'utilisateur télécharge le fichier. En fonction des paramètres de l'utilisateur, le fichier peut ne pas être téléchargé automatiquement et l'utilisateur peut être invité à appuyer sur un bouton de téléchargement.
forceRefresh

boolean

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

Media.Height

Hauteur du support

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

Suggestion

Réponse ou action suggérée incluse dans une fiche enrichie ou dans une liste de chips de suggestion.

Représentation JSON 
{

  // Union field option can be only one of the following:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  }
  // End of list of possible types for union field option.
}
Champs
Champ d'union option. Une suggestion de réponse ou d'action option ne peut être que l'une des suivantes:
reply

object (SuggestedReply)

Les utilisateurs peuvent appuyer sur une suggestion de réponse pour renvoyer la réponse par SMS à l'agent.
action

object (SuggestedAction)

Les utilisateurs peuvent appuyer sur une action suggérée pour lancer l'action native correspondante sur l'appareil.

SuggestedReply

Lorsque vous appuyez 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 renvoyé à l'agent lorsque l'utilisateur appuie dessus. 25 caractères maximum.
postbackData

string

Charge utile encodée en base64 que l'agent reçoit dans un événement utilisateur lorsque l'utilisateur appuie sur la réponse suggérée.

SuggestedAction

Lorsque vous appuyez dessus, il lance l'action native correspondante sur l'appareil.

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

  // Union field action can be only one of the following:
  "dialAction": {
    object (DialAction)
  },
  "viewLocationAction": {
    object (ViewLocationAction)
  },
  "createCalendarEventAction": {
    object (CreateCalendarEventAction)
  },
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "shareLocationAction": {
    object (ShareLocationAction)
  },
  "composeAction": {
    object (ComposeAction)
  }
  // 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

Charge utile (encodée en base64) qui sera envoyée à l'agent dans l'événement utilisateur qui se produit lorsque l'utilisateur appuie sur l'action suggérée. 2 048 caractères maximum.
fallbackUrl

string

(Facultatif) URL de remplacement à utiliser si un client n'est pas compatible avec une action suggérée. Les URL de remplacement s'ouvrent dans de nouvelles fenêtres de navigateur. Doit être un URI valide, tel que défini dans la RFC 3986. 2 048 caractères maximum.
Champ d'union action. L'action native lancée sur l'appareil lorsque l'utilisateur appuie sur l'action suggérée action ne peut être que l'une des suivantes:
dialAction

object (DialAction)

Ouvre l'application de numérotation par défaut de l'utilisateur avec le numéro de téléphone spécifié par l'agent.
viewLocationAction

object (ViewLocationAction)

Ouvre l'application cartographique par défaut de l'utilisateur et sélectionne l'emplacement spécifié par l'agent ou recherche des établissements à proximité de l'emplacement de l'utilisateur en fonction d'une requête spécifiée par l'agent.
createCalendarEventAction

object (CreateCalendarEventAction)

Ouvre l'application d'agenda par défaut de l'utilisateur et lance le nouveau flux d'événements d'agenda avec les données d'événement spécifiées par l'agent préremplies.
openUrlAction

object (OpenUrlAction)

Ouvre l'application de navigateur Web par défaut de l'utilisateur avec l'URL donnée. Si une application installée est enregistrée en tant que gestionnaire par défaut de l'URL, elle s'ouvre à la place et son icône est utilisée dans l'UI de l'action suggérée.
shareLocationAction

object (ShareLocationAction)

Ouvre le sélecteur de position de l'application RCS afin que l'utilisateur puisse choisir un lieu à envoyer à l'agent.
composeAction

object (ComposeAction)

Rédiger et envoyer un message à une destination prédéfinie par chatbot

DialAction

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

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

string

Numéro de téléphone au format E.164 (par exemple, +12223334444).

ViewLocationAction

Ouvre l'application de carte par défaut de l'utilisateur et sélectionne l'emplacement spécifié par l'agent ou recherche des établissements à proximité de l'emplacement de l'utilisateur en fonction d'une requête spécifiée par l'agent.

Représentation JSON 
{
  "latLong": {
    object (LatLng)
  },
  "label": string,
  "query": string
}
Champs
latLong

object (LatLng)

(Facultatif) Latitude et longitude du lieu spécifié.
label

string

(Facultatif) Libellé de la punaise placée à la latitude et à la longitude indiquées.
query

string

(Facultatif, uniquement compatible avec les clients Android Messages) Au lieu de spécifier une latitude et une longitude (et éventuellement un libellé), l'agent peut spécifier une chaîne de requête. Pour les applications cartographiques par défaut compatibles avec la fonctionnalité de recherche (y compris Google Maps), appuyer sur cette action suggérée déclenche une recherche de lieu centrée sur la position actuelle de l'utilisateur. Si la requête est suffisamment précise, les agents peuvent l'utiliser pour sélectionner n'importe quel emplacement dans le monde.

Par exemple, si vous définissez la chaîne de requête sur "Growing Tree Bank", toutes les succursales de Growing Tree Bank situées à proximité de l'utilisateur s'affichent. Si vous définissez la chaîne de requête sur "1600 Amphitheatre Parkway, Mountain View, CA 94043", cette adresse spécifique sera sélectionnée, quel que soit l'emplacement de l'utilisateur.

LatLng

Objet représentant une paire latitude/longitude. Cette valeur est exprimée par une paire de doubles représentant les degrés de latitude et de longitude. Sauf indication contraire, cet objet doit être conforme à la norme WGS84. Les valeurs doivent se situer dans les limites normalisées.

Représentation JSON 
{
  "latitude": number,
  "longitude": number
}
Champs
latitude

number

Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0].
longitude

number

Longitude en degrés. Elle doit être comprise dans la plage [-180.0, +180.0].

CreateCalendarEventAction

Ouvre l'application d'agenda par défaut de l'utilisateur et lance le nouveau flux d'événements d'agenda avec les données d'événement spécifiées par l'agent préremplies.

Représentation JSON 
{
  "startTime": string,
  "endTime": string,
  "title": string,
  "description": string
}
Champs
startTime

string (Timestamp format)

Heure de début de l'événement.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Heure de fin de l'événement.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
title

string

Titre de l'événement 100 caractères au maximum.
description

string

Description de l'événement. 500 caractères maximum.

OpenUrlAction

Ouvre l'application de navigateur Web par défaut de l'utilisateur avec l'URL spécifiée. Si une application installée est enregistrée en tant que gestionnaire par défaut de l'URL, elle s'ouvre à la place et son icône est utilisée dans l'UI de l'action suggérée.

Représentation JSON 
{
  "url": string,
  "application": enum (OpenUrlApplication),
  "webviewViewMode": enum (WebviewViewMode),
  "description": string
}
Champs
url

string

URL. Doit être un URI valide, tel que défini dans la RFC 3986. 2 048 caractères maximum.
application

enum (OpenUrlApplication)

L'URL ouvre l'application, le navigateur ou la WebView. Pour vérifier si l'appareil d'un utilisateur est compatible avec le mode WebView, exécutez d'abord une vérification des fonctionnalités. Pour en savoir plus, consultez la documentation: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities.
webviewViewMode

enum (WebviewViewMode)

Mode d'affichage pour WebView
description

string

Description d'accessibilité pour la vue Web.

OpenUrlApplication

Type de l'application à ouvrir à partir de l'URL

Enums
OPEN_URL_APPLICATION_UNSPECIFIED Si aucune valeur n'est spécifiée, le navigateur est utilisé pour l'ouverture.
BROWSER Ouvrez l'URL dans un navigateur.
WEBVIEW Ouvrir l'URL dans une fenêtre de vue Web intégrée

WebviewViewMode

Type de mode d'affichage de la WebView.

Enums
WEBVIEW_VIEW_MODE_UNSPECIFIED Non spécifié. Pour utiliser la WebView, vous devez spécifier un mode de vue.
FULL Nécessite une superposition en plein écran avec la conversation du chatbot libellée dans la barre d'état.
HALF Nécessite une superposition sur la moitié de l'écran.
TALL Nécessite une superposition sur trois quarts de l'écran.

ShareLocationAction

Ce type ne comporte aucun champ.

Ouvre le sélecteur de position de l'application RCS afin que l'utilisateur puisse choisir un lieu à renvoyer à l'agent.

ComposeAction

Rédiger et envoyer un message à une destination prédéfinie par le chatbot Pour vérifier si l'appareil d'un utilisateur est compatible avec cette action, exécutez d'abord une vérification des fonctionnalités. Pour en savoir plus, consultez la documentation: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities.

Représentation JSON 
{

  // Union field action can be only one of the following:
  "composeTextMessage": {
    object (ComposeAction.ComposeTextMessage)
  },
  "composeRecordingMessage": {
    object (ComposeAction.ComposeRecordingMessage)
  }
  // End of list of possible types for union field action.
}
Champs

Champ d'union action.

action ne peut être qu'un des éléments suivants :
composeTextMessage

object (ComposeAction.ComposeTextMessage)

Rédigez et envoyez un SMS.
composeRecordingMessage

object (ComposeAction.ComposeRecordingMessage)

Lancer l'enregistrement et l'envoi d'un message audio ou vidéo

ComposeAction.ComposeTextMessage

Rédigez et envoyez un SMS.

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

string

Numéro de téléphone de destination prérempli par le chatbot.
text

string

"Brouillon" pour accéder au champ de texte d'envoi du message.

ComposeAction.ComposeRecordingMessage

Lancer l'enregistrement et l'envoi d'un message audio ou vidéo

Représentation JSON 
{
  "phoneNumber": string,
  "type": enum (ComposeRecordingActionType)
}
Champs
phoneNumber

string

Numéro de téléphone de destination prérempli par le chatbot.
type

enum (ComposeRecordingActionType)

Type d'action d'enregistrement.

ComposeRecordingActionType

Type d'action d'enregistrement de composition.

Enums
COMPOSE_RECORDING_ACTION_TYPE_UNSPECIFIED Non spécifié.
ACTION_TYPE_AUDIO Type audio.
ACTION_TYPE_VIDEO Type de vidéo.

StandaloneCard

Carte autonome

Représentation JSON 
{
  "cardOrientation": enum (StandaloneCard.CardOrientation),
  "thumbnailImageAlignment": enum (StandaloneCard.ThumbnailImageAlignment),
  "cardContent": {
    object (CardContent)
  }
}
Champs
cardOrientation

enum (StandaloneCard.CardOrientation)

Orientation de la fiche.
thumbnailImageAlignment

enum (StandaloneCard.ThumbnailImageAlignment)

Alignement de l'aperçu de l'image pour les fiches autonomes avec mise en page horizontale.
cardContent

object (CardContent)

Contenu de la fiche.

StandaloneCard.CardOrientation

Orientation de la fiche.

Enums
CARD_ORIENTATION_UNSPECIFIED Non spécifié.
HORIZONTAL

Mise en page horizontale.

Si le champ object(CardContent) d'une carte enrichie horizontale contient le champ media, il doit également inclure au moins un champ title, description ou suggestions[].
VERTICAL Mise en page verticale.

StandaloneCard.ThumbnailImageAlignment

Alignement de l'aperçu de l'image pour les fiches autonomes avec mise en page horizontale.

Enums
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED Non spécifié.
LEFT L'aperçu du fichier est aligné à gauche.
RIGHT L'aperçu du fichier est aligné à droite.

MessageTrafficType

Types de trafic de messages acceptés. L'énumération sera étendue pour prendre en charge d'autres types de trafic.

Enums
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED Comportement par défaut: le type de trafic des messages est déterminé par le cas d'utilisation de l'agent. Mettez à jour le type de trafic si nécessaire en fonction du contenu du message. Aucune valeur par défaut n'est fournie pour les agents à usage multiple. Le type de trafic doit être défini manuellement (par exemple, TRANSACTION, PROMOTION).
AUTHENTICATION Pour les messages d'authentification dans le cas d'utilisation de l'agent OTP.
TRANSACTION Pour les messages transactionnels dans les cas d'utilisation des agents transactionnels ou multi-usages.
PROMOTION Pour les messages promotionnels dans les cas d'utilisation "Agent promotionnel" ou "Agent multi-usage".
SERVICEREQUEST Pour les messages concernant les services pour lesquels l'utilisateur a donné son consentement. Utilisé dans les cas d'utilisation OTP, transactionnel, promotionnel ou multi-usage.
ACKNOWLEDGEMENT Pour les messages confirmant la demande de désabonnement de l'utilisateur. Utilisé dans les cas d'utilisation OTP, transactionnel, promotionnel ou multi-usage.

Méthodes

create

 Envoie un message de l'agent à un utilisateur.

delete

 Révoque un message d'agent qui a été envoyé, mais pas encore distribué.