Ressource : AgentMessage
Message envoyé par l'agent à un utilisateur.
| Représentation JSON |
|---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
| Champs | |
|---|---|
name |
Ce champ est défini par la plate-forme RCS for Business. Ne l'incluez pas lorsque vous créez un message d'agent. Le champ résout "phones/{E.164}/agentMessages/{messageId}", où {E.164} correspond au numéro de téléphone de l'utilisateur au format E.164 et {messageId} à l'ID du message de l'agent attribué par l'agent. |
sendTime |
Ce champ est défini par la plate-forme RCS for Business. Ne l'incluez pas lorsque vous créez un message d'agent. Le champ indique l'heure à laquelle le message est envoyé à l'utilisateur. Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : |
contentMessage |
Contenu du message de l'agent. |
messageTrafficType |
Type de trafic du message. |
richMessageClassification |
Uniquement en sortie. Classe le message selon le modèle de facturation américain. Pour en savoir plus sur chaque type de classification, consultez le guide Modèle de facturation aux États-Unis. Ce champ n'est renseigné que pour les numéros de téléphone américains. |
totalPayloadSizeBytes |
Uniquement en sortie. Taille totale de la charge utile du message en octets. La charge utile comptabilise toutes les pièces jointes d'un message RCS for Business (vidéos, images, PDF, etc.), à l'exception du texte du message ou des suggestions. Actuellement, ce champ n'est renseigné que pour les numéros de téléphone américains. |
carrier |
Uniquement en sortie. Informations sur l'opérateur auquel appartient le numéro de téléphone de l'utilisateur, selon les backends RCS de Google. Actuellement, ce champ n'est renseigné que pour les numéros de téléphone américains. |
Champ d'union
|
|
expireTime |
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 utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : |
ttl |
Facultatif. Uniquement en entrée. Durée de vie du message avant sa révocation automatique. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par " |
AgentContentMessage
Contenu d'un message envoyé par l'agent à un utilisateur.
| Représentation JSON |
|---|
{ "suggestions": [ { object ( |
| Champs | |
|---|---|
suggestions[] |
Liste de réponses et d'actions suggérées qui s'affiche 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 message le plus récent de la conversation (y compris les messages de l'agent et de l'utilisateur). L'utilisateur peut appuyer sur une réponse suggérée pour renvoyer la réponse textuelle à l'agent ou appuyer sur une action suggérée pour lancer une action native sur l'appareil. Il existe deux types de modèles de suggestions : persistants et transitoires. Pour en savoir plus, consultez Suggestions. |
Champ d'union content. Le contenu du message de l'agent content ne peut être que l'un des suivants : |
|
text |
Texte encodé en UTF-8. 3 072 caractères maximum. |
fileName |
Nom unique d'un fichier. La plate-forme RCS for Business renvoie un nom de fichier lorsqu'un agent importe un fichier. Obsolète, remplacé par uploadedRbmFile ci-dessous. |
uploadedRbmFile |
Contient les identifiants d'un fichier et d'une miniature importés sur le serveur RCS for Business et diffusés par celui-ci. |
richCard |
Carte enrichie autonome. |
contentInfo |
Informations sur un fichier, y compris l'URL du fichier et celle de sa miniature. La plate-forme RCS for Business diffuse du contenu à partir d'un cache, mais un agent peut forcer la plate-forme RCS for Business à récupérer une nouvelle version du contenu et à actualiser le cache. |
UploadedRbmFile
Message contenant des informations sur le fichier et la miniature
| Représentation JSON |
|---|
{ "fileName": string, "thumbnailName": string } |
| Champs | |
|---|---|
fileName |
Nom du fichier renvoyé par la plate-forme RCS for Business lors de l'importation du fichier. |
thumbnailName |
Nom de la miniature renvoyé par la plate-forme RCS for Business lors de l'importation de la miniature. |
RichCard
Carte enrichie autonome ou carrousel de cartes enrichies envoyées par l'agent à l'utilisateur.
| Représentation JSON |
|---|
{ // Union field |
| Champs | |
|---|---|
Champ d'union card. Carte autonome ou carrousel de cartes. card ne peut être qu'un des éléments suivants : |
|
carouselCard |
Carrousel de cartes. |
standaloneCard |
Fiche autonome. |
CarouselCard
Carrousel de cartes.
| Représentation JSON |
|---|
{ "cardWidth": enum ( |
| Champs | |
|---|---|
cardWidth |
Largeur des cartes dans le carrousel. |
cardContents[] |
Liste du contenu de chaque carte du carrousel. Un carrousel peut comporter entre deux et dix cartes. |
CarouselCard.CardWidth
Largeur des cartes dans le carrousel.
| Enums | |
|---|---|
CARD_WIDTH_UNSPECIFIED |
Non spécifié. |
SMALL |
120 DP. |
MEDIUM |
232 DP. |
CardContent
Contenu de la carte
| 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 au maximum. |
media |
(Facultatif) Contenu multimédia (image, GIF, vidéo, PDF) à inclure dans la fiche. |
suggestions[] |
(Facultatif) Liste des suggestions à inclure dans la fiche. Vous ne pouvez pas ajouter plus de quatre suggestions. |
Contenus multimédias
Fichier multimédia dans une carte enrichie.
| Représentation JSON |
|---|
{ "height": enum ( |
| Champs | |
|---|---|
height |
Hauteur du contenu multimédia dans une carte enrichie avec une mise en page verticale. Pour une carte autonome avec une 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 suivants : |
|
fileName |
Nom unique du fichier, renvoyé par la plate-forme RCS for Business lors de l'importation du fichier. Obsolète, remplacé par uploadedRbmFile ci-dessous. |
uploadedRbmFile |
Contient les identifiants d'un fichier et d'une miniature importés sur le serveur RCS for Business et diffusés par celui-ci. |
contentInfo |
Informations sur un fichier, y compris l'URL du fichier et celle de sa miniature. La plate-forme RCS for Business diffuse du contenu à partir d'un cache, mais un agent peut forcer la plate-forme RCS for Business à 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 |
URL du fichier accessible publiquement. La plate-forme RCS for Business détermine le type MIME du fichier à partir du champ "content-type" dans les en-têtes HTTP lorsque la plate-forme récupère le fichier. Le champ "content-type" doit être présent et exact dans la réponse HTTP de l'URL. La taille maximale recommandée pour les fichiers est de 100 Mo. Remarque : Les redirections dans les URL de fichiers ne sont pas acceptées. Veuillez utiliser CreateFileRequest si une redirection est nécessaire. |
thumbnailUrl |
(Facultatif, pour les fichiers image, audio et vidéo uniquement) URL accessible publiquement de la miniature. Taille maximale de 100 Ko. Si vous ne fournissez pas d'URL de vignette, la plate-forme RCS for Business affiche un espace réservé vide pour la vignette jusqu'à ce que l'appareil de l'utilisateur télécharge le fichier. 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. Remarque : Les redirections dans les URL de fichiers ne sont pas acceptées. Veuillez utiliser CreateFileRequest si une redirection est nécessaire. |
forceRefresh |
Si cette option est définie, la plate-forme RCS for Business récupère le fichier et la miniature à partir des URL spécifiées, même si elle dispose de copies mises en cache 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. |
Suggestion
Réponse ou action suggérée incluse dans une carte enrichie ou dans une liste de chips de suggestions.
| Représentation JSON |
|---|
{ "suggestionDisplay": enum ( |
| Champs | |
|---|---|
suggestionDisplay |
Facultatif. Contrôle le comportement d'affichage de la suggestion. Applicable uniquement aux messages en texte brut envoyés aux clients Google Messages (version 20260225.00 ou ultérieure). Ce champ ne doit être défini que pour les suggestions autonomes associées à des messages en texte brut. Le serveur rejettera le message si ce champ est appliqué à des suggestions dans des cartes enrichies ou à des suggestions autonomes avec transfert de fichiers. Ce paramètre n'est sérialisé que pour Google Messages. Il est ignoré par les autres clients (tels qu'iOS ou Samsung). |
Champ d'union option. une réponse ou une action suggérée. option ne peut être qu'un des éléments suivants : |
|
reply |
Les utilisateurs peuvent appuyer sur une réponse suggérée pour renvoyer la réponse textuelle à l'agent. |
action |
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 cette option, 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 renvoyé à l'agent lorsque l'utilisateur appuie dessus. 25 caractères au maximum. |
postbackData |
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
Lorsqu'il est sélectionné, il lance l'action native correspondante sur l'appareil.
| Représentation JSON |
|---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // Union field |
| Champs | |
|---|---|
text |
Texte affiché dans l'action suggérée. 25 caractères au maximum. |
postbackData |
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 |
(Facultatif) URL de remplacement à utiliser si un client n'est pas compatible avec une action suggérée. Les URL de secours 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. Action native déclenchée sur l'appareil lorsque l'utilisateur appuie sur l'action suggérée. action ne peut être qu'un des éléments suivants : |
|
dialAction |
Ouvre l'application de téléphone par défaut de l'utilisateur avec le numéro de téléphone spécifié par l'agent. |
viewLocationAction |
Ouvre l'application de cartographie par défaut de l'utilisateur et sélectionne le lieu spécifié par l'agent ou effectue une recherche autour de la position de l'utilisateur en fonction d'une requête spécifiée par l'agent. |
createCalendarEventAction |
Ouvre l'application d'agenda par défaut de l'utilisateur et lance le flux de création d'un événement d'agenda avec les données d'événement spécifiées par l'agent préremplies. |
openUrlAction |
Ouvre l'application de navigateur Web par défaut de l'utilisateur à l'URL indiquée. Si l'utilisateur a installé une application enregistrée comme gestionnaire par défaut de l'URL, cette application s'ouvrira à la place et son icône sera utilisée dans l'UI de l'action suggérée. |
shareLocationAction |
Ouvre le sélecteur de position de l'application RCS pour que l'utilisateur puisse choisir une position à envoyer à l'agent. |
DialAction
Ouvre l'application de téléphone 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 |
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 le lieu spécifié par l'agent ou effectue une recherche autour de la position de l'utilisateur en fonction d'une requête spécifiée par l'agent.
| Représentation JSON |
|---|
{
"latLong": {
object ( |
| Champs | |
|---|---|
latLong |
(Facultatif) Latitude et longitude de l'emplacement spécifié. |
label |
(Facultatif) Libellé du repère déposé à la position latLong. |
query |
(Facultatif) Au lieu de spécifier une latitude/longitude (et éventuellement un libellé), l'agent peut spécifier une chaîne de requête. Pour les applications de cartographie par défaut qui prennent en charge la fonctionnalité de recherche (y compris Google Maps), appuyer sur cette action suggérée entraîne une recherche de position centrée sur la position actuelle de l'utilisateur. Si la requête est suffisamment spécifique, 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", toutes les agences Growing Tree Bank à proximité de l'utilisateur s'affichent. Si vous définissez la chaîne de requête sur "1600 Amphitheater Parkway, Mountain View, CA 94043", cette adresse spécifique sera sélectionnée, quelle que soit la position 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 |
Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0]. |
longitude |
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 flux de création d'un événement 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 |
Heure de début de l'événement. Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : |
endTime |
Heure de fin de l'événement. Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : |
title |
Titre de l'événement 100 caractères au maximum. |
description |
Description de l'événement. 500 caractères maximum. |
OpenUrlAction
Ouvre l'application de navigateur Web par défaut de l'utilisateur à l'URL spécifiée. Si l'utilisateur a installé une application enregistrée comme gestionnaire par défaut de l'URL, celle-ci s'ouvrira à la place et son icône sera utilisée dans l'UI de l'action suggérée.
| Représentation JSON |
|---|
{ "url": string, "application": enum ( |
| Champs | |
|---|---|
url |
URL à ouvrir. À compter du 1er novembre 2025, le schéma d'URL devra être https:// ou http://. Les requêtes API utilisant d'autres schémas (par exemple, tel:, mailto:, sms:) seront refusées avec une erreur 400 (requête incorrecte) après cette date. L'URL doit être un URI valide tel que défini dans la RFC 3986. 2 048 caractères maximum. |
application |
Ouvrez une application, un navigateur ou une WebView à l'aide d'une URL. 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 |
Mode Vue pour WebView. |
description |
Description de l'accessibilité pour la vue Web. |
OpenUrlApplication
Type d'application d'ouverture de l'URL
| Enums | |
|---|---|
OPEN_URL_APPLICATION_UNSPECIFIED |
Non spécifié : le navigateur sera utilisé pour ouvrir le fichier. |
BROWSER |
Utilisez le navigateur pour ouvrir l'URL. |
WEBVIEW |
Ouvrir l'URL dans une fenêtre Web View intégrée |
WebviewViewMode
Type de mode d'affichage de la WebView.
| Enums | |
|---|---|
WEBVIEW_VIEW_MODE_UNSPECIFIED |
Non spécifié. Pour utiliser WebView, vous devez spécifier un mode d'affichage. |
FULL |
Nécessite une superposition plein écran avec la conversation du chatbot indiquée dans la barre d'état. |
HALF |
Nécessite une superposition sur la moitié de l'écran. |
TALL |
Nécessite une superposition d'écran aux trois quarts. |
Suggestion.SuggestionDisplay
Comportement d'affichage des suggestions de texte autonomes.
| Enums | |
|---|---|
SUGGESTION_DISPLAY_UNSPECIFIED |
Les clients adoptent un comportement d'affichage par défaut :
|
PERSISTENT |
La suggestion reste visible en permanence dans la bulle de message, même lorsque de nouveaux messages sont ajoutés à la conversation. |
StandaloneCard
Carte autonome
| Représentation JSON |
|---|
{ "cardOrientation": enum ( |
| Champs | |
|---|---|
cardOrientation |
Orientation de la carte. |
thumbnailImageAlignment |
Alignement de l'aperçu de l'image pour les cartes autonomes avec une mise en page horizontale. |
cardContent |
Contenu de la fiche. |
StandaloneCard.CardOrientation
Orientation de la carte.
| Enums | |
|---|---|
CARD_ORIENTATION_UNSPECIFIED |
Non spécifié. |
HORIZONTAL |
Mise en page horizontale. Si le champ |
VERTICAL |
Mise en page verticale. |
StandaloneCard.ThumbnailImageAlignment
Alignement de l'aperçu de l'image pour les cartes autonomes avec une 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'enum sera étendu 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 à usages multiples. 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 d'agents transactionnels ou polyvalents. |
PROMOTION |
Pour les messages promotionnels dans les cas d'utilisation d'agents promotionnels ou polyvalents. |
SERVICEREQUEST |
Pour les messages concernant les services que l'utilisateur a accepté de recevoir. Utilisé dans les cas d'utilisation d'agents OTP, transactionnels, promotionnels ou à usages multiples. |
ACKNOWLEDGEMENT |
Messages confirmant la demande de désabonnement de l'utilisateur. Utilisé dans les cas d'utilisation d'agents OTP, transactionnels, promotionnels ou à usages multiples. |
RichMessageClassification
Pour la facturation aux États-Unis uniquement : informations sur les classifications des messages utilisées pour la facturation.
| Représentation JSON |
|---|
{
"classificationType": enum ( |
| Champs | |
|---|---|
classificationType |
|
segmentCount |
Nombre de segments de 160 octets pour le texte du message, toujours arrondi à l'entier supérieur. Calculée à partir de la longueur totale en octets UTF-8 du contenu textuel uniquement. Les données des réponses ou actions suggérées sont exclues. Par exemple, un message de 300 octets a un segmentCount de 2. Ce champ n'est renseigné que pour les types RICH_MESSAGE. |
RichMessageClassificationType
Pour la facturation aux États-Unis uniquement : spécifie la classification du message pour la facturation.
Important : Les opérateurs américains définissent le prix des types de messages facturables décrits sur cette page. Les opérateurs américains déterminent également le montant final facturé au développeur pour l'envoi de messages RCS for Business. Pour obtenir des informations supplémentaires sur les tarifs ou la facturation, veuillez contacter les représentants de l'opérateur concerné.
| Enums | |
|---|---|
RICH_MESSAGE_CLASSIFICATION_TYPE_UNSPECIFIED |
Non spécifié |
RICH_MESSAGE |
Un message est classé comme RICH dans les cas suivants : 1. Il ne contient pas de cartes enrichies. 2. Il ne contient pas de pièces jointes. 3. Toutes les actions suggérées qu'il contient doivent être une action "Composer un numéro" ou une action "Ouvrir une URL" qui n'utilise pas de WebView. |
RICH_MEDIA_MESSAGE |
Tout message qui ne répond pas aux critères RICH_MESSAGE. Cela inclut les messages contenant une carte enrichie, un fichier multimédia ou toute action suggérée autre que "Composer un numéro" ou "Ouvrir l'URL dans le navigateur". |
SUGGESTED_ACTION_CLICK |
Représente l'appui d'un utilisateur sur une action suggérée (et non sur une réponse suggérée). Cette classification ne s'applique qu'aux actions des utilisateurs et n'apparaît que dans la charge utile UserMessage d'un webhook. Elle ne s'applique pas aux messages A2P. |
Méthodes |
|
|---|---|
|
Envoie un message de l'agent à un utilisateur. |
|
Révoque un message d'agent qui a été envoyé, mais pas encore distribué. |