Agent SDK

SDK-Sprache: Typescript

Aktuelle Version: 24.4

Veröffentlichungsdatum der aktuellen Version: 15. Oktober 2024

Verfügbarkeit: Alle Regionen und alle Geschäftssegmente

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

SDK Repository: GitHub

NPM: ACD , Agent , Auth , Digital , Sprache

API-Referenz: CXone Mpower Entwicklerportal

Mit dem CXone Mpower Agent SDK können Sie ein Agent-Anwendung erstellen. Es ermöglicht Ihnen auch, Agent-Funktionen in eine vorhandene Anwendung zu integrieren. Anstatt CXone Mpower 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 Mpower APIs funktionieren. Mit dem SDK können Sie Gruppen von APIs in JavaScript-Wrappern verwenden.

Das Agent 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 Integrated Softphone bereitstellt. Das bedeutet auch, dass Entwickler nur die für Ihren Anwendungsfall erforderlichen SDKs installieren müssen.

Wichtige Informationen zum Agent SDK:

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

  • Alle Funktionen von 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 Agent SDK

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

  • Eigener Agent-Client:
    In diesem Fall haben Sie eine spezielle Funktion oder Anforderungen, die Agent nativ nicht bietet. Möglicherweise lässt sich die erforderliche Funktion auch nicht einfach in 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 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 Agent empfangen. Stattdessen muss die App den VC-Ereignisstrom abonnieren, welcher derselbe ist, den Agent verwendet.

SDK-Aufbau

Das Agent 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.

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 Mpower-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 Mpower verwendet. Der unterstützte Authentifizierungsablauf ist OpenID Connect mit PKCE. Benutzer müssen sich mit einem CXone Mpower-Konto authentifizieren. So können Sie Benutzeridentitäten und ihre Berechtigungen basierend auf ihrer CXone Mpower-RolleGeschlossen Unterscheidet sich von einer negativen 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 Mpower angemeldet hat, können Sie das gültige auth-Token an Ihre App übergeben.

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.

Sprache Dieses SDK bietet Ihnen Integrated 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 Kundenbetreuer, 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.

Multi-Socket-Unterstützung

Die CXone Mpower UI-Warteschlange ist ein WebSocket-basierter Ansatz zum Ausgeben von ACD Ereignissen. Dies ist eine Alternative zum Get-Next-Event-Langpolling. Die UI-Warteschlange unterstützt keine Multi-Socket-Verbindungen. Dieselben Ereignisse können nicht sowohl an den Agent Client als auch an das Agent SDK gesendet werden. Wenn Sie bestimmte Funktionen des SDK mit Agent testen oder überprüfen möchten, achten Sie daher darauf, dass Sie Anwendung schließen, das das SDK verwendet.

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

Agent SDK

Auth SDK

Digitale SDK

Voice SDK