REST Resource: phones.agentMessages

Ressource: AgentMessage

Message envoyé par l'agent à un utilisateur.

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

  // 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 plateforme 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 pour le message de l'agent.
sendTime

string (Timestamp format)

Ce champ est défini par la plateforme RBM. Ne l'incluez pas lorsque vous créez un message d'agent. Le champ résout l'heure à laquelle le message est envoyé à l'utilisateur.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
contentMessage

object (AgentContentMessage)

Contenu du message de l'agent.

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.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
ttl

string (Duration format)

Facultatif. Uniquement en entrée. Durée de conservation du message avant sa révocation automatique.

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'affiche sous forme de liste de chips de suggestion après le message d'agent associé. 11 suggestions maximum.

Les chips ne s'affichent que lorsque le message associé à l'agent est le plus récent de la conversation (y compris les messages de l'agent et ceux des utilisateurs). L'utilisateur peut appuyer sur une réponse suggérée pour renvoyer la réponse par SMS à l'agent ou appuyer sur une action suggérée pour lancer une action native sur l'appareil.
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.
fileName
(deprecated)

string

Nom unique d'un fichier. La plate-forme RBM renvoie un nom de fichier lorsqu'un agent importe un fichier. Abandonné au profit du fichier importéRbmFile ci-dessous
uploadedRbmFile

object (UploadedRbmFile)

Contient les identifiants d'un fichier et d'une vignette qui ont été importés et diffusés par le serveur RBM
richCard

object (RichCard)

Une carte enrichie autonome.
contentInfo

object (ContentInfo)

Informations sur un fichier, y compris l'URL du fichier et l'URL 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 les fichiers et les vignettes

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 miniature, renvoyé par la plate-forme RBM lors de l'importation de la miniature.

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:
  "carouselCard": {
    object (CarouselCard)
  },
  "standaloneCard": {
    object (StandaloneCard)
  }
  // End of list of possible types for union field card.
}
Champs
Champ d'union card. Fiche autonome ou carrousel de cartes. card ne peut être qu'un des éléments suivants :
carouselCard

object (CarouselCard)

Carrousel de fiches.
standaloneCard

object (StandaloneCard)

Carte autonome.

CarouselCard

Carrousel de fiches.

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

enum (CarouselCard.CardWidth)

Largeur des fiches du carrousel.
cardContents[]

object (CardContent)

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

CarouselCard.CardWidth

Largeur des fiches du carrousel.

Enums
CARD_WIDTH_UNSPECIFIED Non spécifié.
SMALL 120 DP. Notez que les grands supports 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 carte. 2 000 caractères maximum.
media

object (Media)

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

object (Suggestion)

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

Contenus multimédias

Fichier multimédia dans une carte 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 carte 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 contenu multimédia content 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. Abandonné au profit du fichier importéRbmFile ci-dessous
uploadedRbmFile

object (UploadedRbmFile)

Contient les identifiants d'un fichier et d'une vignette qui ont été importés et diffusés par le serveur RBM
contentInfo

object (ContentInfo)

Informations sur un fichier, y compris l'URL du fichier et l'URL 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 du fichier accessible publiquement. La plate-forme RBM 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 de l'URL. Taille de fichier maximale recommandée : 100 Mo.
thumbnailUrl

string

(Facultatif, pour les fichiers image et vidéo uniquement) URL de la miniature accessible publiquement. 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é vierge jusqu'à ce que le fichier soit téléchargé sur l'appareil de l'utilisateur. En fonction des paramètres de l'utilisateur, il est possible que le fichier ne se télécharge pas automatiquement et que l'utilisateur doive appuyer sur un bouton de téléchargement.
forceRefresh

boolean

Si cette option est définie, la plate-forme RBM récupère 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).

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 cartes enrichies lorsque la largeur de la fiche est définie sur "Petite".

Suggestion

Réponse suggérée ou action suggérée incluse dans une carte enrichie ou 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 qu'un des éléments suivants:
reply

object (SuggestedReply)

Les utilisateurs peuvent appuyer sur une réponse suggérée pour renvoyer le 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 l'utilisateur appuie sur la réponse, elle est renvoyée par SMS à l'agent.

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

string

Texte qui s'affiche dans la réponse suggérée et qui est 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 l'utilisateur appuie dessus, l'action native correspondante est lancée 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)
  }
  // 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
fallbackUrl

string

(Facultatif) URL de remplacement à utiliser si un client n'accepte pas une action suggérée. Les URL de remplacement s'ouvrent dans une nouvelle fenêtre du navigateur.
Champ d'union action. L'action native déclenchée sur l'appareil lorsque l'utilisateur appuie sur l'action suggérée action ne peut être que l'un des éléments suivants:
dialAction

object (DialAction)

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

object (ViewLocationAction)

Ouvre l'application de cartographie par défaut de l'utilisateur et sélectionne l'emplacement spécifié par l'agent ou effectue une recherche autour de la position de l'utilisateur à partir d'une requête spécifiée par un 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 le navigateur Web par défaut de l'utilisateur sur l'URL indiquée. Si l'utilisateur a installé une application enregistrée en tant que gestionnaire par défaut pour l'URL, cette application sera ouverte à la place et son icône sera utilisée dans l'interface utilisateur d'action suggérée.
shareLocationAction

object (ShareLocationAction)

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

DialAction

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

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 cartographie par défaut de l'utilisateur et sélectionne l'emplacement spécifié par l'agent ou effectue une recherche autour de la position de l'utilisateur à partir d'une requête spécifiée par un 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 l'épingle à latLong.
query

string

(Facultatif, uniquement disponible sur les clients Android Messages) Plutôt que de spécifier une latLong (et éventuellement un libellé), l'agent peut spécifier une chaîne de requête. Pour les applications de cartographie par défaut compatibles avec la fonctionnalité de recherche (y compris Google Maps), appuyer sur cette action suggérée génère 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 lieu dans le monde.

Par exemple, si vous définissez la chaîne de requête sur "Growing Tree Bank", tous les emplacements du Growing Tree Bank à proximité s'affichent. Si vous définissez la chaîne de requête sur "1600 Amphitheater Parkway, Mountain View, CA 94043", cette adresse sera sélectionnée, indépendamment de 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.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Heure de fin de l'événement.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
title

string

Titre de l'événement
description

string

Description de l'événement.

OpenUrlAction

Ouvre le navigateur Web par défaut de l'utilisateur sur l'URL spécifiée. Si l'utilisateur a installé une application enregistrée en tant que gestionnaire par défaut pour l'URL, cette application sera ouverte à la place et son icône sera utilisée dans l'interface utilisateur d'action suggérée.

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

string

URL

ShareLocationAction

Ce type ne comporte aucun champ.

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

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 carte.
thumbnailImageAlignment

enum (StandaloneCard.ThumbnailImageAlignment)

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

object (CardContent)

Contenu de la fiche.

StandaloneCard.CardOrientation

Orientation de la carte.

Enums
CARD_ORIENTATION_UNSPECIFIED Non spécifié.
HORIZONTAL

Mise en page horizontale.

Si l'élément 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 d'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.

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é.