REST Resource: conversations.messages

Risorsa: messaggio

Un messaggio in una conversazione tra un agente e un utente.

Rappresentazione JSON 
{
  "name": string,
  "messageId": string,
  "representative": {
    object (Representative)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "fallback": string,
  "containsRichText": boolean,

  // Union field content can be only one of the following:
  "text": string,
  "image": {
    object (Image)
  },
  "richCard": {
    object (RichCard)
  }
  // End of list of possible types for union field content.
}
Campi
name

string

Il nome del messaggio, come impostato da Business Messages. Risolve in "conversations/{conversationId}/messages/{messageId}", dove {conversationId} è l'ID univoco della conversazione e {messageId} è l'ID univoco del messaggio.
messageId

string

Obbligatorio. L'identificatore univoco del messaggio, assegnato dall'agente. Se un messaggio tenta di utilizzare lo stesso messageId di un messaggio precedente, la consegna corretta del messaggio potrebbe risentirne.
representative

object (Representative)

Dettagli sul rappresentante (umano o chatbot) che ha inviato il messaggio.
suggestions[]

object (Suggestion)

Un elenco di risposte suggerite che viene visualizzato come elenco di chip di suggerimento dopo il messaggio associato. Massimo 13 suggerimenti.

I chip vengono visualizzati solo quando il messaggio associato è il messaggio più recente all'interno della conversazione (inclusi i messaggi dell'agente e quelli degli utenti). L'utente può toccare una risposta suggerita per inviare la risposta testuale all'agente.
fallback

string

(Facoltativo) Testo di riserva visualizzato se il dispositivo dell'utente non supporta il tipo di messaggio o i contenuti. Massimo 3072 caratteri.
containsRichText

boolean

(Facoltativo) Se true, indica che il messaggio contiene rich text. Se il messaggio contiene una formattazione non valida, Business Messages restituisce un errore.
Campo unione content. Il contenuto di un messaggio. content può essere solo uno dei seguenti:
text

string

Messaggio di testo. Massimo 3072 caratteri.
image

object (Image)

Messaggio immagine.
richCard

object (RichCard)

Messaggio della scheda interattiva.

Immagine

Un'immagine.

Rappresentazione JSON 
{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Campi
Campo unione content. Contenuti dell'immagine. content può essere solo uno dei seguenti:
contentInfo

object (ContentInfo)

Informazioni su un'immagine, tra cui l'URL e l'URL della miniatura.

ContentInfo

Messaggio contenente le informazioni sui contenuti.

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

string

URL del file raggiungibile pubblicamente. La piattaforma 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.

Massimo 5 MB.

Tipi di contenuti supportati: image/jpeg, image/jpg, image/png, image/webp
thumbnailUrl

string

(Facoltativo) URL della miniatura raggiungibile pubblicamente.

Se non fornisci un URL della miniatura, la piattaforma mostrerà una miniatura segnaposto vuota finché il dispositivo dell'utente non scarica il file.

Massimo 25 kB.

Tipi di contenuti supportati: image/jpeg, image/jpg, image/png, image/webp
forceRefresh

boolean

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

string

Testo che descrive i dettagli dei contenuti multimediali per motivi di accessibilità.

RichCard

Una scheda interattiva indipendente o un carosello di schede interattive inviate dall'agente all'utente.

Rappresentazione JSON 
{

  // Union field card can be only one of the following:
  "standaloneCard": {
    object (StandaloneCard)
  },
  "carouselCard": {
    object (CarouselCard)
  }
  // End of list of possible types for union field card.
}
Campi
Campo unione card. Possibili tipi di schede informative. card può essere solo uno dei seguenti:
standaloneCard

object (StandaloneCard)

Scheda autonoma.
carouselCard

object (CarouselCard)

Carosello di schede.

StandaloneCard

Scheda autonoma.

Rappresentazione JSON 
{
  "cardContent": {
    object (CardContent)
  }
}
Campi
cardContent

object (CardContent)

Contenuti della scheda.

CardContent

Contenuti della scheda.

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

string

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

string

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

object (Media)

(Facoltativo) I contenuti multimediali da includere nella scheda.
suggestions[]

object (Suggestion)

(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 (Height),

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Campi
height

enum (Height)

L'altezza dei contenuti multimediali in una scheda interattiva.
Campo unione content. Contenuti multimediali. content può essere solo uno dei seguenti:
contentInfo

object (ContentInfo)

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

Altezza

Altezza media

Enum
HEIGHT_UNSPECIFIED Non specificato.
SHORT 112 DP.
MEDIUM 168 DP.
TALL 264 DP. Non disponibile per i caroselli di schede informative quando la larghezza della scheda è impostata su SMALL.

Suggerimento

Un suggerimento all'interno di un elenco di chip.

Rappresentazione JSON 
{

  // Union field option can be only one of the following:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  },
  "liveAgentRequest": {
    object (LiveAgentRequest)
  },
  "authenticationRequest": {
    object (AuthenticationRequest)
  }
  // End of list of possible types for union field option.
}
Campi
Campo unione option. Una risposta suggerita. option può essere solo uno dei seguenti:
reply

object (SuggestedReply)

Un suggerimento per consentire all'utente di rispondere con un testo specificato.
action

object (SuggestedAction)

Un'azione suggerita che avvia un'azione nativa sul dispositivo.
liveAgentRequest

object (LiveAgentRequest)

Una richiesta di partecipazione di un operatore alla conversazione.
authenticationRequest

object (AuthenticationRequest)

Una richiesta di avvio del flusso di autenticazione.

SuggestedReply

Se toccato, invia il messaggio di risposta all'agente.

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

string

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

string

La stringa che l'agente riceve quando un utente tocca la risposta suggerita. Massimo 2048 caratteri.

SuggestedAction

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

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

  // Union field action can be only one of the following:
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "dialAction": {
    object (DialAction)
  }
  // End of list of possible types for union field action.
}
Campi
text

string

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

string

La stringa che l'agente riceve quando un utente tocca l'azione suggerita. 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:
openUrlAction

object (OpenUrlAction)

Apre l'URL specificato.
dialAction

object (DialAction)

Apre l'app Telefono predefinita dell'utente.

OpenUrlAction

Apre l'URL specificato.

Rappresentazione JSON 
{
  "url": string
}
Campi
url

string

URL

DialAction

Consente di aprire l'app Telefono predefinita dell'utente con il numero di telefono specificato compilato.

Rappresentazione JSON 
{
  "phoneNumber": string
}
Campi
phoneNumber

string

Obbligatorio. Il numero di telefono specificato, nel formato RFC 3966. Ad esempio, "+1-201-555-0123".

LiveAgentRequest

Questo tipo non contiene campi.

Se lo tocchi, invia una richiesta a un operatore per partecipare alla conversazione.

AuthenticationRequest

Richiesta di autenticazione di una conversazione.

Rappresentazione JSON 
{

  // Union field authentication_type can be only one of the following:
  "oauth": {
    object (Oauth)
  }
  // End of list of possible types for union field authentication_type.
}
Campi
Campo unione authentication_type. Il tipo di autenticazione. authentication_type può essere solo uno dei seguenti:
oauth

object (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

string

Obbligatorio. L'ID dell'applicazione che richiede l'autorizzazione.
codeChallenge

string

Obbligatorio. La verifica del codice utilizzata per lo scambio dei token di accesso.
scopes[]

string

Obbligatorio. Un array che specifica gli ambiti della richiesta.
codeChallengeMethod

string

(Facoltativo) Il metodo di verifica del codice utilizzato per generare la verifica del codice. Se questo parametro viene omesso, il server presume plain.

CarouselCard

Carosello di schede.

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

enum (CardWidth)

La larghezza delle schede nel carosello.
cardContents[]

object (CardContent)

L'elenco dei contenuti per ogni scheda nel carosello. Un carosello può avere un minimo di 2 schede e un massimo di 10 schede.

CardWidth

La larghezza delle schede nel carosello.

Enum
CARD_WIDTH_UNSPECIFIED Non specificato
SMALL 136 DP. Non è possibile includere contenuti multimediali alti.
MEDIUM 280 dP.

Metodi

create

 Invia un messaggio da un agente a un utente.

updateReceipt

 Invia una conferma per un messaggio da un agente a un utente.