Ressource: AgentMessage
Eine Nachricht, die vom Kundenservicemitarbeiter an einen Nutzer gesendet wurde.
JSON-Darstellung |
---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
Felder | |
---|---|
name |
Dieses Feld wird von der RBM-Plattform festgelegt. Fügen Sie sie nicht in eine Kundenservicemitteilung ein. 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 Kundenservicemitarbeiter zugewiesene ID der Kundenservicemitarbeiternachricht ist. |
sendTime |
Dieses Feld wird von der RBM-Plattform festgelegt. Fügen Sie sie nicht in eine Kundenservicemitteilung ein. Das Feld enthält die Zeit, zu der die Nachricht an den Nutzer gesendet wird. Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: |
contentMessage |
Der Inhalt der Kundenservicemitarbeiter-Nachricht. |
messageTrafficType |
Der Nachrichtenverkehrstyp. |
Union-Feld Für |
|
expireTime |
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 das TTL-Feld festgelegt ist. Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: |
ttl |
Optional. Nur Eingabe. Gibt an, wie lange die Nachricht gültig ist, bevor sie automatisch widerrufen wird. Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit " |
AgentContentMessage
Der Inhalt einer Nachricht, die vom Kundenservicemitarbeiter an einen Nutzer gesendet wurde.
JSON-Darstellung |
---|
{ "suggestions": [ { object ( |
Felder | |
---|---|
suggestions[] |
Eine Liste mit vorgeschlagenen Antworten und Aktionen, die als Liste von Vorschlags-Chips nach der zugehörigen Kundenservicemitarbeiter-Nachricht angezeigt wird. Maximal 11 Vorschläge. Die Chips werden nur angezeigt, wenn die zugehörige Kundenservicemitarbeiternachricht die neueste Nachricht in der Unterhaltung ist (einschließlich Nachrichten von Kundenservicemitarbeitern und Nutzern). Der Nutzer kann auf eine vorgeschlagene Antwort tippen, um die Textantwort an den Kundenservicemitarbeiter zurückzusenden, oder auf eine vorgeschlagene Aktion, um eine native Aktion auf dem Gerät auszuführen. Maximal 11 Vorschläge. |
Union-Feld content . Der Inhalt der Kundenservicemitarbeiternachricht content kann nur einer der folgenden Werte sein: |
|
text |
In UTF-8 codierter Text Maximal 3.072 Zeichen. |
fileName |
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 |
Enthält IDs für eine Datei und ein Thumbnail, die auf den RBM-Server hochgeladen und von diesem gesendet wurden. |
richCard |
Eine eigenständige interaktive Chat-Nachricht. |
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 Kundenservicemitarbeiter 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 |
Der Name der Datei, der von der RBM-Plattform beim Upload der Datei zurückgegeben wurde. |
thumbnailName |
Der Name des Thumbnails, der von der RBM-Plattform beim Hochladen des Thumbnails zurückgegeben wurde. |
RichCard
Eine eigenständige interaktive Karte oder ein Karussell mit interaktiven Karten, die vom Kundenservicemitarbeiter an den Nutzer gesendet werden.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld card . Einzelne Karte oder Karussell mit Karten. Für card ist nur einer der folgenden Werte zulässig: |
|
carouselCard |
Karussell mit Karten. |
standaloneCard |
Eigenständige Karte. |
CarouselCard
Karussell mit Karten.
JSON-Darstellung |
---|
{ "cardWidth": enum ( |
Felder | |
---|---|
cardWidth |
Die Breite der Karten im Karussell. |
cardContents[] |
Die Liste der Inhalte für jede Karte im Karussell. Ein Karussell kann mindestens zwei und maximal zehn Karten enthalten. |
CarouselCard.CardWidth
Die Breite der Karten im Karussell.
Enums | |
---|---|
CARD_WIDTH_UNSPECIFIED |
Nicht angegeben. |
SMALL |
120 DP. Hochformatige Medien können nicht verwendet werden. |
MEDIUM |
232 DP. |
CardContent
Karteninhalt
JSON-Darstellung |
---|
{ "title": string, "description": string, "media": { object ( |
Felder | |
---|---|
title |
Optional: Titel der Karte. Maximal 200 Zeichen. |
description |
Optional: Beschreibung der Karte. Maximal 2.000 Zeichen. |
media |
Optional: Medien (Bild, GIF, Video), die in die Karte aufgenommen werden sollen. |
suggestions[] |
Optional: Liste der Vorschläge, die auf der Karte enthalten sein sollen. Maximal 10 Vorschläge. |
Medien
Eine Mediendatei in einer interaktiven Chatnachricht.
JSON-Darstellung |
---|
{ "height": enum ( |
Felder | |
---|---|
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 und dieses Feld wird ignoriert. |
Union-Feld content . Für content ist nur einer der folgenden Werte zulässig: |
|
fileName |
Der eindeutige Name der Datei, der von der RBM-Plattform beim Hochladen der Datei zurückgegeben wurde. Wurde zugunsten von uploadedRbmFile unten verworfen |
uploadedRbmFile |
Enthält IDs für eine Datei und ein Thumbnail, die auf den RBM-Server hochgeladen und von diesem gesendet wurden. |
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 Kundenservicemitarbeiter 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 |
Öffentlich zugängliche URL der Datei. Die RBM-Plattform ermittelt den MIME-Typ der Datei anhand des „content-type“-Felds in den HTTP-Headern, wenn die Plattform die Datei abruft. Das Feld „content-type“ muss in der HTTP-Antwort von der URL vorhanden und korrekt sein. Die empfohlene maximale Dateigröße beträgt 100 MB. |
thumbnailUrl |
(Optional, nur für Bild-, Audio- und Videodateien) Öffentlich zugängliche URL der Miniaturansicht. Maximale Größe: 100 KB. Wenn du keine Thumbnail-URL angibst, wird auf der RBM-Plattform ein leeres Platzhalter-Thumbnail angezeigt, bis die Datei auf das Gerät des Nutzers heruntergeladen wurde. Je nach Einstellung des Nutzers wird die Datei möglicherweise nicht automatisch heruntergeladen und der Nutzer muss möglicherweise auf eine Schaltfläche zum Herunterladen tippen. |
forceRefresh |
Wenn diese Option aktiviert ist, ruft die RBM-Plattform die Datei und das Thumbnail von den angegebenen URLs ab, auch wenn die Plattform Kopien der Datei (und/oder des Thumbnails) im Cache hat. |
Media.Height
Medienhöhe
Enums | |
---|---|
HEIGHT_UNSPECIFIED |
Nicht angegeben. |
SHORT |
112 DP. |
MEDIUM |
168 DP. |
TALL |
264 DP. Nicht verfügbar für Karussells mit Rich Cards, wenn die Kartenbreite auf „klein“ festgelegt ist. |
Vorschlag
Eine vorgeschlagene Antwort oder Aktion, die in einer Rich Card oder in einer Liste mit Vorschlags-Chips enthalten ist.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld option . Eine vorgeschlagene Antwort oder Aktion option kann nur eine der folgenden Optionen sein: |
|
reply |
Nutzer können auf eine vorgeschlagene Antwort tippen, um sie an den Kundenservicemitarbeiter zurückzugeben. |
action |
Nutzer können auf eine vorgeschlagene Aktion tippen, um die entsprechende native Aktion auf dem Gerät auszuführen. |
SuggestedReply
Wenn darauf getippt wird, wird die Textantwort an den Kundenservicemitarbeiter zurückgesendet.
JSON-Darstellung |
---|
{ "text": string, "postbackData": string } |
Felder | |
---|---|
text |
Text, der in der vorgeschlagenen Antwort angezeigt und an den Kundenservicemitarbeiter zurückgesendet wird, wenn der Nutzer darauf tippt. Maximal 25 Zeichen. |
postbackData |
Die Base64-codierte Nutzlast, die der Kundenservicemitarbeiter in einem Nutzerereignis erhält, wenn der Nutzer auf die vorgeschlagene Antwort tippt. |
SuggestedAction
Wenn darauf getippt wird, wird die entsprechende native Aktion auf dem Gerät gestartet.
JSON-Darstellung |
---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // Union field |
Felder | |
---|---|
text |
Text, der in der vorgeschlagenen Aktion angezeigt wird. Maximal 25 Zeichen. |
postbackData |
Nutzlast (Base64-codiert), die im Nutzerereignis an den Kundenservicemitarbeiter gesendet wird, das auftritt, wenn der Nutzer auf die vorgeschlagene Aktion tippt. Die Beschreibung darf maximal 2.048 Zeichen lang sein. |
fallbackUrl |
Optionale Fallback-URL, die verwendet wird, 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 gestartet wird, wenn der Nutzer auf die vorgeschlagene Aktion action tippt, kann nur eine der folgenden sein: |
|
dialAction |
Die Standard-Anruf-App des Nutzers wird geöffnet. Die vom Kundenservicemitarbeiter angegebene Telefonnummer ist bereits ausgefüllt. |
viewLocationAction |
Die Standardkarten-App des Nutzers wird geöffnet und der vom Kundenservicemitarbeiter angegebene Standort wird ausgewählt oder es wird anhand einer vom Kundenservicemitarbeiter angegebenen Suchanfrage in der Nähe des Standorts des Nutzers gesucht. |
createCalendarEventAction |
Die Standardkalender-App des Nutzers wird geöffnet und der neue Ablauf für Kalendertermine wird gestartet. Dabei sind die vom Kundenservicemitarbeiter angegebenen Termindaten bereits ausgefüllt. |
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 wird in der Benutzeroberfläche für vorgeschlagene Aktionen verwendet. |
shareLocationAction |
Öffnet die Standortauswahl der RCS App, damit der Nutzer einen Standort auswählen kann, der an den Kundenservicemitarbeiter gesendet werden soll. |
composeAction |
Über einen Chatbot eine Nachricht an ein vordefiniertes Ziel senden. |
DialAction
Die Standard-Anruf-App des Nutzers wird geöffnet. Die vom Kundenservicemitarbeiter angegebene Telefonnummer ist bereits ausgefüllt.
JSON-Darstellung |
---|
{ "phoneNumber": string } |
Felder | |
---|---|
phoneNumber |
Die Telefonnummer im E.164-Format, z. B. +12223334444. |
ViewLocationAction
Die Standardkarten-App des Nutzers wird geöffnet und der vom Kundenservicemitarbeiter angegebene Standort wird ausgewählt oder es wird anhand einer vom Kundenservicemitarbeiter angegebenen Suchanfrage in der Nähe des Standorts des Nutzers gesucht.
JSON-Darstellung |
---|
{
"latLong": {
object ( |
Felder | |
---|---|
latLong |
(Optional) Der Breiten- und Längengrad des angegebenen Standorts. |
label |
(Optional) Das Label der Markierung bei latLong. |
query |
Optional, nur bei Android Messages-Clients: Anstatt eine latLong (und optional ein Label) anzugeben, kann der Kundenservicemitarbeiter stattdessen einen Suchstring angeben. Bei Standardkarten-Apps, die die Suchfunktion unterstützen (einschließlich Google Maps), führt das Tippen auf diese vorgeschlagene Aktion zu einer Standortsuche, die sich um den aktuellen Standort des Nutzers dreht. Wenn die Suchanfrage ausreichend spezifisch ist, können Kundenservicemitarbeiter damit jeden Ort auf der Welt auswählen. Wenn Sie beispielsweise den Suchstring auf „Growing Tree Bank“ festlegen, werden alle Standorte von Growing Tree Bank in der Nähe des Nutzers angezeigt. Wenn Sie den Suchstring auf „1600 Amphitheatre Parkway, Mountain View, CA 94043“ festlegen, wird diese Adresse unabhängig vom Standort des Nutzers ausgewählt. |
LatLng
Ein Objekt, das ein Paar aus Breiten- und Längengrad darstellt. Es wird als Paar von Double-Werten ausgedrückt, die für den Breitengrad und den Längengrad stehen. Sofern nicht anders angegeben, muss es dem World Geodetic System 1984 (WGS 84) entsprechen. Die Werte müssen innerhalb normalisierter Bereiche liegen.
JSON-Darstellung |
---|
{ "latitude": number, "longitude": number } |
Felder | |
---|---|
latitude |
Der Breitengrad in Grad. Er muss im Bereich [-90,0, +90,0] liegen. |
longitude |
Der Längengrad in Grad. Er muss im Bereich [-180,0, +180,0] liegen. |
CreateCalendarEventAction
Die Standardkalender-App des Nutzers wird geöffnet und der neue Ablauf für Kalendertermine wird gestartet. Die vom Kundenservicemitarbeiter angegebenen Termindaten sind bereits ausgefüllt.
JSON-Darstellung |
---|
{ "startTime": string, "endTime": string, "title": string, "description": string } |
Felder | |
---|---|
startTime |
Beginn des Termins. Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: |
endTime |
Endzeit des Termins. Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: |
title |
Termintitel Der Titel darf maximal 100 Zeichen lang sein. |
description |
Beschreibung des Termins. 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 wird in der Benutzeroberfläche für vorgeschlagene Aktionen verwendet.
JSON-Darstellung |
---|
{ "url": string, "application": enum ( |
Felder | |
---|---|
url |
URL. Muss ein gültiger URI gemäß RFC 3986 sein. Die Beschreibung darf maximal 2.048 Zeichen lang sein. |
application |
URL, um eine Anwendung, einen Browser oder eine WebView zu öffnen. Wenn Sie prüfen möchten, ob das Gerät eines Nutzers den Webview-Modus unterstützt, führen Sie zuerst eine Funktionsüberprüfung durch. Weitere Informationen finden Sie in der Dokumentation: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities. |
webviewViewMode |
Ansichtsmodus für WebView |
description |
Beschreibung der Barrierefreiheit für WebView. |
OpenUrlApplication
Typ der URL-Öffnungsanwendung
Enums | |
---|---|
OPEN_URL_APPLICATION_UNSPECIFIED |
Wenn nicht angegeben, wird der Browser verwendet. |
BROWSER |
Öffnen Sie die URL im Browser. |
WEBVIEW |
URL in einem integrierten Webview-Fenster öffnen |
WebviewViewMode
Der Typ des Ansichtsmodus der Webansicht.
Enums | |
---|---|
WEBVIEW_VIEW_MODE_UNSPECIFIED |
Nicht angegeben. Wenn du WebView verwenden möchtest, musst du einen Ansichtsmodus angeben. |
FULL |
Erfordert ein Vollbild-Overlay mit der Chatbot-Unterhaltung, die in der Statusleiste gekennzeichnet ist. |
HALF |
Erfordert ein Overlay, das die Hälfte des Displays bedeckt. |
TALL |
Erfordert ein Overlay, das drei Viertel des Displays bedeckt. |
ComposeAction
Eine Nachricht an ein vom Chatbot vordefiniertes Ziel verfassen und senden. Führen Sie zuerst eine Funktionsüberprüfung durch, um zu prüfen, ob das Gerät eines Nutzers diese Aktion unterstützt. Weitere Informationen finden Sie in der Dokumentation: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld Für |
|
composeTextMessage |
SMS schreiben und senden |
composeRecordingMessage |
Starten Sie die Aufnahme und das Senden einer Sprach- oder Videonachricht. |
ComposeAction.ComposeTextMessage
SMS schreiben und senden
JSON-Darstellung |
---|
{ "phoneNumber": string, "text": string } |
Felder | |
---|---|
phoneNumber |
Vom Chatbot vorausgefüllte Zielrufnummer |
text |
„Draft“ (Entwurf), um den Text in das Textfeld für die Nachricht zu kopieren. |
ComposeAction.ComposeRecordingMessage
Starten Sie die Aufnahme und das Senden einer Sprach- oder Videonachricht.
JSON-Darstellung |
---|
{
"phoneNumber": string,
"type": enum ( |
Felder | |
---|---|
phoneNumber |
Vom Chatbot vorausgefüllte Zielrufnummer |
type |
Der Typ der Aufnahmeaktion. |
ComposeRecordingActionType
Typ der Aktion „Aufnahme erstellen“.
Enums | |
---|---|
COMPOSE_RECORDING_ACTION_TYPE_UNSPECIFIED |
Nicht angegeben. |
ACTION_TYPE_AUDIO |
Audiotyp |
ACTION_TYPE_VIDEO |
Videotyp |
StandaloneCard
Eigenständige Karte
JSON-Darstellung |
---|
{ "cardOrientation": enum ( |
Felder | |
---|---|
cardOrientation |
Ausrichtung der Karte. |
thumbnailImageAlignment |
Ausrichtung der Bildvorschau für eigenständige Karten mit horizontalem Layout. |
cardContent |
Karteninhalt |
StandaloneCard.CardOrientation
Ausrichtung der Karte.
Enums | |
---|---|
CARD_ORIENTATION_UNSPECIFIED |
Nicht angegeben. |
HORIZONTAL |
Horizontales Layout Wenn das Feld |
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 links ausgerichtet. |
RIGHT |
Die Dateivorschau ist rechts ausgerichtet. |
MessageTrafficType
Unterstützte Nachrichtenverkehrstypen. Die Aufzählung wird um weitere Traffic-Typen erweitert.
Enums | |
---|---|
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED |
Standardverhalten: Der Nachrichtenverkehrstyp wird durch den Anwendungsfall des Kundenservicemitarbeiters bestimmt. Aktualisieren Sie den Traffic-Typ nach Bedarf basierend auf dem Inhalt der Nachricht. Für Kundenservicemitarbeiter mit mehreren Rollen wird kein Standard festgelegt. Der Traffic-Typ muss manuell festgelegt werden (z.B. TRANSACTION, PROMOTION). |
AUTHENTICATION |
Für Authentifizierungsnachrichten im Anwendungsfall „OTP-Agent“ |
TRANSACTION |
Für transaktionale Nachrichten in Anwendungsfällen für Kundenservicemitarbeiter mit Transaktionen oder Mehrfachnutzung. |
PROMOTION |
Für Werbenachrichten in Anwendungsfällen für Werbe- oder Mehrzweck-Agenten. |
SERVICEREQUEST |
Für Nachrichten zu Diensten, deren Empfang der Nutzer zugestimmt hat. Wird in Anwendungsfällen für OTP, Transaktionen, Werbung oder Mehrfachnutzung verwendet. |
ACKNOWLEDGEMENT |
Für Nachrichten, die die Abbestellungsanfrage des Nutzers bestätigen. Wird in Anwendungsfällen für OTP, Transaktionen, Werbung oder Mehrfachnutzung verwendet. |
Methoden |
|
---|---|
|
Hiermit wird eine Nachricht vom Kundenservicemitarbeiter an einen Nutzer gesendet. |
|
Hiermit wird eine Kundenservicemitarbeiter-Nachricht widerrufen, die gesendet, aber noch nicht zugestellt wurde. |