Virtual Agent API-Funktionen, die in Store-Release 2,0.x verfügbar sind
Virtual Agent API-Version 2,0.x bietet Zugriff auf mehr der gleichen Funktionen, die in verfügbar sind Virtual Agent Und Mitarbeiterchat, Einschließlich Rich Control-Unterstützung und Benachrichtigungen.
Unterstützung für zusätzliche umfassende Steuerungen
Virtual Agent Die API unterstützt jetzt die folgenden umfassenden Steuerungen.
- Boolesche Steuerungen
- Boolesche Steuerungen geben Antworten als Zeichenfolgen zurück (entweder YesOder No) Zur einfacheren Lokalisierung.
Weitere Informationen zur Themenlokalisierung finden Sie unter Wird Lokalisiert Virtual Agent Konversationen.
Virtual Agent Die API sendet das folgende Beispiel-JSON für eine boolesche Steuerung:{ "requestId": "asd2423-wrr434-weruyt-1234567", "clientSessionId": "", "nowSessionId": "", "message": { "text": "7a36412253a13010ff59ddeeff7b12fb", "typed": false, "clientMessageId": "ABC-123" }, "userId": "beth.anglin", "body": [ { "uiType": "Boolean", "group": "DefaultPicker", "required": true, "nluTextEnabled": false, "label": "Sample Response for boolean control", "options": [ { "label": "Yes" }, { "label": "No" } ] } ], "score": 1 } - Anwenderdefinierte Steuerungen
- Themen, die anwenderdefinierte Steuerungen verwenden, werden jetzt unterstützt. Weitere Informationen zu anwenderdefinierten Steuerungen finden Sie unter Wird Angepasst Virtual Agent Mit anwenderdefinierten Steuerungen.
- Tabellen-Bot-Antwortsteuerungen
- Themen, die Tabellen-Bot-Antwortsteuerungen verwenden, werden jetzt unterstützt. Weitere Informationen finden Sie unter Tabellen-Bot-Antwortsteuerung.
Alle Datensätze werden von zurückgegeben Virtual Agent API gleichzeitig. Virtual Agent Wartet auf eine Antwort vom API-Client, um die nächste Steuerung zu senden. Verwenden Sie paginationBreakEigenschaft zum Anzeigen von Datensätzen in Blöcken für den Anwender. Beispiel: Wenn paginationBreakIst auf 10 festgelegt, werden dem Anwender jeweils 10 Datensätze angezeigt. Wenn der Client bereit ist, zur nächsten Steuerung zu wechseln, sollte er senden DONE.
Virtual Agent Die API sendet das folgende Beispiel-JSON für eine Tabellen-Bot-Antwortsteuerung:{ "requestId": "asd2423-wrr434-weruyt-1234567", "clientSessionId": "", "nowSessionId": "", "message": { "text": "Yes", "typed": false, "clientMessageId": "ABC-123" }, "userId": "beth.anglin", "body": [ { "uiType": "OutputTable", "group": "DefaultOutputTable", "label": "Sample Table Rich control", "headers": [ "Number", "Short description" ], "data": [ [ "INC0000005", "CPU load high for over 10 minutes" ], [ "INC0000015", "I can't launch my VPN client since the last software update" ], [ "INC0000025", "Need to add more memory to laptop" ], [ "INC0000035", "Reset my password" ], [ "INC0000055", "SAP Sales app is not accessible" ], [ "INC0009005", "Email server is down." ] ], "paginationBreak": 10, "totalSearchResultsCount": 6, "navigationBtnLabel": "Click for more" } ], "score": 1 } - HTML-Bot-Antwortsteuerungen
- Themen, die HTML-Bot-Antwortsteuerungen verwenden, werden jetzt unterstützt. Weitere Informationen finden Sie unter Steuerelement für HTML-Bot-Antworten.Virtual Agent Die API sendet das folgende Beispiel-JSON für ein HTML-Bot-Antwortsteuerelement:
{ "requestId": "asd2423-wrr434-weruyt-1234567", "clientSessionId": "", "nowSessionId": "", "message": { "text": "Yes", "typed": false, "clientMessageId": "ABC-123" }, "userId": "beth.anglin", "body": [ { "uiType": "OutputHtml", "group": "DefaultOutputHtml", "style": "inline", "height": 100, "width": 100, "value": "<html> <body> Sample Response for Html control </body> </html> ", "imageUrl": null, "imageHeight": 0, "imageWidth": 0, "links": null }, { "uiType": "InputText", "group": "DefaultText", "required": true, "nluTextEnabled": false, "label": "some text", "maskType": "NONE" } ], "score": 1 } - Bot-Antwortsteuerungen mit mehreren Antworten
- Themen, die Bot-Antwortsteuerungen mit mehreren Antworten verwenden, werden jetzt unterstützt. Weitere Informationen finden Sie unter Bot-Antwortsteuerung mit mehreren Antworten.Virtual Agent Die API sendet das folgende Beispiel-JSON für eine Bot-Antwortsteuerung mit mehreren Antworten:
{ "requestId": "asd2423-wrr434-weruyt-1234567", "clientSessionId": "", "nowSessionId": "", "message": { "text": "Done", "typed": false, "clientMessageId": "ABC-123" }, "userId": "beth.anglin", "body": [ { "uiType": "MultiPartOutput", "group": "DefaultMultiPartOutput", "navigationBtnLabel": "Click for more", "content": { "uiType": "OutputText", "value": "Text response from multiflow control example", "maskType": "NONE" } } ], "score": 1 } - Rich-Text-Unterstützung
- Themen, die Rich-Text verwenden, werden jetzt unterstützt. Rich-Text enthält fett oder kursiv formatierten Text, Hyperlinks, Listen mit Aufzählungszeichen und Emojis.
Zusätzliche Funktionen von Mitarbeiterchat
Die Virtual Agent Die API unterstützt jetzt die folgenden Funktionen bei der Übertragung nach Mitarbeiterchat.
- Übergeben Sie Name und Avatar des Service Desk-Mitarbeiters
- Wenn der primäre Bot einen Chat an einen Servicemitarbeiter überträgt, Virtual Agent Kann den Namen und Avatar des Service Desk-Mitarbeiters an den primären Bot senden. Aktivieren Sie, um dies zu aktivieren Namen und Avatare des Service Desk-Mitarbeiters In Mitarbeiterchat-Einstellungen.Eine Beispielnutzlast von Nachrichten könnte wie folgt aussehen:
{ "requestId":"f42f3550-5b44-4cde-aa52-9b6756b3131c", "clientSessionId":"U94CSJLEN", "message":{ "text":"Live Agent support.", "typed":true }, "userId":"U94CSJLEN", "body":[ { "uiType":"OutputText", "group":"DefaultText", "agentInfo":{ "sentFromAgent":true, "agentName":"Beth Anglin", "agentAvatar":"ee4eebf30a0004d963b5c5ac0d734dc4.iix?t=small" }, "value":"Thank you for contacting support. I am looking into your question now and will be with you shortly." } ], "agentChat":true, "score":1 }Weitere Informationen finden Sie unter Konfigurieren Sie Den Mitarbeiterchat .
- Servicemitarbeiter-Wartezeit
- Bei der Übertragung an einen Servicemitarbeiter kann der primäre Bot die Wartezeit empfangen und dem Anwender anzeigen. Wählen Sie aus, um dies zu aktivieren Wartezeit In Live-Chat-Wartestatus Feld in Mitarbeiterchat-Einstellungen. Die spinnerTypeWert ist auf festgelegt wait_time. Wenn Live-Chat-Wartestatus Ist auf festgelegt Keine , spinnerTypeWert ist none.Virtual Agent Die API sendet das folgende Beispiel-JSON in der bodyParameter der Nutzlast.
{ "uiType":"ActionMsg", "actionType":"StartSpinner", "spinnerType":"wait_time", "message":"Routing you to a live agent...", "waitTime":"8 Seconds" }Weitere Informationen finden Sie unter Konfigurieren Sie Den Mitarbeiterchat .
- Chatverlauf vom primären Bot an senden Virtual Agent
- Der primäre Bot kann den Chatverlauf an einen Servicemitarbeiter übergeben, damit der Service Desk-Mitarbeiter den Kontext der Konversation sehen kann.Virtual Agent Konvertiert den Nachrichtenverlauf in HTML und dann in ein Bild.
- Das konvertierte Bild wird als erste Nachricht des Chats an den Servicemitarbeiter gesendet.
- Der primäre Bot sollte den Nachrichtenverlauf in der ersten Anforderung senden. In jeder anderen Anforderung nach der ersten Anforderung wird die Nutzlast des Nachrichtenverlaufs ignoriert.
- Nur Textnachrichten werden unterstützt.
- Der primäre Bot kann jede URL als Wert in der Textnachricht übergeben, der Servicemitarbeiter kann sie jedoch nur als Teil des Bildes anzeigen. Der Servicemitarbeiter kann nicht auf den Link klicken.
Beispielnutzlast der Nachricht:{ "value": "Help me with password reset", "displayName": "able", "type": "text" "isBotMessage": false, }Hinweis:Im vorherigen Beispiel typeIst Groß-/Kleinschreibung beachten und muss einen Wert von haben text.
Angereicherte Anforderungen vom primären Bot
Die Virtual Agent Die API unterstützt jetzt die folgenden Anforderungen vom primären Bot.
- Systemparameter und Kontextvariablen
- Der primäre Bot kann Systemparameter und Kontextvariablen als Eingabe, und übergeben Virtual Agent Berücksichtigt diese Parameter. Systemparameter wie liveagent_devicetype, liveagent_requester_session_language, liveagent_topic, topic, live_agent_only, Und liveagent_devicetimezoneWerden unterstützt. Anwenderdefinierte Kontextvariablen und Mitarbeiterchat Kontextvariablen werden ebenfalls unterstützt. Beispielnutzlast der Nachricht:
{ "requestId": "f42f3550-5b44-4cde-aa52-xxxxxxxxxx", "clientSessionId": "xxxxxxxxxx", "token": "abcd", "message": { "text": "Test", "typed": true }, "contextVariables": { "requester_session_language": "es" }, "userId": ""abel.tuter", "emailId": "abel.tuter@example.com" }Weitere Informationen finden Sie unter Live agent chat context variables und Konfigurieren Sie Kontextvariablen zum Speichern von Chat-bezogenen Informationen.
- Anwenderzeitzone
- Legen Sie die Zeitzone des Anwenders fest, indem Sie sie in der Anforderungsnutzlast übergeben. Sobald festgelegt, wird diese Zeitzoneneinstellung beibehalten, bis sie zurückgesetzt wird.Beispielnutzlast der Nachricht:
{ "requestId": "xxxxxx-xxxxxx-xxxx-xxxx-xxxxxxxxxx", "clientSessionId": "xxxxxxxx-xxxx", "token": "xxxxx", "action" : "SET_USER_TIMEZONE", "userId": "able.tuter", "emailId": "abel.tuter@example.com", "timezone":"Asia/Kolkata" }Beachten Sie bei der Verwendung dieser Funktionalität Folgendes:- Die Konversation muss offen (aktuell) sein, um Datum und Uhrzeit in die Zeitzone des Anwenders zu konvertieren.
- Der primäre Bot muss Datum und Uhrzeit in einem der folgenden Formate senden:
- Name der Zeitzone. Zum Beispiel Asia/Kolkata oder America/New_York.
- 24-Stunden-Format für Datum/Uhrzeit. Beispiel: YYYY-MM-DD HH:MM:SS
- Die Virtual Agent Die API verwendet die vom primären Bot angegebene Zeitzone, auch wenn sich die von ihr festgelegte Zeitzone von dem in der Tabelle [sys_user] gespeicherten Wert unterscheidet.
- Um die Anwenderzeitzone festzulegen, senden Sie SET_TIMEZONEAktion. Wenn der Name der Zeitzone nicht gültig ist, wird der Zeitzonenwert standardmäßig auf UTC-Zeit festgelegt. Zum Beispiel 2021-02-16 20:13:13.
Unterstützung für Knotenüberspringen
Virtual Agent Die API unterstützt das Überspringen eines Knotens, wenn dies im Thema vorgesehen ist. Beispiel: In Virtual Agent-Designer, Sie können ein Anwendereingabesteuerelement als übersprungsfähig in festlegen Bereich des Eigenschaftsblatts.
Weitere Informationen zum Definieren eines Knotens als übersprungsfähig finden Sie unter Virtual Agent-Designer-Steuerelemente für Benutzereingaben.
Wenn ein Knoten als übersprungsfähig markiert ist, zeigt der Bot diese Option dem Anwender an. Wenn der Anwender sie überspringt, sollte der primäre Bot den Befehl überspringen, wie im folgenden Beispiel dargestellt.
{
"requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId": "835607",
"token": "snow",
"message": {
"text": "_skip_",
"typed": false
},
"emailId": "beth.anglin@example.com",
"userId": "beth.anglin"
}Unterstützung für synchronen Handshake
Hinweis:
Diese Anforderungen gelten für Version 2,0.x von Virtual Agent API. Um die Funktionalität des synchronen Handshake zu verbessern, führen Sie ein Upgrade auf Version 3,0.x durch, die die Übertragung von Servicemitarbeitern und andere Erweiterungen unterstützt. Details finden Sie unter Verbesserungen beim synchronen Handshake.
Wenn aktiviert, Virtual Agent Stellt Antworten synchron an den primären Bot bereit. Wenn Sie die Kommunikation mit aktivieren möchten Virtual Agent Im synchronen Modus müssen Sie die folgenden Funktionen manuell deaktivieren, damit der Handshake funktioniert:
- Mitarbeiterchat
- Benachrichtigungen
- Eingabeindikatoren
Hinweis:
Themen, die die folgenden Funktionen verwenden, werden im synchronen Modus nicht unterstützt: Datei-Upload , Aktionsdienstprogramm, Und Themenblock anhalten .
Um diese Funktionen zu deaktivieren und den synchronen Support zu aktivieren, gehen Sie wie folgt vor:
- Schließen Sie den Bot-zu-Bot-Kanal aus Mitarbeiterchat.
- Navigieren Sie zu Alle , Und geben Sie dann ein sys_properties.list Im Filter.
- Wählen Sie aus com.glide.cs.exclude.liveagent.supportSystemeigenschaft zum Öffnen.
- Hinzufügen Bot To BotZu Wert Feld.
Abbildung : 2. Schließen Sie den Bot-zu-Bot-Kanal aus Mitarbeiterchat - Klicken Sie auf Aktualisieren.
- Navigieren Sie zu Alle , Und geben Sie dann ein sys_cs_Channel.list Im Navigationsfilter.
- Wählen Sie den Bot-zu-Bot-Datensatz aus.
- Löschen Sie Aktivieren Sie Benachrichtigungen Kontrollkästchen zum Deaktivieren.
- Löschen Sie Support-Eingabeindikator Kontrollkästchen zum Deaktivieren.
- Wählen Sie aus Synchron Kontrollkästchen.
Abbildung : 3. Bot-zu-Bot-Kanal mit aktivierter synchroner Unterstützung Hinweis:Wenn Synchron Feld ist nicht sichtbar, können Sie Konfigurieren Sie das Formularlayout Um es anzuzeigen. - Klicken Sie auf Aktualisieren.
Benachrichtigungsunterstützung
Verwenden Virtual Agent API zum Senden der folgenden Benachrichtigungstypen im Bot-an-Bot-Kanal, wenn sie im asynchronen Modus aktiviert ist:
- Einfach: Reine Textbenachrichtigungen. Einfache Benachrichtigungen werden gesendet, sobald sie eintreffen.
- Bildkarte: Ein Bild, das auf den Server hochgeladen oder mit einer URL angegeben wird.
- Datensatzkarte: Angegebene Spalten aus einem Datensatz in einer Tabelle.
- Umsetzbar: Bietet dem Anwender die Möglichkeit, bestimmte Aktionen auszuführen. Benachrichtigungen mit Aktionen werden in die Warteschlange gestellt. Der Anwender kann sie bei Bedarf abrufen, indem er den sendet Show NotificationBefehl.
Weitere Informationen finden Sie unter Wird Konfiguriert Virtual Agent Benachrichtigungen.
Virtual Agent Die API sendet das folgende Beispiel-JSON für eine einfache Benachrichtigung:
{
"requestId": "asd2423-wrr434-weruyt-1234567",
"clientSessionId": "",
"nowSessionId": "",
"message": {
"text": "Done",
"typed": false,
"clientMessageId": "ABC-123"
},
"userId": "beth.anglin",
"body": [
{
"uiType": "OutputCard",
"group": "DefaultOutputCard",
"templateName": "Notification",
"data": "{\"sys_id\":null,\"recordDisplayValue\":null,\"messageHeading\":\"[Heading]A notification has arrived. You can continue the conversation after viewing the notification.\",\"imageUrl\":null,\"tableLabel\":null,\"enableLink\":false,\"message\":\"[message]A notification has arrived. You can continue the conversation after viewing the notification.\",\"fields\":[],\"table_name\":null,\"url\":\"http://192.168.1.9:8080/null.do?sys_id=null\"}"
}
],
"completed": true,
"score": 1
}Virtual Agent Die API sendet das folgende Beispiel-JSON für eine Bildkartenbenachrichtigung:
{
"requestId": "asd2423-wrr434-weruyt-1234567",
"clientSessionId": "",
"nowSessionId": "",
"message": {
"text": "Done",
"typed": false,
"clientMessageId": "ABC-123"
},
"userId": "beth.anglin",
"body": [
{
"uiType": "OutputCard",
"group": "DefaultOutputCard",
"templateName": "Notification",
"data": "{\"sys_id\":null,\"recordDisplayValue\":null,\"messageHeading\":\"[Heading]A notification has arrived. You can continue the conversation after viewing the notification.\",\"imageUrl\":\"http://xxxxxx.service-now.com/2b2d0d2653a13010ff59ddeeff7b120d.iix\",\"tableLabel\":null,\"enableLink\":false,\"message\":\"[message]A notification has arrived. You can continue the conversation after viewing the notification.\",\"fields\":[],\"table_name\":null,\"url\":\"http://192.168.1.9:8080/null.do?sys_id=null\"}"
}
],
"completed": true,
"score": 1
}Virtual Agent Die API sendet das folgende Beispiel-JSON für eine Datensatzkartenbenachrichtigung:
{
"requestId": "asd2423-wrr434-weruyt-1234567",
"clientSessionId": "",
"nowSessionId": "",
"message": {
"text": "Done",
"typed": false,
"clientMessageId": "ABC-123"
},
"userId": "beth.anglin",
"body": [
{
"uiType": "OutputCard",
"group": "DefaultOutputCard",
"templateName": "Notification",
"data": "{\"sys_id\":\"552c48888c033300964f4932b03eb092\",\"recordDisplayValue\":\"INC0010112\",\"messageHeading\":\"[Heading]A notification has arrived. You can continue the conversation after viewing the notification.\",\"imageUrl\":null,\"tableLabel\":\"Incident\",\"enableLink\":true,\"message\":\"[message]A notification has arrived. You can continue the conversation after viewing the notification.\",\"fields\":[{\"fieldLabel\":\"Number\",\"fieldValue\":\"INC0010112\"},{\"fieldLabel\":\"Short description\",\"fieldValue\":\"Assessment : ATF Assessor\"}],\"table_name\":\"incident\",\"url\":\"http://192.168.1.9:8080/incident.do?sys_id=552c48888c033300964f4932b03eb092\"}"
}
],
"completed": true,
"score": 1
}Benachrichtigungen für den Bot-zu-Bot-Kanal sind standardmäßig deaktiviert. Gehen Sie wie folgt vor, um sie zu aktivieren:
- Navigieren Sie zu Alle , Und geben Sie dann ein sys_cs_Channel.list Im Navigationsfilter.
- Öffnen Sie den Bot-zu-Bot-Datensatz.
Wenn Sie dazu aufgefordert werden, aktivieren Sie die Bearbeitung des Datensatzes.
- Wählen Sie aus Aktivieren Sie Benachrichtigungen Kontrollkästchen.
- Klicken Sie auf Aktualisieren.
Administratoren können die Anzahl der Empfänger pro Benachrichtigung beschränken, indem sie ändern com.glide.cs.per_notification_user_limitEigenschaft. Der Standardwert ist 1000.
Themenwechsel mithilfe des Themennamens
Zusätzlich zur Verwendung der Themen-ID oder der Themenabsicht-ID zum Wechseln von Themen können Sie den Namen des Themas oder der Themenabsicht verwenden. Es wird empfohlen, nur die Themen-ID oder den Themennamen zu senden. Wenn entweder falsch ist oder sich der Bot bereits im angegebenen Thema befindet, Virtual Agent Sendet keine Antwort. Die Nutzung hängt wie folgt vom verwendeten Modus ab:
- NLU-Themen-Discovery: Verwenden Sie den Namen oder die ID der Themenabsicht.
- Stichwort-Thema-Discovery: Verwenden Sie den Themennamen oder die ID.
Der primäre Bot kann senden SWITCHAktion zusammen mit dem Themennamen, um direkt zu einem bestimmten Thema zu wechseln.
Beispielnutzlast der Nachricht:
{
"requestId": "xxxx-xxxx-xxxx-xxxx",
"clientSessionId": "xxx-xxx-xxx-xxx",
"action":"SWITCH",
"topic":{
"name": "Topic Name"
},
"userId": "beth"
} Unterstützung für Tippindikatoren
Sie können Eingabeindikatoren für Anwender und Servicemitarbeiter aktivieren. Derzeit werden Tippindikatoren wie folgt angezeigt:
- Wird dem Service Desk-Mitarbeiter angezeigt, wenn der Anwender die Eingabe durchführt
- Wird dem Anwender angezeigt, wenn der Bot eine Antwort vorbereitet
Wenn der Tippindikator aktiviert ist, Virtual Agent API sendet StartTypingIndicator Und EndTypingIndicator Aktionen in der Antwortnutzlast. Zum Beispiel:
{
"uiType":"ActionMsg",
"actionType":"StartTypingIndicator"
} Um den Eingabeindikator des Anwenders an einen Servicemitarbeiter zu senden, sollte der Client den senden TYPING Aktion. Wenn der Anwender die Eingabe abgeschlossen hat, sollte der Client den senden VIEWING Aktion. Beispiel:
{
"requestId": "xxxxxx-xxxxxx-xxxx-xxxx-xxxxxxxxxx",
"clientSessionId": "xxxxxxxx-xxxx",
"action": "TYPING/VIEWING",
"userId": "able.tuter",
"emailId": "abel.tuter@example.com",
"timezone":"Asia/Kolkata"
} Um Tippindikatoren zu aktivieren, führen Sie die folgenden Schritte aus.
- Navigieren Sie zu Alle , Und geben Sie dann ein sys_cs_Channel.list Im Navigationsfilter.
- Wählen Sie den Bot-zu-Bot-Datensatz aus.
- Wählen Sie aus Support-Eingabeindikator Kontrollkästchen.
- Klicken Sie auf Aktualisieren.