Virtual Agent API-Funktionen, die in Store Release 2.0.x verfügbar sind
Virtual Agent API Version 2.0.x bietet Zugriff auf weitere Funktionen, die in Virtual Agent und Mitarbeiterchatverfügbar sind, einschließlich umfangreicher Unterstützung für Steuerungen und Benachrichtigungen.
Unterstützung für zusätzliche Rich Controls
Virtual Agent Die API unterstützt jetzt die folgenden Rich Controls.
- Boolesche Steuerungen
- Boolesche Steuerungen geben Antworten als Zeichenfolgen zurück (entweder Yes oder No), um die Lokalisierung zu erleichtern.
Weitere Informationen zur Themenlokalisierung finden Sie unter Virtual Agent -Konversationen werden lokalisiert.
Virtual Agent Die API sendet das folgende JSON-Beispiel für ein boolesches Steuerelement:{ "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 } - Benutzerdefinierte Steuerungen
- Themen, die benutzerdefinierte Steuerelemente verwenden, werden jetzt unterstützt. Weitere Informationen zu benutzerdefinierten Steuerungen finden Sie unter Virtual Agent mit benutzerdefinierten Steuerungen anpassen.
- Tabellen-Bot-Antwortsteuerungen
- Themen, die Steuerelemente für Tabellen-Bot-Antworten verwenden, werden jetzt unterstützt. Weitere Informationen finden Sie unter Tabellen-Bot-Antwortsteuerung.
Alle Datensätze werden gleichzeitig von der API Virtual Agent zurückgegeben. Virtual Agent wartet auf eine Antwort vom API-Client, um das nächste Steuerelement zu senden. Verwenden Sie die Eigenschaft paginationBreak, um dem Benutzer Datensätze in Blöcken anzuzeigen. Beispiel: Wenn paginationBreak auf 10 festgelegt ist, werden dem Benutzer 10 Datensätze gleichzeitig angezeigt. Wenn der Client bereit ist, zum nächsten Steuerelement zu wechseln, sollte er DONEsenden.
Virtual Agent Die API sendet das folgende JSON-Beispiel für ein Tabellen-Bot-Antwortsteuerelement:{ "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 } - Steuerelemente für HTML-Bot-Antwort
- 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 JSON-Beispiel 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 JSON-Beispiel für ein Bot-Antwortsteuerelement 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 umfasst fetten oder kursiven Text, Hyperlinks, Aufzählungslisten und Emojis.
Zusätzliche Funktionen von Mitarbeiterchat
Die Virtual Agent API unterstützt jetzt die folgenden Funktionen bei der Übertragung an Mitarbeiterchat.
- Übergeben Sie Name und Avatar des Service Desk-Mitarbeiters
- Wenn der primäre Bot einen Chat an einen Servicemitarbeiter überträgt, kann Virtual Agent den Namen und den Avatar des Service Desk-Mitarbeiters an den primären Bot senden. Um dies zu aktivieren, aktivieren Sie Namen und Avatare von Service Desk-Mitarbeitern in den Einstellungen für den Mitarbeiterchat.Eine Beispiel-Nachrichtennutzlast 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 Agent Chat konfigurieren.
- Servicemitarbeiter-Wartezeit
- Bei der Übertragung an einen Servicemitarbeiter kann der primäre Bot die Wartezeit erhalten und dem Benutzer anzeigen. Um dies zu aktivieren, wählen Sie in den Einstellungen für Mitarbeiterchat im Feld Live-Chat-Wartestatus die Option Wartezeit aus. Der Wert spinnerType wird auf wait_timefestgelegt. Wenn der Wartestatus des Live-Chats aufKeinefestgelegt ist, ist der Wert [ spinnerTypenone.Die APIVirtual Agent sendet das folgende JSON-Beispiel im Parameter body der Nutzlast.
{ "uiType":"ActionMsg", "actionType":"StartSpinner", "spinnerType":"wait_time", "message":"Routing you to a live agent...", "waitTime":"8 Seconds" }Weitere Informationen finden Sie unter Agent Chat konfigurieren.
- Senden Sie den Chatverlauf vom primären Bot an Virtual Agent
- Der primäre Bot kann den Chatverlauf an einen Servicemitarbeiter übergeben, damit dieser 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. Bei jeder anderen Anforderung nach der ersten Anforderung wird die Nutzlast des Nachrichtenverlaufs ignoriert.
- Nur Textnachrichten werden unterstützt.
- Der primäre Bot kann eine beliebige 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.
Beispiel für Nachrichtennutzlast:{ "value": "Help me with password reset", "displayName": "able", "type": "text" "isBotMessage": false, }Hinweis:Im vorherigen Beispiel wird bei type zwischen Groß- und Kleinschreibung unterschieden, und der Wert muss text.
Angereicherte Anforderungen vom primären Bot
Die Virtual Agent API unterstützt jetzt die folgenden Anforderungen des primären Bots.
- Systemparameter und Kontextvariablen
- Der primäre Bot kann Systemparameter und Kontextvariablen als Eingabe übergeben, und Virtual Agent berücksichtigt diese Parameter. Systemparameter wie liveagent_devicetype, liveagent_requester_session_language, liveagent_topic, topic, live_agent_onlyund liveagent_devicetimezone werden unterstützt. Benutzerdefinierte Kontextvariablen und Kontextvariablen Mitarbeiterchat werden ebenfalls unterstützt. Beispiel für Nachrichtennutzlast:
{ "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 Kontextvariablen des Servicemitarbeiter-Chats und Konfigurieren Sie Kontextvariablen zum Speichern von chatbezogenen Informationen.
- Benutzerzeitzone
- Legen Sie die Zeitzone des Benutzers fest, indem Sie sie in der Anforderungsnutzlast übergeben. Einmal festgelegt, wird diese Zeitzoneneinstellung beibehalten, bis sie zurückgesetzt wird.Beispiel für Nachrichtennutzlast:
{ "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" }Berücksichtigen Sie bei der Verwendung dieser Funktionalität Folgendes:- Die Konversation muss geöffnet (aktuell) sein, um Datum und Uhrzeit in die Zeitzone des Benutzers zu konvertieren.
- Der primäre Bot muss Datum und Uhrzeit in einem der folgenden Formate senden:
- Zeitzonenname. Zum Beispiel Asia/Kolkata oder America/New_York.
- Datum/Uhrzeit im 24-Stunden-Format. Beispiel: YYYY-MM-DD HH:MM:SS
- Die Virtual Agent API verwendet die vom primären Bot angegebene Zeitzone, auch wenn sich die festgelegte Zeitzone von dem in der Tabelle [sys_user] gespeicherten Wert unterscheidet.
- Senden Sie die Aktion SET_TIMEZONE, um die Benutzerzeitzone festzulegen. Wenn der Zeitzonenname nicht gültig ist, wird der Zeitzonenwert standardmäßig auf UTC-Zeit gesetzt. Zum Beispiel 2021-02-16 20:13:13.
Unterstützung für das Überspringen von Knoten
Virtual Agent Die API unterstützt das Überspringen eines Knotens, wenn dies im Thema vorgesehen ist. Beispielsweise können Sie in Virtual Agent-Designerein Benutzereingabesteuerelement als überspringbar festlegen Bereich des Eigenschaftenblatts.
Weitere Informationen zum Definieren eines Knotens als überspringbar finden Sie unter Virtual Agent-Designer-Steuerelemente für Benutzereingaben.
{
"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
- Mitarbeiterchat
- Benachrichtigungen
- Eingabeindikatoren
- Bot-zu-Bot-Kanal aus Mitarbeiterchatausschließen.
- Navigieren Sie zu Alle, und geben Sie dann sys_properties.list in den Filter ein.
- Wählen Sie die Systemeigenschaft com.glide.cs.exclude.liveagent.support aus, um sie zu öffnen.
- Fügen Sie Bot To Bot zum Feld Wert hinzu.
Abbildung : 2. Schließen Sie den Bot-zu-Bot-Kanal aus aus Mitarbeiterchat - Klicken Sie auf Aktualisieren.
- Navigieren Sie zu Alle, und geben Sie dann sys_cs_channel.list in den Navigationsfilter ein.
- Wählen Sie den Bot-zu-Bot-Datensatz aus.
- Deaktivieren Sie das Kontrollkästchen Benachrichtigungen aktivieren, um sie zu deaktivieren.
- Deaktivieren Sie das Kontrollkästchen Eingabeindikator unterstützen, um ihn zu deaktivieren.
- Aktivieren Sie das Kontrollkästchen Synchron.
Abbildung : 3. Bot-zu-Bot-Kanal mit aktivierter synchroner Unterstützung Hinweis:Wenn das Feld Synchron nicht sichtbar ist, können Sie das Formularlayout so konfigurieren, dass es angezeigt wird. - Klicken Sie auf Aktualisieren.
Unterstützung für Benachrichtigungen
- Einfach: Nur-Text-Benachrichtigungen. Einfache Benachrichtigungen werden zugestellt, 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 Benutzer die Möglichkeit, bestimmte Aktionen auszuführen. Umsetzbare Benachrichtigungen werden in die Warteschlange gestellt. Der Benutzer kann sie bei Bedarf abrufen, indem er den Befehl Show Notification sendet.
Weitere Informationen finden Sie unter Virtual Agent Benachrichtigungen konfigurieren.
{
"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
}{
"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
}{
"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
}- Navigieren Sie zu Alle, und geben Sie dann sys_cs_channel.list in den Navigationsfilter ein.
- Öffnen Sie den Bot-zu-Bot-Datensatz.
Wenn Sie dazu aufgefordert werden, aktivieren Sie die Bearbeitung des Datensatzes.
- Aktivieren Sie das Kontrollkästchen Benachrichtigungen aktivieren.
- Klicken Sie auf Aktualisieren.
Administratoren können die Anzahl der Empfänger pro Benachrichtigung begrenzen, indem sie die Eigenschaft com.glide.cs.per_notification_user_limit ändern. Der Standardwert ist 1000.
Themenwechsel anhand des Themennamens
- NLU-Themenerkennung: Verwenden Sie den Absichtsnamen oder die ID des Themas.
- Stichwort-Themenerkennung: Verwenden Sie den Themennamen oder die ID.
Der primäre Bot kann die Aktion SWITCH zusammen mit dem Themennamen senden, um direkt zu einem bestimmten Thema zu wechseln.
{
"requestId": "xxxx-xxxx-xxxx-xxxx",
"clientSessionId": "xxx-xxx-xxx-xxx",
"action":"SWITCH",
"topic":{
"name": "Topic Name"
},
"userId": "beth"
} Unterstützung für Eingabeindikator
- Wird dem Service Desk-Mitarbeiter angezeigt, wenn der Benutzer tippt
- Wird dem Benutzer angezeigt, wenn der Bot eine Antwort vorbereitet
{
"uiType":"ActionMsg",
"actionType":"StartTypingIndicator"
} {
"requestId": "xxxxxx-xxxxxx-xxxx-xxxx-xxxxxxxxxx",
"clientSessionId": "xxxxxxxx-xxxx",
"action": "TYPING/VIEWING",
"userId": "able.tuter",
"emailId": "abel.tuter@example.com",
"timezone":"Asia/Kolkata"
} - Navigieren Sie zu Alle, und geben Sie dann sys_cs_channel.list in den Navigationsfilter ein.
- Wählen Sie den Bot-zu-Bot-Datensatz aus.
- Aktivieren Sie das Kontrollkästchen Support-Typisierungsindikator.
- Klicken Sie auf Aktualisieren.