REST Resource: phones.agentMessages

Ressource: AgentMessage

Eine Nachricht, die vom Agent an einen Nutzer gesendet wird.

JSON-Darstellung 
{
  "name": string,
  "sendTime": string,
  "contentMessage": {
    object (AgentContentMessage)
  },
  "messageTrafficType": enum (MessageTrafficType),

  // 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. Sie darf nicht in Agent-Nachrichten enthalten sein. Das Feld wird in „phones/{E.164}/agentMessages/{messageId}“ aufgelöst, wobei {E.164} die Telefonnummer des Nutzers im E.164-Format und {messageId} die vom Kundenservicemitarbeiter zugewiesene ID der Kundenservicemitarbeiter-Nachricht ist.
sendTime

string (Timestamp format)

Dieses Feld wird von der RBM-Plattform festgelegt. Sie darf nicht in Agent-Nachrichten enthalten sein. Das Feld gibt die Zeit an, zu der die Nachricht an den Nutzer gesendet wird.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
contentMessage

object (AgentContentMessage)

Der Inhalt der Agent-Nachricht.
messageTrafficType

enum (MessageTrafficType)

Der Nachrichtentyp.

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 ist oder wenn das TTL-Feld festgelegt ist.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
ttl

string (Duration format)

Optional. Nur Eingabe. Wie lange die Nachricht aktiv ist, 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 nach der zugehörigen Agent-Nachricht als Liste mit Vorschlagschips angezeigt werden. Maximal 11 Vorschläge.

Die Chips werden nur angezeigt, wenn die zugehörige Agent-Nachricht die letzte Nachricht in der Unterhaltung ist (einschließlich Agent- und Nutzer-Nachrichten). Der Nutzer kann auf eine vorgeschlagene Antwort tippen, um die Textantwort an den Agent zu senden, oder auf eine vorgeschlagene Aktion, um eine native Aktion auf dem Gerät zu starten. Maximal 11 Vorschläge.
Union-Feld content. Der Inhalt der Agent-Nachricht content kann nur einer der folgenden Werte sein:
text

string

In UTF-8 codierter Text. Maximal 3.072 Zeichen.
fileName
(deprecated)

string

Der eindeutige Name einer Datei. Die RBM-Plattform gibt einen Dateinamen zurück, wenn ein Kundenservicemitarbeiter eine Datei hochlädt. Wurde zugunsten von „uploadedRbmFile“ unten verworfen.
uploadedRbmFile

object (UploadedRbmFile)

Enthält Kennungen für eine Datei und eine Miniaturansicht, 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. Ein Agent kann die RBM-Plattform jedoch dazu zwingen, eine neue Version der Inhalte abzurufen und den Cache zu aktualisieren.

UploadedRbmFile

Nachricht mit Datei- und Miniaturansichtsinformationen

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

string

Der Name der Datei, der von der RBM-Plattform zurückgegeben wurde, als die Datei hochgeladen wurde.
thumbnailName

string

Der Name der Miniaturansicht, der von der RBM-Plattform zurückgegeben wird, als die Miniaturansicht hochgeladen wurde.

RichCard

Eine einzelne interaktive Chat-Nachricht oder ein Karussell mit interaktiven Chat-Nachrichten, die vom Kundenservicemitarbeiter 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. Einzelne Karte oder Karussell mit Karten. Für card ist nur einer der folgenden Werte zulässig:
carouselCard

object (CarouselCard)

Karussell mit Karten.
standaloneCard

object (StandaloneCard)

Eigenständige Karte

CarouselCard

Karussell mit Karten.

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. Hochformat-Media können nicht verwendet werden.
MEDIUM 232 DP.

CardContent

Karteninhalte

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, PDF), die in die Karte aufgenommen werden sollen.
suggestions[]

object (Suggestion)

Optional: Liste der Vorschläge, die auf der Karte enthalten sein sollen. Maximal 4 Vorschläge.

Medien

Eine Media-Datei in einer interaktiven Chat-Nachricht.

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 Media 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. Der Media-Inhalt content kann nur einer der folgenden Werte sein:
fileName
(deprecated)

string

Der eindeutige Name der Datei, der von der RBM-Plattform zurückgegeben wird, als die Datei hochgeladen wurde. Wurde zugunsten von „uploadedRbmFile“ unten verworfen.
uploadedRbmFile

object (UploadedRbmFile)

Enthält Kennungen für eine Datei und eine Miniaturansicht, 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. Ein Agent kann die RBM-Plattform jedoch dazu zwingen, eine neue Version der Inhalte abzurufen und den Cache zu aktualisieren.

ContentInfo

Nachricht mit den Inhaltsinformationen.

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

string

Öffentlich erreichbare URL der Datei. Der MIME-Typ der Datei wird von der RBM-Plattform anhand des Felds „content-type“ in den HTTP-Headern bestimmt, 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.

Hinweis: Weiterleitungen in Datei-URLs werden nicht unterstützt. Verwenden Sie CreateFileRequest, wenn eine Weiterleitung erforderlich ist.
thumbnailUrl

string

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

Wenn Sie keine Thumbnail-URL angeben, wird auf der RBM-Plattform ein leerer Platzhalter-Thumbnail angezeigt, bis das Gerät des Nutzers die Datei herunterlädt. Je nach Einstellung des Nutzers wird die Datei möglicherweise nicht automatisch heruntergeladen und der Nutzer muss auf eine Schaltfläche zum Herunterladen tippen.

Hinweis: Weiterleitungen in Datei-URLs werden nicht unterstützt. Verwenden Sie CreateFileRequest, wenn eine Weiterleitung erforderlich ist.
forceRefresh

boolean

Falls 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 für Rich Card-Karussells verfügbar, wenn die Kartenbreite auf „Klein“ festgelegt ist.

Vorschlag

Ein Antwortvorschlag oder eine vorgeschlagene Aktion, die in einer Rich Card oder in einer Liste mit Vorschlags-Chips enthalten ist.

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. Eine vorgeschlagene Antwort oder Aktion option kann nur eine der folgenden sein:
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 darauf getippt wird, wird die Textantwort an den Kundenservicemitarbeiter gesendet.

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 in einem Nutzerereignis empfängt, wenn der Nutzer auf die vorgeschlagene Antwort tippt.

SuggestedAction

Wird angetippt, um die entsprechende native Aktion auf dem Gerät zu starten.

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

Die Nutzlast (base64-codiert), die im Nutzerereignis an den Agent gesendet wird, wenn der Nutzer auf die vorgeschlagene Aktion tippt. Die Beschreibung darf maximal 2.048 Zeichen lang sein.
fallbackUrl

string

(Optional) Fallback-URL, die verwendet werden soll, wenn ein Client eine vorgeschlagene Aktion nicht unterstützt. Fallback-URLs werden in neuen Browserfenstern geöffnet. Muss ein gültiger URI gemäß RFC 3986 sein. Die Beschreibung darf maximal 2.048 Zeichen lang sein.
Union-Feld action. Die native Aktion, die auf dem Gerät ausgelöst wird, wenn der Nutzer auf die vorgeschlagene Aktion action tippt, kann nur eine der folgenden sein:
dialAction

object (DialAction)

Öffnet die Standard-App für Anrufe des Nutzers mit der vom Kundenservicemitarbeiter angegebenen Telefonnummer.
viewLocationAction

object (ViewLocationAction)

Öffnet die Standardkarten-App des Nutzers und wählt den vom Agenten angegebenen Ort aus oder sucht anhand einer vom Agenten angegebenen Anfrage in der Nähe des Standorts des Nutzers.
createCalendarEventAction

object (CreateCalendarEventAction)

Öffnet die Standardkalender-App des Nutzers und startet den Ablauf für neue Kalendertermine mit den vom Agent angegebenen Ereignisdaten, die bereits ausgefüllt sind.
openUrlAction

object (OpenUrlAction)

Öffnet die Standard-Webbrowser-App des Nutzers mit 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 in der Benutzeroberfläche für vorgeschlagene Aktionen verwendet.
shareLocationAction

object (ShareLocationAction)

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

DialAction

Öffnet die Standard-App für Anrufe des Nutzers mit der vom Kundenservicemitarbeiter 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 Agenten angegebenen Ort aus oder sucht anhand einer vom Agenten angegebenen Anfrage in der Nähe des Standorts des Nutzers.

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

object (LatLng)

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

string

(Optional) Das Label der Markierung, die bei latLong platziert wurde.
query

string

(Optional, nur in Android Messages-Clients unterstützt) Anstatt „latLong“ (und optional ein Label) anzugeben, kann der Agent stattdessen einen Suchstring angeben. Wenn Sie in Standardkarten-Apps, die die Suchfunktion unterstützen (einschließlich Google Maps), auf diese vorgeschlagene Aktion tippen, wird eine standortbezogene Suche nach dem aktuellen Standort des Nutzers durchgeführt. Wenn die Anfrage spezifisch genug ist, können KI-Agenten damit einen beliebigen Ort auf der Welt auswählen.

Wenn Sie den Abfragestring beispielsweise auf „Growing Tree Bank“ festlegen, werden alle Standorte von Growing Tree Bank in der Nähe des Nutzers angezeigt. Wenn Sie den Abfragestring auf „1600 Amphitheater Parkway, Mountain View, CA 94043“ festlegen, wird diese bestimmte Adresse ausgewählt, unabhängig vom Standort des Nutzers.

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 Ablauf für neue Kalendertermine mit den vom Agent angegebenen Ereignisdaten, die bereits ausgefüllt sind.

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

string (Timestamp format)

Startzeit des Termins.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Endzeit des Termins

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
title

string

Termintitel Der Titel darf maximal 100 Zeichen lang sein.
description

string

Terminbeschreibung. Maximal 500 Zeichen.

OpenUrlAction

Öffnet die Standard-Webbrowser-App des Nutzers mit 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 in der Benutzeroberfläche für vorgeschlagene Aktionen verwendet.

JSON-Darstellung 
{
  "url": string,
  "application": enum (OpenUrlApplication),
  "webviewViewMode": enum (WebviewViewMode),
  "description": string
}
Felder
url

string

Die zu öffnende URL. Ab dem 1. November 2025 muss das URL-Schema „https://“ oder „http://“ sein. API-Anfragen mit anderen Schemas (z.B. tel:, mailto:, sms:) werden nach diesem Datum mit dem Fehler „400 Bad Request“ abgelehnt. Die URL muss ein gültiger URI gemäß RFC 3986 sein. Die Beschreibung darf maximal 2.048 Zeichen lang sein.
application

enum (OpenUrlApplication)

URL zum Öffnen einer Anwendung, eines Browsers oder eines WebView. Um zu prüfen, ob das Gerät eines Nutzers den WebView-Modus unterstützt, führen Sie zuerst einen Capability-Check durch. Weitere Informationen finden Sie in der Dokumentation: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities.
webviewViewMode

enum (WebviewViewMode)

Ansichtsmodus für WebView
description

string

Beschreibung der Bedienungshilfen für die Webansicht.

OpenUrlApplication

Typ der URL zum Öffnen der Anwendung

Enums
OPEN_URL_APPLICATION_UNSPECIFIED Nicht angegeben. Der Browser wird zum Öffnen verwendet.
BROWSER Öffnen Sie die URL im Browser.
WEBVIEW URL in einem integrierten Webview-Fenster öffnen

WebviewViewMode

Typ des Ansichtsmodus der Webview.

Enums
WEBVIEW_VIEW_MODE_UNSPECIFIED Nicht angegeben. Wenn Sie WebView verwenden möchten, muss ein Ansichtsmodus angegeben werden.
FULL Erfordert ein Vollbild-Overlay mit der Chatbot-Unterhaltung, die in der Statusleiste gekennzeichnet ist.
HALF Erfordert ein Overlay auf dem halben Bildschirm.
TALL Erfordert ein Overlay, das drei Viertel des Bildschirms abdeckt.

ShareLocationAction

Dieser Typ hat keine Felder.

Öffnet die Ortsauswahl der RCS-App, damit der Nutzer einen Ort auswählen kann, der an den Kundenservicemitarbeiter gesendet werden soll.

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)

Karteninhalte.

StandaloneCard.CardOrientation

Ausrichtung der Karte.

Enums
CARD_ORIENTATION_UNSPECIFIED Nicht angegeben.
HORIZONTAL

Horizontales Layout

Wenn das object(CardContent) einer horizontalen Rich Card das Feld media enthält, muss es auch mindestens ein 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.
RIGHT Die Dateivorschau ist rechtsbündig.

MessageTrafficType

Unterstützte Nachrichtentraffic-Typen. Das Enum wird erweitert, um zusätzliche Traffic-Typen zu unterstützen.

Enums
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED Standardverhalten: Der Nachrichtentraffic-Typ wird durch den Anwendungsfall des Agenten bestimmt. Aktualisieren Sie den Traffic-Typ nach Bedarf basierend auf dem Nachrichteninhalt. Für Agents zur Mehrfachverwendung wird kein Standardwert angegeben. Der Traffic-Typ muss manuell festgelegt werden, z.B. TRANSACTION, PROMOTION).
AUTHENTICATION Für Authentifizierungsnachrichten im Anwendungsfall „OTP-Agent“.
TRANSACTION Für Transaktionsnachrichten in Anwendungsfällen mit Transaktions- oder Mehrzweck-Agents.
PROMOTION Für Werbebotschaften in Anwendungsfällen für Werbe- oder Mehrzweck-Agents.
SERVICEREQUEST Für Mitteilungen zu Diensten, deren Erhalt der Nutzer zugestimmt hat. Wird in Anwendungsfällen für Agenten für Einmalpasswörter, Transaktionen, Werbeaktionen oder Mehrfachverwendung verwendet.
ACKNOWLEDGEMENT Für Nachrichten, in denen die Abmeldeanfrage des Nutzers bestätigt wird. Wird in Anwendungsfällen für Agenten für Einmalpasswörter, Transaktionen, Werbeaktionen oder Mehrfachverwendung verwendet.

Methoden

create

 Sendet eine Nachricht vom Agent an einen Nutzer.

delete

 Ruft eine Agentennachricht zurück, die gesendet, aber noch nicht zugestellt wurde.