REST Resource: phones.agentMessages

Risorsa: AgentMessage

Un messaggio inviato dall'agente a un utente.

Rappresentazione 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.
}
Campi
name

string

Questo campo è impostato dalla piattaforma RBM. Non includerlo durante la creazione di un messaggio agente. Il campo risolve "phones/{E.164}/agentMessage/{messageId}", dove {E.164} è il numero di telefono dell'utente in formato E.164 e {messageId} è l'ID assegnato dall'agente del messaggio dell'agente.
sendTime

string (Timestamp format)

Questo campo è impostato dalla piattaforma RBM. Non includerlo durante la creazione di un messaggio agente. Il campo indica la data e l'ora in cui il messaggio viene inviato all'utente.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
contentMessage

object (AgentContentMessage)

Il contenuto del messaggio dell'agente.

Campo di unione expiration.

expiration può essere solo uno dei seguenti:
expireTime

string (Timestamp format)

Campo facoltativo. Timestamp in UTC di quando questa risorsa è considerata scaduta. Questo valore viene fornito nell'output se è impostato o se il campo TTL è impostato.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
ttl

string (Duration format)

Campo facoltativo. Solo input. La durata della pubblicazione del messaggio prima che venga revocato automaticamente.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

AgentContentMessage

I contenuti di un messaggio inviato dall'agente a un utente.

Rappresentazione 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.
}
Campi
suggestions[]

object (Suggestion)

Un elenco di risposte suggerite e azioni suggerite 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 è quello più recente all'interno della conversazione, inclusi i messaggi dell'agente e dell'utente. L'utente può toccare una risposta suggerita per inviare la risposta testuale all'agente o toccare un'azione suggerita per avviare un'azione nativa sul dispositivo.
Campo di unione content. Il contenuto del messaggio dell'agente content può essere solo uno dei seguenti:
text

string

Testo con codifica UTF-8.
fileName
(deprecated)

string

Il nome univoco di un file. La piattaforma RBM restituisce un nome file quando un agente carica un file. Interrotto a favore di uploadRbmFile di seguito
uploadedRbmFile

object (UploadedRbmFile)

Contiene identificatori di un file e di una miniatura caricati e pubblicati dal server RBM
richCard

object (RichCard)

Una scheda informativa a sé stante.
contentInfo

object (ContentInfo)

Informazioni su un file, tra cui l'URL del file e l'URL della relativa miniatura.

La piattaforma RBM gestisce i contenuti da una cache, ma un agente può forzare la piattaforma RBM a recuperare una nuova versione dei contenuti e aggiornare la cache.

UploadedRbmFile

Messaggio contenente informazioni sul file e sulla miniatura

Rappresentazione JSON 
{
  "fileName": string,
  "thumbnailName": string
}
Campi
fileName

string

Il nome del file, restituito dalla piattaforma RBM al momento del caricamento del file.
thumbnailName

string

Il nome della miniatura, restituito dalla piattaforma RBM al momento del caricamento della miniatura.

RichCard

Una scheda informativa a sé stante o un carosello di schede informative inviate dall'agente all'utente.

Rappresentazione 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.
}
Campi
Campo di unione card. Una scheda indipendente o un carosello di schede. card può essere solo uno dei seguenti:
carouselCard

object (CarouselCard)

Carosello di schede.
standaloneCard

object (StandaloneCard)

Scheda autonoma.

CarouselCard

Carosello di schede.

Rappresentazione JSON 
{
  "cardWidth": enum (CarouselCard.CardWidth),
  "cardContents": [
    {
      object (CardContent)
    }
  ]
}
Campi
cardWidth

enum (CarouselCard.CardWidth)

La larghezza delle schede nel carosello.
cardContents[]

object (CardContent)

L'elenco dei contenuti di ogni scheda nel carosello. Un carosello può avere 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. Tieni presente che non è possibile utilizzare contenuti multimediali alti.
MEDIUM 232 DP.

CardContent

Contenuto della scheda

Rappresentazione JSON 
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
Campi
title

string

(Facoltativo) Titolo della carta. Massimo 200 caratteri.
description

string

(Facoltativo) Descrizione della carta. Massimo 2000 caratteri.
media

object (Media)

(Facoltativo) Contenuti multimediali (immagini, GIF, video) da includere nella scheda.
suggestions[]

object (Suggestion)

(Facoltativo) Elenco di suggerimenti da includere nella scheda. Massimo 4 suggerimenti.

Contenuti multimediali

Un file multimediale all'interno di una scheda informativa.

Rappresentazione 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.
}
Campi
height

enum (Media.Height)

L'altezza dell'elemento multimediale all'interno di una scheda informativa con layout verticale. Per una scheda autonoma con layout orizzontale, l'altezza non è personalizzabile e questo campo viene ignorato.
Campo di unione content. Il contenuto multimediale content può essere solo uno dei seguenti:
fileName
(deprecated)

string

Il nome univoco del file, restituito dalla piattaforma RBM al momento del caricamento del file. Interrotto a favore di uploadRbmFile di seguito
uploadedRbmFile

object (UploadedRbmFile)

Contiene identificatori di un file e di una miniatura caricati e pubblicati dal server RBM
contentInfo

object (ContentInfo)

Informazioni su un file, tra cui l'URL del file e l'URL della relativa miniatura.

La piattaforma RBM gestisce i contenuti da una cache, ma un agente può forzare la piattaforma RBM a recuperare una nuova versione dei contenuti e aggiornare la cache.

ContentInfo

Messaggio contenente informazioni sui contenuti.

Rappresentazione JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean
}
Campi
fileUrl

string

URL del file raggiungibile pubblicamente. La piattaforma RBM determina il tipo MIME del file dal campo content-type nelle intestazioni HTTP quando la piattaforma recupera il file. Il campo content-type deve essere presente e preciso nella risposta HTTP dell'URL. La dimensione massima consigliata del file è 100 MB.
thumbnailUrl

string

(Facoltativo, solo per file immagine e video) URL raggiungibile pubblicamente della miniatura. Dimensione massima 100 kB.

Se non fornisci un URL miniatura, la piattaforma RBM visualizza una miniatura segnaposto vuota fino a quando 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.
forceRefresh

boolean

Se impostata, la piattaforma RBM recupera il file e la miniatura dagli URL specificati, anche se la piattaforma dispone di copie del file memorizzate nella cache (e/o della miniatura).

Media.Height

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 della scheda è impostata su piccola.

Suggerimento

Una risposta suggerita o un'azione suggerita inclusa in una scheda informativa o in un elenco di chip di suggerimento.

Rappresentazione 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.
}
Campi
Campo di unione option. Una risposta suggerita o un'azione suggerita option può essere solo una delle seguenti:
reply

object (SuggestedReply)

Gli utenti possono toccare una risposta suggerita per inviarla all'agente.
action

object (SuggestedAction)

Gli utenti possono toccare un'azione suggerita per avviare l'azione nativa corrispondente sul dispositivo.

SuggestedReply

Se toccato, l'SMS risponde all'agente.

Rappresentazione JSON 
{
  "text": string,
  "postbackData": string
}
Campi
text

string

Testo visualizzato nella risposta suggerita e inviato di nuovo all'agente quando l'utente lo tocca. Massimo 25 caratteri.
postbackData

string

Payload con codifica Base64 che l'agente riceve in un evento utente quando l'utente tocca la risposta suggerita.

SuggestedAction

Se toccato, avvia l'azione nativa corrispondente sul dispositivo.

Rappresentazione 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.
}
Campi
text

string

Testo visualizzato nell'azione suggerita. Massimo 25 caratteri.
postbackData

string

Payload (con codifica Base64) che verrà inviato all'agente nell'evento utente generato quando l'utente tocca l'azione suggerita
fallbackUrl

string

(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.
Campo di unione action. L'azione nativa avviata sul dispositivo quando l'utente tocca l'azione suggerita action può essere solo una delle seguenti:
dialAction

object (DialAction)

Apre l'app tastiera predefinita dell'utente in cui è compilato il numero di telefono specificato dall'agente.
viewLocationAction

object (ViewLocationAction)

Apre l'app di mappe predefinita dell'utente e seleziona la posizione specificata dall'agente o esegue ricerche intorno alla posizione dell'utente in base a una query specificata dall'agente.
createCalendarEventAction

object (CreateCalendarEventAction)

Apre l'app di calendario predefinita dell'utente e avvia il nuovo flusso di eventi di calendario con i dati sugli eventi specificati dall'agente precompilati.
openUrlAction

object (OpenUrlAction)

Apre l'app browser web predefinita dell'utente nell'URL specificato. Se l'utente ha installato un'app che è registrata come gestore predefinito dell'URL, verrà aperta questa app e la relativa icona verrà utilizzata nell'interfaccia utente delle azioni suggerite.
shareLocationAction

object (ShareLocationAction)

Apre il selettore di posizione dell'app RCS per consentire all'utente di scegliere una posizione da inviare all'agente.

DialAction

Apre l'app tastiera predefinita dell'utente in cui è compilato il numero di telefono specificato dall'agente.

Rappresentazione JSON 
{
  "phoneNumber": string
}
Campi
phoneNumber

string

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 ricerche intorno alla posizione dell'utente in base a una query specificata dall'agente.

Rappresentazione JSON 
{
  "latLong": {
    object (LatLng)
  },
  "label": string,
  "query": string
}
Campi
latLong

object (LatLng)

(Facoltativo) La latitudine e la longitudine della posizione specificata.
label

string

(Facoltativo) L'etichetta del segnaposto inserito in corrispondenza di latLong.
query

string

(Facoltativo, supportato solo sui client Android Messaggi) Anziché specificare latLong (e, facoltativamente, un'etichetta), l'agente può specificare una stringa di query. Per le app predefinite delle mappe che supportano la funzionalità di ricerca (compreso Google Maps), toccando questa azione suggerita viene avviato una ricerca della posizione centrata sulla posizione corrente dell'utente. Se la query è sufficientemente specifica, gli agenti possono utilizzarla per selezionare qualsiasi località nel mondo.

Ad esempio, se imposti la stringa di query su "Growing Tree Bank", verranno mostrate 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 località dell'utente.

LatLng

Un oggetto che rappresenta una coppia latitudine/longitudine. Questo valore è espresso come una coppia di doppi per rappresentare i gradi di latitudine e i gradi di longitudine. Se non diversamente specificato, questo oggetto deve essere conforme allo standard WGS84. I valori devono essere compresi negli intervalli normalizzati.

Rappresentazione JSON 
{
  "latitude": number,
  "longitude": number
}
Campi
latitude

number

Latitudine in gradi. Deve essere compreso nell'intervallo [-90,0, +90,0].
longitude

number

Longitudine in gradi. Deve essere compreso nell'intervallo [-180,0, +180,0].

CreateCalendarEventAction

Apre l'app di calendario predefinita dell'utente e avvia il nuovo flusso di eventi di calendario con i dati sugli eventi specificati dall'agente precompilati.

Rappresentazione JSON 
{
  "startTime": string,
  "endTime": string,
  "title": string,
  "description": string
}
Campi
startTime

string (Timestamp format)

Ora di inizio dell'evento.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Ora di fine dell'evento.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
title

string

Titolo dell'evento.
description

string

Descrizione dell'evento.

OpenUrlAction

Apre l'app browser web predefinita dell'utente con l'URL specificato. Se l'utente ha installato un'app che è registrata come gestore predefinito dell'URL, verrà aperta questa app e la relativa icona verrà utilizzata nell'interfaccia utente delle azioni suggerite.

Rappresentazione JSON 
{
  "url": string
}
Campi
url

string

URL

ShareLocationAction

Questo tipo non contiene campi.

Apre il selettore di posizione dell'app RCS per consentire all'utente di scegliere una posizione da inviare all'agente.

StandaloneCard

Scheda autonoma

Rappresentazione JSON 
{
  "cardOrientation": enum (StandaloneCard.CardOrientation),
  "thumbnailImageAlignment": enum (StandaloneCard.ThumbnailImageAlignment),
  "cardContent": {
    object (CardContent)
  }
}
Campi
cardOrientation

enum (StandaloneCard.CardOrientation)

Orientamento della scheda.
thumbnailImageAlignment

enum (StandaloneCard.ThumbnailImageAlignment)

Allineamento dell'anteprima dell'immagine per le schede indipendenti con layout orizzontale.
cardContent

object (CardContent)

Contenuti della scheda.

StandaloneCard.CardOrientation

Orientamento della scheda.

Enum
CARD_ORIENTATION_UNSPECIFIED Non specificato.
HORIZONTAL

Layout orizzontale.

Se il campo object(CardContent) di una scheda interattiva orizzontale contiene il campo media, deve anche includere almeno un campo title, description o suggestions[].
VERTICAL Layout verticale.

StandaloneCard.ThumbnailImageAlignment

Allineamento dell'anteprima dell'immagine per le schede indipendenti 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.

Metodi

create

 Invia un messaggio dall'agente a un utente.

delete

 Revoca un messaggio dell'agente che è stato inviato ma non ancora consegnato.