Ressource: Nachricht
Eine Nachricht in einer Unterhaltung zwischen einem Agent und einem Nutzer.
JSON-Darstellung |
---|
{ "name": string, "messageId": string, "representative": { object ( |
Felder | |
---|---|
name |
Der von Business Messages festgelegte Name der Nachricht. Gibt „conversations/{conversationId}/messages/{messageId}“ auf, wobei {conversationId} die eindeutige ID für die Unterhaltung und {messageId} die eindeutige ID für die Nachricht ist. |
messageId |
Erforderlich. Die eindeutige ID der Nachricht, die vom Agent zugewiesen wurde. Wenn eine Nachricht versucht, dieselbe |
representative |
Details zum Mitarbeiter (Mensch oder Chatbot), der die Nachricht gesendet hat |
suggestions[] |
Eine Liste mit Antwortvorschlägen, die nach der zugehörigen Nachricht als Liste mit Vorschlags-Chips angezeigt wird. Maximal 13 Vorschläge. Die Chips werden nur angezeigt, wenn die zugehörige Nachricht die neueste Nachricht in der Unterhaltung ist (sowohl Agent- als auch Nutzernachrichten). Der Nutzer kann auf eine vorgeschlagene Antwort tippen, um die Textantwort an den Kundenservicemitarbeiter zu senden. |
fallback |
Optional. Ersatztext, der angezeigt wird, wenn das Gerät des Nutzers den Nachrichtentyp oder -inhalt nicht unterstützt Maximal 3.072 Zeichen. |
containsRichText |
Optional. Falls |
Union-Feld content . Der Inhalt einer Nachricht. Für content ist nur einer der folgenden Werte zulässig: |
|
text |
SMS. Maximal 3.072 Zeichen. |
image |
Bildnachricht. |
richCard |
Rich Card-Nachricht. |
Bild
Ein Bild.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld content . Bildinhalt. Für content ist nur einer der folgenden Werte zulässig: |
|
contentInfo |
Informationen zu einem Bild, einschließlich der URL des Bildes und der URL der Miniaturansicht des Bildes. |
ContentInfo
Nachricht mit den Informationen zum Inhalt.
JSON-Darstellung |
---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean, "altText": string } |
Felder | |
---|---|
fileUrl |
Öffentlich erreichbare URL der Datei Die Plattform bestimmt den MIME-Typ der Datei beim Abrufen der Datei über das Feld content-type in den HTTP-Headern. Das Feld „content-type“ muss in der HTTP-Antwort der URL vorhanden und korrekt sein. Maximal 5 MB. Unterstützte Inhaltstypen: Bild/JPEG, Bild/JPG, Bild/PNG, Bild/Webp |
thumbnailUrl |
Optional. Öffentlich erreichbare URL der Miniaturansicht Wenn Sie keine Miniaturansicht-URL angeben, zeigt die Plattform so lange eine leere Platzhalter-Miniaturansicht an, bis das Gerät des Nutzers die Datei heruntergeladen hat. Maximal 25 KB. Unterstützte Inhaltstypen: Bild/JPEG, Bild/JPG, Bild/PNG, Bild/Webp |
forceRefresh |
Wenn festgelegt, ruft die Plattform die Datei und die Miniaturansicht von den angegebenen URLs ab, auch wenn auf der Plattform Kopien der Datei (und/oder der Miniaturansicht) im Cache gespeichert sind. |
altText |
Text zur Barrierefreiheit mit Details zu den Medien. |
RichCard
Eine eigenständige Rich Card oder ein Karussell mit Rich Cards, die vom Agent an den Nutzer gesendet werden
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld card . Mögliche Rich Cards-Typen Für card ist nur einer der folgenden Werte zulässig: |
|
standaloneCard |
Eigenständige Karte. |
carouselCard |
Infokarten-Karussell |
StandaloneCard
Eigenständige Karte.
JSON-Darstellung |
---|
{
"cardContent": {
object ( |
Felder | |
---|---|
cardContent |
Karteninhalt. |
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, die in die Karte aufgenommen werden sollen. |
suggestions[] |
Optional. Liste der Vorschläge für die Karte. Maximal vier Vorschläge. |
Medien
Eine Mediendatei innerhalb einer Rich Card.
JSON-Darstellung |
---|
{ "height": enum ( |
Felder | |
---|---|
height |
Die Höhe der Medien innerhalb einer Rich Card. |
Union-Feld content . Medieninhalte. Für content ist nur einer der folgenden Werte zulässig: |
|
contentInfo |
Informationen zu einer Datei, einschließlich der URL der Datei und der URL der Miniaturansicht der Datei. |
Größe
Medienhöhe
Enums | |
---|---|
HEIGHT_UNSPECIFIED |
Nicht angegeben. |
SHORT |
112 DP. |
MEDIUM |
168 DP. |
TALL |
264 DP. Nicht verfügbar für Rich-Kartenkarussells, wenn die Kartenbreite auf SMALL festgelegt ist. |
Vorschlag
Ein Vorschlag innerhalb einer Chipliste.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld option . Ein Antwortvorschlag. Für option ist nur einer der folgenden Werte zulässig: |
|
reply |
Ein Vorschlag für den Nutzer, mit dem angegebenen Text zu antworten. |
action |
Eine vorgeschlagene Aktion, die eine native Aktion auf dem Gerät initiiert. |
liveAgentRequest |
Eine Anfrage, einen Kundenservicemitarbeiter zu bitten, an der Unterhaltung teilzunehmen. |
authenticationRequest |
Eine Anfrage zum Starten des Authentifizierungsvorgangs. |
SuggestedReply
Beim Antippen wird die SMS-Antwort an den Kundenservicemitarbeiter zurückgesendet.
JSON-Darstellung |
---|
{ "text": string, "postbackData": string } |
Felder | |
---|---|
text |
Text, der in der vorgeschlagenen Antwort angezeigt und an den Kundenservicemitarbeiter gesendet wird, wenn der Nutzer darauf tippt. Maximal 25 Zeichen. |
postbackData |
Der String, den der Agent erhält, wenn ein Nutzer auf die vorgeschlagene Antwort tippt. Maximal 2.048 Zeichen. |
SuggestedAction
Durch Antippen wird die entsprechende native Aktion auf dem Gerät gestartet.
JSON-Darstellung |
---|
{ "text": string, "postbackData": string, // Union field |
Felder | |
---|---|
text |
Text, der in der vorgeschlagenen Aktion angezeigt wird. Maximal 25 Zeichen. |
postbackData |
Der String, den der Agent erhält, wenn ein Nutzer auf die vorgeschlagene Aktion tippt. Maximal 2.048 Zeichen. |
Union-Feld action . Native Aktion, die auf dem Gerät initiiert wird, wenn der Nutzer auf die vorgeschlagene Aktion tippt Für action ist nur einer der folgenden Werte zulässig: |
|
openUrlAction |
Öffnet die angegebene URL. |
dialAction |
Öffnet die Standard-Telefon-App des Nutzers. |
OpenUrlAction
Öffnet die angegebene URL.
JSON-Darstellung |
---|
{ "url": string } |
Felder | |
---|---|
url |
URL |
DialAction
Öffnet die Standard-Telefon-App des Nutzers mit der angegebenen Telefonnummer.
JSON-Darstellung |
---|
{ "phoneNumber": string } |
Felder | |
---|---|
phoneNumber |
Erforderlich. Die angegebene Telefonnummer im Format RFC 3966. Beispiel: „+1-201-555-0123“. |
LiveAgentRequest
Dieser Typ hat keine Felder.
Beim Tippen wird eine Anfrage an einen Kundenservicemitarbeiter gesendet, der an der Unterhaltung teilnehmen soll.
AuthenticationRequest
Anfrage zum Authentifizieren einer Unterhaltung.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld authentication_type . Der Authentifizierungstyp. Für authentication_type ist nur einer der folgenden Werte zulässig: |
|
oauth |
Details für die Authentifizierung über OAuth. |
OAuth
Details für die Authentifizierung über OAuth.
JSON-Darstellung |
---|
{ "clientId": string, "codeChallenge": string, "scopes": [ string ], "codeChallengeMethod": string } |
Felder | |
---|---|
clientId |
Erforderlich. Die ID der Anwendung, die die Autorisierung anfordert. |
codeChallenge |
Erforderlich. Die Identitätsbestätigung, mit der Zugriffstokens ausgetauscht werden. |
scopes[] |
Erforderlich. Ein Array, das die Bereiche der Anfrage angibt. |
codeChallengeMethod |
Optional. Die zum Generieren der Codeherausforderung verwendete Methode zur Codeherausforderung. Wenn dieser Parameter weggelassen wird, geht der Server von |
CarouselCard
Infokarten-Karussell
JSON-Darstellung |
---|
{ "cardWidth": enum ( |
Felder | |
---|---|
cardWidth |
Die Breite der Karten im Karussell. |
cardContents[] |
Die Inhaltsliste für jede Karte im Karussell. Ein Karussell kann mindestens zwei und maximal zehn Karten enthalten. |
CardWidth
Die Breite der Karten im Karussell.
Enums | |
---|---|
CARD_WIDTH_UNSPECIFIED |
Nicht angegeben |
SMALL |
136 DP. Hohe Medien können nicht aufgenommen werden. |
MEDIUM |
280 DP |
Methoden |
|
---|---|
|
Sendet eine Nachricht von einem Agent an einen Nutzer. |
|
Sendet eine Empfangsbestätigung für eine Nachricht von einem Agent an einen Nutzer. |