REST Resource: conversations.messages

Ressource: Nachricht

Eine Nachricht in einer Unterhaltung zwischen einem Agent und einem Nutzer.

JSON-Darstellung 
{
  "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.
}
Felder
name

string

Der in Business Messages festgelegte Name der Nachricht. Wird in „conversations/{conversationId}/messages/{messageId}“ zurückgegeben, wobei {conversationId} die eindeutige ID für die Unterhaltung und {messageId} die eindeutige ID für die Nachricht ist.
messageId

string

Erforderlich. Die eindeutige Kennung der Nachricht, die vom Agent zugewiesen wurde. Wenn eine Nachricht versucht, denselben messageId wie bei einer vorherigen Nachricht zu verwenden, kann sich das auf die korrekte Zustellung der Nachricht auswirken.
representative

object (Representative)

Details zum Mitarbeiter oder Chatbot, der die Nachricht gesendet hat
suggestions[]

object (Suggestion)

Eine Liste mit Antwortvorschlägen, die nach der verknüpften Nachricht als Vorschlags-Chips angezeigt werden. Maximal 13 Vorschläge.

Die Chips werden nur angezeigt, wenn die zugehörige Nachricht die neueste Nachricht in der Unterhaltung ist (einschließlich Agent- und Nutzernachrichten). Der Nutzer kann auf eine vorgeschlagene Antwort tippen, um die Textantwort an den Agent zu senden.
fallback

string

Optional. Fallback-Text, der angezeigt wird, wenn das Gerät des Nutzers den Nachrichtentyp oder -inhalt nicht unterstützt. Maximal 3.072 Zeichen.
containsRichText

boolean

Optional. Wenn true, bedeutet dies, dass die Nachricht RTF enthält. Wenn die Nachricht eine ungültige Formatierung enthält, gibt Business Messages einen Fehler zurück.
Union-Feld content. Der Inhalt einer Nachricht. Für content ist nur einer der folgenden Werte zulässig:
text

string

SMS. Maximal 3.072 Zeichen.
image

object (Image)

Bildnachricht.
richCard

object (RichCard)

Rich Card-Nachricht.

Bild

Ein Bild.

JSON-Darstellung 
{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Felder
Union-Feld content. Bildinhalte. Für content ist nur einer der folgenden Werte zulässig:
contentInfo

object (ContentInfo)

Informationen zu einem Bild, einschließlich der URL des Bildes und der URL der Miniaturansicht des Bildes.

ContentInfo

Nachricht mit den Informationen zum Inhalt.

JSON-Darstellung 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean,
  "altText": string
}
Felder
fileUrl

string

Öffentlich erreichbare URL der Datei Die Plattform bestimmt den MIME-Typ der Datei im Feld "content-type" in den HTTP-Headern, wenn die Plattform die Datei abruft. Das Feld "content-type" muss in der HTTP-Antwort der URL vorhanden und korrekt sein.

Maximal 5 MB.

Unterstützte Inhaltstypen: Bild/JPEG, Bild/JPG, Bild/PNG, Bild/WebP
thumbnailUrl

string

Optional. Öffentlich zugängliche URL des Thumbnails.

Wenn Sie keine Miniaturansicht-URL angeben, zeigt die Plattform eine leere Platzhalter-Miniaturansicht an, bis das Gerät des Nutzers die Datei herunterlädt.

Maximal 25 KB.

Unterstützte Inhaltstypen: Bild/JPEG, Bild/JPG, Bild/PNG, Bild/WebP
forceRefresh

boolean

Wenn festgelegt, ruft die Plattform die Datei und die Miniaturansicht von den angegebenen URLs ab, auch wenn auf der Plattform Kopien der Datei und/oder der Miniaturansicht im Cache gespeichert sind.
altText

string

Text, der die Details zu den Medien für Barrierefreiheit beschreibt.

RichCard

Eine eigenständige Rich Card oder ein Karussell mit Rich Cards, die vom Agent an den Nutzer gesendet werden.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld card. Mögliche Arten von Rich Cards. Für card ist nur einer der folgenden Werte zulässig:
standaloneCard

object (StandaloneCard)

Eigenständige Karte.
carouselCard

object (CarouselCard)

Kartenkarussell

StandaloneCard

Eigenständige Karte.

JSON-Darstellung 
{
  "cardContent": {
    object (CardContent)
  }
}
Felder
cardContent

object (CardContent)

Karteninhalt.

CardContent

Karteninhalt.

JSON-Darstellung 
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
Felder
title

string

Optional. Titel der Karte. Maximal 200 Zeichen.
description

string

Optional. Beschreibung der Karte Maximal 2.000 Zeichen.
media

object (Media)

Optional. Medien, die in die Karte aufgenommen werden sollen.
suggestions[]

object (Suggestion)

Optional. Liste der Vorschläge für die Karte. Maximal vier Vorschläge.

Medien

Eine Mediendatei innerhalb einer Rich Card.

JSON-Darstellung 
{
  "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.
}
Felder
height

enum (Height)

Die Höhe der Medien in einer Rich Card.
Union-Feld content. Medieninhalte. Für content ist nur einer der folgenden Werte zulässig:
contentInfo

object (ContentInfo)

Informationen zu einer Datei, einschließlich der URL der Datei und der URL der Miniaturansicht der Datei.

Höhe

Medienhöhe

Enums
HEIGHT_UNSPECIFIED Nicht angegeben.
SHORT 112 DP.
MEDIUM 168 DP.
TALL 264 DP. Nicht verfügbar für Rich-Card-Karussells, wenn die Kartenbreite auf SMALL festgelegt ist.

Vorschlag

Ein Vorschlag in einer Chipliste.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld option. Ein Antwortvorschlag. Für option ist nur einer der folgenden Werte zulässig:
reply

object (SuggestedReply)

Ein Vorschlag für den Nutzer, mit angegebenem Text zu antworten.
action

object (SuggestedAction)

Eine vorgeschlagene Aktion, die eine native Aktion auf dem Gerät initiiert.
liveAgentRequest

object (LiveAgentRequest)

Eine Anfrage, dass ein Kundenservicemitarbeiter an der Unterhaltung teilnimmt.
authenticationRequest

object (AuthenticationRequest)

Eine Anfrage zum Starten des Authentifizierungsvorgangs.

SuggestedReply

Wenn Sie darauf tippen, wird die Textantwort an den Kundenservicemitarbeiter zurückgesendet.

JSON-Darstellung 
{
  "text": string,
  "postbackData": string
}
Felder
text

string

Text, der in der vorgeschlagenen Antwort angezeigt und an den Agent gesendet wird, wenn der Nutzer darauf tippt. Maximal 25 Zeichen.
postbackData

string

Der String, den der Agent erhält, wenn ein Nutzer auf die vorgeschlagene Antwort tippt. Maximal 2.048 Zeichen.

SuggestedAction

Durch Antippen wird die entsprechende native Aktion auf dem Gerät gestartet.

JSON-Darstellung 
{
  "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.
}
Felder
text

string

Text, der in der vorgeschlagenen Aktion angezeigt wird. Maximal 25 Zeichen.
postbackData

string

Der String, den der Agent empfängt, wenn ein Nutzer auf die vorgeschlagene Aktion tippt. Maximal 2.048 Zeichen.
Union-Feld action. Die native Aktion, die auf dem Gerät initiiert wird, wenn der Nutzer auf die vorgeschlagene Aktion tippt. Für action ist nur einer der folgenden Werte zulässig:
openUrlAction

object (OpenUrlAction)

Öffnet die angegebene URL.
dialAction

object (DialAction)

Öffnet die Standard-Telefon-App des Nutzers.

OpenUrlAction

Öffnet die angegebene URL.

JSON-Darstellung 
{
  "url": string
}
Felder
url

string

URL

DialAction

Öffnet die Standard-Telefon-App des Nutzers mit der angegebenen Telefonnummer.

JSON-Darstellung 
{
  "phoneNumber": string
}
Felder
phoneNumber

string

Erforderlich. Die angegebene Telefonnummer im Format RFC 3966. Beispiel: „+1-201-555-0123“.

LiveAgentRequest

Dieser Typ hat keine Felder.

Wenn Sie darauf tippen, wird eine Anfrage an einen Live-Kundenservicemitarbeiter gesendet, um an der Unterhaltung teilzunehmen.

AuthenticationRequest

Authentifizierung einer Unterhaltung anfordern

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld authentication_type. Der Authentifizierungstyp. Für authentication_type ist nur einer der folgenden Werte zulässig:
oauth

object (Oauth)

Details zur Authentifizierung über OAuth.

OAuth

Details zur Authentifizierung über OAuth.

JSON-Darstellung 
{
  "clientId": string,
  "codeChallenge": string,
  "scopes": [
    string
  ],
  "codeChallengeMethod": string
}
Felder
clientId

string

Erforderlich. Die ID der Anwendung, die die Autorisierung anfordert.
codeChallenge

string

Erforderlich. Die Code-Abfrage, mit der Zugriffstokens ausgetauscht werden.
scopes[]

string

Erforderlich. Ein Array, das die Bereiche der Anfrage angibt.
codeChallengeMethod

string

Optional. Die Methode der Code-Abfrage, die zur Generierung der Code-Abfrage verwendet wurde. Wenn Sie diesen Parameter nicht angeben, geht der Server von plain aus.

CarouselCard

Kartenkarussell

JSON-Darstellung 
{
  "cardWidth": enum (CardWidth),
  "cardContents": [
    {
      object (CardContent)
    }
  ]
}
Felder
cardWidth

enum (CardWidth)

Die Breite der Karten im Karussell.
cardContents[]

object (CardContent)

Die Inhaltsliste für jede Karte im Karussell. Ein Karussell kann mindestens 2 und maximal 10 Karten enthalten.

CardWidth

Die Breite der Karten im Karussell.

Enums
CARD_WIDTH_UNSPECIFIED Nicht angegeben
SMALL 136 DP. Große Medien können nicht enthalten sein.
MEDIUM 280 DP.

Methoden

create

 Sendet eine Nachricht von einem Agent an einen Nutzer.

updateReceipt

 Sendet eine Bestätigung für eine Nachricht von einem Agent an einen Nutzer.