Digital Chat-Web-SDK

SDK: Github

API-Referenz: Github Seiten

Beispiel-App: Github

NPM-Paket: npmjs.com

Mit der Chat-Web-SDK können Sie Ihren eigenen digital Chat Anwendung erstellen oder digital Chat in einer vorhandenen Web-App hinzufügen. Sie können dabei die digitale Infrastruktur von CXone in einer UI Ihrer Wahl verwenden. Es handelt sich dabei um ein JavaScript-basiertes SDK, das sowohl LiveChat als auch Chatnachrichten – sowohl synchrones als auch asynchrones Messaging – unterstützt. Sie können es auch für singleGeschlossen In einer Anwendung mit nur einem Thread kann jeder Kontakt nur einen Chat-Thread haben. Jede Interaktion, die sie mit Ihrer Organisation haben, findet in diesem einen Chat-Thread statt. oder multithreadedGeschlossen In einer App mit mehreren Threads können Kontakte so viele Threads erstellen, wie sie möchten, um neue Themen zu diskutieren. Diese Threads können gleichzeitig aktiv sein. Messaging einrichten. Mit dem SDK haben Sie mehr Kontrolle über CXone auf Ihrer Website. Es kann dazu beitragen, bestimmte technische Einschränkungen einer Website zu umgehen. So könnte auf Ihrer Website zum Beispiel kein externer Code zulässig sein, sodass der native CXone digital-Chat nicht ausgeführt werden kann.

Das SDK unterstützt die folgenden Funktionen:

  • Digitale Chatnachrichten
  • OAuth2.0 für Autorisierung
  • Kontaktidentifizierung und eigene Felder
  • Liste mit Threads und Thread-Wiederherstellung
  • Anlagen
  • Rich Messages
  • Indikatoren für Eingabe, Nachricht gelesen und Nachricht zugestellt
  • Systemnachrichten wie Fallstatusereignisse oder Zuweisungsereignisse
  • Warteschlangenpositionsereignisse

Dieses SDK ist in TypeScript 4.9+ geschrieben. Sie müssen außerdem eine eigene Anwendung bundler like webpack or Create React App verwenden.

SDK-Ressourcen

Oben auf dieser Seite oder in der Dropdown-Liste darunter finden Sie Links zu den verschiedenen SDK-Ressourcen.

Ihre Entwickler können das SDK von Github erhalten. Das Repository verfügt über eine README-Datei, die den Entwicklern bei den ersten Schritten hilft. Es enthält außerdem Dokumentation für Ereignisse und die API-Referenz. Die benutzerfreundlichere API-Referenz wird separat über github.io gehostet.

Sie können sich auch die Beispiel-Anwendung ansehen. Hier können Sie den Chat ausprobieren und sich den dazugehörigen Quellcode ansehen.

Entwickler importieren das SDK als NPM-Paket. Der Paketeintrag auf npmjs.com enthält denselben Inhalt und dieselbe Anleitung für die Einrichtung und Erstellung mit dem SDK.

Wichtige Begriffe

  • Thread: Eine Unterhaltung innerhalb der Chat-App. Die erste Nachricht, die der Agent oder der KontaktGeschlossen Die Person, die mit einem Agenten, IVR oder Bot in Ihrem Contact Center interagiert. sendet, startet einen Thread. Jede folgende Nachricht in der Unterhaltung wird dem Thread hinzugefügt. Threads sind Objekte, die die einzelnen Nachrichten enthalten. Nachrichten werden vom Verfasser der Nachricht strukturiert. Eine threadId identifiziert eine gesamte Unterhaltung, und alle Nachrichten innerhalb einer Unterhaltung haben eine Nachrichten-ID. Ein Thread endet, wenn die Unterhaltung endet.

  • Single-Thread: Ein App-Design, bei dem der Kontakt jeweils nur eine Unterhaltung führen kann.

  • Multi-Thread: Ein App-Design, bei dem der Kontakt mehrere Unterhaltungen gleichzeitig führen kann.

  • Kanal: Im Zusammenhang mit Digital Experience, bezieht sich Kanal auf die Art des Messaging oder die Plattform, die für die Kommunikation verwendet wird. Sie könnten zum Beispiel einen WhatsApp-Echtzeit-Messaging-Kanal haben. Sie können ihrer mobilen App mit dem SDK einen Chat-Messaging-Kanal hinzufügen. Ein Kanal wird auf der CXone-Plattform erstellt. Dies bestimmt die Einstellungen des Kanals, zusammen mit einer Kanal-ID. Sie verwenden diese ID, um den Chatkanal zu initiieren, wenn ein App-Benutzer den Chat öffnet.

  • Kanal-ID: Die ID des digitalen Chatkanals, der im Digital-Bereich von CXone erstellt wird. Sie finden sie in den Einstellungen des Chatkanals in CXone (ACD > Digital > Kontaktstelle digital > Chat > Initialisierung und Test).

  • Brand-ID: Dies ist wie eine MandantenGeschlossen Eine übergeordnete organisatorische Gruppierung, die Sie für die technische Unterstützung und Abrechnung und außerdem zur Bearbeitung von globalen Einstellungen in Ihrer CXone Umgebung einsetzen können.-ID für Digital Experience. Sie wird verwendet, um den Chat zu initialisieren. Sie finden sie in den Einstellungen des Chatkanals in CXone (ACD > Digital > Kontaktstelle digital > Chat > Initialisierung und Test).

  • Kunden-ID: Die eindeutige ID des Chat-Endbenutzers. Das SDK erstellt diese ID, wenn der Chat initialisiert wird. Wenn Sie OAuth eingerichtet haben, bleibt diese ID für die einzelnen Kontakte auf allen Geräten dieselbe. Wenn Sie OAuth nicht eingerichtet haben, ist diese ID auf jedem Gerät unterschiedlich; die ID ist dann eine Art Gastanmeldung.

  • Region oder Umgebung: Der geografische Ort, an dem Ihre CXone-Bereitstellung gehostet wird. Mögliche Optionen: Australien (AU1), Kanada (CA1), Europa (EU1), Japan (JP1), Nordamerika (NA1) oder Vereinigtes Königreich (UK1). Der Entwickler muss dieselbe Region verwenden, in der Ihr CXone-System gehostet wird, andernfalls wird die Chatverbindung abgelehnt.

  • Kontakt, Kunde und Benutzer: Diese Begriffe beziehen sich alle auf den Endbenutzer der mobilen App. In der Online-Hilfe wird normalerweise der Begriff Kontakt verwendet. In der SDK-Dokumentation und in den Codekommentaren finden Sie wahrscheinlich eher die Begriffe Kunde und Benutzer.

  • CXone: Die zentrale Plattform, auf der Sie alle Tools für das Kundenerlebnis verwalten und aufrufen, die NICE CXone bietet. Je nachdem, welche Chatfunktionen Sie in Ihrer mobilen App anbieten möchten, muss ein Administrator mit den erforderlichen Benutzerkonto-Berechtigungen verschiedene Einrichtungsaufgaben in CXone abschließen.

  • Digital Experience: Der Bereich von CXone, in dem Sie digitale Kanäle verwalten.

Bevor Sie mit der Entwicklung beginnen

Berücksichtigen Sie vor der Entwicklung mit dem mobilen SDK die folgenden Punkte:

  • Haben Sie sowohl ein Administrator- als auch ein Agentenkonto in CXone? Kann ein Administrator Ihnen bei der Einrichtung der nötigen Funktionen in der CXonePlattform helfen?
  • Haben Sie bestehende Chat-Kanäle oder möchten Sie einen neuen erstellen?
  • Möchten Sie Unterhaltungen mit nur einem Thread oder mit mehreren Threads anbieten?
  • Welche Arten von Rich Messages möchten Sie einrichten? Gibt es Beispiele für Anwendungsfälle, für die Sie diese interaktiven Nachrichten nutzen können?
  • Sollen proaktive Aktionen wie Popups oder Begrüßungsnachrichten verwendet werden?