Risorsa: messaggio
Un messaggio in una conversazione tra un agente e un utente.
Rappresentazione JSON |
---|
{ "name": string, "messageId": string, "representative": { object ( |
Campi | |
---|---|
name |
Il nome del messaggio, impostato in Business Messages. Viene risolto in "conversations/{conversationId}/messages/{messageId}", dove {conversationId} è l'ID univoco della conversazione e {messageId} è l'ID univoco del messaggio. |
messageId |
Obbligatorio. L'identificatore univoco del messaggio assegnato dall'agente. Se un messaggio tenta di utilizzare lo stesso |
representative |
Dettagli sul rappresentante (umano o chatbot) che ha inviato il messaggio. |
suggestions[] |
Un elenco di risposte suggerite che vengono visualizzate come elenco di chip di suggerimenti che seguono il messaggio associato. Massimo 13 suggerimenti. I chip vengono visualizzati solo quando il messaggio associato è quello più recente nella conversazione, inclusi i messaggi dell'agente e degli utenti. L'utente può toccare una risposta suggerita per inviare la risposta testuale all'agente. |
fallback |
Campo facoltativo. Testo di riserva che viene visualizzato se il dispositivo dell'utente non supporta il tipo o i contenuti del messaggio. Massimo 3072 caratteri. |
containsRichText |
Campo facoltativo. Se |
Campo di unione content . I contenuti di un messaggio. content può essere solo uno dei seguenti: |
|
text |
Messaggio di testo. Massimo 3072 caratteri. |
image |
Messaggio immagine. |
richCard |
Messaggio scheda informativa. |
Immagine
Un'immagine.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo di unione content . Contenuti delle immagini. content può essere solo uno dei seguenti: |
|
contentInfo |
Informazioni su un'immagine, tra cui l'URL dell'immagine e l'URL della miniatura dell'immagine. |
ContentInfo
Messaggio contenente le informazioni sui contenuti.
Rappresentazione JSON |
---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean, "altText": string } |
Campi | |
---|---|
fileUrl |
URL raggiungibile pubblicamente del file. La piattaforma 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 dall'URL. Massimo 5 MB. Tipi di contenuti supportati: image/jpeg, image/jpg, image/png, image/webp |
thumbnailUrl |
Campo facoltativo. URL raggiungibile pubblicamente della miniatura. Se non fornisci un URL miniatura, la piattaforma visualizza una miniatura segnaposto vuota fino a quando il dispositivo dell'utente non scarica il file. Massimo 25 kB. Tipi di contenuti supportati: image/jpeg, image/jpg, image/png, image/webp |
forceRefresh |
Se impostata, la piattaforma recupera il file e la miniatura dagli URL specificati, anche se ha copie cache del file (e/o della miniatura). |
altText |
Testo che descrive i dettagli dei contenuti multimediali per motivi di accessibilità. |
RichCard
Una scheda informativa indipendente o un carosello di schede interattive inviate dall'agente all'utente.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo di unione card . Possibili tipi di schede interattive. card può essere solo uno dei seguenti: |
|
standaloneCard |
Scheda indipendente. |
carouselCard |
Carosello di schede. |
StandaloneCard
Scheda indipendente.
Rappresentazione JSON |
---|
{
"cardContent": {
object ( |
Campi | |
---|---|
cardContent |
Contenuti della scheda. |
CardContent
Contenuti della scheda.
Rappresentazione JSON |
---|
{ "title": string, "description": string, "media": { object ( |
Campi | |
---|---|
title |
Campo facoltativo. Titolo della scheda. Massimo 200 caratteri. |
description |
Campo facoltativo. Descrizione della carta. Massimo 2000 caratteri. |
media |
Campo facoltativo. Contenuti multimediali da includere nella scheda. |
suggestions[] |
Campo facoltativo. Elenco di suggerimenti da includere nella scheda. Massimo 4 suggerimenti. |
Contenuti multimediali
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. |
Campo di unione content . Contenuti multimediali. content può essere solo uno dei seguenti: |
|
contentInfo |
Informazioni su un file, inclusi l'URL del file e l'URL della relativa miniatura. |
Altezza
Altezza media
Enum | |
---|---|
HEIGHT_UNSPECIFIED |
Non specificato. |
SHORT |
112 DP. |
MEDIUM |
168 DP. |
TALL |
264 DP. Non disponibile per i caroselli di schede interattive quando la larghezza delle schede è impostata su SMALL . |
Suggerimento
Un suggerimento all'interno di un elenco di chip.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo di unione option . Una risposta suggerita. option può essere solo uno dei seguenti: |
|
reply |
Un suggerimento che invita l'utente a rispondere con il testo specificato. |
action |
Azione suggerita che avvia un'azione nativa sul dispositivo. |
liveAgentRequest |
Richiesta di partecipazione di un operatore alla conversazione. |
authenticationRequest |
Richiesta di avvio del flusso di autenticazione. |
SuggestedReply
Quando l'utente lo tocca, invia il messaggio di risposta all'agente.
Rappresentazione JSON |
---|
{ "text": string, "postbackData": string } |
Campi | |
---|---|
text |
Testo visualizzato nella risposta suggerita e inviato all'agente quando l'utente la tocca. Massimo 25 caratteri. |
postbackData |
La stringa che l'agente riceve quando un utente tocca la risposta suggerita. Massimo 2048 caratteri. |
SuggestedAction
Se l'utente lo tocca, avvia l'azione nativa corrispondente sul dispositivo.
Rappresentazione JSON |
---|
{ "text": string, "postbackData": string, // Union field |
Campi | |
---|---|
text |
Testo visualizzato nell'azione suggerita. Massimo 25 caratteri. |
postbackData |
La stringa che l'agente riceve quando un utente tocca l'azione suggerita. Massimo 2048 caratteri. |
Campo di unione action . L'azione nativa avviata sul dispositivo quando l'utente tocca l'azione suggerita. action può essere solo uno dei seguenti: |
|
openUrlAction |
Apre l'URL specificato. |
dialAction |
Consente di aprire l'app tastiera predefinita dell'utente. |
OpenUrlAction
Apre l'URL specificato.
Rappresentazione JSON |
---|
{ "url": string } |
Campi | |
---|---|
url |
URL |
DialAction
Consente di aprire l'app tastiera predefinita dell'utente con il numero di telefono specificato inserito.
Rappresentazione JSON |
---|
{ "phoneNumber": string } |
Campi | |
---|---|
phoneNumber |
Obbligatorio. Il numero di telefono specificato, in formato RFC 3966. Ad esempio, "+1-201-555-0123". |
LiveAgentRequest
Questo tipo non contiene campi.
Quando l'utente tocca il pulsante, invia una richiesta a un agente umano di partecipare alla conversazione.
AuthenticationRequest
Richiedi l'autenticazione di una conversazione.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo di unione authentication_type . Il tipo di autenticazione. authentication_type può essere solo uno dei seguenti: |
|
oauth |
Dettagli per l'autenticazione tramite OAuth. |
OAuth
Dettagli per l'autenticazione tramite OAuth.
Rappresentazione JSON |
---|
{ "clientId": string, "codeChallenge": string, "scopes": [ string ], "codeChallengeMethod": string } |
Campi | |
---|---|
clientId |
Obbligatorio. L'ID dell'applicazione che richiede l'autorizzazione. |
codeChallenge |
Obbligatorio. La verifica del codice utilizzata per lo scambio dei token di accesso. |
scopes[] |
Obbligatorio. Un array che specifica gli ambiti della richiesta. |
codeChallengeMethod |
Campo facoltativo. Il metodo di verifica del codice utilizzato per generare la verifica del codice. Se questo parametro viene omesso, il server presuppone che il valore sia |
CarouselCard
Carosello di schede.
Rappresentazione JSON |
---|
{ "cardWidth": enum ( |
Campi | |
---|---|
cardWidth |
La larghezza delle schede nel carosello. |
cardContents[] |
L'elenco dei contenuti per ciascuna scheda nel carosello. Un carosello può avere un minimo di 2 e un massimo di 10 schede. |
CardWidth
La larghezza delle schede nel carosello.
Enum | |
---|---|
CARD_WIDTH_UNSPECIFIED |
Non specificato |
SMALL |
136 DP. Non può includere contenuti multimediali alti. |
MEDIUM |
280 DP. |
Metodi |
|
---|---|
|
Invia un messaggio da un agente a un utente. |
|
Invia la ricevuta di un messaggio da un agente a un utente. |