RCS for Business-Agents kommunizieren mit Nutzern, indem sie Nachrichten senden und empfangen. Wenn Ihr Agent Nachrichten an Nutzer senden möchte, sendet er Nachrichtenanfragen an die RCS Business Messaging API. Eine einzelne Anfrage kann Text, interaktive Chat-Nachrichten, Medien- und PDF-Dateien, Antwortvorschläge und vorgeschlagene Aktionen enthalten.
Die RCS for Business-Plattform gibt in bestimmten Situationen Fehler zurück, um Sie bei der Verwaltung der Nachrichtenzustellung zu unterstützen:
- Wenn Sie eine Nachricht an einen Nutzer senden, dessen Gerät RCS nicht unterstützt oder auf dem RCS nicht aktiviert ist, gibt die RCS for Business-Plattform den Fehler
404 NOT_FOUNDzurück. In diesem Fall können Sie versuchen, den Nutzer über die in Ihrer Infrastruktur definierten Fallback-Methoden zu erreichen. - Wenn Sie eine Nachricht an einen RCS-Nutzer in einem Netzwerk senden, in dem Ihr Agent noch nicht eingeführt wurde, oder in einem Netzwerk, in dem RCS-Traffic nicht aktiviert ist, gibt die RCS for Business-Plattform den Fehler
404 NOT_FOUNDzurück. - Wenn Sie eine Nachricht mit Funktionen senden, die das Gerät eines Nutzers nicht unterstützt, gibt die RCS for Business-Plattform den Fehler
400 INVALID_ARGUMENTzurück und stellt Ihre Nachricht nicht zu.
Im Rahmen Ihrer Multi-Channel-Messaging-Strategie ist es am besten, Nachrichten, die nach einer angemessenen Zeit nicht zugestellt wurden, zu widerrufen und über einen anderen Kanal zu senden. Wenn Sie Nachrichten automatisch zu einem vordefinierten Zeitpunkt widerrufen möchten, legen Sie einen Nachrichtenablauf fest.
Empfänger ist offline
Die RCS for Business-Plattform akzeptiert eine Nachricht auch dann, wenn der Empfänger offline ist. Sie erhalten eine 200 OK-Antwort und die RCS for Business-Plattform speichert die Nachricht und versucht 30 Tage lang, sie zuzustellen. Sie müssen RCS for Business nicht bitten, die Nachricht noch einmal zu senden.
RCS for Business löscht alle nicht zugestellten Nachrichten 30 Tage nach dem Senden.
Je nach Anwendungsfall Ihres Agenten möchten Sie möglicherweise eine nicht zugestellte Nachricht widerrufen, bevor diese 30-tägige Frist abläuft. Durch den Widerruf kann verhindert werden, dass Offline-Nutzer eine veraltete Nachricht erhalten, wenn sie wieder online sind. Es gibt mehrere Möglichkeiten, eine Nachricht zu widerrufen:
- Senden Sie eine Widerrufsanfrage, um den Widerruf auszulösen.
- Legen Sie ein Ablaufdatum für die Nachricht fest, damit sie zum entsprechenden Zeitpunkt automatisch widerrufen wird.
ein Ablaufdatum für die Nachricht festlegen.
Ist die Nachricht Ihres KI-Agenten zeitkritisch? Einmalpasswörter sind beispielsweise nur für kurze Zeit gültig. Zeitlich begrenzte Angebote laufen ab. Und Terminerinnerungen sind nach dem Termindatum nicht mehr relevant. Damit Nachrichten aktuell und relevant bleiben, legen Sie ein Ablaufdatum für Nachrichten fest. So kann verhindert werden, dass Offline-Nutzer veraltete Inhalte erhalten, wenn sie wieder online sind. Der Ablauf ist auch ein guter Hinweis, um Ihre Fallback-Messaging-Strategie aufzurufen, damit Nutzer die benötigten Informationen rechtzeitig erhalten.
Wenn Sie ein Ablaufdatum für eine Nachricht festlegen möchten, geben Sie eines der folgenden Felder in der Agent-Nachricht an:
expireTime: Die genaue Uhrzeit in UTC, zu der die Nachricht abläuft.ttl(time to live): Die Zeit, bis die Nachricht abläuft.
Informationen zu Formatierungs- und Wertoptionen finden Sie unter AgentMessage.
Der Höchstwert für ttl und expireTime beträgt 15 Tage nach dem Senden der Nachricht.
Der Mindestwert für ttl und expireTime beträgt sechs Sekunden nach dem Senden der Nachricht.
Empfehlungen zum Festlegen des Ablaufs von Nachrichten
Für Authentifizierungsnachrichten (OTP): Setzen Sie
ttlauf mindestens 15 Sekunden nach dem Senden der Nachricht, um die Wahrscheinlichkeit von Race-Bedingungen bei der Zustellung und beim Widerruf erheblich zu verringern.Für Transaktions- und Werbenachrichten: Legt längere Ablaufzeiten fest (mindestens 60 Sekunden oder je nach Anwendungsfall Minuten bis Stunden), da Geräte zusätzliche Zeit zum Scannen von Nachrichten und zum Herunterladen oder Verarbeiten von Rich-Media-Inhalten benötigen und Nutzer kurzzeitig die Verbindung verlieren können (z. B. in einem Aufzug oder Tunnel).
Gültigkeitsdauer (TTL) für eine Nachricht
Wenn Sie eine TTL für eine RCS for Business-Nachricht festlegen, geben Sie an, wie lange die Nachricht als gültig und zustellbar gelten soll. Wenn die Nachricht nicht innerhalb dieser TTL-Frist erfolgreich an das Gerät des Nutzers zugestellt wird, versucht die RCS for Business-Plattform automatisch, sie zu widerrufen.
Wenn Sie eine Nachricht widerrufen, fordern Sie die RCS for Business-Plattform auf, die Zustellung dieser bestimmten Nachricht nicht mehr zu versuchen. Diese Aktion wirkt sich jedoch nur auf zukünftige Zustellversuche aus. Wenn das Gerät eines Nutzers die Nachricht bereits erfolgreich abgerufen hat, wird die Nachricht verarbeitet und die RCS for Business-Plattform kann die Nachricht nicht vom Gerät des Nutzers widerrufen.
Das passiert mit Benachrichtigungen:
Nachricht innerhalb der TTL zugestellt: Wenn das Gerät des Nutzers online geht und die Nachricht vor Ablauf der TTL empfängt, erhalten Sie eine
DELIVERED-Benachrichtigung. Es wird keine Benachrichtigung über den Widerruf gesendet, da die Nachricht erfolgreich zugestellt wurde. Das ist das gängigste und zu erwartende Szenario.Nachricht nicht vor Ablauf der TTL zugestellt: Wenn die TTL abläuft, bevor die Nachricht das Gerät des Nutzers erreicht (z. B. weil das Gerät offline ist), versucht die RCS for Business-Plattform, die Nachricht zu widerrufen. Sie erhalten eine
TTL_EXPIRATION_REVOKED-Benachrichtigung, die angibt, dass die Nachricht erfolgreich aus der Zustellungswarteschlange entfernt wurde. In diesem Fall erhält der Nutzer die Nachricht nicht.
Empfehlungen für den Umgang mit Grenzfällen
Unser System verarbeitet die Zustellung von RCS for Business-Nachrichten und den Ablauf der TTL parallel. Aus diesem Grund kann es in sehr seltenen Fällen vorkommen, dass Benachrichtigungen zu unerwarteten Zeiten gesendet werden. Beispielsweise erhalten Sie möglicherweise sowohl eine Zustellungs- als auch eine TTL-Benachrichtigung oder keine von beiden.
Hier sind unsere Empfehlungen für den Umgang mit Benachrichtigungen zu RCS for Business-Nachrichten:
DELIVERED-Benachrichtigung: Wenn Sie eineDELIVERED-Benachrichtigung für eine Nachricht erhalten, wurde die Nachricht dem Nutzer zugestellt. Sie können alle nachfolgenden TTL-Benachrichtigungen für diese Nachricht ignorieren.TTL_EXPIRATION_REVOKED-Benachrichtigung: Wenn Sie eine TTL-Benachrichtigung mit dem StatusTTL_EXPIRATION_REVOKEDerhalten, bedeutet das, dass das RCS for Business-System die Zustellung dieser bestimmten Nachricht nicht mehr versucht. Sie sollten diese Nachricht als nicht zugestellt behandeln und bei Bedarf mit Ihrer Fallback-Strategie fortfahren.TTL-Benachrichtigung mit einem anderen Status: Wenn Sie eine TTL-Benachrichtigung mit einem anderen Status erhalten, deutet dies auf einen nicht eindeutigen Widerrufsversuch hin.
- Leiten Sie für kritische Nachrichten wie Einmalpasswörter (OTPs) Ihre Fallback-Methode ein.
- Bei nicht kritischen Nachrichten entscheiden Sie, ob Sie den Fallback initiieren möchten oder nicht.
- Keine Benachrichtigungen: In seltenen Fällen kann es vorkommen, dass das System keine TTL-Benachrichtigung sendet und der Client keine Zustellungsbenachrichtigung generiert. Dies ist ein extrem seltener Fall.
Nachrichten-Traffic-Typ festlegen
Die RBM API enthält das Feld messageTrafficType, um Nachrichten zu kategorisieren.
Während Anwendungsfälle für KI-Agenten weiterhin das Verhalten des KI-Agenten und die geltenden Geschäftsregeln definieren, ermöglicht messageTrafficType eine detailliertere Kategorisierung des Nachrichteninhalts. Letztendlich ist es so möglich, dass ein einzelner Agent mehrere Anwendungsfälle verarbeiten kann. Derzeit gibt es keine Auswirkungen auf bestehende Anwendungsfälle oder Geschäftsregeln für Agenten.
Dieses Feld ist optional. Es wird jedoch empfohlen, es jetzt festzulegen, damit Sie keine Fehlermeldung erhalten, wenn das Feld erforderlich wird.
Wenn Sie den Typ des Nachrichtentraffics festlegen möchten, weisen Sie jeder Nachricht basierend auf ihrem Inhalt die entsprechende messageTrafficType zu. In der folgenden Tabelle sind die unterstützten Traffictypen und die erwarteten Anwendungsfälle für Agenten aufgeführt. Diese Zuordnung ist eine empfohlene Anleitung für die erwartete Nutzung, keine Einschränkung, die derzeit von der API erzwungen wird.
| Traffictyp | Inhalt der Nachricht | Empfohlener Anwendungsfall für KI-Agenten |
|---|---|---|
AUTHENTICATION |
Für Authentifizierungsnachrichten. | OTP |
TRANSACTION |
Für Nachrichten zu bestehenden Diensten oder Produkten eines Nutzers. Beispiele: Bestätigungen, Zahlungsbelege oder Buchungsdetails. | Transaktions- oder Mehrfachnutzung |
PROMOTION |
Für Werbenachrichten wie Angebote, Rabatte, Ankündigungen oder andere Werbeinhalte. | Werbe- oder Mehrfachnutzung |
SERVICEREQUEST |
Für Nachrichten zu Diensten, die der Nutzer ausdrücklich angefordert hat. | OTP, Transaktionen, Werbung oder Mehrfachnutzung |
ACKNOWLEDGEMENT |
Für Nachrichten, die zur Bestätigung einer Nutzeraktion verwendet werden, insbesondere einer Abmeldeanfrage. Damit wird bestätigt, dass die Anfrage des Nutzers eingegangen ist und bearbeitet wird. | OTP, Transaktionen, Werbung oder Mehrfachnutzung |
Wenn kein Traffictyp festgelegt ist, weist das System den Standardtyp für den Anwendungsfall des KI-Agenten zu.
| Anwendungsfall eines Agents | Standard-Traffic-Typ |
|---|---|
| OTP | AUTHENTICATION |
| Transaktional | TRANSACTION |
| Werbung | PROMOTION |
| Mehrfachnutzung | MESSAGE_TRAFFIC_TYPE_UNSPECIFIED |
Mehrzweck-Agents haben keinen Standard-Traffictyp. Sie sollten den Traffic-Typ für jede Nachricht explizit anhand ihres Inhalts festlegen. Wenn Sie den Wert MESSAGE_TRAFFIC_TYPE_UNSPECIFIED nicht ersetzen, wird die Nachricht trotzdem akzeptiert und ohne eine bestimmte Traffic-Typ-Klassifizierung zugestellt.
Größenbeschränkungen für Nachrichten
Die maximale Größe der gesamten stringifizierten AgentMessage beträgt 250 KB. Der Textteil der Nachricht hat ein eigenes Limit von 3.072 Zeichen.
Um einen unerwarteten Datenverbrauch für Nutzer zu vermeiden, beträgt die maximale Größe einer Datei, die über RCS for Business gesendet werden kann, 100 MiB. Die Gesamtgröße aller Medien- und PDF-Anhänge in einer einzelnen RCS for Business-Nachricht darf 100 MiB nicht überschreiten. (1 MiB = 1.048.576 Byte). Weitere Informationen finden Sie unter Medien- und PDF-Dateien.
Text
Die einfachsten Nachrichten bestehen aus Text. Textnachrichten eignen sich am besten, um Informationen zu kommunizieren, ohne dass visuelle Elemente, komplexe Interaktionen oder Antworten erforderlich sind.
Beispiel
Mit dem folgenden Code wird eine Nur-Text-Nachricht gesendet. Informationen zu Formatierungs- und Wertoptionen finden Sie unter phones.agentMessages.create.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d '{ "contentMessage": { "text": "Hello, world!" }, "messageTrafficType": "PROMOTION" }'
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); let params = { messageText: 'Hello, world!', msisdn: '+12223334444', }; // Send a simple message to the device rbmApiHelper.sendMessage(params, function(response) { console.log(response); });
Java
import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Send simple text message to user rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444" ); } catch(Exception e) { e.printStackTrace(); }
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create a simple RBM text message message_text = messages.TextMessage('Hello, world!') # Send text message to the device messages.MessageCluster().append_message(message_text).send_to_msisdn('+12223334444')
C#
using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", );
Inhalt von Basic Message – Konvertierung von SMS
Mobilfunkanbieter haben Abrechnungsmodelle eingeführt, um die Umstellung von SMS-Nachrichten auf RCS for Business zu unterstützen. Eine RCS for Business-Nachricht mit bis zu 160 UTF-8-Zeichen wird als einfache Nachricht bezeichnet.
Wenn du eine Anfrage zum Senden einer einfachen Nachricht erstellst, denke daran, dass Zeichen als 1 Byte (UTF-8) gezählt werden. Wenn Sie eine Nachricht mit Sonderzeichen wie Emojis oder einem Multi-Byte-Zeichensatz senden, zählt jedes Zeichen als 2–4 UTF-8-Zeichen oder mehr.
Geben Sie Text in das Feld ein, um die Länge zu prüfen:
Nachrichteninhalt und Linkvorschauen
RCS-Clients können Linkvorschauen implementieren. Wenn eine reine Textnachricht von RCS for Business eine URL für eine Website mit openGraph-Tags enthält, kann der Client eine Vorschau (Bild, Titel usw.) generieren, um die Nachricht ansprechender zu gestalten. Beispiel: Einfache Nachricht mit URL-Vorschau.
Beachten Sie, dass der RCS-Client dem Nutzer möglicherweise erlaubt, Linkvorschauen zu deaktivieren.
Einmalpasswörter für die Nutzerbestätigung
Mit RCS for Business können Sie Einmalpasswörter (OTPs) für die automatische Nutzerbestätigung mit der SMS Retriever API senden. Es gibt keine spezielle API zum Lesen von OTPs, die über RCS for Business eingehen.
Funktionsweise unter Android
Bei Android-Apps, die bei der SMS Retriever API registriert sind, wartet die API auf eine korrekt formatierte RCS for Business-Nachricht. Diese Nachricht muss sowohl das OTP als auch einen eindeutigen Hash enthalten, der Ihre App identifiziert.
Wenn eine RCS for Business-Nachricht im richtigen Format empfangen wird, verarbeitet die SMS Retriever API sie wie ein SMS-OTP. Nachdem der Hash mit Ihrer App abgeglichen wurde, wird das OTP extrahiert und zur automatischen Nutzerbestätigung an Ihre App weitergeleitet.
- Beispiel für eine RCS for Business-Nachricht zur Nutzerbestätigung:
Your code is <OTP><app hash>. - Beispiel:
Your code is 123456 M8tue43FGT.
Weitere Informationen zum SMS Retriever und zugehörigen APIs finden Sie in der Dokumentation zum SMS Retriever. Weitere Informationen zur automatischen Nutzerbestätigung in Apps, die mit der SMS Retriever API registriert sind, finden Sie in diesem Flussdiagramm.
Funktionsweise unter iOS
Unter iOS erkennt die integrierte OTP-Verarbeitung des Systems automatisch RCS for Business-OTPs und schlägt sie für das automatische Ausfüllen vor, genau wie SMS-OTPs. Für die iOS-App ist keine spezielle API-Integration erforderlich, um das OTP zu lesen.
Medien- und PDF-Dateien
Wenn Sie eine Nachricht mit einem Bild, Video, Audio oder einer PDF-Datei senden, muss Ihr Agent eine öffentlich zugängliche URL für den Inhalt angeben oder die Datei direkt hochladen.
Die maximale Größe einer Datei, die gesendet werden kann, beträgt 100 MiB. Die Gesamtgröße aller Medien- und PDF-Anhänge in einer einzelnen Nachricht darf 100 MiB nicht überschreiten.
Medienkomprimierung und -transcodierung
Die RCS for Business-Plattform transcodiert und komprimiert Mediendateien (z. B. Bilder und Videos) automatisch, bevor sie gesendet werden. So wird sichergestellt, dass sie schnell geladen werden und in verschiedenen Netzwerken und auf verschiedenen Geräten gut funktionieren.
Die Komprimierung basiert auf der Qualität der Eingabemedien und nicht ausschließlich auf Dateigrößenbeschränkungen. Das bedeutet, dass eine Datei auch dann komprimiert werden kann, wenn ihre Größe weit unter dem maximalen Limit von 100 MiB liegt. Die Transcodierungsstandards ändern sich ständig. Es gibt also keine feste Dateigrößenbeschränkung, die bestimmt, wann die Transcodierung umgangen wird. Experimentieren Sie mit verschiedenen Medienformaten, Dimensionen und Komprimierungsraten, um die optimale Balance für Ihre Nutzlasten zu finden.
Spezifikationen für Thumbnails
Für Mediendateien kannst du auch ein Thumbnail angeben, mit dem Nutzer eine Vorschau des Inhalts sehen können, bevor sie darauf klicken. Bei Audiodateien wird das Standard-Audiowidget als Platzhalter verwendet.
- Die maximale Dateigröße eines Thumbnails beträgt 100 KB. Für eine optimale Nutzererfahrung empfehlen wir eine Größe von maximal 50 kB.
- Das Seitenverhältnis der Miniaturansicht sollte dem Seitenverhältnis der Originaldatei entsprechen.
Caching und URL-Verwaltung
Die RCS for Business-Plattform speichert Dateien 60 Tage lang im Cache. Die API gibt eine Datei-ID zurück, die Ihr Agent in Nachrichten an Nutzer einfügen kann. Nach 60 Tagen werden die Dateien von RCS for Business aus dem Cache entfernt.
Wenn Sie Dateien nach URL angeben, ist es Best Practice, contentMessage.forceRefresh auf false zu setzen. Wenn Sie contentMessage.forceRefresh auf true setzen, wird RCS for Business gezwungen, neue Inhalte von der angegebenen URL abzurufen, auch wenn der URL-Inhalt im Cache gespeichert ist. Dadurch verlängert sich die Zustellzeit von Nachrichten für Nutzer.
Beispiel für eine Datei-URL
Mit dem folgenden Code wird ein Bild gesendet. Informationen zu Formatierungs- und Wertoptionen finden Sie unter AgentContentMessage.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d '{ "contentMessage": { "contentInfo": { "fileUrl": "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif", "forceRefresh": false } } }'
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); let params = { fileUrl: 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif', msisdn: '+12223334444', }; // Send an image/video to a device rbmApiHelper.sendMessage(params, function(response) { console.log(response); });
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.AgentContentMessage; import com.google.api.services.rcsbusinessmessaging.v1.model.AgentMessage; import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); String fileUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif"; // create media only message AgentContentMessage agentContentMessage = new AgentContentMessage(); agentContentMessage.setContentInfo(new ContentInfo().setFileUrl(fileUrl)); // attach content to message AgentMessage agentMessage = new AgentMessage(); agentMessage.setContentMessage(agentContentMessage); rbmApiHelper.sendAgentMessage(agentMessage, "+12223334444"); } catch(Exception e) { e.printStackTrace(); }
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create media file attachment file_message = messages.FileMessage('http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif') messages.MessageCluster().append_message(file_message).send_to_msisdn('+12223334444')
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); string fileUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif"; // Create content info with the file url ContentInfo contentInfo = new ContentInfo { FileUrl = fileUrl }; // Attach content info to a message AgentContentMessage agentContentMessage = new AgentContentMessage { ContentInfo = contentInfo, }; // Attach content to message AgentMessage agentMessage = new AgentMessage { ContentMessage = agentContentMessage }; rbmApiHelper.SendAgentMessage(agentMessage, "+12223334444");
Alternativ können Sie Medien vor dem Senden in einer Nachricht mit files.create hochladen.
Beispiel für den Dateiupload
Mit dem folgenden Code werden eine Videodatei und eine Thumbnail-Datei hochgeladen und dann beide Dateien in einer Nachricht gesendet. Informationen zu Formatierungs- und Wertoptionen finden Sie unter files.create und AgentContentMessage.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/upload/v1/files?agentId=AGENT_ID" \ -H "Content-Type: video/mp4" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ --upload-file "FULL_PATH_TO_VIDEO_MEDIA_FILE"# Capture server-specified video file name from response body JSONcurl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/upload/v1/files?agentId=AGENT_ID" \ -H "Content-Type: image/jpeg" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ --upload-file "FULL_PATH_TO_THUMBNAIL_MEDIA_FILE"# Capture server-specified image file name from response body JSONcurl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d '{ "contentMessage": { "uploadedRbmFile": { "fileName": "SERVER-SPECIFIED_VIDEO_FILE_NAME", "thumbnailName": "SERVER-SPECIFIED_THUMBNAIL_FILE_NAME" } } }'
Unterstützte Medientypen
RCS for Business unterstützt die folgenden Medientypen. Für Thumbnails werden nur image/jpeg, image/jpg, image/gif und image/png unterstützt.
| Medientyp | Dokumenttyp | Erweiterung | Funktioniert mit Rich Cards |
|---|---|---|---|
| application/ogg | OGG-Audio | .ogx | Nein |
| application/pdf | Ja (nur für Google Messages in Indien) | ||
| audio/aac | AAC-Audio | .aac | Nein |
| audio/mp3 | MP3-Audio | .mp3 | Nein |
| audio/mpeg | MPEG-Audio | .mpeg | Nein |
| audio/mpg | MPG-Audio | .mp3 | Nein |
| audio/mp4 | MP4-Audio | .mp4 | Nein |
| audio/mp4-latm | MP4-latm-Audio | .mp4 | Nein |
| audio/3gpp | 3GPP-Audio | .3gp | Nein |
| image/jpeg | JPEG | .jpeg, .jpg | Ja |
| image/gif | GIF | GIF | Ja |
| image/png | PNG | PNG | Ja |
| video/h263 | H263-Video | .h263 | Ja |
| video/m4v | M4V-Video | .m4v | Ja |
| video/mp4 | MP4-Video | .mp4 | Ja |
| video/mpeg4 | MPEG-4-Video | .mp4, .m4p | Ja |
| video/mpeg | MPEG-Video | .mpeg | Ja |
| video/webm | WEBM-Video | .webm | Ja |
Vorschläge
Ihr Agent sendet Vorschläge (Antwortvorschläge und vorgeschlagene Aktionen) in Listen mit Vorschlags-Chips oder in interaktiven Chat-Nachrichten.
Antwortvorschläge
Antwortvorschläge führen Nutzer durch Unterhaltungen, indem sie Antworten bereitstellen, auf die Ihr Agent reagieren kann.
Wenn ein Nutzer auf einen Antwortvorschlag tippt, empfängt Ihr Agent ein Ereignis, das den Text und die Postback-Daten der Antwort enthält. Die Nutzlast darf maximal 2.048 Zeichen lang sein.
Beispiel
Mit dem folgenden Code wird Text mit zwei Antwortvorschlägen gesendet. Informationen zu Formatierungs- und Wertoptionen finden Sie unter SuggestedReply.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d '{ "contentMessage": { "text": "Hello, world!", "suggestions": [ { "reply": { "text": "Suggestion #1", "postbackData": "suggestion_1" } }, { "reply": { "text": "Suggestion #2", "postbackData": "suggestion_2" } } ] } }'
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); let suggestions = [ { reply: { 'text': 'Suggestion #1', 'postbackData': 'suggestion_1', }, }, { reply: { 'text': 'Suggestion #2', 'postbackData': 'suggestion_2', }, }, ]; let params = { messageText: 'Hello, world!', msisdn: '+12223334444', suggestions: suggestions, }; // Send a simple message with suggestion chips to the device rbmApiHelper.sendMessage(params, function(response) { console.log(response); });
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.RbmApiHelper; import com.google.rbm.SuggestionHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); suggestions.add( new SuggestionHelper("Suggestion #1", "suggestion_1").getSuggestedReply()); suggestions.add( new SuggestionHelper("Suggestion #2", "suggestion_2").getSuggestedReply()); // Send simple text message to user rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444", suggestions ); } catch(Exception e) { e.printStackTrace(); }
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create text message to send to user text_msg = messages.TextMessage('Hello, world!') cluster = messages.MessageCluster().append_message(text_msg) # Append suggested replies for the message to send to the user cluster.append_suggestion_chip(messages.SuggestedReply('Suggestion #1', 'reply:suggestion_1')) cluster.append_suggestion_chip(messages.SuggestedReply('Suggestion #2', 'reply:suggestion_2')) # Send a simple message with suggestion chips to the device cluster.send_to_msisdn('+12223334444')
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); List<Suggestion> suggestions = new List<Suggestion> { // Create suggestion chips new SuggestionHelper("Suggestion #1", "suggestion_1").SuggestedReply(), new SuggestionHelper("Suggestion #2", "suggestion_2").SuggestedReply() }; // Send simple text message with suggestions to user rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", suggestions );
Vorgeschlagene Aktionen
Vorgeschlagene Aktionen führen Nutzer durch Unterhaltungen, indem sie die integrierten Funktionen ihrer Geräte nutzen. Ihr Agent kann Nutzern vorschlagen, eine Nummer zu wählen, einen Ort auf einer Karte zu öffnen, einen Standort zu teilen, eine URL zu öffnen oder einen Kalendertermin zu erstellen.
Für jede vorgeschlagene Aktion können Sie optional eine Fallback-URL (maximal 2.048 Zeichen) angeben. Diese URL wird in einem neuen Browserfenster geöffnet, wenn das Gerät des Nutzers die vorgeschlagene Aktion nicht unterstützt.
Wenn ein Nutzer auf eine vorgeschlagene Aktion tippt, empfängt Ihr Agent ein Ereignis, das die Postback-Daten der Aktion enthält.
Informationen zu Formatierungs- und Wertoptionen finden Sie unter SuggestedAction.
Anzeige von Vorschlägen
Es gibt zwei Möglichkeiten, Vorschläge anzuzeigen:
- Persistent: Vorgeschlagene Aktionen oder Antworten, die in der Nachrichtenblase angezeigt werden und während der gesamten Unterhaltung sichtbar bleiben.
- Vorübergehend: Vorschläge, die außerhalb der Nachrichtenblase angezeigt werden und verschwinden, wenn die Unterhaltung fortgesetzt wird.
Unterstützte Nachrichtenformate
- Dauerhafte Vorschläge: Funktionieren mit eigenständigen Textnachrichten und interaktiven Chat-Nachrichten.
- Temporäre Vorschläge: Funktionieren mit eigenständigen Textnachrichten, Mediennachrichten und interaktiven Chat-Nachrichten.
Vorschläge kombinieren
Sie können dauerhafte und vorübergehende Vorschläge in derselben Nachricht oder interaktiven Chat-Nachricht kombinieren.
- Nachrichten: Vorschläge sind standardmäßig temporär. Damit sie in der Bubble bleiben, müssen Sie sie als persistent konfigurieren.
- Interaktive Chat-Nachrichten: Diese unterstützen standardmäßig bis zu vier dauerhafte Vorschläge. Anschließend können Sie temporäre Vorschläge als „Chip-Liste“ unter der Karte hinzufügen.
Vorschlagslimits
Eine einzelne Nachricht unterstützt insgesamt maximal 11 Vorschläge. Alle von Ihnen hinzugefügten dauerhaften Vorschläge werden auf dieses Gesamtlimit angerechnet. Wenn Sie beispielsweise 4 dauerhafte Vorschläge einfügen, können Sie bis zu 7 vorübergehende Vorschläge hinzufügen.
| Vorschlagstyp | Limit | Wo werden sie angezeigt? |
|---|---|---|
| Nichtflüchtig | Bis zu 4 | In der Sprechblase |
| Transient | Bis zu 11 | Außerhalb der Bubble (als Chips) |
Zeichenbeschränkung
Jeder Vorschlag darf maximal 25 Zeichen lang sein.
URL-Transparenz bei vorgeschlagenen Aktionen
Um das Vertrauen der Nutzer zu stärken, wird die zugrunde liegende URL als zweite Textzeile in der Vorschlagsschaltfläche für die vorgeschlagene Aktion „URL öffnen“ angezeigt. Dieses einheitliche Verhalten gilt für eigenständige Textnachrichten, interaktive Chat-Nachrichten und Karussells.
Unterstützte Clients für dauerhafte Vorschläge
- Unterstützt: Google Messages (Version
20260225.00oder höher). - Nicht unterstützt: Google Messages-Versionen vor
20260225.00, iOS und Samsung Messages.
Vorschläge in Systembenachrichtigungen
Wenn ein Nutzer eine Nachricht erhält, zeigt Google Messages den ersten geeigneten Vorschlag direkt in der Android-Systembenachrichtigung an. Nutzer können auf diesen Vorschlag tippen, um eine Antwort zu senden oder eine Aktion auszulösen, ohne die App öffnen zu müssen.
Beachten Sie beim Entwerfen Ihrer Nachrichten das folgende Verhalten:
- Reihenfolge ist wichtig: Pro Benachrichtigung wird nur ein Vorschlag angezeigt. Wenn Sie die Interaktion maximieren möchten, platzieren Sie den Antwortvorschlag oder die Aktion mit der höchsten Priorität an erster Stelle in der Vorschlagsliste.
- Ausgeschlossene Aktionen: Die Aktion Standort teilen wird nie in Systembenachrichtigungen angezeigt. Nutzer müssen die Unterhaltung öffnen, um ihren Standort zu teilen.
Nummer wählen
Die Aktion „Anrufen“ führt den Nutzer dazu, eine von Ihrem Agenten angegebene Telefonnummer zu wählen.
Telefonnummern dürfen nur Ziffern (0-9), Pluszeichen (+), Sternchen (*) und Nummernzeichen (#) enthalten. Das internationale Format E.164 (z. B. +14155555555) wird unterstützt, ist aber nicht erforderlich. Sowohl +14155555555 als auch 1011 sind gültige Einträge.
Beispiel
Mit dem folgenden Code wird eine Wählaktion gesendet. Informationen zu Formatierungs- und Wertoptionen finden Sie unter DialAction.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d '{ "contentMessage": { "text": "Hello, world!", "suggestions": [ { "action": { "text": "Call", "postbackData": "postback_data_1234", "fallbackUrl": "https://www.google.com/contact/", "dialAction": { "phoneNumber": "+15556667777" } } } ] } }'
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Define a dial suggested action let suggestions = [ { action: { text: 'Call', postbackData: 'postback_data_1234', dialAction: { phoneNumber: '+15556667777' } } }, ]; let params = { messageText: 'Hello, world!', msisdn: '+12223334444', suggestions: suggestions, }; // Send a simple message with a dial suggested action rbmApiHelper.sendMessage(params, function(response) { console.log(response); });
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.DialAction; import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); // creating a dial suggested action DialAction dialAction = new DialAction(); dialAction.setPhoneNumber("+15556667777"); // creating a suggested action based on a dial action SuggestedAction suggestedAction = new SuggestedAction(); suggestedAction.setText("Call"); suggestedAction.setPostbackData("postback_data_1234"); suggestedAction.setDialAction(dialAction); // attaching action to a suggestion Suggestion suggestion = new Suggestion(); suggestion.setAction(suggestedAction); suggestions.add(suggestion); // Send simple text message with the suggestion action rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444", suggestions ); } catch(Exception e) { e.printStackTrace(); }
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create a dial suggested action suggestions = [ messages.DialAction('Call', 'reply:postback_data_1234', '+15556667777') ] # Create text message to send to user text_msg = messages.TextMessage('Hello, world!') cluster = messages.MessageCluster().append_message(text_msg) # Append suggestions for the message to send to the user for suggestion in suggestions: cluster.append_suggestion_chip(suggestion) # Send a simple message with suggested action to the device cluster.send_to_msisdn('+12223334444')
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); // Create a dial an agent suggested action DialAction dialAction = new DialAction { PhoneNumber = "+15556667777" }; // Creating a suggested action based on a dial action SuggestedAction suggestedAction = new SuggestedAction { Text = "Call", PostbackData = "postback_data_1234", DialAction = dialAction }; // Attach action to a suggestion Suggestion suggestion = new Suggestion { Action = suggestedAction }; List<Suggestion> suggestions = new List<Suggestion> { suggestion }; rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", suggestions );
Standort ansehen
Mit der Aktion „Standort ansehen“ wird ein Standort in der Standard-Karten-App des Nutzers angezeigt. Sie können den Standort entweder über den Breiten- und Längengrad oder mit einer Abfrage basierend auf dem aktuellen Standort des Nutzers angeben. Sie können auch ein benutzerdefiniertes Label für die Markierung festlegen, die in der Karten-App angezeigt wird.
Beispiel
Mit dem folgenden Code wird eine Aktion zum Aufrufen des Standorts gesendet. Informationen zu Formatierungs- und Wertoptionen finden Sie unter ViewLocationAction.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d '{ "contentMessage": { "text": "Hello, world!", "suggestions": [ { "action": { "text": "View map", "postbackData": "postback_data_1234", "fallbackUrl": "https://www.google.com/maps/@37.4220188,-122.0844786,15z", "viewLocationAction": { "latLong": { "latitude": "37.4220188", "longitude": "-122.0844786" }, "label": "Googleplex" } } } ] } }'
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Define a view location suggested action let suggestions = [ { action: { text: 'View map', postbackData: 'postback_data_1234', viewLocationAction: { latLong: { latitude: 37.4220188, longitude: -122.0844786 }, label: 'Googleplex' } } }, ]; let params = { messageText: 'Hello, world!', msisdn: '+12223334444', suggestions: suggestions, }; // Send a simple message with a view location suggested action rbmApiHelper.sendMessage(params, function(response) { console.log(response); });
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.ViewLocationAction; import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); // creating a view location suggested action ViewLocationAction viewLocationAction = new ViewLocationAction(); viewLocationAction.setQuery("Googleplex, Mountain View, CA"); // creating a suggested action based on a view location action SuggestedAction suggestedAction = new SuggestedAction(); suggestedAction.setText("View map"); suggestedAction.setPostbackData("postback_data_1234"); suggestedAction.setViewLocationAction(viewLocationAction); // attaching action to a suggestion Suggestion suggestion = new Suggestion(); suggestion.setAction(suggestedAction); suggestions.add(suggestion); // Send simple text message with the suggestion action rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444", suggestions ); } catch(Exception e) { e.printStackTrace(); }
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create a view location suggested action suggestions = [ messages.ViewLocationAction('View map', 'reply:postback_data_1234', query='Googleplex, Mountain View, CA') ] # Create text message to send to user text_msg = messages.TextMessage('Hello, world!') cluster = messages.MessageCluster().append_message(text_msg) # Append suggestions for the message to send to the user for suggestion in suggestions: cluster.append_suggestion_chip(suggestion) # Send a simple message with suggested action to the device cluster.send_to_msisdn('+12223334444')
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); // create an view location action ViewLocationAction viewLocationAction = new ViewLocationAction { Query = "Googleplex Mountain View, CA" }; // Attach the view location action to a suggested action SuggestedAction suggestedAction = new SuggestedAction { ViewLocationAction = viewLocationAction, Text = "View map", PostbackData = "postback_data_1234" }; // Attach the action to a suggestion object Suggestion suggestion = new Suggestion { Action = suggestedAction }; List<Suggestion> suggestions = new List<Suggestion> { suggestion }; rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", suggestions );
Standort teilen
Mit der Aktion „Standort teilen“ kann der Nutzer einen Standort mit Ihrem Agenten teilen. Der Nutzer kann entweder seinen aktuellen Standort oder einen manuell ausgewählten Standort aus der Maps App teilen.
Beispiel
Mit dem folgenden Code wird eine Aktion zum Teilen des Standorts gesendet. Informationen zu Formatierungs- und Wertoptionen finden Sie unter ShareLocationAction.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d '{ "contentMessage": { "text": "Hello, world!", "suggestions": [ { "action": { "text": "Share your location", "postbackData": "postback_data_1234", "shareLocationAction": {} } } ] } }'
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Define a share location suggested action let suggestions = [ { action: { text: 'Share your location', postbackData: 'postback_data_1234', shareLocationAction: { } } }, ]; let params = { messageText: 'Hello, world!', msisdn: '+12223334444', suggestions: suggestions, }; // Send a simple message with a share location suggested action rbmApiHelper.sendMessage(params, function(response) { console.log(response); });
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.ShareLocationAction; import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); // creating a share location suggested action ShareLocationAction shareLocationAction = new ShareLocationAction(); // creating a suggested action based on a share location action SuggestedAction suggestedAction = new SuggestedAction(); suggestedAction.setText("Share location"); suggestedAction.setPostbackData("postback_data_1234"); suggestedAction.setShareLocationAction(shareLocationAction); // attaching action to a suggestion Suggestion suggestion = new Suggestion(); suggestion.setAction(suggestedAction); suggestions.add(suggestion); // Send simple text message with the suggestion action rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444", suggestions ); } catch(Exception e) { e.printStackTrace(); }
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create a share location suggested action suggestions = [ messages.ShareLocationAction('Share location', 'reply:postback_data_1234') ] # Create text message to send to user text_msg = messages.TextMessage('Hello, world!') cluster = messages.MessageCluster().append_message(text_msg) # Append suggestions for the message to send to the user for suggestion in suggestions: cluster.append_suggestion_chip(suggestion) # Send a simple message with suggested action to the device cluster.send_to_msisdn('+12223334444')
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); // Create a share location action ShareLocationAction shareLocationAction = new ShareLocationAction(); // Attach the share location action to a suggested action SuggestedAction suggestedAction = new SuggestedAction { ShareLocationAction = shareLocationAction, Text = "Share location", PostbackData = "postback_data_1234" }; // Attach the action to a suggestion object Suggestion suggestion = new Suggestion { Action = suggestedAction }; List<Suggestion> suggestions = new List<Suggestion> { suggestion }; rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", suggestions );
URL öffnen
Mit der Aktion „URL öffnen“ können Sie Nutzer zu einer Webseite weiterleiten, die von Ihrem KI-Agenten angegeben wird. Standardmäßig wird die Webseite im Browser des Nutzers geöffnet. Sie können auch festlegen, dass die Webseite in einer Webansicht geöffnet wird. Weitere Informationen finden Sie unter URL mit Webansicht öffnen.
Nur in Google Messages
Anzeige der zugrunde liegenden URL: Für mehr Transparenz bei A2P-Nachrichten wird in Google Messages die zugrunde liegende URL-Adresse in den vorgeschlagenen Aktionen „URL öffnen“ angezeigt. Diese Änderung betrifft vorgeschlagene Aktionen in standardmäßigen Rich Cards und Rich Card-Karussells.
Anzeige des App-Symbols für Weblinks: Wenn ein Nutzer eine Standard-App für die Webseite konfiguriert hat, wird diese App anstelle des Browsers oder der WebView geöffnet und auf der Vorschlagsschaltfläche wird das Symbol der App angezeigt. Damit das App-Symbol in Google Messages angezeigt wird, müssen Sie die vollständige, direkte URL angeben. Wenn Sie eine gekürzte URL verwenden, wird stattdessen das Standardsymbol „URL öffnen“ angezeigt.
Beispiel
Mit dem folgenden Code wird eine Aktion zum Öffnen einer URL gesendet. Informationen zu Formatierungs- und Wertoptionen finden Sie unter OpenUrlAction.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d '{ "contentMessage": { "text": "Hello, world!", "suggestions": [ { "action": { "text": "Open Google", "postbackData": "postback_data_1234", "openUrlAction": { "url": "https://www.google.com" } } } ] } }'
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Define an open URL suggested action let suggestions = [ { action: { text: 'Open Google', postbackData: 'postback_data_1234', openUrlAction: { url: 'https://www.google.com' } } }, ]; let params = { messageText: 'Hello, world!', msisdn: '+12223334444', suggestions: suggestions, }; // Send a simple message with an open URL suggested action rbmApiHelper.sendMessage(params, function(response) { console.log(response); });
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.OpenUrlAction; import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); // creating an open url suggested action OpenUrlAction openUrlAction = new OpenUrlAction(); openUrlAction.setUrl("https://www.google.com"); // creating a suggested action based on an open url action SuggestedAction suggestedAction = new SuggestedAction(); suggestedAction.setText("Open Google"); suggestedAction.setPostbackData("postback_data_1234"); suggestedAction.setOpenUrlAction(openUrlAction); // attaching action to a suggestion Suggestion suggestion = new Suggestion(); suggestion.setAction(suggestedAction); suggestions.add(suggestion); // Send simple text message with the suggestion action rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444", suggestions ); } catch(Exception e) { e.printStackTrace(); }
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create an open url suggested action suggestions = [ messages.OpenUrlAction('Open Google', 'reply:postback_data_1234', 'https://www.google.com') ] # Create text message to send to user text_msg = messages.TextMessage('Hello, world!') cluster = messages.MessageCluster().append_message(text_msg) # Append suggestions for the message to send to the user for suggestion in suggestions: cluster.append_suggestion_chip(suggestion) # Send a simple message with suggested action to the device cluster.send_to_msisdn('+12223334444')
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); // Create an open url action OpenUrlAction openUrlAction = new OpenUrlAction { Url = "https://www.google.com" }; // Attach the open url action to a suggested action SuggestedAction suggestedAction = new SuggestedAction { OpenUrlAction = openUrlAction, Text = "Open Google", PostbackData = "postback_data_1234" }; // Attach the action to a suggestion object Suggestion suggestion = new Suggestion { Action = suggestedAction }; List<Suggestion> suggestions = new List<Suggestion> { suggestion }; rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", suggestions );
URL mit WebView öffnen
Mit der Aktion „URL mit Webansicht öffnen“ wird die angegebene Webseite in der Messaging-App mit der Rendering-Engine Ihres Standardbrowsers geladen. So kann der Nutzer mit der Webseite interagieren, ohne die RCS for Business-Unterhaltung zu verlassen. Wenn das Gerät des Nutzers keine WebViews unterstützt, wird die Webseite stattdessen im Browser des Nutzers geöffnet. Informationen zum Aktivieren von WebViews finden Sie unter OpenURLApplication.
Für Webansichten gibt es drei Anzeigemodi. Informationen zu Formatierungs- und Wertoptionen finden Sie unter WebviewViewMode.
- Vollbild: Die Webseite wird im Vollbildmodus angezeigt.
- Halb: Die Webseite nimmt die Hälfte des Bildschirms ein.
- Hoch: Die Webseite nimmt drei Viertel des Bildschirms ein.
Beispiel
Mit dem folgenden Code wird eine Aktion „URL mit Webansicht öffnen“ gesendet. Informationen zu Formatierungs- und Wertoptionen finden Sie unter OpenURLAction.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d '{ "contentMessage": { "text": "Hello, world!", "suggestions": [ { "action": { "text": "Open Google", "postbackData": "postback_data_1234", "openUrlAction": { "url": "https://www.google.com", "application": "WEBVIEW", "webviewViewMode": "FULL", "description": "Accessibility description" } } } ] } }'
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.OpenUrlAction; import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.RbmApiHelper; … try { String URL = "https://www.google.com"; // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); // Create suggestion to view webpage in full mode Suggestion viewInFullMode = getUrlActionInWebview(URL, "FULL") suggestions.add(viewInFullMode); // create suggestion to view webpage in half mode Suggestion viewInHalfMode = getUrlActionInWebview(URL, "HALF") suggestions.add(viewInHalfMode); // create suggestion to view webpage in tall mode Suggestion viewInTallMode = getUrlActionInWebview(URL, "TALL") suggestions.add(viewInTallMode); // Send simple text message with the suggested action rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444", suggestions ); } catch(Exception e) { e.printStackTrace(); } /** * Creates a suggested action to open URL in webview. * * @return a suggestion object for an open URL in webview action . */ private Suggestion getUrlActionInWebview(String url, String viewMode) { // create an open url action OpenUrlAction openUrlAction = new OpenUrlAction(); openUrlAction.setUrl(url); openUrlAction.setApplication("WEBVIEW"); openUrlAction.setWebviewViewMode(viewMode); openUrlAction.setDescription("Accessibility description"); // attach the open url action to a suggested action SuggestedAction suggestedAction = new SuggestedAction(); suggestedAction.setOpenUrlAction(openUrlAction); suggestedAction.setText('display_text'); suggestedAction.setPostbackData('postback_data_123'); // attach the action to a suggestion object Suggestion suggestion = new Suggestion(); suggestion.setAction(suggestedAction); return suggestion; }
Kalendertermin erstellen
Mit der Aktion „Kalendertermin erstellen“ wird die Kalender-App des Nutzers geöffnet und ein neuer Termin mit den angegebenen Informationen erstellt.
Ein Titel für den Kalendertermin ist erforderlich. Er darf maximal 100 Zeichen lang sein. Die Beschreibung des Kalendertermins ist optional und darf maximal 500 Zeichen lang sein.
Beispiel
Mit dem folgenden Code wird eine Aktion zum Erstellen eines Kalendertermins gesendet. Informationen zu Formatierungs- und Wertoptionen finden Sie unter CreateCalendarEventAction.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d '{ "contentMessage": { "text": "Hello, world!", "suggestions": [ { "action": { "text": "Save to calendar", "postbackData": "postback_data_1234", "fallbackUrl": "https://www.google.com/calendar", "createCalendarEventAction": { "startTime": "2020-06-30T19:00:00Z", "endTime": "2020-06-30T20:00:00Z", "title": "My calendar event", "description": "Description of the calendar event" } } } ] } }'
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Define a create calendar event suggested action let suggestions = [ { action: { text: 'Save to calendar', postbackData: 'postback_data_1234', createCalendarEventAction: { startTime: '2020-06-30T19:00:00Z', endTime: '2020-06-30T20:00:00Z', title: 'My calendar event', description: 'Description of the calendar event', }, } }, ]; let params = { messageText: 'Hello, world!', msisdn: '+12223334444', suggestions: suggestions, }; // Send a simple message with a create calendar event suggested action rbmApiHelper.sendMessage(params, function(response) { console.log(response); });
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.CreateCalendarEventAction; import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); // creating a create calendar event suggested action CreateCalendarEventAction createCalendarEventAction = new CreateCalendarEventAction(); calendarEventAction.setTitle("My calendar event"); calendarEventAction.setDescription("Description of the calendar event"); calendarEventAction.setStartTime("2020-06-30T19:00:00Z"); calendarEventAction.setEndTime("2020-06-30T20:00:00Z"); // creating a suggested action based on a create calendar event action SuggestedAction suggestedAction = new SuggestedAction(); suggestedAction.setText("Save to calendar"); suggestedAction.setPostbackData("postback_data_1234"); suggestedAction.setCreateCalendarEventAction(createCalendarEventAction); // attaching action to a suggestion Suggestion suggestion = new Suggestion(); suggestion.setAction(suggestedAction); suggestions.add(suggestion); // Send simple text message with the suggestion action rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444", suggestions ); } catch(Exception e) { e.printStackTrace(); }
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create a calendar event suggested action suggestions = [ messages.CreateCalendarEventAction('Save to Calendar', 'reply:postback_data_1234', '2020-06-30T19:00:00Z', '2020-06-30T20:00:00Z', 'My calendar event', 'Description of the calendar event') ] # Create text message to send to user text_msg = messages.TextMessage('Hello, world!') cluster = messages.MessageCluster().append_message(text_msg) # Append suggestions for the message to send to the user for suggestion in suggestions: cluster.append_suggestion_chip(suggestion) # Send a simple message with suggested action to the device cluster.send_to_msisdn('+12223334444')
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); // Create a calendar event action CreateCalendarEventAction calendarEventAction = new CreateCalendarEventAction { Title = "My calendar event", Description = "Description of the calendar event", StartTime = "2020-06-30T19:00:00Z", EndTime = "2020-06-30T20:00:00Z" }; // Attach the calendar event action to a suggested action SuggestedAction suggestedAction = new SuggestedAction { CreateCalendarEventAction = calendarEventAction, Text = "Save to calendar", PostbackData = "postback_data_1234" }; // Attach the action to a suggestion object Suggestion suggestion = new Suggestion { Action = suggestedAction }; List<Suggestion> suggestions = new List<Suggestion> { suggestion }; rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", suggestions );
Liste der Vorschlags-Chips
Ihr Agent sendet Listen mit Vorschlags-Chips mit Nachrichten, um die nachfolgenden Aktionen der Nutzer zu steuern. Die Chipliste wird nur angezeigt, wenn sich die zugehörige Nachricht am Ende der Unterhaltung befindet. Alle nachfolgenden Nachrichten in der Unterhaltung (entweder von einem Nutzer oder Ihrem Agenten) überschreiben die Chip-Liste.
Die Chips in der Liste sind Antwortvorschläge und vorgeschlagene Aktionen.
Chip-Listen enthalten maximal 11 Vorschlags-Chips und jedes Chip-Label darf maximal 25 Zeichen enthalten.
Informationen zu Formatierungs- und Wertoptionen finden Sie unter AgentContentMessage.
Interaktive Chat-Nachrichten
Interaktive Chat-Nachrichten kombinieren Medien, Text und interaktive Vorschläge in einer einzigen Nachricht. Sie eignen sich ideal, um zusammengehörige Informationen zu präsentieren (z. B. ein Produkt mit Bild, Name und Preis) und Nutzern mit einem klaren nächsten Schritt wie dem Vorschlag „Details ansehen“ zu helfen.
Eine interaktive Chat-Nachricht kann Folgendes enthalten:
- Medien (Bild, GIF oder Video)
- Text für Titel
- Beschreibungstext
- Antwortvorschläge und vorgeschlagene Aktionen (maximal 4)
Jedes dieser Felder ist optional, aber mindestens eines der Felder 1–3 muss in der interaktiven Chat-Nachricht enthalten sein.
Mehrere Karten können zusammen in einem horizontal scrollbaren Karussell gesendet werden.
Die Gesamtnutzlast für eine interaktive Chat-Nachricht beträgt 250 KB.
Ausführliche technische Details finden Sie in der Dokumentation zu Rich Cards.
Kartenhöhe
Interaktive Chat-Nachrichten werden vertikal maximiert, um den Inhalt vollständig anzuzeigen. Sie haben eine Mindesthöhe von 112 DP und eine maximale Höhe von 344 DP. Wenn der Karteninhalt nicht groß genug ist, um die Mindesthöhe der Karte zu füllen, wird die Karte maximiert und die zusätzliche Höhe mit Leerzeichen gefüllt.
Medien in interaktiven Chat-Nachrichten müssen eine von drei Höhen haben:
- Short: 112 dp
- Mittel: 168 DP
- Groß: 264 DP
Wenn die Medien nicht in die Abmessungen der Karte passen, wird die Medienvorschau durch Zoomen und Zuschneiden der Medien ausgewählt.
Beispiel
Mit dem folgenden Code wird eine interaktive Chat-Nachricht mit einem Bild und Antwortvorschlägen gesendet. Informationen zu Formatierungs- und Wertoptionen finden Sie unter RichCard.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d '{ "contentMessage": { "richCard": { "standaloneCard": { "thumbnailImageAlignment": "RIGHT", "cardOrientation": "VERTICAL", "cardContent": { "title": "Hello, world!", "description": "RBM is awesome!", "media": { "height": "TALL", "contentInfo":{ "fileUrl": "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif", "forceRefresh": false } }, "suggestions": [ { "reply": { "text": "Suggestion #1", "postbackData": "suggestion_1" } }, { "reply": { "text": "Suggestion #2", "postbackData": "suggestion_2" } } ] } } } } }'
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Suggested replies to be used in the card let suggestions = [ { reply: { 'text': 'Suggestion #1', 'postbackData': 'suggestion_1', }, }, { reply: { 'text': 'Suggestion #2', 'postbackData': 'suggestion_2', }, }, ]; // Image to be displayed by the card let imageUrl = 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif'; // Definition of the card parameters let params = { messageText: 'Hello, world!', messageDescription: 'RBM is awesome!', msisdn: '+12223334444', suggestions: suggestions, imageUrl: imageUrl, height: 'TALL', }; // Send rich card to device rbmApiHelper.sendRichCard(params, function(response) { console.log(response); });
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.StandaloneCard; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.cards.CardOrientation; import com.google.rbm.cards.MediaHeight; import com.google.rbm.RbmApiHelper; import com.google.rbm.SuggestionHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); suggestions.add( new SuggestionHelper("Suggestion #1", "suggestion_1").getSuggestedReply()); suggestions.add( new SuggestionHelper("Suggestion #2", "suggestion_2").getSuggestedReply()); String imageUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif"; // Create a standalone rich card to send to the user StandaloneCard standaloneCard = rbmApiHelper.createStandaloneCard( "Hello, world!", "RBM is awesome!", imageUrl, MediaHeight.MEDIUM, CardOrientation.VERTICAL, suggestions ); rbmApiHelper.sendStandaloneCard(standaloneCard, "+12223334444"); } catch(Exception e) { e.printStackTrace(); }
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Suggested replies to be used in the card suggestions = [ messages.SuggestedReply('Suggestion #1', 'reply:suggestion_1'), messages.SuggestedReply('Suggestion #2', 'reply:suggestion_2') ] # Image to be displayed by the card image_url = 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif'; # Define rich card structure rich_card = messages.StandaloneCard('VERTICAL', 'Hello, world!', 'RBM is awesome!', suggestions, image_url, None, None, 'MEDIUM') # Append rich card and send to the user cluster = messages.MessageCluster().append_message(rich_card) cluster.send_to_msisdn('+12223334444')
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; using RCSBusinessMessaging.Cards; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); List<Suggestion> suggestions = new List<Suggestion> { // Create suggestion chips new SuggestionHelper("Suggestion #1", "suggestion_1").SuggestedReply(), new SuggestionHelper("Suggestion #2", "suggestion_2").SuggestedReply() }; string imageUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif"; // Create rich card with suggestions StandaloneCard standaloneCard = rbmApiHelper.CreateStandaloneCard( "Hello, world!", "RBM is awesome", imageUrl, MediaHeight.TALL, CardOrientation.VERTICAL, suggestions ); // Send rich card to user rbmApiHelper.SendStandaloneCard(standaloneCard, "+12223334444");
Karussells mit interaktiven Chat-Nachrichten
In Karussells werden mehrere interaktive Chat-Nachrichten aneinandergereiht, sodass Nutzer Elemente vergleichen und auf jedes einzeln reagieren können.
Karussells können mindestens zwei und maximal zehn interaktive Chat-Nachrichten enthalten. Interaktive Chat-Nachrichten in Karussells müssen den allgemeinen Anforderungen an interaktive Chat-Nachrichten für Inhalte und Höhe entsprechen, wie in der Dokumentation zu interaktiven Chat-Nachrichten beschrieben. Weitere Informationen zum Karussell-Layout und zu den Spezifikationen finden Sie in der Dokumentation zu Karussells.
Beispiel
Mit dem folgenden Code wird ein Karussell mit interaktiven Chat-Nachrichten gesendet. Informationen zu Formatierungs- und Wertoptionen finden Sie unter RichCard.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d '{ "contentMessage": { "richCard": { "carouselCard": { "cardWidth": "MEDIUM", "cardContents": [ { "title": "Card #1", "description": "The description for card #1", "suggestions": [ { "reply": { "text": "Card #1", "postbackData": "card_1" } } ], "media": { "height": "MEDIUM", "contentInfo": { "fileUrl": "https://storage.googleapis.com/welcome-bot-sample-images/200.jpg", "forceRefresh": false } } }, { "title": "Card #2", "description": "The description for card #2", "suggestions": [ { "reply": { "text": "Card #2", "postbackData": "card_2" } } ], "media": { "height": "MEDIUM", "contentInfo": { "fileUrl": "https://storage.googleapis.com/welcome-bot-sample-images/201.jpg", "forceRefresh": false } } } ] } } } }'
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Images for the carousel cards let card1Image = 'https://storage.googleapis.com/welcome-bot-sample-images/200.jpg'; let card2Image = 'https://storage.googleapis.com/welcome-bot-sample-images/201.jpg'; // Define the card contents for a carousel with two cards, each with one suggested reply let cardContents = [ { title: 'Card #1', description: 'The description for card #1', suggestions: [ { reply: { text: 'Card #1', postbackData: 'card_1', } } ], media: { height: 'MEDIUM', contentInfo: { fileUrl: card1Image, forceRefresh: false, }, }, }, { title: 'Card #2', description: 'The description for card #2', suggestions: [ { reply: { text: 'Card #2', postbackData: 'card_2', } } ], media: { height: 'MEDIUM', contentInfo: { fileUrl: card2Image, forceRefresh: false, }, }, }, ]; // Definition of carousel card let params = { msisdn: '+12223334444', cardContents: cardContents, }; // Send the device the carousel card defined above rbmApiHelper.sendCarouselCard(params, function(response) { console.log(response); });
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.CardContent; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.cards.CardOrientation; import com.google.rbm.cards.CardWidth; import com.google.rbm.cards.MediaHeight; import com.google.rbm.RbmApiHelper; import com.google.rbm.SuggestionHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); List cardContents = new ArrayList(); // Images for the carousel cards String card1Image = "https://storage.googleapis.com/welcome-bot-sample-images/200.jpg"; // Create suggestions for first carousel card List card1Suggestions = new ArrayList(); card1Suggestions.add( new SuggestionHelper("Card #1", "card_1")); cardContents.add( new StandaloneCardHelper( "Card #1", "The description for card #1", card1Image, card1Suggestions) .getCardContent(MediaHeight.SHORT) ); // Images for the carousel cards String card2Image = "https://storage.googleapis.com/welcome-bot-sample-images/201.jpg"; // Create suggestions for second carousel card List card2Suggestions = new ArrayList(); card2Suggestions.add( new SuggestionHelper("Card #2", "card_2")); cardContents.add( new StandaloneCardHelper( "Card #2", "The description for card #2", card2Image, card2Suggestions) .getCardContent(MediaHeight.SHORT) ); // Send the carousel to the user rbmApiHelper.sendCarouselCards(cardContents, CardWidth.MEDIUM, "+12223334444"); } catch(Exception e) { e.printStackTrace(); }
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Images for the carousel cards card_image_1 = 'https://storage.googleapis.com/welcome-bot-sample-images/200.jpg'; card_image_2 = 'https://storage.googleapis.com/welcome-bot-sample-images/201.jpg'; # Suggested replies to be used in the cards suggestions1 = [ messages.SuggestedReply('Card #1', 'reply:card_1') ] suggestions2 = [ messages.SuggestedReply('Card #2', 'reply:card_2') ] # Define the card contents for a carousel with two cards, # each with one suggested reply card_contents = [] card_contents.append(messages.CardContent('Card #1', 'The description for card #1', card_image_1, 'MEDIUM', suggestions1)) card_contents.append(messages.CardContent('Card #2', 'The description for card #2', card_image_2, 'MEDIUM', suggestions2)) # Send the device the carousel card defined above carousel_card = messages.CarouselCard('MEDIUM', card_contents) cluster = messages.MessageCluster().append_message(carousel_card) cluster.send_to_msisdn('+12223334444')
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; using RCSBusinessMessaging.Cards; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); // Image references to be used in the carousel cards string card1Image = "https://storage.googleapis.com/welcome-bot-sample-images/200.jpg"; string card2Image = "https://storage.googleapis.com/welcome-bot-sample-images/201.jpg"; // Suggestion chip lists to be used in carousel cards List<Suggestion> suggestions1 = new List<Suggestion> { new SuggestionHelper("Card #1", "card_1").SuggestedReply() }; List<Suggestion> suggestions2 = new List<Suggestion> { new SuggestionHelper("Card #2", "card_2").SuggestedReply() }; // Create the card content for the carousel List<CardContent> cardContents = new List<CardContent> { // Add items as card content new StandaloneCardHelper( "Card #1", "The description for card #1", card1Image, suggestions1).GetCardContent(), new StandaloneCardHelper( "Card #2", "The description for card #2", card2Image, suggestions2).GetCardContent() }; // Send the carousel to the user rbmApiHelper.SendCarouselCards(cardContents, CardWidth.MEDIUM, msisdn);