Risorsa: AgentMessage
Un messaggio inviato dall'agente a un utente.
| Rappresentazione JSON |
|---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
| Campi | |
|---|---|
name |
Questo campo è impostato dalla piattaforma RCS for Business. Non includerlo quando crei un messaggio dell'agente. Il campo restituisce "phones/{E.164}/agentMessages/{messageId}", dove {E.164} è il numero di telefono dell'utente in formato E.164 e {messageId} è l'ID del messaggio dell'agente assegnato dall'agente. |
sendTime |
Questo campo è impostato dalla piattaforma RCS for Business. Non includerlo quando crei un messaggio dell'agente. Il campo risolve l'ora in cui il messaggio viene inviato all'utente. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
contentMessage |
Il contenuto del messaggio dell'agente. |
messageTrafficType |
Il tipo di traffico dei messaggi. |
richMessageClassification |
Solo output. Classifica il messaggio in base al modello di fatturazione statunitense. Per informazioni dettagliate su ciascun tipo di classificazione, consulta la guida Modello di fatturazione per gli Stati Uniti. Questo campo viene compilato solo per i numeri di telefono statunitensi. |
totalPayloadSizeBytes |
Solo output. La dimensione totale del payload del messaggio in byte. Il payload conteggia tutti gli allegati in un messaggio RCS for Business, che possono essere video, immagini, PDF e così via, ad eccezione del testo del messaggio o dei suggerimenti. Al momento, questo campo viene compilato solo per i numeri di telefono statunitensi. |
carrier |
Solo output. Le informazioni sull'operatore a cui appartiene il numero di telefono dell'utente, secondo i backend RCS di Google. Al momento, questo campo viene compilato solo per i numeri di telefono statunitensi. |
Campo unione
|
|
expireTime |
Facoltativo. Timestamp in UTC di quando questa risorsa è considerata scaduta. Questo valore viene fornito nell'output se è impostato o se è impostato il campo TTL. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
ttl |
Facoltativo. Solo input. Per quanto tempo il messaggio sarà attivo prima di essere revocato automaticamente. Una durata in secondi con un massimo di nove cifre frazionarie, che termina con " |
AgentContentMessage
I contenuti di un messaggio inviato dall'agente a un utente.
| Rappresentazione JSON |
|---|
{ "suggestions": [ { object ( |
| Campi | |
|---|---|
suggestions[] |
Un elenco di risposte e azioni suggerite che vengono visualizzate come elenco di chip di suggerimenti dopo il messaggio dell'agente associato. Massimo 11 suggerimenti. I chip vengono visualizzati solo quando il messaggio dell'agente associato è il messaggio più recente della conversazione (inclusi i messaggi dell'agente e dell'utente). L'utente può toccare una risposta suggerita per inviare la risposta di testo all'agente o toccare un'azione suggerita per avviare un'azione nativa sul dispositivo. Esistono due tipi di pattern di suggerimento: persistenti e temporanei. Per maggiori dettagli, vedi Suggerimenti. |
Campo unione content. I contenuti del messaggio dell'agente content possono essere solo uno dei seguenti: |
|
text |
Testo codificato in UTF-8. Massimo 3072 caratteri. |
fileName |
Il nome univoco di un file. La piattaforma RCS for Business restituisce un nome file quando un agente carica un file. Ritirato a favore di uploadedRbmFile di seguito. |
uploadedRbmFile |
Contiene gli identificatori di un file e di una miniatura caricati e pubblicati dal server RCS for Business. |
richCard |
Una scheda interattiva autonoma. |
contentInfo |
Informazioni su un file, inclusi l'URL del file e l'URL della miniatura del file. La piattaforma RCS for Business pubblica i contenuti da una cache, ma un agente può forzare la piattaforma RCS for Business a recuperare una nuova versione dei contenuti e aggiornare la cache. |
UploadedRbmFile
Messaggio contenente informazioni su file e miniature
| Rappresentazione JSON |
|---|
{ "fileName": string, "thumbnailName": string } |
| Campi | |
|---|---|
fileName |
Il nome del file, restituito dalla piattaforma RCS for Business al momento del caricamento. |
thumbnailName |
Il nome della miniatura, restituito dalla piattaforma RCS for Business al momento del caricamento. |
RichCard
Una scheda informativa autonoma o un carosello di schede informative inviate dall'agente all'utente.
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione card. Scheda autonoma o carosello di schede. card può essere solo uno dei seguenti tipi: |
|
carouselCard |
Carosello di schede. |
standaloneCard |
Scheda autonoma. |
CarouselCard
Carosello di schede.
| Rappresentazione JSON |
|---|
{ "cardWidth": enum ( |
| Campi | |
|---|---|
cardWidth |
La larghezza delle schede nel carosello. |
cardContents[] |
L'elenco dei contenuti per ogni scheda del carosello. Un carosello può contenere un minimo di 2 schede e un massimo di 10 schede. |
CarouselCard.CardWidth
La larghezza delle schede nel carosello.
| Enum | |
|---|---|
CARD_WIDTH_UNSPECIFIED |
Non specificato. |
SMALL |
120 DP. |
MEDIUM |
232 DP. |
CardContent
Contenuti della scheda
| Rappresentazione JSON |
|---|
{ "title": string, "description": string, "media": { object ( |
| Campi | |
|---|---|
title |
(Facoltativo) Titolo della scheda. Massimo 200 caratteri. |
description |
(Facoltativo) Descrizione della carta. Massimo 2000 caratteri. |
media |
(Facoltativo) Elementi multimediali (immagine, GIF, video, PDF) da includere nella scheda. |
suggestions[] |
(Facoltativo) Elenco di suggerimenti da includere nella scheda. Massimo 4 suggerimenti. |
Media
Un file multimediale all'interno di una scheda interattiva.
| Rappresentazione JSON |
|---|
{ "height": enum ( |
| Campi | |
|---|---|
height |
L'altezza dei contenuti multimediali all'interno di una scheda interattiva con layout verticale. Per una scheda autonoma con layout orizzontale, l'altezza non è personalizzabile e questo campo viene ignorato. |
Campo unione content. I contenuti multimediali content possono essere solo uno dei seguenti tipi: |
|
fileName |
Il nome univoco del file, restituito dalla piattaforma RCS for Business al momento del caricamento. Ritirato a favore di uploadedRbmFile di seguito. |
uploadedRbmFile |
Contiene gli identificatori di un file e di una miniatura caricati e pubblicati dal server RCS for Business. |
contentInfo |
Informazioni su un file, inclusi l'URL del file e l'URL della miniatura del file. La piattaforma RCS for Business pubblica i contenuti da una cache, ma un agente può forzare la piattaforma RCS for Business a recuperare una nuova versione dei contenuti e aggiornare la cache. |
ContentInfo
Messaggio contenente le informazioni sui contenuti.
| Rappresentazione JSON |
|---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean } |
| Campi | |
|---|---|
fileUrl |
URL del file raggiungibile pubblicamente. La piattaforma RCS for Business determina il tipo MIME del file dal campo Content-Type nelle intestazioni HTTP quando recupera il file. Il campo Content-Type deve essere presente e preciso nella risposta HTTP dell'URL. Dimensioni massime consigliate del file: 100 MB. Nota: i reindirizzamenti negli URL dei file non sono supportati. Utilizza CreateFileRequest se è necessario il reindirizzamento. |
thumbnailUrl |
(Facoltativo, solo per file immagine, audio e video) URL raggiungibile pubblicamente della miniatura. Dimensioni massime di 100 kB. Se non fornisci un URL della miniatura, la piattaforma RCS for Business visualizza una miniatura segnaposto vuota finché il dispositivo dell'utente non scarica il file. A seconda dell'impostazione dell'utente, il file potrebbe non essere scaricato automaticamente e potrebbe richiedere all'utente di toccare un pulsante di download. Nota: i reindirizzamenti negli URL dei file non sono supportati. Utilizza CreateFileRequest se è necessario il reindirizzamento. |
forceRefresh |
Se impostata, la piattaforma RCS for Business recupera il file e la miniatura dagli URL specificati, anche se la piattaforma ha copie memorizzate nella cache del file (e/o della miniatura). |
Media.Height
Altezza media
| Enum | |
|---|---|
HEIGHT_UNSPECIFIED |
Non specificato. |
SHORT |
112 DP. |
MEDIUM |
168 DP. |
TALL |
264 DP. |
Suggerimento
Una risposta suggerita o un'azione suggerita inclusa in una scheda avanzata o in un elenco di chip di suggerimenti.
| Rappresentazione JSON |
|---|
{ "suggestionDisplay": enum ( |
| Campi | |
|---|---|
suggestionDisplay |
Facoltativo. Controlla il comportamento di visualizzazione del suggerimento. Valido solo per i messaggi di testo normale inviati ai client Google Messaggi (versione 20260225.00 o successive). Questo campo deve essere impostato solo per i suggerimenti autonomi associati a messaggi di testo normale. Il server rifiuterà il messaggio se questo campo viene applicato ai suggerimenti nelle schede avanzate o ai suggerimenti autonomi con trasferimenti di file. Questa impostazione viene serializzata solo per Google Messaggi e viene ignorata da altri client (come iOS o Samsung). |
Campo unione option. Una risposta suggerita o un'azione suggerita. option può essere solo uno dei seguenti tipi: |
|
reply |
Gli utenti possono toccare una risposta suggerita per inviare la risposta di testo all'agente. |
action |
Gli utenti possono toccare un'azione suggerita per avviare l'azione nativa corrispondente sul dispositivo. |
SuggestedReply
Se toccata, invia la risposta di testo all'agente.
| Rappresentazione JSON |
|---|
{ "text": string, "postbackData": string } |
| Campi | |
|---|---|
text |
Testo mostrato nella risposta suggerita e inviato all'agente quando l'utente lo tocca. Massimo 25 caratteri. |
postbackData |
Il payload codificato in base64 che l'agente riceve in un evento utente quando l'utente tocca la risposta suggerita. |
SuggestedAction
Quando viene toccato, avvia l'azione nativa corrispondente sul dispositivo.
| Rappresentazione JSON |
|---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // Union field |
| Campi | |
|---|---|
text |
Testo visualizzato nell'azione suggerita. Massimo 25 caratteri. |
postbackData |
Payload (codificato in base64) che verrà inviato all'agente nell'evento utente che si verifica quando l'utente tocca l'azione suggerita. Massimo 2048 caratteri. |
fallbackUrl |
(Facoltativo) URL di riserva da utilizzare se un client non supporta un'azione suggerita. Gli URL di riserva si aprono in nuove finestre del browser. Deve essere un URI valido come definito nella RFC 3986. Massimo 2048 caratteri. |
Campo unione action. L'azione nativa avviata sul dispositivo quando l'utente tocca l'azione suggerita. action può essere solo uno dei seguenti tipi: |
|
dialAction |
Apre l'app per chiamate predefinita dell'utente con il numero di telefono specificato dall'agente compilato. |
viewLocationAction |
Apre l'app di mappe predefinita dell'utente e seleziona la posizione specificata dall'agente o esegue una ricerca nei dintorni della posizione dell'utente in base a una query specificata dall'agente. |
createCalendarEventAction |
Apre l'app calendario predefinita dell'utente e avvia il nuovo flusso di eventi nel calendario con i dati sugli eventi specificati dall'agente precompilati. |
openUrlAction |
Apre l'app del browser web predefinita dell'utente all'URL specificato. Se l'utente ha installato un'app registrata come gestore predefinito per l'URL, verrà aperta questa app e la sua icona verrà utilizzata nell'interfaccia utente dell'azione suggerita. |
shareLocationAction |
Apre il selettore della posizione dell'app RCS in modo che l'utente possa scegliere una posizione da inviare all'agente. |
DialAction
Apre l'app per chiamate predefinita dell'utente con il numero di telefono specificato dall'agente compilato.
| Rappresentazione JSON |
|---|
{ "phoneNumber": string } |
| Campi | |
|---|---|
phoneNumber |
Il numero di telefono in formato E.164, ad esempio +12223334444. |
ViewLocationAction
Apre l'app di mappe predefinita dell'utente e seleziona la posizione specificata dall'agente o esegue una ricerca nei dintorni della posizione dell'utente in base a una query specificata dall'agente.
| Rappresentazione JSON |
|---|
{
"latLong": {
object ( |
| Campi | |
|---|---|
latLong |
(Facoltativo) La latitudine e la longitudine della posizione specificata. |
label |
(Facoltativo) L'etichetta del segnaposto inserito in latLong. |
query |
(Facoltativo, supportato solo sui client Android Messages) Invece di specificare un valore latLong (e, facoltativamente, un'etichetta), l'agente può specificare una stringa di query. Per le app di mappe predefinite che supportano la funzionalità di ricerca (inclusa Google Maps), toccando questa azione suggerita viene eseguita una ricerca di una posizione centrata sulla posizione attuale dell'utente. Se la query è sufficientemente specifica, gli agenti possono utilizzarla per selezionare qualsiasi località al mondo. Ad esempio, se imposti la stringa di query su "Growing Tree Bank", verranno visualizzate tutte le sedi di Growing Tree Bank nelle vicinanze dell'utente. Se imposti la stringa di query su "1600 Amphitheater Parkway, Mountain View, CA 94043", verrà selezionato quell'indirizzo specifico, indipendentemente dalla posizione dell'utente. |
LatLng
Un oggetto che rappresenta una coppia di coordinate di latitudine e longitudine. Questi valori sono espressi come una coppia di numeri double per rappresentare i gradi di latitudine e longitudine. Se non diversamente specificato, questo oggetto deve essere conforme allo standard WGS84. I valori devono rientrare negli intervalli normalizzati.
| Rappresentazione JSON |
|---|
{ "latitude": number, "longitude": number } |
| Campi | |
|---|---|
latitude |
La latitudine in gradi. Deve essere compreso nell'intervallo [-90,0, +90,0]. |
longitude |
La longitudine in gradi. Deve essere compreso nell'intervallo [-180,0, +180,0]. |
CreateCalendarEventAction
Apre l'app calendario predefinita dell'utente e avvia il nuovo flusso di eventi nel calendario con i dati sugli eventi specificati dall'agente precompilati.
| Rappresentazione JSON |
|---|
{ "startTime": string, "endTime": string, "title": string, "description": string } |
| Campi | |
|---|---|
startTime |
Ora di inizio dell'evento. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
endTime |
Ora di fine dell'evento. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
title |
Titolo dell'evento. Massimo 100 caratteri. |
description |
Descrizione dell'evento. Massimo 500 caratteri. |
OpenUrlAction
Apre l'app del browser web predefinita dell'utente all'URL specificato. Se l'utente ha installato un'app registrata come gestore predefinito per l'URL, verrà aperta questa app e la sua icona verrà utilizzata nell'interfaccia utente dell'azione suggerita.
| Rappresentazione JSON |
|---|
{ "url": string, "application": enum ( |
| Campi | |
|---|---|
url |
L'URL da aprire. A partire dal 1° novembre 2025, lo schema dell'URL deve essere https:// o http://. Le richieste API che utilizzano altri schemi (ad es. tel:, mailto:, sms:) verranno rifiutate con un errore 400 Bad Request dopo questa data. L'URL deve essere un URI valido come definito nella RFC 3986. Massimo 2048 caratteri. |
application |
URL open application, browser, or webview. Per verificare se il dispositivo di un utente supporta la modalità WebView, esegui prima un controllo delle funzionalità. Per maggiori dettagli, consulta la documentazione: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities. |
webviewViewMode |
Modalità di visualizzazione per WebView. |
description |
Descrizione per l'accessibilità per la webview. |
OpenUrlApplication
Tipo di applicazione di apertura dell'URL
| Enum | |
|---|---|
OPEN_URL_APPLICATION_UNSPECIFIED |
Non specificato, verrà utilizzato il browser per l'apertura. |
BROWSER |
Utilizza il browser per aprire l'URL. |
WEBVIEW |
Apri l'URL in una finestra di visualizzazione web integrata |
WebviewViewMode
Tipo di modalità di visualizzazione della webview.
| Enum | |
|---|---|
WEBVIEW_VIEW_MODE_UNSPECIFIED |
Non specificato. Per utilizzare WebView, è necessario specificare una modalità di visualizzazione. |
FULL |
Richiede un overlay schermo intero con la conversazione con il chatbot etichettata nella barra di stato. |
HALF |
Richiede un overlay schermo a metà. |
TALL |
Richiede un overlay schermo di tre quarti. |
Suggestion.SuggestionDisplay
Il comportamento di visualizzazione dei suggerimenti di testo autonomi.
| Enum | |
|---|---|
SUGGESTION_DISPLAY_UNSPECIFIED |
I client adottano il comportamento di visualizzazione predefinito:
|
PERSISTENT |
Il suggerimento rimane visibile in modo permanente all'interno della bolla del messaggio, anche quando vengono aggiunti nuovi messaggi alla conversazione. |
StandaloneCard
Scheda autonoma
| Rappresentazione JSON |
|---|
{ "cardOrientation": enum ( |
| Campi | |
|---|---|
cardOrientation |
Orientamento della scheda. |
thumbnailImageAlignment |
Allineamento dell'anteprima dell'immagine per le schede autonome con layout orizzontale. |
cardContent |
Contenuti della scheda. |
StandaloneCard.CardOrientation
Orientamento della scheda.
| Enum | |
|---|---|
CARD_ORIENTATION_UNSPECIFIED |
Non specificato. |
HORIZONTAL |
Layout orizzontale. Se il campo |
VERTICAL |
Layout verticale. |
StandaloneCard.ThumbnailImageAlignment
Allineamento dell'anteprima dell'immagine per le schede autonome con layout orizzontale.
| Enum | |
|---|---|
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED |
Non specificato. |
LEFT |
L'anteprima del file è allineata a sinistra. |
RIGHT |
L'anteprima del file è allineata a destra. |
MessageTrafficType
Tipi di traffico dei messaggi supportati. L'enumerazione verrà estesa per supportare altri tipi di traffico.
| Enum | |
|---|---|
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED |
Comportamento predefinito: il tipo di traffico dei messaggi è determinato dal caso d'uso dell'agente. Aggiorna il tipo di traffico in base alle esigenze in base ai contenuti del messaggio. Per gli agenti multiuso, non viene fornito alcun valore predefinito. Il tipo di traffico deve essere impostato manualmente (ad es. TRANSACTION, PROMOTION). |
AUTHENTICATION |
Per i messaggi di autenticazione nel caso d'uso dell'agente OTP. |
TRANSACTION |
Per i messaggi transazionali nei casi d'uso dell'agente transazionale o multiuso. |
PROMOTION |
Per i messaggi promozionali nei casi d'uso dell'agente promozionale o multiuso. |
SERVICEREQUEST |
Per i messaggi relativi ai servizi che l'utente ha acconsentito a ricevere. Utilizzato nei casi d'uso di agenti OTP, transazionali, promozionali o multiuso. |
ACKNOWLEDGEMENT |
Per i messaggi che confermano la richiesta di annullamento dell'iscrizione dell'utente. Utilizzato nei casi d'uso di agenti OTP, transazionali, promozionali o multiuso. |
RichMessageClassification
Solo per la fatturazione negli Stati Uniti: dettagli sulle classificazioni dei messaggi utilizzate per la fatturazione.
| Rappresentazione JSON |
|---|
{
"classificationType": enum ( |
| Campi | |
|---|---|
classificationType |
|
segmentCount |
Il numero di segmenti di 160 byte per il testo del messaggio, sempre arrotondato per eccesso. Calcolato in base alla lunghezza totale in byte UTF-8 del solo contenuto di testo; i dati delle risposte o delle azioni suggerite sono esclusi. Ad esempio, un messaggio di testo lungo 300 byte ha un segmentCount di 2. Questo campo viene compilato solo per i tipi RICH_MESSAGE. |
RichMessageClassificationType
Solo per la fatturazione negli Stati Uniti: specifica la classificazione del messaggio ai fini della fatturazione.
Importante:gli operatori statunitensi impostano il prezzo per i tipi di messaggi fatturabili descritti in questa pagina. Gli operatori statunitensi determinano anche l'addebito finale dello sviluppatore per l'invio di messaggi RCS for Business. Per ulteriori informazioni su prezzi o dati di fatturazione, contatta i rappresentanti dell'operatore appropriato.
| Enum | |
|---|---|
RICH_MESSAGE_CLASSIFICATION_TYPE_UNSPECIFIED |
Non specificato |
RICH_MESSAGE |
Il messaggio viene classificato come RICH alle seguenti condizioni: 1. Non contiene schede interattive. 2. Non contiene allegati. 3. Tutte le azioni suggerite che contiene devono essere un'azione Chiama o Apri URL che non utilizza una webview. |
RICH_MEDIA_MESSAGE |
Qualsiasi messaggio che non soddisfa i criteri RICH_MESSAGE. Sono inclusi i messaggi contenenti una scheda avanzata, un file multimediale o qualsiasi azione suggerita diversa da Chiama o Apri URL nel browser. |
SUGGESTED_ACTION_CLICK |
Rappresenta il tocco di un utente su un'azione suggerita (non una risposta suggerita). Questa classificazione si applica solo alle azioni dell'utente e viene visualizzata esclusivamente nel payload UserMessage di un webhook. Non si applica ai messaggi A2P. |
Metodi |
|
|---|---|
|
Invia un messaggio dall'agente a un utente. |
|
Revoca un messaggio dell'agente che è stato inviato ma non ancora consegnato. |