---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# API für Virtual Agent-Bot-Integration

# API für Virtual Agent-Bot-Integration {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 24 Minuten Lesedauer

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 AgentUnd/oder Servicemitarbeiter.

Diese API basiert auf dem anwenderdefinierten Chat-Integrations-Framework für Konversationen, das mit bereitgestellt wird Virtual AgentUnd arbeitet in `sn_va_as_service `Namespace.

Für zusätzliche Informationen zur Installation und Konfiguration von Virtual AgentBot-Integrations-API, siehe [Virtual Agent-API](https://www.servicenow.com/docs/access?context=virtual-agent-api&version=yokohama&pubname=yokohama-conversational-interfaces&ft:locale=en-US).

## VA-Bot-Integration -- POST /sn_va_as_service/bot/Integration {#ariaid-title2}

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 ServiceNowBots. Zusätzlich zur Übergabe von Nachrichten an ServiceNowVA sekundärer Bot, der primäre Bot oder Chat-Client kann diesen Endpunkt verwenden, um Nachrichten über an einen Service Desk-Mitarbeiter zu übergeben ServicemitarbeiterChat. Verwenden Sie actionParameter, der im Anforderungstext übergeben wird, um anzugeben, wie der angegebene Inhalt behandelt werden soll.  
Hinweis:  
Dieser Endpunkt kann je nach Konfiguration entweder synchron oder asynchron sein. Wenn die Anforderung asynchron vom Endpunkt empfangen wird, validiert sie die Anforderung und antwortet mit dem Anrufstatus „Erfolg" oder „Fehler" und dem entsprechenden HTTP-Statuscode. Der VA verarbeitet dann die Anforderung und sendet eine zweite Antwort an den konfigurierten Antwortenendpunkt. Beispiel: Bei einer Bot-zu-Bot-Integration wäre 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](https://www.servicenow.com/docs/access?context=configure-response-endpoint-va-api&version=yokohama&pubname=yokohama-conversational-interfaces&ft:locale=en-US).  
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

{#bot-POST-integration__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 1. Pfad-Parameter]

{#bot-POST-integration__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 2. Abfrageparameter]

{#bot-POST-integration__entry__10}

| Name | Beschreibung |
|-|-|
| Aktion | Aktion, die der VA ausführen soll. Gültige Werte: * AGENT: Wechselt die Konversation von VA zu Servicemitarbeiter. * END_CONVERSATION: Beendet die Chat-Konversation. Die message.textParameter muss leer sein, wenn diese Aktion verwendet wird. * START_CONVERSATION: Startet eine Chat-Konversation. * WECHSELN: Wechseln Sie die Konversation zu einem Thema, das den Angaben in entspricht intent.idOder topic.nameParameter. Hinweis: Verwenden Sie nur `WECHSELN `Aktion für Themenwechsel, wenn die Absichtserkennung im primären Bot erfolgt. Wenn die Absichtserkennung in erfolgt ServiceNow®VA, verwenden Sie message.textParameter. * SET_USER_TIMEZONE: Legt die Zeitzone des Anwenders auf die in angegebene Zeitzone fest timezoneParameter. Diese Zeitzone bleibt gültig, bis Sie sie mit demselben Parameter zurücksetzen. * EINGABE/ANZEIGE: Zeigt den Tippindikator in an Servicemitarbeiter. Zuerst gesendet `EINGABE `Und senden Sie dann, nachdem der Anwender die Eingabe abgeschlossen hat `WIRD ANGEZEIGT `. * Null oder Parameter nicht übergeben: Sendet die Nachricht an ServiceNowVA. {#bot-POST-integration__ul_dtc_3fg_4mb} Datentyp: Zeichenfolge Standard: Null |
| BotToBot | Kennzeichnung, die angibt, ob die Konversation zwischen Bots stattfindet, z. B. zwischen einem primären und einem sekundären Bot. Mögliche Werte: * Wahr: Bot-zu-Bot-Konversation. * Falsch: Eigenständig ServiceNowBot-Konversation. {#bot-POST-integration__ul_prw_jkj_qmb} Datentyp: Boolescher Wert Standard: Wahr |
| ClientSessionId | Eindeutiger Clientsitzungsbezeichner der Anwendung/des Service, den der Endanwender für die Kommunikation mit verwendet ServiceNowBot. Diese ID hilft, den Satz von Anforderungen/Antworten für eine bestimmte Anwenderkonversation zu identifizieren. Das Format dieses Parameters wird vom Implementierer bestimmt. Datentyp: Zeichenfolge Standard: Null |
| ClientVariables | Pass-Through-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](https://www.servicenow.com/docs/access?context=ac-configure-context-variables&version=yokohama&pubname=yokohama-conversational-interfaces&ft:locale=en-US). Zum Beispiel: "contextVariables": { "requester_session_language": "es", "deviceTimeZone": "America/Los_Angeles" "live_agent_only": "true", "liveagent_deviceType": "test_device_type" "topic": "7c3c819073a3101066c7e9344ef6a7e4" } 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 zur Account-Verknüpfung finden Sie unter [Verknüpfen Sie Ihren ServiceNow-Anwenderaccount mit einer Messaging-Anwendung für Virtual Agent-Konversationen](https://www.servicenow.com/docs/access?context=link-accounts-with-virtual-agent&version=yokohama&pubname=yokohama-conversational-interfaces&ft:locale=en-US). Datentyp: Zeichenfolge |
| Verlauf | Verlauf der Konversation des primären Bots mit dem Anwender, beginnend mit der ersten Anforderung des Anwenders. Datentyp: Objekt "history": { "displayName": "String", "isBotMessage": Boolean, "type": "String", "value": "String" } Zum Beispiel: { "isBotMessage": true, "value": "message 1", "displayName": "Bot", "type": "text" }, { "isBotMessage": false, "value": "message 2", "displayName": "User", "type": "text" } |
| History.displayName | Name des Anwenders, an den die Nachricht gesendet wurde. Wenn der primäre Bot ist, übergeben <kbd class="ph userinput">Bot </kbd>. Datentyp: Zeichenfolge |
| Verlauf.isBotMessage | Kennzeichnung, die angibt, ob die Nachricht vom primären Bot gesendet wurde. Gültige Werte: * Wahr: Die Nachricht wurde vom primären Bot gesendet. * Falsch: Die Nachricht wurde vom Anwender gesendet. {#bot-POST-integration__ul_mzy_pgc_lqb} Datentyp: Boolescher Wert |
| History.type | Typ der gesendeten Nachricht. Gültige Werte: Text Datentyp: Zeichenfolge |
| Verlauf.Wert | Inhalt der Informationen. 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": "String" } |
| 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, wird die Sprache aus der Sitzung/dem Profil des Anwenders abgerufen. Datentyp: Zeichenfolge Tabelle: CS-Themensprache \[sys_cs_topic_language\] |
| Nachricht | Erforderlich. Details der Nachricht, die an gesendet werden soll ServiceNowBot. Datentyp: Objekt "message": { "attachment": {Object}, "clientMessageId": "String", "text": "String", "typed": Boolean } |
| 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 "attachment": [ { "clientAttachmentId": "String", "contentType": "String", "fileName": "String", "headers":{Object}, "url": "String" } ] |
| Message.attachment.clientAttachmentId | Eindeutiger Bezeichner des Anhangs, der an gesendet werden soll ServiceNowBot. Das Format dieses Bezeichners wird vom Implementierer bestimmt. Datentyp: Zeichenfolge Standard: Null |
| Message.attachment.contentType | Erforderlich, wenn Anhang angegeben ist. Standard-MIME-Typ des Anhangs. Gültige Werte (Groß-/Kleinschreibung wird nicht beachtet): * Anwendung/PDF * Anwendung/msword * Bild/PNG * Image/JPEG * Text/nur * Video/mpeg {#bot-POST-integration__ul_ktc_xnj_4mb} 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 "headers":{ "Authorization":"String" } |
| 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 |
| Message.attachment.url | Erforderlich, wenn Anhang angegeben ist. URL, in 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.Text | Erforderlich, wenn attachmentParameter ist nicht angegeben. Nachrichtentext. Die Sprache der Nachricht muss in übergeben werden contextVariablesParameter. 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: * Wahr: Nachricht wurde vom Anwender eingegeben. * Falsch: Nachricht war eine Optionsauswahl. Datentyp: Boolescher Wert |
| 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: * Wahr: Stumme Nachricht, keine Antwortnachricht erwartet. * Falsch: Reguläre Nachricht, Antwortnachricht erwartet. Hinweis: Wenn eine Anforderung mit `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: Boolescher Wert Standard: Falsch |
| 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: "timezone":"Asia/Kolkata" 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 von ServiceNowInstanz. |
| 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 im Objekt nur einen einzelnen Themennamen oder eine ID angeben. Datentyp: Objekt "topic": { "name": "String", "id": "String" } Zum Beispiel: {​ "requestId": "xxxx-xxxx-xxxx-xxxx",​ "clientSessionId": "xxx-xxx-xxx-xxx",​ "action":"SWITCH",​ "topic":{​     "name": "Topic Name"​   },​   "userId": "beth"​ }​ |
| 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 |
[Tabelle : 3. Anforderungstext-Parameter]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#bot-POST-integration__entry__76}{#bot-POST-integration__accept-JSON-only-entry-RESTAPI}{#bot-POST-integration__content_type-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Nur unterstützt application/json. |
| Token | Erforderlich bei Verwendung der tokenbasierten Authentifizierung; optional für Standard- oder OAuth-Authentifizierung. Authentifizierungstoken, das verwendet werden soll, wenn die Tokenauthentifizierung für diesen Endpunkt eingerichtet wurde. Datentyp: Zeichenfolge |
[Tabelle : 4. Anforderungskopfzeilen.]

{#bot-POST-integration__entry__84}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwort-Header]

### 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](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#bot-POST-integration__entry__88}{#bot-POST-integration__entry-400-status-code}{#bot-POST-integration__entry-401-status-code}{#bot-POST-integration__entry-405-status-code}{#bot-POST-integration__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. Wenn Sie einen 200-Statuscode erhalten, aber keine Antwort erhalten, überprüfen Sie die folgenden Dinge: * Gibt an, ob die Anforderung bei der Validierung statischer, JWT- oder Hash-basierter Token fehlschlägt, was im Allgemeinen im Worker-Thread von geschieht Virtual Agent. * Gibt an, ob das Format des Anforderungstexts korrekt ist. Wenn falsch, erfolgt die Konvertierung nicht richtig. * Gibt an, ob im Anforderungstext einige erforderliche Parameter fehlen. Sie können Ausnahmen und Fehler in den Systemprotokollen auf nachverfolgen ServiceNowInstanz. * Gibt an, ob die in der REST-Nachricht definierte Site, die die Antwort empfangen soll, funktionsfähig ist; in Protokollen erkennen kann. * Stellen Sie sicher, dass die REST-Nachricht, die definiert, wo die Antwort veröffentlicht werden soll, richtig festgelegt ist. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 405 | Ungültige Methode. Die Funktionalität ist deaktiviert. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Antworttext-Parameter

Status des Endpunktaufrufs. Dies wird als Antwort gesendet, wenn die anfängliche Anrufanforderung empfangen wird. Die Anforderung wurde noch nicht verarbeitet.
{#bot-POST-integration__entry__100}

| Name | Beschreibung |
|-|-|
| Fehler | Beschreibung des erkannten Fehlers. Wird nur zurückgegeben, wenn ein Fehler auftritt. Datentyp: Objekt "error": { "detail": "String", "message": "String" } |
| error.detail | Details zum aufgetretenen Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Fehlermeldung ausgelöst. Datentyp: Zeichenfolge |
| Status | Status des Endpunktaufrufs. Gültige Werte: * Fehler * Erfolg {#bot-POST-integration__ul_mdj_f2f_1nb} Datentyp: Zeichenfolge |
[ ]

### VA-Antworttext-Parameter {#bot-POST-integration__section_vb2_yny_jlb}

Antworttext, der vom VA an den konfigurierten Antwortenendpunkt gesendet wird.
{#bot-POST-integration__table_bql_jkx_zmb__entry__2}

| Name | Beschreibung |
|-|-|
| AgentChat | Kennzeichnung, die angibt, ob die Konversation mit verbunden ist ServiceNow Servicemitarbeiter. Mögliche Werte: * Wahr: Chatnachrichten stammen von einem Servicemitarbeiter. * Falsch: Chatnachrichten stammen von einem Bot, und dieser Parameter wird in der Antwort nicht zurückgegeben. {#bot-POST-integration__ul_cql_jkx_zmb} Datentyp: Boolescher Wert |
| body | Liste von Objekten, die die Elemente des Antwortnachrichtentexts beschreiben. Datentyp: Array von Objekten "body": [ { "actionType": "String", "agentInfo": {Object}, "data": "String", "group": "String", "header": "String", "height": Number, "itemType": "String", "label": "String", "maskType": "String", "maxCount": Number, "maxSize": Number, "message": "String", "multiSelect": Boolean, "nluTextEnabled": Boolean, "options": {Object}, "promptMsg": "String", "required": Boolean, "style": "String", "templateName": "String", "type": "String", "uiType": "String", "value": "String/{Object}", "width": Number } ] |
| Text.actionType | 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: * Endtypenindikator * StartSpinner * StartTypenindikator {#bot-POST-integration__ul_dgw_fhy_lqb} Zum Beispiel: Wird Gesendet `Starttypindikator `Zum primären Bot, wenn der Tippindikator aktiviert ist. "body": {​ "uiType":"ActionMsg",​   "actionType":"StartTypingIndicator"​ }  Wird Gesendet `StartSpinner `Bei der Übertragung an ServicemitarbeiterZum Anzeigen der Wartezeit für den Endanwender. "body": { "uiType":"ActionMsg", "actionType":"StartSpinner", "spinnerType":"wait_time", "message":"Routing you to a live agent...", "waitTime":"8 Seconds" } Datentyp: Zeichenfolge |
| Text.agentInfo | Wenn diese Option im Service Desk-Mitarbeiter-Chat-Setup aktiviert ist, Name und Avatar des zugehörigen Service Desk-Mitarbeiters. Datentyp: Objekt "agentInfo":{ "agentAvatar":"String", "agentName": "String", "sentFromAgent": Boolean } Zum Beispiel: "agentInfo":{ "sentFromAgent": true, "agentName":"Beth Anglin", "agentAvatar":"https://instance.servicenow.com/ee4eebf30a0004d963b5c5ac0d734dc4.iix?t=small" } |
| Body.agentInfo.agentAvatar | URL der zugeordneten Avatar-Datei des Service Desk-Mitarbeiters. Beispiel: „https://instance.servicenow.com/ee4eebf30a0004d963b5c5ac0d734dc4.iix?t=small" 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: * Wahr: Von einem Servicemitarbeiter gesendet. * Falsch: Von einem Virtual Agent gesendet. {#bot-POST-integration__ul_arr_gky_lqb} Datentyp: Boolescher Wert |
| Textkörper.Daten | JSON-Zeichenfolge, die die Daten innerhalb der Karte definiert. Datentyp: Zeichenfolge |
| body.group | Rich-Kontrollgruppe, zu der das Textelement gehört. Sie können diese Standardsteuerelemente weiter transformieren, indem Sie ausgehende Transformationsskripts schreiben. Weitere Informationen zu diesen Skripts finden Sie unter [Aktionsskripts für Virtual Agent](https://www.servicenow.com/docs/access?context=va-action-scripts&version=yokohama&pubname=yokohama-conversational-interfaces&ft:locale=en-US). Mögliche Werte: * Standardausgabekarte * Standarddatum * StandardgruppePartsOutputControl * StandardHtml * Standardausgabebild * Standardausgabelink * Standardtext * Standardauswahl 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) * Standardtext * Datei * Image * Eingabetext * Ausgabetext {#bot-POST-integration__ul_fql_jkx_zmb} * Standardauswahl * Bild: Elemente werden in einem Karussell angezeigt. * Liste: Elemente werden in einer Dropdown-Liste angezeigt. {#bot-POST-integration__ul_gql_jkx_zmb} {#bot-POST-integration__ul_eql_jkx_zmb} 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: * KEINE: Zugeordnete Daten sind allgemeiner Art und müssen nicht gesichert werden. * SICHER: Zugehörige Daten sind vertraulicher Natur und sollten sicher behandelt werden. {#bot-POST-integration__ul_hbb_dbz_n4b} Datentyp: Zeichenfolge |
| Textkörper.max. Anzahl | Nur zurückgegeben, wenn uiTypeIst `DateiUpload `. Maximale Anzahl von Anhängen, die gleichzeitig hochgeladen werden können. Datentyp: Zahl (Ganzzahl) |
| Textkörper.maxSize | Nur zurückgegeben, wenn uiTypeIst `DateiUpload `. Maximale Größe des Anhangs, der hochgeladen werden kann. Datentyp: Zahl (Ganzzahl) Einheit: Megabyte |
| Textkörper.Nachricht | Nur zurückgegeben, wenn actionTypeIst `StartSpinner `. Nachricht, die dem Anwender angezeigt werden soll. Datentyp: Zeichenfolge |
| Textkörper.Mehrfachauswahl | Kennzeichnung, die angibt, ob der Anwender mehrere Optionen auswählen kann. Mögliche Werte: * Wahr: Mehrfachauswahl. * Falsch: Einzelauswahl. {#bot-POST-integration__ul_hql_jkx_zmb} Datentyp: Boolescher Wert |
| body.nluTextEnabled | Kennzeichnung, die angibt, ob der Anwender-Chat-Client Textnachrichten (Natural Language Understanding, NLU) empfangen kann. Mögliche Werte: * Wahr: Kann NLU-Nachrichten empfangen. * Falsch: NLU-Nachrichten können nicht empfangen werden. {#bot-POST-integration__ul_iql_jkx_zmb} Datentyp: Boolescher Wert |
| Textkörper.Optionen | Liste, die die für ein Auswahlsteuerelement verfügbaren Optionen beschreibt. Datentyp: Array von Objekten "options": [ { "attachment": "String", "description": "String", "enabled": Boolean, "label": "String", "renderStyle": "String", "value": "String" } ] |
| 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 auf dem Chat-Client des Endanwenders aktiviert ist. In Bot-zu-Bot-Implementierungen ist der primäre Bot dafür verantwortlich, sicherzustellen, dass die Auswahlsteuerung deaktiviert ist. Mögliche Werte: * Wahr: Aktiviert * Falsch: Deaktiviert {#bot-POST-integration__ul_jql_jkx_zmb} Datentyp: Boolescher Wert |
| Textkörper.Optionen.Bezeichnung | Bezeichnung, die für die zugeordnete angezeigt werden soll body.options.valueParameter. Datentyp: Zeichenfolge |
| Textkörper.Optionen.RenderStyle | Stil, der beim Rendern des zugeordneten Elements verwendet werden soll. Möglicher Wert: Daten Datentyp: Zeichenfolge |
| Textkörper.Optionen.Wert | Wert, der für die zugeordnete angezeigt werden soll body.options.labelParameter. Datentyp: Zeichenfolge |
| body.promptMsg | Prompt-Nachricht, 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: * Wahr: Erforderlich * Falsch: Optional {#bot-POST-integration__ul_lql_jkx_zmb} Datentyp: Boolescher Wert |
| Body.SpinnerType | Nur zurückgegeben, wenn actionTypeIst `StartSpinner `. Typ des dem Chat-Anwender angezeigten Spinners. Mögliche Werte: Wartezeit: Nachricht, die die Verzögerung vor der Übertragung an einen Servicemitarbeiter angibt. Datentyp: Zeichenfolge |
| Textkörper.Stil | Stil des Textkörpers. Mögliche Werte: * Schaltfläche * Karussell * Liste * Null Datentyp: Zeichenfolge |
| Textkörper.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](https://www.servicenow.com/docs/access?context=conversation-designer-virtual-agent&version=yokohama&pubname=yokohama-conversational-interfaces&ft:locale=en-US). Mögliche Werte: * Aktionsnachricht * StandardausgabekarteAusgabekarte * Standarddatum * Datum * DateTime * Zeit {#bot-POST-integration__ul_qql_jkx_zmb} * StandardgruppePartsOutputControlGroupedPartsOutputControl * StandardHtmlAusgabeHtml * StandardausgabebildAusgabebild * StandardausgabelinkAusgabelink * Standardtext * Eingabetext * Ausgabetext * DateiUpload {#bot-POST-integration__ul_uql_jkx_zmb} * Standardauswahl * Auswahl * Themenauswahl-Steuerelement * Boolean {#bot-POST-integration__ul_vql_jkx_zmb} 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. "value": { "action": "String" } Ausgabebild: Zeichenfolge. Bild-URL. AusgabeHtml: Zeichenfolge. HTML, die 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 |
| Textkörper.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 ServiceNowBot. 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 AgentHat die Konversation erfolgreich abgeschlossen. Mögliche Werte: * Wahr: Konversation wurde erfolgreich abgeschlossen. * Falsch: Konversation ist nicht abgeschlossen, und dieser Parameter wird in der Antwort nicht zurückgegeben. Datentyp: Boolescher Wert |
| EnterpriseID | Derzeit nicht verwendet. |
| Nachricht | Details der Nachricht, die an gesendet wurde ServiceNowVA. Dies ist mit dem übergebenen Nachrichtenobjekt identisch. Datentyp: Objekt "message": { "attachment": {Object}, "clientMessageId": "String", "text": "String", "typed": Boolean } |
| Nachricht.Anhang | Details des Anhangs. Anhänge können entweder eine Datei oder eine URL sein. Datentyp: Objekt "attachment": { "clientAttachmentId": "String", "contentType": "String", "fileName": "String", "url": "String" |
| Message.attachment.clientAttachmentId | Eindeutiger Bezeichner des Anhangs, der an gesendet wurde ServiceNowVA. Das Format dieses Bezeichners wird vom Implementierer bestimmt. Datentyp: Zeichenfolge |
| Message.attachment.contentType | Standard-MIME-Typ des Anhangs. Mögliche Werte (Groß-/Kleinschreibung nicht beachten): * Anwendung/msword * Anwendung/PDF * Image/JPEG * Bild/PNG * Text/nur * Video/mpeg {#bot-POST-integration__ul_xql_jkx_zmb} Datentyp: Zeichenfolge |
| Nachricht.Anhang.Dateiname | Dateiname des Anhangs. Datentyp: Zeichenfolge |
| Message.attachment.url | URL, in 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: * Wahr: Nachricht wurde vom Anwender eingegeben. * Falsch: Nachricht war eine Optionsauswahl. Datentyp: Boolescher Wert |
| NowBotId | Derzeit nicht verwendet. |
| NowSessionId | Derzeit nicht verwendet. |
| requestId | Eindeutiger Bezeichner für diese Anforderung. Datentyp: Zeichenfolge |
| Punktzahl | Absichtskonfidenzpunktzahl aus ServiceNow NLUModell, 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 NLUVertrauensschwellenwert des Modells. Die ServiceNow NLUDer Konfidenzschwellenwert des Modells wird auf ignoriert ServiceNowInstanz so, dass die primären Bots NLUDer Konfidenzschwellenwert des Modells kann konsistent auf alle sekundären Bots angewendet werden. Datentyp: Zahl |
| TakeControl | Kennzeichnung, die angibt, dass ServiceNow Virtual AgentMöchte die Kontrolle an den primären Bot zurückgeben. Mögliche Werte: * Wahr: Steuerung an den primären Bot zurückgeben. * Falsch: Behalten Sie die Kontrolle. {#bot-POST-integration__ul_zql_jkx_zmb} Datentyp: Boolescher Wert Standard: Falsch |
| userId | Bezeichner des Endanwenders, der mit dem Bot interagiert. Datentyp: Zeichenfolge |
[ ]

{#bot-POST-integration__table_bql_jkx_zmb}  

### Starten Sie eine Konversation mit der Aktion „START_CONVERSATION", um eine Konversation zu starten

Das folgende Beispiel zeigt, wie Sie die Aktion „START_CONVERSATION" verwenden, um eine Konversation mit zu beginnen Virtual Agent. Dieser Anruf leitet den Anwender zum Begrüßungsthema.

    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"

Folgendes ist der Antworttext, der vom VA an den konfigurierten Antwortenendpunkt 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 
    } 

### Übertragen Sie eine Konversation an ServicemitarbeiterÄußerung wird verwendet {#bot-POST-integration__example_e31_srx_sqb}

Das folgende Beispiel veranschaulicht, wie eine Konversation an übertragen wird Servicemitarbeiter, Umgehung des Begrüßungsthemas, indem übergeben wird `Service Desk-Mitarbeiter `Als Äußerung in message.textParameter. Mögliche Äußerungswerte sind in der sys_cs_contextual_action-Tabelle definiert. Weitere Informationen zu kontextbezogenen Aktionen finden Sie unter [Kontextbezogene Aktionen für anwenderdefinierte Chat-Integrationen](https://www.servicenow.com/docs/access?context=contextual-actions&version=yokohama&pubname=yokohama-conversational-interfaces&ft:locale=en-US).

    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"
    }"

Folgendes ist der Antworttext, der vom VA an den konfigurierten Antwortenendpunkt 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 {#bot-POST-integration__example_f31_srx_sqb}

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"
    } "

Folgendes ist der Antworttext, der vom VA an den konfigurierten Antwortenendpunkt 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 AgentKonversation durch Festlegen des Aktionsparameters

Das folgende Beispiel zeigt, wie ein beendet wird Virtual AgentKonversation durch Festlegen von 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 ist der Antworttext, der vom VA an den konfigurierten Antwortenendpunkt 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 ServicemitarbeiterKonversation durch Festlegen des Aktionsparameters {#bot-POST-integration__example_fxw_jbc_s4b}

Das folgende Beispiel zeigt, wie ein beendet wird ServicemitarbeiterKonversation durch Festlegen von 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 ist der Antworttext, der vom VA an den konfigurierten Antwortenendpunkt 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 sys_cs_contextual_action-Tabelle definiert sind, als Äußerung, um eine Konversation mit zu beginnen Virtual Agent

Das folgende Beispiel zeigt, wie verwendet wird HiBefehl, der in der sys_cs_contextual_action-Tabelle als Äußerung definiert ist, mit der eine Konversation gestartet werden soll Virtual AgentAnstatt festzulegen actionParameter bis `START_KONVERSATION `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"
    }"

Folgendes ist der Antworttext, der vom VA an den konfigurierten Antwortenendpunkt 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 sys_cs_contextual_action-Tabelle definiert sind, als Äußerung, um eine Konversation zu beenden

Das folgende Beispiel zeigt, wie verwendet wird ByeBefehl, der in der sys_cs_contextual_action-Tabelle als Äußerung definiert ist, mit der eine Konversation beendet werden soll Virtual AgentAnstelle von Einstellung actionBis `END_CONVERSATION `Wie in vorherigen Beispielen gezeigt. Dieses Beispiel zeigt die Verwendung einer der Sprachvarianten von ByeBefehl, „auswahl".

    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"
    }"

Folgendes ist der Antworttext, der vom VA an den konfigurierten Antwortenendpunkt 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, wie verwendet wird `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 Antwortenendpunkt 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
    }

### Erhalten Sie einen Natural Language Understanding( NLU) Konfidenzpunktzahl für eine Äußerung {#bot-POST-integration__example_onb_ltc_s4b}

Das folgende Beispiel zeigt, wie Sie einen erhalten NLUKonfidenzpunktzahl für eine Äußerung, wenn NLUIst 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 Antwortenendpunkt 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 eine Konversation an Servicemitarbeiter in einer bestimmten Warteschlange übertragen wird. 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](https://www.servicenow.com/docs/access?context=awa-create-queue&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US).

    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"

Folgendes ist der Antworttext, der vom VA an den konfigurierten Antwortenendpunkt 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 {#bot-POST-integration__example_yr4_2ry_lqb}

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"

Folgendes ist der Antworttext, der vom VA an den konfigurierten Antwortenendpunkt 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 {#bot-POST-integration__example_uyn_mwy_lqb}

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"

Folgendes ist der Antworttext, der vom VA an den konfigurierten Antwortenendpunkt 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 einen Bild-/JPEG-Anhang {#bot-POST-integration__example_nnb_nwy_lqb}

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"

Folgendes ist der Antworttext, der vom VA an den konfigurierten Antwortenendpunkt 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
    }


