Virtual Agent-Bot-Integrations-API
Die Virtual Agent-Bot-Integration Die API stellt Endpunkte bereit, mit denen Anwender jede Chat-Schnittstelle oder ein Bot-Ökosystem in integrieren können ServiceNow Virtual Agent Und/oder Servicemitarbeiter.
Diese API basiert auf dem mit bereitgestellten anwenderdefinierten Konversations-Chat-Integrations-Framework Virtual Agent Und wird in ausgeführt sn_va_as_Service Namespace.
Für zusätzliche Informationen zur Installation und Konfiguration von Virtual Agent Bot-Integrations-API, siehe Virtual Agent-API .
VA-Bot-Integration – POST /sn_va_as_Service/bot/Integration
Sendet eine angegebene Nachricht, einen angegebenen Anhang oder eine angegebene URL an eine angegebene sekundäre Adresse ServiceNow Virtual Agent(VA) Bot.
Der Standort eines Kunden kann mindestens einen sekundären Standort haben ServiceNow Bots. Zusätzlich zur Übergabe von Nachrichten an ServiceNow VA sekundärer Bot, der primäre Bot oder Chat-Client kann diesen Endpunkt verwenden, um Nachrichten über an einen Service Desk-Mitarbeiter zu übergeben Servicemitarbeiter Chat. Verwenden Sie actionParameter, der im Anforderungstext übergeben wird, um anzugeben, wie der angegebene Inhalt behandelt werden soll.
Hinweis:
Dieser Endpunkt kann entweder synchron oder asynchron sein, je nachdem, wie er konfiguriert ist. Wenn die Anforderung asynchron ist und vom Endpunkt empfangen wird, validiert sie die Anforderung und antwortet mit dem Aufrufstatus „Erfolg“ oder „Fehler“ und dem entsprechenden HTTP-Statuscode. Der VA verarbeitet dann die Anforderung und sendet eine zweite Antwort an den konfigurierten Antwortendpunkt. Beispiel: Bei einer Bot-to-Bot-Integration lautet die zweite Antwort an die URL Ihres primären Bots. Beide Antworten sind unten definiert. Weitere Informationen zu diesem konfigurierten Antwortendpunkt finden Sie unter Konfigurieren Sie den REST-Endpunkt der Ausgabeantwort und die ausgehende Authentifizierung für die Virtual Agent-API .
Hinweis:
Die Antworten in den Codebeispielen für diesen Endpunkt zeigen, was vom VA an den konfigurierten Antwortendpunkt gesendet wird. Sie zeigen nicht die tatsächliche Antwort auf diesen Endpunkt an, bei der es sich um eine einfache Erfolgs- oder Fehlerantwort handelt.
URL-Format
Standard-URL: /api/sn_va_as_Service/bot/Integration
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Aktion | Aktion, die der VA ausführen soll. Gültige Werte:
Datentyp: Zeichenfolge Standard: Null |
| BotToBot | Kennzeichnung, die angibt, ob die Konversation zwischen Bots stattfindet, z. B. zwischen einem primären Bot und einem sekundären Bot. Mögliche Werte:
Datentyp: Boolesch Standardwert: wahr |
| Ursache | Ursache eines Fehlers bei der Chatkonversation, z. B. EXTERNAL_FAILURE . Diese Eigenschaft wird nur verwendet, wenn actionEigenschaft ist auf festgelegt FAULT_CONVERSATION. Datentyp: Zeichenfolge |
| ClientSessionId | Eindeutiger Clientsitzungsbezeichner der Anwendung/des Service, den der Endanwender für die Kommunikation mit verwendet ServiceNow Bot Oder die unterstützten Chat-Anwendungen von Drittparteien .
Tabelle: Interaktion [Interaktion] Datentyp: Zeichenfolge Standard: Null |
| ClientVariables | Übergeben Sie JSON-formatierte Name-Wert-Paare, die in der Antwort zurückgesendet werden. Diese Werte werden nicht vom Endpunkt verarbeitet, können jedoch verwendet werden, um bestimmte Kundeninformationen an die Konversation angehängt zu lassen. Datentyp: Objekt Standard: Null |
| ContextVariables | JSON-formatierte Name-Wert-Paare, die zusätzliche Informationen zum Anwender bereitstellen. Geben Sie diese Informationen an, um die Konversations-Experience anzupassen. Weitere Informationen zu Kontextvariablen finden Sie unter Definieren und veröffentlichen Sie Chat-Kontextvariablen . Zum Beispiel: Datentyp: Objekt Standard: Null |
| E-Mail-ID | Erforderlich, wenn die Accountverknüpfung aktiviert wird, andernfalls werden alle Anwender als Gastanwender betrachtet. E-Mail-Adresse des Endanwenders des Chat-Clients, der Person, mit der der Bot interagiert. Weitere Informationen zum Verknüpfen von Accounts finden Sie unter Verknüpfen Sie Ihren ServiceNow-Anwenderaccount mit einer Messaging-Anwendung für Virtual Agent-Konversationen . Datentyp: Zeichenfolge |
| Verlauf | Verlauf der Konversation des primären Bots mit dem Anwender, beginnend mit der ersten Anforderung des Anwenders. Datentyp: Objekt |
| History.displayName | Name des Anwenders, an den die Nachricht gesendet wurde. Wenn der primäre Bot, übergeben Bot . Datentyp: Zeichenfolge |
| Verlauf.isBotNachricht | Kennzeichnung, die angibt, ob die Nachricht vom primären Bot gesendet wurde. Gültige Werte:
Datentyp: Boolesch |
| Verlauf.Zeitstempel | Zeitstempel, der den Zeitpunkt angibt, zu dem die Nachricht gesendet wurde, in Millisekunden. Gültige Werte: 13-stelliger Unix-Zeitstempel Datentyp: Zeichenfolge |
| Verlauf.Typ | Typ der gesendeten Nachricht. Gültige Werte: Text Datentyp: Zeichenfolge |
| Verlauf.Wert | Inhalt der Informationen. Zum Beispiel der Nachrichtentext. Datentyp: Zeichenfolge |
| Absicht | Beschreibt die Absicht der Konversation. Geben Sie diese Informationen an, wenn actionParameter ist auf festgelegt WECHSELN .Datentyp: Objekt |
| intent.id | NLU Absichts-ID des Systemthemas, zu dem die Konversation gewechselt werden soll. Die intent.idWird basierend auf der in der Chatsitzung übergebenen Sprache gelöst. Wenn beim Starten einer Konversation keine Sprache übergeben wird, erhält sie die Sprache aus der Sitzung/dem Profil des Anwenders. Datentyp: Zeichenfolge Tabelle: CS-Themensprache [sys_cs_topic_language] |
| Nachricht | Erforderlich. Details der Nachricht, die an gesendet werden soll ServiceNow Bot. Datentyp: Objekt |
| Nachricht.Anhang | Erforderlich, wenn Anhänge gesendet werden. Details jedes zu sendenden Anhangs. Sie können Anhänge nur als URL übergeben. Für alle Anhänge wird ein Virenscan ausgelöst. Es gibt keine Einschränkung für die Größe eines Anhangs, die Übertragung großer Dateien kann jedoch beträchtliche Zeit in Anspruch nehmen. Datentyp: Array von Objekten |
| Nachricht.Anhang.clientAttachmentId | Eindeutiger Bezeichner des Anhangs, der an gesendet werden soll ServiceNow Bot. Das Format dieses Bezeichners wird vom Implementierer bestimmt. Datentyp: Zeichenfolge Standard: Null |
| Nachricht.Anhang.ContentType | Erforderlich, wenn Anhang angegeben ist. Standard-MIME-Typ des Anhangs. Gültige Werte (Groß-/Kleinschreibung nicht beachten):
Datentyp: Zeichenfolge |
| Nachricht.Anhang.Dateiname | Erforderlich, wenn Anhang angegeben ist. Dateiname des Anhangs. Datentyp: Zeichenfolge |
| Nachricht.Anhang.Header | Zusätzliche Informationen erforderlich, wenn die Anhangdatei privat und geschützt ist. Datentyp: Objekt |
| Nachricht.Anhang.Header.Autorisierung | Informationen, die erforderlich sind, um die Autorisierung für den Zugriff auf den Anhang zu erhalten, z. B. Anwendername und Passwort. Datentyp: Zeichenfolge |
| Nachricht.Anhang.url | Erforderlich, wenn Anhang angegeben ist. URL, unter der sich der Anhang befindet. Der VA ruft den Anhang von dieser URL ab, führt einen Virenscan aus und verarbeitet die Datei dann. Wenn der Anhang keine öffentliche Datei ist, müssen Sie übergeben message.attachment.headerObjekt, das die Autorisierungsinformationen enthält, damit auf den Anhang zugegriffen werden kann. Sie müssen auch sicherstellen, dass die URL-Domäne in den vertrauenswürdigen Domänen vorhanden ist, die in eingereicht wurden sys_cs_provider. Datentyp: Zeichenfolge |
| Message.clientMessageId | Eindeutiger alphanumerischer Bezeichner für die Nachricht. Das Format dieses Bezeichners wird vom Implementierer bestimmt. Datentyp: Zeichenfolge Standard: Null |
| Nachricht.ID | Wird nur mit verwendet UPDATE_MESSAGESAktion. Eindeutige ID der zu aktualisierenden Chatnachricht. Datentyp: Zeichenfolge |
| Nachricht.Status | Nachrichtenstatus. Gültige Werte (Groß-/Kleinschreibung nicht beachten):
Datentyp: Zeichenfolge |
| Nachricht.Text | Erforderlich, wenn attachmentParameter ist nicht angegeben. Nachrichtentext.
Datentyp: Zeichenfolge Maximale Länge: Unbegrenzt |
| Nachricht.typisiert | Erforderlich. Kennzeichnung, die angibt, ob die Nachricht eingegeben wurde oder eine Optionsauswahl war (ausgewählt). Gültige Werte:
Datentyp: Boolesch |
| requestId | Erforderlich. Eindeutiger alphanumerischer Bezeichner für diese Anforderung. Das Format dieses Bezeichners wird vom Implementierer bestimmt. Datentyp: Zeichenfolge |
| SilentMessage | Kennzeichnung, die angibt, ob es sich um eine stille Nachricht handelt. Eine stumme Nachricht ist eine Nachricht, die keine Antwort erfordert. Gültige Werte:
Hinweis:
Wenn eine Anforderung mit ist SilentMessage = wahr Wird gesendet, bleiben alle nachfolgenden Bot-Nachrichten unterdrückt, bis eine Anforderung zum Deaktivieren des stillen Modus durch Übergabe gesendet wird SilentMessage = falsch .Datentyp: Boolesch Standardwert: false |
| timestamp | UNIX-Epochenzeit, zu der die Nachricht vom Endanwender des Chat-Clients gesendet wurde. Datentyp: Zahl Einheit: Millisekunden Standard: Aktuelle Zeit |
| Feld | GMT-Zeitzone des Endanwenders des Chat-Clients. Zum Beispiel: Eine Liste der verfügbaren Zeitzonenwerte finden Sie unter https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. Datentyp: Zeichenfolge Standard: GMT-Zeitzone des ServiceNow Instanz. |
| Thema | Erforderlich, wenn der Anwender durch Angabe eines Themennamens zu einem bestimmten Thema wechseln möchte. Name-Wert-Paar des Themas, zu dem gewechselt werden soll. Sie können entweder den Themennamen oder die sys_ID des Themas angeben Hinweis:
Sie können nur einen einzelnen Themennamen oder eine einzelne Themennummer im Objekt angeben. Datentyp: Objekt Zum Beispiel: |
| topic.name | Name des Themas, zu dem gewechselt werden soll. Datentyp: Zeichenfolge Tabelle: Im Namensfeld der Tabelle „Virtual Agent-Themen“ [sys_cs_topic]. |
| Thema.ID | SYS_ID des Themas, zu dem gewechselt werden soll. Datentyp: Zeichenfolge Tabelle: Virtual Agent-Themen [sys_cs_topic] |
| userId | Erforderlich. Eindeutiger Anwenderbezeichner. Dies ist der Bezeichner des Endanwenders, der mit dem Bot interagiert. Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Token | Erforderlich bei Verwendung einer Token-basierten Authentifizierung; optional für Standard- oder OAuth-Authentifizierung. Authentifizierungstoken, das verwendet werden soll, wenn die Tokenauthentifizierung für diesen Endpunkt eingerichtet wurde. Datentyp: Zeichenfolge |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. Wenn Sie einen Statuscode 200 erhalten, aber keine Antwort erhalten, überprüfen Sie Folgendes:
|
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 405 | Ungültige Methode. Die Funktion ist deaktiviert. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antwort-Haupttexts
Status des Endpunktaufrufs. Dies wird als Antwort gesendet, wenn die Anforderung des ersten Anrufs empfangen wird. Die Anforderung wurde noch nicht verarbeitet.
| Name | Beschreibung |
|---|---|
| Fehler | Beschreibung des erkannten Fehlers. Wird nur zurückgegeben, wenn ein Fehler auftritt. Datentyp: Objekt |
| error.detail | Details zum aufgetretenen Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Fehlermeldung ausgelöst. Datentyp: Zeichenfolge |
| status | Status des Endpunktaufrufs. Gültige Werte:
Datentyp: Zeichenfolge |
VA-Antworttext-Parameter
Antworttext, der vom VA an den konfigurierten Antwortendpunkt gesendet wird.
| Name | Beschreibung |
|---|---|
| AgentChat | Kennzeichnung, die angibt, ob die Konversation mit verbunden ist ServiceNow Servicemitarbeiter. Mögliche Werte:
Datentyp: Boolesch |
| body | Liste von Objekten, die die Elemente des Antwortnachrichtentexts beschreiben. Datentyp: Array von Objekten |
| Textkörper.Aktionstyp | Typ der Aktionsnachricht, die vom sekundären Bot an den primären Bot gesendet wird. Beispiel: Geben Sie den Indikator oder die Wartezeit des Service Desk-Mitarbeiters ein. Mögliche Werte:
Zum Beispiel: Wird Gesendet Wird Gesendet Datentyp: Zeichenfolge |
| Textkörper.AgentInfo | Wenn diese Option im Service Desk-Mitarbeiter-Chat-Setup aktiviert ist, Name und Avatar des zugehörigen Service Desk-Mitarbeiters. Datentyp: Objekt Zum Beispiel: |
| Textkörper.AgentInfo.AgentAvatar | URL der zugehörigen Avatar-Datei des Service Desk-Mitarbeiters. Beispiel: „https://instance.servicenow.com/ee4eebf30a0004d963b5c5ac0d734dc4.iix?t=small" Datentyp: Zeichenfolge |
| Body.agentInfo.AGENTID | Die sys_ID des Servicemitarbeiters. Tabelle: Live-Profil [live_Profile] Datentyp: Zeichenfolge |
| Textkörper.AgentInfo.AgentName | Anzeigename des Service Desk-Mitarbeiters. Datentyp: Zeichenfolge |
| body.agentInfo.sentFromAgent | Kennzeichnung, die angibt, ob die Nachricht von einem Servicemitarbeiter gesendet wurde. Mögliche Werte:
Datentyp: Boolesch |
| Textkörper.Daten | JSON-Zeichenfolge, die die Daten innerhalb der Karte definiert. Datentyp: Zeichenfolge |
| body.group | Rich-Steuerungsgruppe, zu der das Textelement gehört. Sie können diese Standardsteuerungen weiter transformieren, indem Sie ausgehende Transformationsskripts schreiben. Weitere Informationen zu diesen Skripts finden Sie unter Virtual Agent-Aktionsskripts . Mögliche Werte:
Datentyp: Zeichenfolge |
| Textkörper.Header | Link-Header. Datentyp: Zeichenfolge |
| Textkörper.Höhe | Höhe des HTML-Elements. Datentyp: Zahl Einheit: Pixel |
| body.itemType | Typ des Textkörpers. Mögliche Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| Textkörper.Bezeichnung | Bezeichnung, die für das zugeordnete Element angezeigt werden soll. Datentyp: Zeichenfolge |
| Textkörper.Maskiertyp | Vertraulichkeit der zugehörigen Daten. Mögliche Werte:
Datentyp: Zeichenfolge |
| Textkörper.max. Anzahl | Wird nur zurückgegeben, wenn uiTypeIst DateiUpload . Maximale Anzahl von Anhängen, die gleichzeitig hochgeladen werden können.Datentyp: Zahl (Ganzzahl) |
| Textkörper.max. Größe | Wird nur zurückgegeben, wenn uiTypeIst DateiUpload . Maximale Größe des Anhangs, der hochgeladen werden kann.Datentyp: Zahl (Ganzzahl) Einheit: Megabyte |
| Textkörper.Nachricht | Wird nur zurückgegeben, wenn actionTypeIst StartSpinner . Nachricht, die dem Anwender angezeigt werden soll.Datentyp: Zeichenfolge |
| Textkörper.MessageID | Eindeutiger Bezeichner für die Nachricht, die von an die unterstützten Chat-Anwendungen von Drittparteien gesendet wird ServiceNow Virtual Agent. Tabelle: Konversationsnachricht [sys_cs_message] Datentyp: Zeichenfolge |
| Textkörper.Mehrfachauswahl | Kennzeichnung, die angibt, ob der Anwender mehrere Optionen auswählen kann. Mögliche Werte:
Datentyp: Boolesch |
| body.nluTextEnabled | Kennzeichnung, die angibt, ob der Anwender-Chat-Client NLU-Textnachrichten (Natural Language Understanding) erhalten kann. Mögliche Werte:
Datentyp: Boolesch |
| Textkörper.Optionen | Liste, die die für ein Auswahlsteuerelement verfügbaren Optionen beschreibt. Datentyp: Array von Objekten |
| Textkörper.Optionen.Anhang | URL des abzurufenden Bilds im Karussell. Datentyp: Zeichenfolge |
| body.options.description | Beschreibung des Karussellelements. Datentyp: Zeichenfolge |
| Textkörper.Optionen.aktiviert | Kennzeichnung, die angibt, ob das Auswahlsteuerelement im Chat-Client des Endanwenders aktiviert ist. In Bot-to-Bot-Implementierungen ist der primäre Bot dafür verantwortlich, sicherzustellen, dass die Auswahlsteuerung deaktiviert ist. Mögliche Werte:
Datentyp: Boolesch |
| Textkörper.Optionen.Bezeichnung | Bezeichnung, die für die zugeordnete angezeigt werden soll body.options.valueParameter. Datentyp: Zeichenfolge |
| Textkörper.Optionen.RenderStil | Stil, der beim Rendern des zugehörigen Elements verwendet werden soll. Möglicher Wert: Daten Datentyp: Zeichenfolge |
| Text.Optionen.Wert | Wert, der für die zugeordnete angezeigt werden soll body.options.labelParameter. Datentyp: Zeichenfolge |
| body.promptMsg | Aufforderungsnachricht, die mit dem Auswahlsteuerelement angezeigt werden soll. Datentyp: Zeichenfolge |
| Textkörper.erforderlich | Kennzeichnung, die angibt, ob der Endanwender auf die Abfrage im Textelement antworten muss. Mögliche Werte:
Datentyp: Boolesch |
| Body.SpinnerType | Wird nur zurückgegeben, wenn actionTypeIst StartSpinner . Typ des dem Chatanwender angezeigten Spinners.Mögliche Werte: Wait_time: Nachricht, die die Verzögerung vor der Übertragung an einen Servicemitarbeiter angibt. Datentyp: Zeichenfolge |
| Textkörper.Stil | Stil des Textkörpers. Mögliche Werte:
Datentyp: Zeichenfolge |
| Text.templateName | Name der Vorlage, die zum Anzeigen der zugehörigen Karte verwendet werden soll. Datentyp: Zeichenfolge |
| Textkörper.Typ | Nur für DefaultOutputLink zurückgegeben. Typ der Rückgabedaten. Mögliche Werte: Link Datentyp: Zeichenfolge |
| Text.uiType | Typ des Textkörpers. Die möglichen Werte hängen vom Wert in ab body.groupParameter. Diese Werte werden den im Virtual Agent-Designer definierten Steuerungen zugeordnet. Weitere Informationen finden Sie unter Erste Schritte mit Virtual Agent-Designer . Mögliche Werte:
Datentyp: Zeichenfolge |
| Textkörper.Wert | Daten, die zum Verarbeiten des Textelements verwendet werden sollen. Die Art der zurückgegebenen Informationen hängt vom Typ des Textkörpers ab. OutputLink: Objekt. OutputImage: Zeichenfolge. Bild-URL. OutputHtml: Zeichenfolge. HTML, das der Client rendern muss. Datentyp: Zeichenfolge oder Objekt |
| Textkörper.Wert.Aktion | Nur für DefaultOutputLink zurückgegeben. URL des zurückgegebenen Links. Datentyp: Zeichenfolge |
| Text.Wartezeit | Zeit, die der Anwender warten muss, bevor er mit einem Servicemitarbeiter verbunden wird. Datentyp: Zeichenfolge |
| Textkörper.Breite | Breite des zugeordneten HTML-Elements. Datentyp: Zahl Einheit: Pixel |
| ClientSessionId | Eindeutiger Clientsitzungsbezeichner der Chatanwendung/des Chatservices, die der Endanwender für die Kommunikation mit verwendet ServiceNow Bot. Datentyp: Zeichenfolge |
| ClientVariables | JSON-formatierte Name-Wert-Paare, die aus dem kopiert werden, was in übergeben wird clientVariablesParameter im Anforderungstext. Diese Werte werden nicht vom Endpunkt verarbeitet, können jedoch verwendet werden, um bestimmte Kundeninformationen an die Konversation angehängt zu lassen. Datentyp: Objekt |
| abgeschlossen | Kennzeichnung, die angibt, ob ServiceNow Virtual Agent Hat die Konversation erfolgreich abgeschlossen. Mögliche Werte:
Datentyp: Boolesch |
| EnterpriseID | Derzeit nicht verwendet. |
| interactionId | Eindeutiger Bezeichner für jede Konversation zwischen ServiceNow Virtual Agent Und die unterstützten Chat-Anwendungen von Drittparteien. Datentyp: Zeichenfolge |
| Nachricht | Details der Nachricht, die an gesendet wurde ServiceNow VA. Dies ist mit dem übergebenen Nachrichtenobjekt identisch. Datentyp: Objekt |
| Nachricht.Anhang | Details des Anhangs. Anhänge können entweder eine Datei oder eine URL sein. Datentyp: Objekt |
| Nachricht.Anhang.clientAttachmentId | Eindeutiger Bezeichner des Anhangs, der an gesendet wurde ServiceNow VA. Das Format dieses Bezeichners wird vom Implementierer bestimmt. Datentyp: Zeichenfolge |
| Nachricht.Anhang.ContentType | Standard-MIME-Typ des Anhangs. Mögliche Werte (Groß-/Kleinschreibung nicht beachten):
Datentyp: Zeichenfolge |
| Nachricht.Anhang.Dateiname | Dateiname des Anhangs. Datentyp: Zeichenfolge |
| Nachricht.Anhang.url | URL, unter der sich der Anhang befindet. Datentyp: Zeichenfolge |
| Message.clientMessageId | Eindeutiger alphanumerischer Bezeichner für die Nachricht. Datentyp: Zeichenfolge |
| Nachricht.Text | Nachrichtentext. Datentyp: Zeichenfolge Maximale Länge: Unbegrenzt |
| Nachricht.typisiert | Kennzeichnung, die angibt, ob die Nachricht eingegeben wurde oder eine Optionsauswahl war (ausgewählt). Mögliche Werte:
Datentyp: Boolesch |
| NowBotId | Derzeit nicht verwendet. |
| NowSessionId | Derzeit nicht verwendet. |
| requestId | Eindeutiger Bezeichner für diese Anforderung. Datentyp: Zeichenfolge |
| Punktzahl | Absichtskonfidenzpunktzahl aus dem ServiceNow NLU Modell, angegeben als Prozentsatz, z. B. 87,3%. Mit dieser Punktzahl kann der primäre Bot entscheiden, ob die zugehörige Absicht basierend auf den primären Bots angezeigt werden soll NLU Vertrauensschwellenwert des Modells. Die ServiceNow NLU Der Konfidenzschwellenwert des Modells wird auf ignoriert ServiceNow Instanz, damit die primären Bots NLU Der Konfidenzschwellenwert des Modells kann konsistent auf alle sekundären Bots angewendet werden. Datentyp: Zahl |
| TakeControl | Kennzeichnung, die angibt, dass ServiceNow Virtual Agent Möchte die Kontrolle an den primären Bot zurückgeben. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| userId | Bezeichner des Endanwenders, der mit dem Bot interagiert. Datentyp: Zeichenfolge |
Starten Sie eine Konversation mit der Aktion „START_CONVERSATION“, um eine Konversation zu starten
Das folgende Beispiel zeigt, wie Sie mit der Aktion „START_CONVERSATION“ eine Konversation mit starten Virtual Agent. Dieser Anruf leitet den Anwender zum Begrüßungsthema weiter.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"requestId": "asd2423-sda23-qwe23-we23",
"action": "START_CONVERSATION",
"enterpriseId": "ServiceNow",
"nowBotId": "A85PWLERF",
"clientSessionId": "",
"nowSessionId": "",
"message":{
"text": "",
"typed": true,
"clientMessageId": "ABC-123"
},
"userId": "beth.anglin",
"emailId": "beth.anglin@example.com",
"timestamp": 1588824102,
"timezone": "America/New_York"
}"
--user "username":"password"
Im Folgenden finden Sie den Antworttext, der vom VA an den konfigurierten Antwortendpunkt gesendet wird.
{
"requestId":"asd2423-sda23-qwe23-we23",
"clientSessionId":"",
"nowSessionId":"",
"message":{
"text":"",
"typed":true,
"clientMessageId":"ABC-123"
},
"userId":"beth.anglin",
"body":[
{
"uiType":"OutputText",
"group":"DefaultText",
"value":"Hi, I'm your Virtual Agent. Let me know how I can help you today.",
"maskType":"NONE"
},
{
"uiType":"TopicPickerControl",
"group":"DefaultPicker",
"nluTextEnabled":false,
"promptMsg":"Hi guest, please enter your request or make a selection of what I can help with. You can type help any time when you need help.",
"label":"Show me everything",
"options":[
{
"label":"b2b topic",
"value":"2bb7bd7670de6010f877c7f188266fc7",
"enabled":true
},
{
"label":"Live Agent Support.",
"value":"ce2ee85053130010cf8cddeeff7b12bf",
"enabled":true
}
]
}
],
"score":1
} Erstellen Sie eine Chat-Interaktion
Das folgende Beispiel zeigt, wie Sie die Aktion CREATE_CONVERSATION zum Erstellen einer Chat-Interaktion verwenden.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId": "",
"action": "CREATE_CONVERSATION",
"message": {
"text": "hi",
"typed": false
},
"userId": "abel.tuter",
"emailId": "abel.tuter@example.com"
}"
--user "username":"password"
Im Folgenden finden Sie den Antworttext, der vom VA an den konfigurierten Antwortendpunkt gesendet wird.
{
"requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId": "",
"message": {
"text": "hi",
"typed": false
},
"userId": "abel.tuter",
"interactionId": "240c91c8fd9f2e50f877c29ac5fbe8ed",
"body": [
{
"uiType": "ActionMsg",
"actionType": "CreateConversation",
"conversationId": "a40c91c8fd9f2e50f877c29ac5fbe8eb",
"interactionId": "240c91c8fd9f2e50f877c29ac5fbe8ed",
"messageId": "b80c91c8fd9f2e50f877c29ac5fbe8f8"
}
],
"score": 1
}Starten Sie eine Konversation, die mit der Aktion „START_CREATED_CONVERSATION“ initiiert wurde
Das folgende Beispiel zeigt, wie Sie eine Chat-Konversation starten, die mit der Aktion CREATE_CONVERSATION initiiert wurde.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId": "",
"action": "START_CREATED_CONVERSATION",
"userId": "abel.tuter",
"emailId": "abel.tuter@example.com"
}"
--user "username":"password"
Im Folgenden finden Sie den Antworttext, der vom VA an den konfigurierten Antwortendpunkt gesendet wird.
{
"requestId":"302bas2be70-sadsa-we32-3eq2-1231ra9",
"clientSessionId":"",
"message":{
"text":"hola",
"typed":true
},
"userId”:”abel.tuter",
"body":[
{
"uiType":"OutputText",
"group":"DefaultText",
"value":"Hi, I'm your Virtual Agent. Let me know how I can help you today.",
"maskType":"NONE"
},
{
"uiType":"TopicPickerControl",
"group":"DefaultPicker",
"nluTextEnabled":false,
"promptMsg":"Hi guest, please enter your request or make a selection of what I can help with. You can type hellllp! any time when you need help.",
"label":"Show me everything",
"options":[
{
"label":"boolean check",
"value":"1b5257a1db712010d3d6d9595e9619f3",
"enabled":true
},
{
"label":"Test_table_datepicker",
"value":"6515f0cadb4220108249f7541d961980",
"enabled":true
},
{
"label":"Test File upload",
"value":"76c1f4b2db7520108249f7541d9619a7",
"enabled":true
},
{
"label":"Test B2B 2",
"value":"8373e55cdb8120108249f7541d96196d",
"enabled":true
},
{
"label":"FAQ Conversation Builder_Global",
"value":"9f3114a3dbc520108249f7541d961981",
"enabled":true
},
{
"label":"Get to know you",
"value":"a443dd6adb812010d3d6d9595e961954",
"enabled":true
},
{
"label":"Get to know you_Global",
"value":"b1a56b87db8120108249f7541d9619b2",
"enabled":true
},
{
"label":"Live Agent Support.",
"value":"ce2ee85053130010cf8cddeeff7b12bf",
"enabled":true
},
{
"label":"Apply for PTO_B2B NLU",
"value":"d948c94cdb052010d3d6d9595e961969",
"enabled":true
}
]
}
],
"score":1
} Fehler bei einer Konversation mit
Das folgende Beispiel zeigt, wie die Aktion „FAULT_CONVERSATION“ verwendet und der Wert von festgelegt wird causeParameter.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId": "",
"action": "FAULT_CONVERSATION",
"cause": "EXTERNAL_FAILURE",
"userId": "abel.tuter",
"emailId": "abel.tuter@example.com"
}"
--user "username":"password"
Im Folgenden finden Sie den Antworttext, der vom VA an den konfigurierten Antwortendpunkt gesendet wird.
{
"requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId": "",
"userId": "abel.tuter",
"body": [],
"takeControl": true,
"score": 0
}Aktualisieren Sie die Nachricht im Chat-Bereich des Service Desk-Mitarbeiters
Die Aktion „UPDATE_MESSAGES“ wird während Servicemitarbeiter-Konversationen verwendet und wird verwendet, um Nachrichtenaktualisierungen im Chat-Bereich von Service Desk-Mitarbeitern aus Drittpartei-Chatintegrationen widerzuspiegeln. Diese Aktion kann eine Liste von Nachrichten akzeptieren, und Updates für alle Nachrichten können in einer einzigen Ausführung ausgeführt werden.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId": "",
"message": [
{
"status": "external_error",
"id": "54623afeff762210efa1ffffffffff77"
}
],
"userId": "abel.tuter",
"emailId": "abel.tuter@example.com",
"action": "UPDATE_MESSAGES"
}"
--user "username":"password"Im Folgenden finden Sie die Antwortnachricht, die vom VA an den konfigurierten Antwortendpunkt gesendet wird.
Message Processed SuccessfullyAktualisieren Sie nur den Chatverlauf
Das folgende Beispiel zeigt, wie nur der Chatverlauf aktualisiert wird.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId": "",
"userId": "abel.tuter",
"emailId": abel.tuter@example.com,
"action": "SEND_HISTORY",
"history": [
{
"isBotMessage": true,
"value": "How can I help you?",
"displayName": "Genesys Bot",
"type": "text",
"timestamp": "1739866290393"
},
{
"isBotMessage": false,
"value": "I am facing an issue while creating an incident.",
"displayName": "User",
"type": "text",
"timestamp": "1739877357223"
},
{
"isBotMessage": true,
"value": "Okay. i am routing you to an agent",
"displayName": "Genesys Bot",
"type": "text",
"timestamp": "1739877409746"
},
{
"isBotMessage": false,
"value": "Thanks.",
"displayName": "User",
"type": "text",
"timestamp": "1739877453201"
}
]
}"
--user "username":"password"Im Folgenden finden Sie die Erfolgsantwort, die vom VA an den konfigurierten Antwortendpunkt gesendet wurde.
{"status": "success"}Übertragen Sie eine Konversation an ServicemitarbeiterÄußerung wird verwendet
Das folgende Beispiel veranschaulicht, wie Sie eine Konversation an übertragen Servicemitarbeiter, Umgehung des Begrüßungsthemas, indem übergeben wird Service Desk-Mitarbeiter Als Äußerung in message.textParameter. Mögliche Äußerungswerte sind in der Tabelle „sys_cs_contextual_action“ definiert. Weitere Informationen zu kontextbezogenen Aktionen finden Sie unter Kontextbezogene Aktionen für anwenderdefinierte Chatintegrationen .
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: ORANGE" \
--data " {
"requestId": "322bas2be70-sadsa-we32-3eq2-1231ra9",
"botToBot": true,
"clientSessionId": "",
"silentMessage": false,
"message":{
"text": "agent",
"typed": true
},
"userId": "abel.tuter",
"emailId": "abel.tuter@servicenow.com",
"timestamp": 1588824102,
"timezone": "America/New_York"
}"Im Folgenden finden Sie den Antworttext, der vom VA an den konfigurierten Antwortendpunkt gesendet wird.
{
"requestId":"322bas2be70-sadsa-we32-3eq2-1231ra9",
"clientSessionId":"",
"message":{
"text":"agent",
"typed":true
},
"userId":"abel.tuter",
"body":[
{
"uiType":"Picker",
"group":"DefaultPicker",
"required":true,
"nluTextEnabled":false,
"label":"I want to be sure I got this right. What item best describes what you want to do?",
"itemType":"List",
"style":"list",
"multiSelect":false,
"options":[
{
"label":"Live Agent Support.",
"value":"Live Agent Support.",
"renderStyle":"data",
"enabled":false
},
{
"label":"Virtual Agent Capabilities.",
"value":"Virtual Agent Capabilities.",
"renderStyle":"data",
"enabled":false
},
{
"label":"I want something else",
"value":"-1",
"renderStyle":"data",
"enabled":false
}
],
"scriptedData":null
}
],
"score":1
}Übertragen Sie eine Konversation basierend auf der Auswahl des Anwenders an den Service Desk-Mitarbeiter-Support
Das folgende Beispiel zeigt die Übertragung der Konversation an den Servicemitarbeiter-Support basierend auf der Auswahl des Anwenders aus der vorherigen Interaktion.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: ORANGE" \
--data "{
"requestId": "322bas2be70-sadsa-we32-3eq2-1231ra9",
"botToBot": true,
"clientSessionId": "",
"silentMessage": false,
"message":{
"text": "Live Agent Support.",
"typed": true
},
"userId": "abel.tuter",
"emailId": "abel.tuter@servicenow.com",
"timestamp": 1588824102,
"timezone": "America/New_York"
} "Im Folgenden finden Sie den Antworttext, der vom VA an den konfigurierten Antwortendpunkt gesendet wird.
{
"requestId":"322bas2be70-sadsa-we32-3eq2-1231ra9",
"clientSessionId":"",
"message":{
"text":"Live Agent Support.",
"typed":true
},
"userId":"abel.tuter",
"body":[
{
"uiType":"OutputText",
"group":"DefaultText",
"value":"Please stand by while I connect you to a live agent."
}
],
"agentChat":true,
"score":1
}Beenden Sie A Virtual Agent Konversation durch Festlegen des Aktionsparameters
Das folgende Beispiel zeigt, wie ein beendet wird Virtual Agent Konversation, indem Sie festlegen actionParameter bis END_CONVERSATION .
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"requestId": "s345ew-sjg554-qwe23-we23",
"action": "END_CONVERSATION",
"enterpriseId": "ServiceNow",
"nowBotId": "A85PWLERF",
"clientSessionId": "",
"nowSessionId": "",
"message":{
"text": "b2b topic",
"typed": true,
"clientMessageId": "ABC-123"
},
"userId": "beth.anglin",
"emailId": beth.anglin@example.com,
"timestamp": 1588824102,
"timezone": "America/New_York"
}"
--user "username":"password"
Im Folgenden wird der Antworttext angezeigt, der vom VA an den konfigurierten Antwortendpunkt gesendet wird und zeigt, dass die Konversation beendet wurde.
{
"requestId":"s345ew-sjg554-qwe23-we23",
"clientSessionId":"",
"nowSessionId":"",
"message":{
"text":"",
"typed":true,
"clientMessageId":"ABC-123"
},
"userId":"beth.anglin",
"body":[
{
"uiType":"OutputText",
"group":"DefaultText",
"value":"The conversation has ended. If you need help again, type hi.",
"maskType":"NONE"
}
],
"score":1
}Beenden Sie A Servicemitarbeiter Konversation durch Festlegen des Aktionsparameters
Das folgende Beispiel zeigt, wie ein beendet wird Servicemitarbeiter Konversation, indem Sie festlegen actionParameter bis END_CONVERSATION .
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"requestId": "sad-sjg554-qwe23-we23",
"action": "END_CONVERSATION",
"enterpriseId": "ServiceNow",
"nowBotId": "A85PWLERF",
"clientSessionId": "",
"nowSessionId": "",
"message":{
"text": "",
"typed": true,
"clientMessageId": "ABC-123"
},
"userId": "beth.anglin",
"emailId": "beth.anglin@example.com",
"timestamp": 1588824102,
"timezone": "America/New_York"
}"
--user "username":"password"
Im Folgenden wird der Antworttext angezeigt, der vom VA an den konfigurierten Antwortendpunkt gesendet wird und zeigt, dass die Konversation beendet wurde.
{
"requestId":"sad-sjg554-qwe23-we23",
"clientSessionId":"",
"nowSessionId":"",
"message":{
"text":"",
"typed":true,
"clientMessageId":"ABC-123"
},
"userId":"beth.anglin",
"body":[
{
"uiType":"OutputText",
"group":"DefaultText",
"value":"The conversation has ended. If you need help again, type hi.",
"maskType":"NONE"
}
],
"completed":true,
"score":1
}Verwenden Sie Befehle, die in der Tabelle „sys_cs_contextual_action“ definiert sind, als Äußerung, um eine Konversation mit zu beginnen Virtual Agent
Das folgende Beispiel zeigt die Verwendung von HiBefehl, der in der Tabelle „sys_cs_contextual_action“ als Äußerung zum Starten einer Konversation definiert ist Virtual Agent Anstatt festzulegen actionParameter bis START_CONVERSATION Wie in vorherigen Beispielen gezeigt. Dieses Beispiel zeigt die Verwendung einer der Sprachvarianten von HiBefehl, „hola“.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: ORANGE" \
--data "{
"requestId": "302bas2be70-sadsa-we32-3eq2-1231ra9",
"botToBot": true,
"clientSessionId": "",
"silentMessage": false,
"message":{
"text": "hola",
"typed": true
},
"userId": "fred.ludy",
"emailId": "abel.tuter@servicenow.com",
"timestamp": 1588824102,
"timezone": "America/New_York"
}"Im Folgenden finden Sie den Antworttext, der vom VA an den konfigurierten Antwortendpunkt gesendet wird.
{
"requestId":"302bas2be70-sadsa-we32-3eq2-1231ra9",
"clientSessionId":"",
"message":{
"text":"hola",
"typed":true
},
"userId":"fred.ludy",
"body":[
{
"uiType":"OutputText",
"group":"DefaultText",
"value":"Hi, I'm your Virtual Agent. Let me know how I can help you today.",
"maskType":"NONE"
},
{
"uiType":"TopicPickerControl",
"group":"DefaultPicker",
"nluTextEnabled":false,
"promptMsg":"Hi guest, please enter your request or make a selection of what I can help with. You can type hellllp! any time when you need help.",
"label":"Show me everything",
"options":[
{
"label":"boolean check",
"value":"1b5257a1db712010d3d6d9595e9619f3",
"enabled":true
},
{
"label":"Test_table_datepicker",
"value":"6515f0cadb4220108249f7541d961980",
"enabled":true
},
{
"label":"Test File upload",
"value":"76c1f4b2db7520108249f7541d9619a7",
"enabled":true
},
{
"label":"Test B2B 2",
"value":"8373e55cdb8120108249f7541d96196d",
"enabled":true
},
{
"label":"FAQ Conversation Builder_Global",
"value":"9f3114a3dbc520108249f7541d961981",
"enabled":true
},
{
"label":"Get to know you",
"value":"a443dd6adb812010d3d6d9595e961954",
"enabled":true
},
{
"label":"Get to know you_Global",
"value":"b1a56b87db8120108249f7541d9619b2",
"enabled":true
},
{
"label":"Live Agent Support.",
"value":"ce2ee85053130010cf8cddeeff7b12bf",
"enabled":true
},
{
"label":"Apply for PTO_B2B NLU",
"value":"d948c94cdb052010d3d6d9595e961969",
"enabled":true
}
]
}
],
"score":1
} Verwenden Sie Befehle, die in der Tabelle „sys_cs_contextual_action“ als Äußerung definiert sind, um eine Konversation zu beenden
Das folgende Beispiel zeigt die Verwendung von ByeBefehl, der in der Tabelle „sys_cs_contextual_action“ als Äußerung zum Beenden einer Konversation definiert ist Virtual Agent Anstelle von Einstellung actionBis END_CONVERSATION Wie in vorherigen Beispielen gezeigt. Dieses Beispiel zeigt die Verwendung einer der Sprachvarianten von ByeBefehl, „choa“.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: ORANGE" \
--data "{
"requestId": "302bas2be70-sadsa-we32-3eq2-1231ra9",
"botToBot": true,
"clientSessionId": "",
"silentMessage": false,
"message":{
"text": "choa",
"typed": true
},
"userId": "fred.ludy",
"emailId": "abel.tuter@servicenow.com",
"timestamp": 1588824102,
"timezone": "America/New_York"
}"Im Folgenden finden Sie den Antworttext, der vom VA an den konfigurierten Antwortendpunkt gesendet wird.
{
"requestId":"302bas2be70-sadsa-we32-3eq2-1231ra9",
"clientSessionId":"",
"message":{
"text":"chao",
"typed":true
},
"userId":"fred.ludy",
"body":[
{
"uiType":"Picker",
"group":"DefaultPicker",
"required":true,
"nluTextEnabled":false,
"label":"Please make a selection.",
"itemType":"List",
"style":"list",
"multiSelect":false,
"options":[
{
"label":"End conversation",
"value":"1",
"renderStyle":"data",
"enabled":false
},
{
"label":"Cancel",
"value":"0",
"renderStyle":"data",
"enabled":false
}
],
"scriptedData":null
}
],
"score":1
}Ändern Sie eine laufende Konversation mithilfe des WECHSELAKTIONSPARAMETERS
Das folgende Beispiel zeigt die Verwendung von WECHSELN actionParameter zum Ändern einer laufenden Konversation in das Thema, das den Angaben in entspricht intent.idParameter.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"requestId": "sdfsfs-hgfhg-34fssd-zxcz-sd43",
"enterpriseId": "ServiceNow",
"nowBotId": "A85PWLERF",
"clientSessionId": "",
"nowSessionId": "",
"action": "SWITCH",
"intent" : {
"id": "Saloon Vehicle"
},
"message":{
"typed": true,
"clientMessageId": "ABC-123"
},
"userId": "Guest",
"timestamp": 1588824102,
"timezone": "America/New_York"
}"
--user "username":"password"
Im Folgenden wird der Antworttext angezeigt, der vom VA an den konfigurierten Antwortendpunkt gesendet wird und zeigt, dass der VA zum neuen Thema gewechselt ist.
{
"requestId":"sdfsfs-hgfhg-34fssd-zxcz-sd43",
"clientSessionId":"",
"nowSessionId":"",
"message":{
"typed":true,
"clientMessageId":"ABC-123"
},
"userId":"Guest",
"body":[
{
"uiType":"InputText",
"group":"DefaultText",
"required":true,
"nluTextEnabled":false,
"label":"limo input:",
"maskType":"NONE"
}
],
"score":1
}Besorgen Sie sich einen Natural Language Understanding( NLU) Konfidenzpunktzahl für eine Äußerung
Das folgende Beispiel zeigt, wie Sie einen erhalten NLU Konfidenzpunktzahl für eine Äußerung, wenn NLU Ist in VA aktiviert.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"requestId": "sdfsfs-hgfhg-34fssd-zxcz-sd43",
"enterpriseId": "ServiceNow",
"nowBotId": "A85PWLERF",
"clientSessionId": "",
"nowSessionId": "",
"message":{
"text": "most popular choice",
"typed": true,
"clientMessageId": "ABC-123"
},
"userId": "Guest",
"timestamp": 1588824102,
"timezone": "America/New_York"
}"
--user "username":"password"
Im Folgenden wird der Antworttext angezeigt, der vom VA an den konfigurierten Antwortendpunkt gesendet wird und die NLU-Konfidenzpunktzahl anzeigt.
{
"requestId":"sdfsfs-hgfhg-34fssd-zxcz-sd43",
"clientSessionId":"",
"nowSessionId":"",
"message":{
"text":"most popular choice",
"typed":true,
"clientMessageId":"ABC-123"
},
"userId":"Guest",
"body":[
{
"uiType":"InputText",
"group":"DefaultText",
"required":true,
"nluTextEnabled":false,
"label":"model input:",
"maskType":"NONE"
}
],
"score":"0.92"
}Übertragen Sie eine Konversation an Servicemitarbeiter in einer bestimmten Warteschlange
Das folgende Beispiel zeigt, wie Sie eine Konversation an Servicemitarbeiter in einer bestimmten Warteschlange übertragen. Sie müssen zuerst Ihre Warteschlangen mit bestimmten Bedingungen einrichten. Dann übergeben Sie diese Bedingungen als contextVariablesIm Anforderungstext. Weitere Informationen zum Erstellen einer Arbeitselementwarteschlange finden Sie unter Erstellen Sie eine Arbeitselementwarteschlange .
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"requestId": "34re-dasd-qwe23-dsds", // Unique value for a message (hash)
"enterpriseId": "ServiceNow", // ServiceNow (Optional
"nowBotId": "A85PWLERF", // In case of multiple ServiceNow secondary bots (one for HR, one for ITSM)
"action":"AGENT", // Actions to close conversation. Other possible value is END_CONVERSATION
"clientSessionId": "", // Client conversation id
"nowSessionId": "", // ServiceNow conversation id
"message":{
"text": "How are you?", // User passed message
"typed": true, // typed or clicked
"clientMessageId": "ABC-123"
},
"userId": "abraham.lincoln", // User’s id in their system
"emailId": "abraham.lincoln@example.com",
"timestamp": 1588824102,
"timezone": "America/New_York",
"contextVariables":{
"b2b_category":"humanresource"
}
}"
--user "username":"password"
Im Folgenden finden Sie den Antworttext, der vom VA an den konfigurierten Antwortendpunkt gesendet wird.
{
"requestId":"34re-dasd-qwe23-dsds",
"clientSessionId":"",
"nowSessionId":"",
"message":{
"text":"How are you?",
"typed":true,
"clientMessageId":"ABC-123"
},
"userId":"abraham.lincoln",
"body":[
{
"uiType":"OutputText",
"group":"DefaultText",
"value":"I am sorry but I didn't understand your request.",
"maskType":"NONE"
},
{
"uiType":"OutputText",
"group":"DefaultText",
"value":"Please try giving me your request in a different way. I'm currently better at understanding short sentences.",
"maskType":"NONE"
},
{
"uiType":"TopicPickerControl",
"group":"DefaultPicker",
"nluTextEnabled":false,
"promptMsg":"Hi guest, please enter your request or make a selection of what I can help with. You can type help any time when you need help.",
"label":"Show me everything",
"options":[
{
"label":"Live Agent Support.",
"value":"ce2ee85053130010cf8cddeeff7b12bf",
"enabled":true
}
]
}
],
"score":0
}Übertragen Sie eine öffentliche Anwendungs-/PDF-Anhangsdatei
Dieses Beispiel zeigt, wie eine öffentliche Anwendung/ein PDF-Anhang übertragen wird.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: BOT_Token" \
--data "{
"requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId": "U94CSJLEN",
"message": {
"attachment": {
"clientAttachmentId": "my-unique-identifier",
"contentType": "application/pdf",
"fileName": "MY PDF TEST",
"url": "http://www.africau.edu/images/default/sample.pdf"
}
},
"userId": "U94CSJLEN",
"emailId": "admin@example.com"
}"
--user "username":"password"
Im Folgenden finden Sie den Antworttext, der vom VA an den konfigurierten Antwortendpunkt gesendet wird.
{
"requestId":"f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId":"U94CSJLEN",
"message":{
"attachment":{
"clientAttachmentId":"my-unique-identifier",
"contentType":"application/pdf",
"fileName":"MY PDF TEST",
"url":"http://www.africau.edu/images/default/sample.pdf"}
},
"userId":"U94CSJLEN",
"body":[
{
"uiType":"OutputText",
"group":"DefaultText",
"required":false,
"nluTextEnabled":false,
"label":"File got",
"maskType":"NONE",
"itemType":"outputtext"
},
{
"uiType":"OutputText",
"group":"DefaultText",
"required":false,
"nluTextEnabled":false,
"label":"The conversation has ended. If you need help again, type hi.",
"maskType":"NONE",
"itemType":"outputtext"
}
],
"completed":true,
"score":1
}Übertragen Sie einen Video-/mpeg-Anhang
Dieses Beispiel zeigt die Anforderung/Antwort zum Hochladen eines Video-/mpeg-Anhangs.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: BOT_TOKEN" \
--data "{
"requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId": "U94CSJLEN",
"message": {
"attachment": {
"clientAttachmentId": "my-unique-identifier10",
"contentType": "video/mpeg",
"fileName": "MY TEST10.mp4",
"url": "https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_1mb.mp4"
}
},
"userId": "U94CSJLEN",
"emailId": "admin@example.com"
}"
--user "username":"password"
Im Folgenden finden Sie den Antworttext, der vom VA an den konfigurierten Antwortendpunkt gesendet wird.
{
"requestId":"f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId":"U94CSJLEN",
"message":{
"attachment":{
"headers":{
"Authorization":"Basic amFzbWluZS53YWRod2FuaWE6VGVzdGluZ0AxMjM="
},
"clientAttachmentId":"my-unique-identifier10",
"contentType":"video/mpeg",
"fileName":"MY TEST10.mp4",
"url":"https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_1mb.mp4"
}
},
"userId":"U94CSJLEN",
"body":[
{
"uiType":"OutputText",
"group":"DefaultText",
"required":false,
"nluTextEnabled":false,
"label":"File got",
"maskType":"NONE",
"itemType":"outputtext"
},
{
"uiType":"OutputText",
"group":"DefaultText",
"required":false,
"nluTextEnabled":false,
"label":"The conversation has ended. If you need help again, type hi.",
"maskType":"NONE","itemType":"outputtext"
}
],
"completed":true,
"score":1
}Übertragen Sie ein Bild/einen JPEG-Anhang
Dieses Beispiel zeigt die Anforderung/Antwort zum Hochladen eines Bild-/JPEG-Anhangs.
curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: BOT_TOKEN" \
--data "{
"requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId": "U94CSJLEN",
"message": {
"attachment": {
"clientAttachmentId": "my-unique-identifier10",
"contentType": "image/jpeg",
"fileName": "MY TEST10.jpg",
"url": "https://image.imagestock.com/image-photo/pink-butterfly-isolated-on-white-260nw-1218104047.jpg"
}
},
"userId": "U94CSJLEN",
"emailId": "admin@example.com"
}"
--user "username":"password"
Im Folgenden finden Sie den Antworttext, der vom VA an den konfigurierten Antwortendpunkt gesendet wird.
{
"requestId":"f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId":"U94CSJLEN",
"message":{
"attachment":{
"headers":{
"Authorization":"Basic amFzbWluZS53YWRod2FuaWE6VGVzdGluZ0AxMjM="
},
"clientAttachmentId":"my-unique-identifier10",
"contentType":"image/jpeg",
"fileName":"MY TEST10.jpg",
"url":"https://image.imagestock.com/image-photo/pink-butterfly-isolated-on-white-260nw-1218104047.jpg"
}
},
"userId":"U94CSJLEN",
"body":[
{
"uiType":"OutputText",
"group":"DefaultText",
"required":false,
"nluTextEnabled":false,
"label":"File got",
"maskType":"NONE",
"itemType":"outputtext"
},
{
"uiType":"OutputText",
"group":"DefaultText",
"required":false,
"nluTextEnabled":false,
"label":"The conversation has ended. If you need help again, type hi.",
"maskType":"NONE",
"itemType":"outputtext"
}
],
"completed":true,
"score":1
}