--- sourceDocument: Xanadu-Konversations-Schnittstellen sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/xanadu/conversational-interfaces Release : - xanadu ft:locale : - de-DE ft:publication_title : - Xanadu-Konversations-Schnittstellen ft:clusterId : - convint bundleId : - convint workflow : - Platform --- # Virtual Agent API verwenden # Virtual Agent API verwenden {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer Verwenden Sie die API-App ServiceNow® Virtual Agent, um eine beliebige Chatschnittstelle oder einen Bot mit ServiceNow® Virtual Agent oder Mitarbeiterchatzu integrieren. Die App ist im ServiceNow® Storeverfügbar. ## Übersicht {#virtual-agent-api__section_cxx_ldc_qmb} Die Virtual Agent -API ist eine REST-API. Diese API basiert auf dem Framework für die Integration benutzerdefinierter Konversationschats, das ab dem Release Paris mit Virtual Agent bereitgestellt wird. Die API ermöglicht Entwicklern von ServiceNow, erfahrenen Benutzern und Administratoren, Virtual Agent auf eine der folgenden Arten zu verwenden: Eigenständiger Bot : Verwenden Sie Virtual Agent als eigenständigen Bot, den Sie mit Enterprise oder einer anderen Chatschnittstelle von Drittparteien integrieren, die Konversationsschnittstellen unterstützt. Endanwender können mithilfe dieser Integration über mehrere Kanäle mit Virtual Agent und Mitarbeiterchat interagieren. Sekundärer Bot : Verwenden Sie Virtual Agent als sekundären Bot in einer Umgebung mit mehreren spezialisierten Bots, die von einem primären Bot verwaltet werden. In diesem Szenario verwaltet ein primärer Bot die Kommunikation mit sekundären Bots im Namen des Endanwenders. Ein primärer Bot kann IBM Watson Assistant, Microsoft LUISoder ein selbst erstellter primärer Bot sein. Ihre sekundären Bots, z. B. der Bot ServiceNow, können bestimmte Arten von Endanwenderanforderungen bearbeiten, z. B. Servicetickets oder Reservierungen. Bot Interconnect : Verwenden Sie Virtual Agent Bot Interconnect als primären Bot in einer Chatumgebung mit unterschiedlichen Bedingungen. Bot Interconnect bietet eine einheitliche Chat-Experience und ermöglicht Ihren Endanwendern Zugriff auf mehrere Kanäle und eine Vielzahl von Unternehmensaufgaben, die über ServiceNowverfügbar sind. Die Virtual Agent API eignet sich zum Erstellen von Server-zu-Server-Integrationen. Für Integrationen, die die Transformation nicht unterstützter Steuerelemente erfordern, die in Ihrer vorhandenen Chatoberfläche gerendert werden müssen, sollten Sie jedoch das [Custom Chat Integration Framework](https://servicenow-prod.fluidtopics.net/f7iiryhIERqJYMkPSZXPaw "Das Framework für die Integration benutzerdefinierter Chats für Konversationen ist ein leistungsstarkes Framework, das aus skriptfähigen APIs und Konfigurationen besteht, um ServiceNow Virtual Agent auf jede Konversationsschnittstelle zu bringen.")verwenden. Informationen zu Funktionen wie dem URL-Format und den unterstützten Anforderungs- und Antwortparametern in der Virtual Agent API finden Sie unter [Virtual Agent Bot Integration API](https://www.servicenow.com/docs/access?context=bot-api&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US). ![Videolink zur Virtual Agent Academy.]() [Erweitern Sie Ihre Experiences mit der Virtual Agent API](https://www.youtube.com/watch?v=cyhmMyG4jKk) (Virtual Agent Academy-Video) ## Funktionsweise der Virtual Agent -API {#virtual-agent-api__section_ivs_d2r_fnb} Das folgende Diagramm zeigt, wie die REST API Benutzereingaben von einer Chatschnittstelle einer Drittpartei oder einem primären Bot verarbeitet und dann eine Bot-Antwort generiert. 1. Der Benutzer gibt Eingaben an eine primäre Bot- oder Chatschnittstelle einer Drittpartei. 2. Der Bot sendet eine JSON-POST-Anforderung an den eingehenden REST-Endpunkt (über eine geskriptete REST-API). 3. Now Platform authentifiziert und verarbeitet die Anforderung, die an Virtual Agent oder einen Servicemitarbeiter gesendet wird. 4. Now Platform sendet eine POST-Antwort-JSON vom ausgehenden REST-Endpunkt (über die REST API) an den Bot zurück. 5. Der primäre Bot oder die Chatoberflächen einer Drittpartei zeigen dem Anwender die Antwort an. {#virtual-agent-api__ol_pwf_jqc_kyb} Abbildung : 1. Eingehende und ausgehende REST-Endpunkte in der Virtual Agent -API Eine Demonstration der Virtual Agent -API und häufig gestellte Fragen finden Sie unter [Erste Schritte mit Virtual Agent-APIs](https://community.servicenow.com/community?id=community_article&sys_id=080e3903dbc4e4107d3e02d5ca96198c) auf der Community-Website. ## Einschränkungen {#virtual-agent-api__section_xqy_r1l_2qb} Die Virtual Agent API unterstützt die folgenden Funktionen nicht: * Chat-Branding über diese Virtual Agent API-Integration {#virtual-agent-api__ul_yqy_r1l_2qb} ## Versions- und Release-Kompatibilität {#virtual-agent-api__section_t11_5zb_dqb} {#virtual-agent-api__table_syv_gzb_dqb__entry__2} | Version | Kompatible Releases | |-|-| | 3.10.0 | Washington DC | | 3.9.x | Vancouver | | 3.8.x | Vancouver | | 3.7.x | Utah | | 3.5.x | Tokyo | | 3.0.x | San Diego | | 2.0.x | Rome Eine Teilmenge der Funktionen ist kompatibel mit Quebec. | | 1.3.0 | Quebec | | 1.0.12 | Quebec | | 1.0.9 | Paris | [Tabelle : 1. Virtual Agent API-Versions- und Release-Kompatibilität] {#virtual-agent-api__table_syv_gzb_dqb} Hinweis: Die Virtual Agent API erfordert eine ähnliche Pro-Lizenz wie Virtual Agent. * **[Virtual Agent API-Funktionen](https://servicenow-prod.fluidtopics.net/v_BAg~CsyJgBR~lgrBtBfw)** Sie können die Virtual Agent -API verwenden, um viele der gleichen Funktionen, die in Virtual Agent und Mitarbeiterchat verfügbar sind, in Ihre Chat-Umgebung zu integrieren. Die Unterstützung unterschiedlicher Funktionen hängt von Ihrem -Release ServiceNow und der Versionsnummer der Store-App-API ab. * **[Virtual Agent API-Funktionen, die in Store-Version 2.0.x verfügbar sind](https://servicenow-prod.fluidtopics.net/EXLCAVgZdqRZnkIvpI~t7w#va-api-features-v2)** DieVirtual Agent API-Version 2.0.x bietet Zugriff auf weitere der gleichen Funktionen, die in Virtual Agent und Mitarbeiterchatverfügbar sind, einschließlich Rich Control-Unterstützung und Benachrichtigungen. * **[Virtual Agent API Funktionen, die in Store-Version 3.0.x verfügbar sind](https://servicenow-prod.fluidtopics.net/~1lVEsPzbZWNEyhy5PW5sg#va-api-features-v3)** Virtual Agent API Version 3.0.x bietet Zugriff auf weitere der gleichen Funktionen, die in Virtual Agent und Mitarbeiterchatverfügbar sind, einschließlich der Möglichkeit, Dateien von einer privaten URL hochzuladen, und Verbesserungen des synchronen Handshake. * **[Installieren Sie die Virtual Agent -API](https://servicenow-prod.fluidtopics.net/U_MwUybcRlvIX3wn0uoR1A)** Installieren Sie die API-App Virtual Agent, um eine beliebige Chatoberfläche oder einen Bot mit ServiceNow® Virtual Agent oder Mitarbeiterchatzu integrieren. * **[Überprüfen Sie den eingehenden REST-Endpunkt, und konfigurieren Sie die eingehende Authentifizierung](https://servicenow-prod.fluidtopics.net/wnWqdc~ET2lzo_z8cJvpPQ)** Navigieren Sie nach der Installation der API Virtual Agent zur Ressource „Geskriptete REST-API", um den Endpunkt zu überprüfen und die Authentifizierung einzurichten. * **[Konfigurieren Sie die Nachrichtenauthentifizierung für eingehende Kommunikation](https://servicenow-prod.fluidtopics.net/pNAtfXR6~TGxQvzejTxb~w)** Anstelle von Basis- oder OAuth-Authentifizierung können Sie auch die Nachrichtenauthentifizierung für die Virtual Agent -API konfigurieren. Die Nachrichtenauthentifizierung umfasst die Konfiguration von statischen oder Hash-Token, das Einrichten der Anbieterauthentifizierung und das Festlegen der Kanalidentität. * **[Konfigurieren Sie den REST-Endpunkt der Ausgabeantwort und die ausgehende Authentifizierung für die Virtual Agent -API](https://servicenow-prod.fluidtopics.net/~UpXvrc6bRCcSTcz8ma0WQ)** Geben Sie die URL des ausgehenden Endpunkts an, an die die Virtual Agent -Antworten gesendet werden. Konfigurieren Sie die ausgehende Authentifizierung. * **[Virtual Agent Bot-zu-Bot-Integration](https://servicenow-prod.fluidtopics.net/fXhVs4Dl55tCKo2Am3yDXQ)** Die Virtual Agent API unterstützt Umgebungen, die mehrere Bots verwenden. In dieser Situation kommuniziert ein primärer Bot mit sekundären Drittpartei-Bots, z. B. dem ServiceNow -Bot. * **[Inaktive Bot-zu-Bot-Konversationen werden geschlossen](https://servicenow-prod.fluidtopics.net/9ed9kfj9SaPTnEx11p6Ypg)** In Bot-zu-Bot-Integrationen (Virtual Agent-API) werden abgebrochene Konversationen, die länger als eine Stunde im Leerlauf sind, automatisch von der geplanten Aufgabe Time Out Abandoned B2B Conversationsgeschlossen. Dieser Auftrag wird jeden Tag stündlich ausgeführt. * **[Konfigurieren Sie Anwendungen für mehrere Anbieter](https://servicenow-prod.fluidtopics.net/Vnm8t2_Z_YBsb74Mi0EnKw)** Sie können Anwendungen von mehreren Anbietern konfigurieren, um Anwendungsfälle zu unterstützen, in denen mehrere primäre Bots Virtual Agent API verwenden, und Sie müssen zwischen ihnen unterscheiden. * **[Transformieren Sie die Virtual Agent-API-Anforderung und -Antwort](https://servicenow-prod.fluidtopics.net/iNrd_T5PD1tkh7hv5CRcZw)** Sie können die Virtual Agent-API-Anforderung und -Antwort über die in der Virtual Agent-API bereitgestellten geskripteten Erweiterungspunkte in unterstützte Formate umwandeln. * **[Experience Now Assist in Virtual Agent APIaktivieren](https://servicenow-prod.fluidtopics.net/MwkQlfDGjUTPLGlORml_Ng)** Aktivieren Sie die Experience \[ Now Assist in Virtual Agent API, um generative KI-Kompetenzen über mehrere Anbieterkanäle hinweg zu unterstützen.