REST Resource: phones.agentMessages

Ressource: AgentMessage

Eine vom Agent an einen Nutzer gesendete Nachricht.

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

string

Dieses Feld wird von der RBM-Plattform festgelegt. Fügen Sie sie nicht hinzu, wenn Sie eine Agent-Nachricht erstellen. Das Feld löst „phones/{E.164}/agentMessages/{messageId}“ auf, wobei {E.164} die Telefonnummer des Nutzers im E.164-Format und {messageId} die vom Agent zugewiesene ID der Agent-Nachricht ist.

sendTime

string (Timestamp format)

Dieses Feld wird von der RBM-Plattform festgelegt. Fügen Sie sie nicht hinzu, wenn Sie eine Agent-Nachricht erstellen. Das Feld löst den Zeitpunkt auf, zu dem die Nachricht an den Nutzer gesendet wird.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

contentMessage

object (AgentContentMessage)

Der Inhalt der Agent-Nachricht.

Union-Feld expiration.

Für expiration ist nur einer der folgenden Werte zulässig:

expireTime

string (Timestamp format)

Optional. Der Zeitstempel in UTC, der angibt, wann diese Ressource als abgelaufen gilt. Dieser Wert wird in der Ausgabe angegeben, wenn er festgelegt oder das Feld „TTL“ konfiguriert ist.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

ttl

string (Duration format)

Optional. Nur Eingabe. Die Gültigkeitsdauer der Nachricht, bevor sie automatisch widerrufen wird.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".

AgentContentMessage

Der Inhalt einer Nachricht, die vom Agent an einen Nutzer gesendet wird.

JSON-Darstellung
{
  "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.
}
Felder
suggestions[]

object (Suggestion)

Eine Liste mit Antwortvorschlägen und vorgeschlagenen Aktionen, die als Liste mit Vorschlags-Chips nach der zugehörigen Nachricht an einen Kundenservicemitarbeiter angezeigt werden. Maximal 11 Vorschläge.

Die Chips werden nur angezeigt, wenn die zugehörige Agent-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 Kundenservicemitarbeiter zu senden, oder auf eine vorgeschlagene Aktion tippen, um eine native Aktion auf dem Gerät zu starten.

Union-Feld content. Der Inhalt der Agent-Nachricht content darf nur einer der folgenden sein:
text

string

Text ist in UTF-8 codiert.

fileName
(deprecated)

string

Der eindeutige Name einer Datei. Die RBM-Plattform gibt einen Dateinamen zurück, wenn ein Agent eine Datei hochlädt. Wurde zugunsten von "uploadRbmFile" unten eingestellt

uploadedRbmFile

object (UploadedRbmFile)

Enthält Kennungen für eine Datei und ein Thumbnail, die auf den RBM-Server hochgeladen und von diesem bereitgestellt wurden

richCard

object (RichCard)

Eine eigenständige interaktive Chat-Nachricht.

contentInfo

object (ContentInfo)

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

Die RBM-Plattform stellt Inhalte aus einem Cache bereit, aber ein Agent kann die RBM-Plattform zwingen, eine neue Version des Inhalts abzurufen und den Cache zu aktualisieren.

UploadedRbmFile

Nachricht mit Informationen zur Datei und Miniaturansicht

JSON-Darstellung
{
  "fileName": string,
  "thumbnailName": string
}
Felder
fileName

string

Der Name der Datei, der von der RBM-Plattform beim Hochladen der Datei zurückgegeben wurde.

thumbnailName

string

Der Name des Thumbnails, der beim Hochladen des Thumbnails von der RBM-Plattform zurückgegeben wurde.

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:
  "carouselCard": {
    object (CarouselCard)
  },
  "standaloneCard": {
    object (StandaloneCard)
  }
  // End of list of possible types for union field card.
}
Felder
Union-Feld card. Eigenständige Karte oder Karussell mit Karten. Für card ist nur einer der folgenden Werte zulässig:
carouselCard

object (CarouselCard)

Kartenkarussell

standaloneCard

object (StandaloneCard)

Eigenständige Karte.

CarouselCard

Kartenkarussell

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

enum (CarouselCard.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.

CarouselCard.CardWidth

Die Breite der Karten im Karussell.

Enums
CARD_WIDTH_UNSPECIFIED Nicht angegeben.
SMALL 120 DP. Beachten Sie, dass hohe Medien nicht verwendet werden können.
MEDIUM 232 DP.

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 (Bild, GIF, Video), 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 (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.
}
Felder
height

enum (Media.Height)

Die Höhe der Medien in einer Rich Card mit vertikalem Layout. Bei einer eigenständigen Karte mit horizontalem Layout kann die Höhe nicht angepasst werden. Dieses Feld wird ignoriert.

Union-Feld content. Für den Medieninhalt content ist nur einer der folgenden Werte zulässig:
fileName
(deprecated)

string

Der eindeutige Name der Datei, der von der RBM-Plattform beim Hochladen der Datei zurückgegeben wird. Wurde zugunsten von "uploadRbmFile" unten eingestellt

uploadedRbmFile

object (UploadedRbmFile)

Enthält Kennungen für eine Datei und ein Thumbnail, die auf den RBM-Server hochgeladen und von diesem bereitgestellt wurden

contentInfo

object (ContentInfo)

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

Die RBM-Plattform stellt Inhalte aus einem Cache bereit, aber ein Agent kann die RBM-Plattform zwingen, eine neue Version des Inhalts abzurufen und den Cache zu aktualisieren.

ContentInfo

Nachricht mit den Informationen zum Inhalt.

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

string

Öffentlich erreichbare URL der Datei Die RBM-Plattform bestimmt den MIME-Typ der Datei aus dem Feld für den Inhaltstyp 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. Die empfohlene maximale Dateigröße beträgt 100 MB.

thumbnailUrl

string

(Optional, nur für Bild-, Audio- und Videodateien) Öffentlich erreichbare URL der Miniaturansicht. Maximale Größe: 100 KB

Wenn Sie keine Miniaturansicht-URL angeben, zeigt die RBM-Plattform eine leere Platzhalter-Miniaturansicht an, bis das Gerät des Nutzers die Datei herunterlädt. Je nach Nutzereinstellung wird die Datei möglicherweise nicht automatisch heruntergeladen und der Nutzer muss auf eine Downloadschaltfläche tippen.

forceRefresh

boolean

Wenn festgelegt, ruft die RBM-Plattform die Datei und die Miniaturansicht von den angegebenen URLs ab, auch wenn die Plattform Kopien der Datei (und/oder der Miniaturansicht) im Cache gespeichert hat.

Media.Height

Medienhöhe

Enums
HEIGHT_UNSPECIFIED Nicht angegeben.
SHORT 112 DP.
MEDIUM 168 DP.
TALL 264 DP. Nicht verfügbar für Rich-Card-Karussells mit einer kleinen Kartenbreite.

Vorschlag

Eine vorgeschlagene Antwort oder eine vorgeschlagene Aktion in einer Rich Card oder einer Liste mit Vorschlags-Chips.

JSON-Darstellung
{

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

object (SuggestedReply)

Nutzer können auf eine vorgeschlagene Antwort tippen, um die Textantwort an den Kundenservicemitarbeiter zu senden.

action

object (SuggestedAction)

Nutzer können auf eine vorgeschlagene Aktion tippen, um die entsprechende native Aktion auf dem Gerät zu starten.

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 Kundenservicemitarbeiter zurückgesendet wird, wenn der Nutzer darauf tippt. Maximal 25 Zeichen.

postbackData

string

Die base64-codierte Nutzlast, die der Agent bei einem Nutzerereignis empfängt, wenn der Nutzer auf die vorgeschlagene Antwort tippt.

SuggestedAction

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

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

string

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

postbackData

string

Base64-codierte Nutzlast, die im Nutzerereignis an den Agent gesendet wird, das entsteht, wenn der Nutzer auf die vorgeschlagene Aktion tippt

fallbackUrl

string

Optional: Fallback-URL, die verwendet wird, wenn ein Client eine vorgeschlagene Aktion nicht unterstützt. Fallback-URLs werden in einem neuen Browserfenster geöffnet.

Union-Feld action. Die native Aktion, die auf dem Gerät initiiert wird, wenn der Nutzer auf die vorgeschlagene Aktion „action“ tippt, darf nur eine der folgenden Aktionen sein:
dialAction

object (DialAction)

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

viewLocationAction

object (ViewLocationAction)

Öffnet die Standardkarten-App des Nutzers und wählt den vom Agent angegebenen Standort aus oder sucht anhand einer Agent-spezifischen Anfrage in der Nähe des Nutzerstandorts.

createCalendarEventAction

object (CreateCalendarEventAction)

Öffnet die Standardkalender-App des Nutzers und startet den neuen Ablauf für Kalenderereignisse, wobei die vom Agent angegebenen Termindaten vorausgefüllt sind.

openUrlAction

object (OpenUrlAction)

Öffnet die Standard-Webbrowser-App des Nutzers unter der angegebenen URL. Wenn der Nutzer eine App installiert hat, die als Standard-Handler für die URL registriert ist, wird stattdessen diese App geöffnet und ihr Symbol wird in der UI für vorgeschlagene Aktionen verwendet.

shareLocationAction

object (ShareLocationAction)

Öffnet die Standortauswahl der RCS-App, damit der Nutzer einen Standort auswählen kann, der an den Agent gesendet werden soll.

DialAction

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

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

string

Die Telefonnummer im E.164-Format, z. B. +12223334444.

ViewLocationAction

Öffnet die Standardkarten-App des Nutzers und wählt den vom Agent angegebenen Standort aus oder sucht anhand einer Agent-spezifischen Anfrage in der Nähe des Nutzerstandorts.

JSON-Darstellung
{
  "latLong": {
    object (LatLng)
  },
  "label": string,
  "query": string
}
Felder
latLong

object (LatLng)

(Optional) Breiten- und Längengrad des angegebenen Standorts.

label

string

Optional: Das Label der Markierung, das auf latLong gesetzt wurde.

query

string

(Optional, nur in Android Messages-Clients unterstützt): Statt einen latLong-Wert (und optional ein Label) anzugeben, kann der Agent stattdessen einen Abfragestring angeben. Bei Standardkarten-Apps, die Suchfunktionen unterstützen (einschließlich Google Maps), kann das Tippen auf diese vorgeschlagene Aktion in einer Standortsuche auf den aktuellen Standort des Nutzers erfolgen. Wenn die Abfrage ausreichend spezifisch ist, können Kundenservicemitarbeiter damit einen beliebigen Standort auf der Welt auswählen.

Wenn Sie z. B. den Abfragestring auf „Wachsen-Baumbank“ setzen, zeigt alle Growing Tree Bank-Standorte in der Nähe des Nutzers an. Festlegen der Abfragezeichenfolge auf "1600 Amphitheater Parkway, Mountain View, CA 94043" wählt diese Adresse unabhängig vom Standort des Nutzers aus.

LatLng

Ein Objekt, das ein Paar aus Breiten- und Längengrad darstellt. Es wird als Paar aus Werten vom Typ „Double“ (Breiten- und Längengrad) ausgedrückt. Sofern nicht anders angegeben, muss dieses Objekt dem WGS84-Standard entsprechen. Die Werte müssen innerhalb normalisierter Bereiche liegen.

JSON-Darstellung
{
  "latitude": number,
  "longitude": number
}
Felder
latitude

number

Der Breitengrad in Grad. Er muss im Bereich [-90,0, +90,0] liegen.

longitude

number

Der Längengrad in Grad. Er muss im Bereich [-180,0, +180,0] liegen.

CreateCalendarEventAction

Öffnet die Standardkalender-App des Nutzers und startet den neuen Ablauf für Kalenderereignisse, wobei die vom Agent angegebenen Termindaten vorausgefüllt sind.

JSON-Darstellung
{
  "startTime": string,
  "endTime": string,
  "title": string,
  "description": string
}
Felder
startTime

string (Timestamp format)

Beginn des Ereignisses.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Ende des Termins.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

title

string

Termintitel

description

string

Ereignisbeschreibung

OpenUrlAction

Öffnet die Standard-Webbrowser-App des Nutzers unter der angegebenen URL. Wenn der Nutzer eine App installiert hat, die als Standard-Handler für die URL registriert ist, wird stattdessen diese App geöffnet und ihr Symbol wird in der UI für vorgeschlagene Aktionen verwendet.

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

string

URL

ShareLocationAction

Dieser Typ hat keine Felder.

Öffnet die Standortauswahl der RCS-App, damit der Nutzer einen Standort auswählen kann, der an den Kundenservicemitarbeiter zurückgesendet wird.

StandaloneCard

Eigenständige Karte

JSON-Darstellung
{
  "cardOrientation": enum (StandaloneCard.CardOrientation),
  "thumbnailImageAlignment": enum (StandaloneCard.ThumbnailImageAlignment),
  "cardContent": {
    object (CardContent)
  }
}
Felder
cardOrientation

enum (StandaloneCard.CardOrientation)

Ausrichtung der Karte.

thumbnailImageAlignment

enum (StandaloneCard.ThumbnailImageAlignment)

Ausrichtung der Bildvorschau für eigenständige Karten mit horizontalem Layout.

cardContent

object (CardContent)

Karteninhalt.

StandaloneCard.CardOrientation

Ausrichtung der Karte.

Enums
CARD_ORIENTATION_UNSPECIFIED Nicht angegeben.
HORIZONTAL

Horizontales Layout.

Wenn object(CardContent) einer horizontalen Rich Card das Feld media enthält, muss es auch mindestens das Feld title, description oder suggestions[] enthalten.

VERTICAL Vertikales Layout.

StandaloneCard.ThumbnailImageAlignment

Ausrichtung der Bildvorschau für eigenständige Karten mit horizontalem Layout.

Enums
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED Nicht angegeben.
LEFT Die Dateivorschau ist linksbündig ausgerichtet.
RIGHT Die Dateivorschau ist rechtsbündig ausgerichtet.

Methoden

create

Sendet eine Nachricht vom Agent an einen Nutzer.

delete

Hebt eine Nachricht an Kundenservicemitarbeiter auf, die gesendet, aber noch nicht zugestellt wurde.