CXone Agent SDK

Der Inhalt dieser Seite bezieht sich auf ein Produkt oder eine Funktion in kontrollierter Freigabe (CR). Wenn Sie nicht Teil der CR-Gruppe sind und weitere Informationen wünschen, wenden Sie sich an Ihren CXone Account Representative.

SDK-Sprache: Typescript

Aktuelle Version: 24.3

Veröffentlichungsdatum der aktuellen Version: 23. Juli 2024

Verfügbarkeit: Alle Regionen und alle Geschäftssegmente

Unterstützte Browser: Google Chrome, Microsoft Edge, Island Enterprise

SDK-Repository: Fragen Sie Ihren CXone Account Representative nach einem Link zum Repository

Ein Software Development Kit (SDK) ist eine Art Werkzeugkasten für Entwickler. Sie finden darin verschiedene Tools und Ressourcen, mit denen die Entwicklung von Software-Anwendungen einfacher ist. Sie können sich ein SDK als Sammlung vorgefertigter Bausteine vorstellen. Diese Bausteine enthalten bestimmte Funktionen. Ihre Entwickler können diese vorhandenen Bausteine verwenden, statt die Funktionen von Grund auf selbst zu entwickeln. Die Verwendung eines SDK bietet vier wichtige Vorteile:

  1. Effizienz: Mit den vorgefertigten Tools und Komponenten sparen Entwickler Zeit. Statt das Rad immer wieder neu zu erfinden, können sie sich auf die speziellen Aspekte ihrer App konzentrieren.

  2. Einheitlichkeit: Das SDK sorgt in den verschiedenen Apps für Konsistenz. Da immer dieselben Tools und Bibliotheken verwendet werden, schaffen Entwickler ein einheitliches Nutzererlebnis.

  3. Plattformkompatibilität: Die iOS- und Android-SDKs sind für die jeweiligen Plattformen maßgeschneidert. Sie verarbeiten Plattform-spezifische komplexe Aspekte, sodass es einfacher ist, plattformübergreifende Apps zu entwickeln.

  4. Qualitätssicherung: Mithilfe des Loggers können Entwickler ihren Code überprüfen, Bugs in einer frühen Phase der Entwicklung erkennen und beheben sowie zuverlässigere Software liefern.

Kurz, ein SDK vereinfacht den Entwicklungsprozess, sichert die Qualität und fördert die Zusammenarbeit und wird dadurch zu einem unerlässlichen Tool für die effiziente App-Erstellung.

Mit dem CXone Agent SDK können Sie eine Agent-AnwendungGeschlossen Möglichkeit, Datumsangaben als Gleitkommazahlen zu schreiben. Gibt die Anzahl der Tage seit dem 30. Dezember 1899 an. entwickeln. Es ermöglicht Ihnen auch, CXone Agent-Funktionen in eine vorhandene Anwendung zu integrieren. Anstatt CXone APIs direkt zu verwenden, können Entwickler die vorkonfigurierten Funktionen über das SDK verwenden. Diese Vorgehensweise verkürzt die Entwicklungszeit und spart Ressourcen. Ihre Entwickler müssen nicht im Einzelnen verstehen, wie alle CXone APIs funktionieren. Mit dem SDK können Sie Gruppen von APIs in JavaScript-Wrappern verwenden.

Das CXA SDK ist eine Sammlung kleinerer SDKs. Jedes dieser kleineren SDKs deckt einen bestimmten Funktionsaspekt ab, zum Beispiel die Authentifizierung oder Anrufsteuerungen. So brauchen Sie nur die für Ihren Anwendungsfall erforderlichen SDKs auszuwählen. Beispielsweise benötigen Sie möglicherweise das Voice SDK nicht, das WebRTC-Funktionen für ein Integriertes Softphone bereitstellt. Das bedeutet auch, dass Entwickler nur die für Ihren Anwendungsfall erforderlichen SDKs installieren müssen.

Wichtige Informationen zum CXA SDK:

  • Das SDK arbeitet mit Ereignisabos. Daten von der CXone-Plattform werden mit einem Ereignis veröffentlicht. Um die Daten zu verwenden, muss Ihre App diese Ereignisse abonnieren.

  • Alle Funktionen von CXone Agent sind über dieses SDK verfügbar.

  • Sie müssen die Anwendung registrieren, mit der Sie das SDK verwenden werden. Füllen Sie das Formular für die Registrierung aus, um Anmeldeinformationen für diese App zu erhalten. Auf der Seite Getting Started des Entwicklerportals werden Sie durch die Registrierung Ihrer App und die Einrichtung der Authentifizierung geleitet.

  • Das SDK unterstützt OpenID Connect mit dem PKCE-Authentifizierungsablauf.

Anwendungsfälle für das CXA SDK

Nachstehend finden Sie drei gängige Anwendungsfälle für das CXA SDK.

  • Eigener Agent-Client:
    In diesem Fall haben Sie eine spezielle Funktion oder Anforderungen, die CXone Agent nativ nicht bietet. Möglicherweise lässt sich die erforderliche Funktion auch nicht einfach in CXone Agent einbetten. Beispiel: Sie möchten einschränken, welche Kontaktinformationen Ihre Agenten sehen können. Dies könnte etwa durch eine bestimmte Sicherheitsanforderung begründet sein. Sie müssten alle Kontaktdaten für die Agenten maskieren – das kann nur ein benutzerdefinierter Client leisten.

  • Einen Agent-Client mit einer Drittanbieter-Anwendung integrieren:
    In diesem Fall können Sie Agentenanwendung nicht in eine andere App einbetten. Andere Apps sind oft CRMs, Online-Banking-Websites oder Hotelbuchungssysteme. Bei diesem Anwendungsfall möchten Sie die Funktionen eines Agent-Clients nutzen, brauchen aber nicht unbedingt die Benutzeroberfläche (UI) des Clients. Mit dem SDK können Sie Funktionen in eine andere Anwendung einbinden. Im Beispiel eines Hotelbuchungssystems könnte das Personal über das Buchungssystem ein bestimmtes Zimmer aufrufen.

  • Ereignisabo für eingebettete Anwendungen:
    Dies wird im Allgemeinen verwendet, um bestimmten Browser-Sicherheitseinschränkungen zu entsprechen. Google verhindert zum Beispiel das Übernehmen von Daten von einer anderen Website in ein iframe-Fenster. Dadurch wird der Austausch von Nachrichten oder Daten zwischen zwei Frames komplizierter. Beispiel: Sie haben eine App für das Gesundheitswesen, die per iframe in CXone Agent angezeigt wird. Wenn der Agent einen Kontakt annimmt, sollt die Telefonnummer des Kontakts verwendet werden, um dessen Informationen in Ihrer App aufzurufen. So können dem Agenten automatisch Kontaktinformationen angezeigt werden. Wenn der Agent Google Chrome verwendet, kann Ihre Gesundheits-App nicht die Telefonnummer aus CXone Agent empfangen. Stattdessen muss die App den VC-Ereignisstrom abonnieren, welcher derselbe ist, den CXone Agent verwendet.

SDK-Aufbau

Das CXA SDK besteht aus den folgenden kleineren SDKs:

SDK Details
ACD

Dieses SDK bietet Funktionen zum Bearbeiten von Sprachanrufen, Voicemail und ArbeitselementenGeschlossen Anpassbare Methode für die Bereitstellung von Kontakten an einen Agenten über Studio-Skripte.. Beispiel:

  • Bei Sprachanrufen können Sie die Anrufe initiieren, empfangen, weiterleiten und in Konferenz schalten.

  • Bei Voicemail können Sie die Sprachnachrichten empfangen, speichern und verwalten.

  • Bei Arbeitselementen können Sie die Verteilung der Arbeitselemente an Agenten automatisieren. So lässt sich mithilfe von Regeln und Kriterien die Arbeit optimal auf die Agenten verteilen.

Nachstehend finden Sie wichtige technische Details zum ACD SDK:

  • Nach der erfolgreichen Authentifizierung können Sie initAcdEngagement() aufrufen, um dieses Modul zu instanziieren und ACD-Funktionen zu entwickeln.

  • Sie können eine Sitzung zwischen einem Agenten und einem Kontakt aufbauen, indem Sie die Methoden startSession und joinSession verwenden.

  • Nach dem Sitzungsaufbau kann Ihre App andere Methoden aufrufen, die für Funktionen wie Wählen, Weiterleiten, Zusammenschalten usw. verwendet werden.

  • Durch den erfolgreichen Aufruf der Methoden dieses Moduls werden ACD-Ereignisse erzeugt.
Agent

Dieses SDK dient der Verarbeitung von Sitzungsereignissen. Sie können damit eine Sitzung starten, an einer bereits laufenden Sitzung teilnehmen usw. Hauptschwerpunkte des SDK sind:

  • die Schleife "get-next-event" (nächstes Ereignis abrufen)

  • alles, was ACD und Digital Experience-Bereiche der CXone-Plattform gemeinsam haben, zum Beispiel WEM oder Benachrichtigungen
Auth

Dieses SDK ermöglicht die sichere Authentifizierung und Autorisierung. Sie können damit vor allem einen Anmeldeablauf einrichten, der die globale Authentifizierung von CXone verwendet. Der unterstützte Authentifizierungsablauf ist OpenID Connect mit PKCE. Benutzer müssen sich mit einem CXone-Konto authentifizieren. So können Sie Benutzeridentitäten und ihre Berechtigungen basierend auf ihrer CXone-RolleGeschlossen Sucht nach Anzeichen der Verärgerung beim Kunden. Dazu gehören zum Beispiel Wörter und Ausdrücke wie "Ich finde das sehr ärgerlich". Frustration ist nicht dasselbe wie negative Stimmung. Anzeichen der Frustration zeigen, dass ein Kunde nicht nur über etwas Negatives spricht, sondern sich aufregt oder wütend ist. verifizieren.

Wichtige Funktionen sind:

  • Automatische Aktualisierung von auth-Tokens. So können Benutzer angemeldet bleiben, bis sie die App schließen oder sich abmelden.

  • Token-Verwaltung und -Validierung. Wenn sich ein Benutzer bereits bei CXone angemeldet hat, können Sie das gültige auth-Token an Ihre App übergeben.

Nachstehend finden Sie wichtige technische Details zum Auth SDK:

  • Rufen Sie cxoneAuth.init() auf, um cxoneHostname, clientId und redirectUri an das SDK zu übergeben.

  • Rufen Sie die getAuthorizeUrl()-Methode auf, um Benutzer zur globalen CXone-Authentifizierungsseite weiterzuleiten. Nach der Anmeldung werden sie zurück zu Ihrer App geleitet.

  • Wenn der Benutzer die Anmeldeinformationen eingibt und die Authentifizierung initiiert, wird ein AuthSettings-Objekt mit den Benutzerinformationen erstellt. Die CXoneAuth-Instanz wird mit AuthSettings initialisiert.

  • Verwenden Sie getAccessTokebByCode(), um den zurückgegebenen Code zu erfassen und ein Authentifizierungs-Token zu generieren. Dabei werden auch die Benutzerinformationen gespeichert.

  • Abonnieren Sie onAuthStatusChange, das Ereignisse im Zusammenhang mit der Authentifizierung erzeugt, zum Beispiel AUTHENTICATED oder AUTHENTICATEDFAILED. Im Fall von AUTHENTICATED wird automatisch der Aktualisierungsablauf ausgelöst, sodass der Benutzer angemeldet bleibt.
Digital

Mit diesem SDK können Sie digitale Kommunikationskanäle integrieren. Sie können digitale Standardkanäle wie E-Mail, Chat und SMS sowie Social-Media-Plattformen wie WhatsApp verwenden. Je nachdem, wie viele Kanäle Sie eingerichtet haben, können Sie Mehrkanal-Kommunikation erstellen.

Nachstehend finden Sie wichtige technische Details zum Digital SDK:

  • Nach der erfolgreichen Authentifizierung können Sie CXoneDigitalClient.instance.initDigitalEngagement() aufrufen. Dadurch werden die erforderlichen Komponenten für digitale Nachrichten instanziiert und es wird eine digitale WebSocket-Verbindung hergestellt.

  • Verwenden Sie digitale Ereignisse, um bereits zugewiesene Fälle mit ihren vorhandenen Nachrichten-Threads zu empfangen.

  • Ihre App kann mit der reply()-Methode auf digitale Nachrichten antworten.

  • Sie können auch eine neue ausgehende Interaktion initiieren, indem Sie die reply()-Methode verwenden.
Sprache Dieses SDK bietet Ihnen Integriertes Softphone-Funktionen. Es ist ein Wrapper für WebRTC.

Ressourcen

Mit einem SDK können Sie Ihre eigenen Funktionen erstellen, deshalb sind Ihre Support-Ressourcen hauptsächlich Selfservice-Inhalte. Ihre Optionen für den technischen Support richten sich nach der Support-Vereinbarung Ihrer Organisation mit NICE. Wenden Sie sich an Ihren CXone Account Representative, um weitere Informationen zu Ihren Support-Optionen zu erhalten.

Abgesehen von dieser Seite bieten Ihre Selfservice-Inhalte hauptsächlich Ressourcen für Entwickler. Das SDK-Paket enthält Folgendes:

  • README-Dateien für die einzelnen SDKs mit Informationen zum Einstieg.

  • Eine Beispiel-Anwendung zur Demonstration der grundlegenden Funktionen.

  • Anwendungsbeispiele mit Code-Auszügen aus der Beispiel-Anwendung.

  • Code-Kommentare.

Ereignisse

Nachstehend sind Ereignisse aufgeführt, auf die Ihre App mit Listenern warten kann. Die Ereignisse sind nach dem Modul kategorisiert, in dem sie verfügbar sind.

ACD SDK

Instanz Ereignis Beschreibung

CXoneAcdClient.instance.contactManager

conferenceCallEvent

Wartet auf Ereignisse im Zusammenhang mit Konferenzgesprächen.

 

onDispositionEvent

Verarbeitet Ereignisse im Zusammenhang mit DispositionenGeschlossen Ergebnisse, die einer Interaktion an derem Ende vom Agenten oder System zugewiesen werden; bei Sprachinteraktionen als Disposition und bei digitalen Interaktionen als Status von Interaktionen.

 

onTagsEvent

Verwaltet Ereignisse im Zusammenhang mit Tags, die Interaktionen zugewiesen werden.

 

voiceContactUpdateEvent

Wartet auf Aktualisierungen von Sprachkontakten.

 

voiceMailContactUpdateEvent

Wartet auf Aktualisierungen von Voicemail-Kontakten.

 

workItemContactUpdateEvent

Wartet auf Aktualisierungen von Arbeitselement-Kontakten.

CXoneAcdClient.instance.notification

onUpdateMessageEvent

Wartet auf neue Nachrichten oder Benachrichtigungen für den Agenten.

CXoneAcdClient.instance.screenPop

agentAssistSubject

Verarbeitet Ereignisse im Zusammenhang mit Agentenassistenten oder Copilot-Anwendungen.

 

contactScreenPopSubject

Verarbeitet Ereignisse im Zusammenhang mit Bildschirm-Pop-ups für eingehende Kontakte.

 

pageOpenSubject

Verarbeitet Ereignisse im Zusammenhang mit dem Öffnen von Webseiten.

 

popUrlSubject

Verarbeitet Ereignisse im Zusammenhang mit der Anzeige von URLs in einem neuen Fenster oder Tab.

 

runAppSubject

Verarbeitet Ereignisse im Zusammenhang mit dem Ausführen von Anwendungen oder dem Öffnen benutzerdefinierter Formulare.

CXoneAcdClient.instance.session

agentLegEvent

Wartet auf Ereignisse im Zusammenhang mit dem Agenten-AbschnittGeschlossen Der Teil einer Interaktion, der zwischen CXone und dem Agenten stattfindet. in der Sitzung.

 

agentStateSubject

Beobachtbares Ereignis, das Ereignisse im Zusammenhang mit Änderungen am Agentenstatus sendet, zum Beispiel beim Wechsel von "Verfügbar" zu "Nicht verfügbar".

 

naturalCallingSkillListSubject

Wartet auf Aktualisierungen an der Liste der Skills, die für Natural Calling aktiviert sind.

Zu den Ereignistypen gehören: SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS und JOIN_SESSION_FAILURE.

 

networkOfflineSubject

Wartet auf Ereignisse im Zusammenhang mit Problemen bei der Netzwerkkonnektivität.

 

onAgentSessionChange

Wartet auf Änderungen am Sitzungsstatus des Agenten, zum Beispiel Start oder Ende.

Zu den Ereignistypen gehören: SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS und JOIN_SESSION_FAILURE.

CXoneAcdClient.instance.session.agentStateService

agentStateSubject

Beobachtbares Ereignis, das Aktualisierungen zu Änderungen des Agenten-Status sendet.

Agent SDK

Instanz Ereignis Beschreibung

CXoneClient.instance

autoSummaryService

Dienst zur Verwaltung automatischer Zusammenfassungen.

 

copilotNotificationClient

Ermöglicht den Empfang von Echtzeit-Benachrichtigungen für Agent Copilot.

 

cxoneApiPerformanceMetrics

Wartet auf Leistungsmetriken von der CXone API.

CXoneClient.instance.agentSession

agentSessionEndSubject

Sendet ein Ereignis, wenn die aktuelle Sitzung des Agenten endet.

CXoneClient.instance.agentSetting

mchAgentSettingsChangeEvent

Wartet auf Änderungen an den Einstellungen für "Make Call Heard (MCH)" (Anruf hörbar machen) des Agenten.

CXoneClient.instance.autoSummaryService

onAutoSummaryReceived

Beobachtbares Ereignis, das ausgelöst wird, wenn eine automatisch generierte Zusammenfassung für einen Kontakt empfangen wird.

CXoneClient.instance.commitment

onCommitmentEvent

Wartet auf Ereignisse im Zusammenhang mit den Verpflichtungen des Agenten.

 

onCommitmentStatusEvent

Wartet auf Änderungen am Status der Verpflichtungen des Agenten.

 

onUpdateCommitments

Wartet auf Aktualisierungen der Verpflichtungen des Agenten.

CXoneClient.instance.contactManager

onDigitalContactEvent

Bietet Aktualisierungen zu digitalen Kontakten wie Chatsitzungen und ausgehenden Nachrichten in CXone.

 

onDispositionEvent

Bietet Aktualisierungen zum Status der Anrufdisposition, nachdem der Anruf beendet wurde.

 

voiceContactUpdateEvent

Bietet Echtzeit-Aktualisierungen zu Details von laufenden Sprachanrufen wie Anrufername und Telefonnummer.

CXoneClient.instance.copilotNotificationClient

onMessageNotification

Beobachtbares Ereignis / Ereignissender, das/der für das Abonnement von eingehenden Copilot-Nachrichten oder -Benachrichtigungen verwendet wird.

Zu den Ereignistypen gehören: ADAPTIVE_CARD, RT_SUMMARY, NEXT_BEST_RESPONSE, NEXT_BEST_RESPONSE_LLM, NEXT_BEST_RESPONSE_EXPERT, KB_ANSWERS, SENTIMENT, KB_LINKS, KB_IMAGES, TEXT, FINAL_SUMMARY, FINAL_SUMMARY_NOTES, KB_ANSWERS_VOICE, KB_IMAGES_VOICE, ENLIGHTEN_AGENT_COPILOT und AGENT_COPILOT.

CXoneClient.instance.directory

directoryEvent

Wartet auf Ereignisse im Zusammenhang mit dem Verzeichnis, zum Beispiel Agenten, Teams oder Skills.

Bietet Aktualisierungen zu Änderungen an Verzeichnisdaten wie neue Kontakte, Updates und Berechtigungsänderungen in CXone.

 

onUpdateSkillsEvent

Wartet auf Aktualisierungen der zugewiesenen Skills des Agenten.

CXoneClient.instance.directory.dynamicDirectory

searchDirectoryResult

Wartet auf die Rückgabe von Ergebnissen, nachdem Sie zum Beispiel eine Person oder Abteilung in einem Verzeichnis innerhalb des Systems nachgeschlagen haben.

CXoneClient.instance.indicator

agentIndicatorsEvent

Bietet Aktualisierungen zu Agentenindikatoren wie Verfügbarkeit, aktuelle Aktivität und benutzerdefinierten Agentenstatusanzeigen.

 

contactIndicatorsEvent

Bietet Aktualisierungen zu Kontaktindikatoren, die Aktionen auslösen können, etwa die Anzeige benutzerdefinierter Formulare zum Abfragen zusätzlicher Informationen

CXoneClient.instance.notification

onCXoneNotificationEvent

Wartet auf Benachrichtigungen von der CXone-Plattform.

CXoneClient.instance.screenPop

contactScreenPopSubject

Löst das Öffnen einer Webseite aus, auf der Anruferinformationen zu einem bestehenden Anruf angezeigt werden.

 

pageOpenSubject

Löst das Öffnen einer Webseite aus, die nicht unbedingt mit dem aktuellen Anruf zu tun haben muss.

 

popUrlSubject

Löst das Öffnen einer relevanten Webseite für einen bestehenden Anruf aus.

 

runAppSubject

Löst den Start einer App oder die Anzeige eines benutzerdefinierten Formulars für einen Anruf aus.

CXoneClient.instance.session

agentLegEvent

Wartet auf Aktualisierungen zu einem bestimmten Abschnitt des Agenten, zum Beispiel einen eingehenden oder ausgehenden Anruf.

CXoneClient.instance.session.agentStateService

agentStateSubject

Bietet Aktualisierungen in Echtzeit zum Verfügbarkeitsstatus des Agenten und zu Statusänderungen in CXone.

CXoneClient.instance.skillActivityQueue

agentQueueSubject

Bietet Aktualisierungen zu Informationen zur zugewiesenen Warteschlange eines Agenten, z. B. Warteschlangenname, Anzahl der Anrufe und Agentenverfügbarkeit.

 

agentQueuesDetailSubject

Bietet ausführliche Aktualisierungen zu zugewiesenen Warteschlangen eines Agenten, darunter Metriken wie durchschnittliche Wartezeit, Servicelevelvereinbarungen (SLA) und Agentenleistung.

 

skillActivityEvent

Bietet Aktualisierungen zu Metriken zur Skillaktivität, z. B. Länge der Anrufwarteschlange, durchschnittliche Wartezeit und verfügbare Agenten.

Auth SDK

Instanz Ereignis Beschreibung

CXoneAuth.instance

onAuthStatusChange

Beobachtbares Ereignis, das auf Statusänderungen bei der Benutzerauthentifizierung wartet.

Zu den Ereignistypen gehören: AUTHENTICATED,AUTHENTICATING, NOT_AUTHENTICATED, AUTHENTICATION_FAILED und REFRESH_TOKEN_SUCCESS

Digitale SDK

Instanz Ereignis Beschreibung

CXoneDigitalClient.instance.digitalContactManager

onDigitalContactEvent

Wartet auf Ereignisse im Zusammenhang mit digitalen Kontakten.

Zu den Ereignistypen gehören: CASE_INBOX_ASSIGNEE_CHANGED, CASE_STATUS_CHANGED, MESSAGE_ADDED_INTO_CASE, CASE_INBOX_ASSIGNED, CASE_INBOX_UNASSIGNED, MESSAGE_CREATED, MESSAGE_NOTE_CREATED, MESSAGE_NOTE_DELETED, MESSAGE_NOTE_UPDATED, MESSAGE_UPDATED, SENDER_TYPING_START, SENDER_TYPING_END und MESSAGE_PREVIEW.

 

onDigitalContactNewMessageEvent

Wartet auf neue Nachrichten von digitalen Kontakten.

 

onDigitalContactUserTypingPreviewEvent

Wartet auf Eingabevorschau-Ereignisse von digitalen Kontakten.

Zu den Ereignistypen gehören: CASE_INBOX_ASSIGNEE_CHANGED, CASE_STATUS_CHANGED, MESSAGE_ADDED_INTO_CASE, CASE_INBOX_ASSIGNED, CASE_INBOX_UNASSIGNED, MESSAGE_CREATED, MESSAGE_NOTE_CREATED, MESSAGE_NOTE_DELETED, MESSAGE_NOTE_UPDATED, MESSAGE_UPDATED, SENDER_TYPING_START, SENDER_TYPING_END und MESSAGE_PREVIEW.

Voice SDK

Instanz Ereignis Beschreibung

CXoneVoiceClientWrapper.instance

onCallStatusChanged

Verarbeitet Ereignisse im Zusammenhang mit Änderungen des Anrufstatus.

 

onConnectionStatusChanged

Verarbeitet Ereignisse im Zusammenhang mit Änderungen des Anrufverbindungsstatus.