Digitaal Chatweb-SDK

API-referentiemateriaal: GitHub-pagina's

Voorbeeldapp: GitHub

Met de Chatweb-SDK kunt u uw eigen digitaal chat-applicatie maken of digitaal chat toevoegen aan een bestaande web-app. Hiermee kunt u de digitale infrastructuur van CXone gebruiken in een gebruikersinterface van uw keuze. Dit is een op JavaScript gebaseerde SDK die zowel synchroon als asynchroon berichtenverkeer via Live chat en Chatberichten ondersteunt. U kunt ook single-thread In een single-thread app kan elk contact maar één chat-thread hebben. Elke interactie met uw organisatie vindt plaats dan plaats via die ene chat-thread. of multi-thread In een multi-thread app kunnen contacten zoveel threads maken als ze willen om nieuwe onderwerpen te bespreken. Deze threads kunnen gelijktijdig actief zijn. berichtenverkeer configureren. Deze SDK geeft u meer controle over CXone op uw website. Hiermee kunt u bepaalde technische beperkingen van sommige websites vermijden. Het kan bijvoorbeeld zijn dat uw site geen externe code toestaat, waardoor de native digitaal chatfunctie van CXone niet kan worden uitgevoerd.

De SDK ondersteunt de volgende functies:

Digitale chatberichten
OAuth2.0 voor autorisatie
Contactidentificatie- en aangepaste velden
Lijst met threads en threadherstel
Bijlagen
Rijke berichten
Typ-indicator, en indicatoren dat berichten respectievelijk gelezen en bezorgd zijn
Systeemberichten, bijvoorbeeld over case-status- of toewijzingsgebeurtenissen
Wachtrijpositiegebeurtenissen

Deze SDK is geschreven in TypeScript 4.9+. U moet ook een aangepaste applicatie-bundler like webpack or Create React App gebruiken.

SDK-bronnen

Bovenaan deze pagina of in de onderstaande vervolgkeuzelijst worden links naar de diverse SDK-bronnen weergegeven.

Uw ontwikkelaars kunnen de SDK van GitHub downloaden. De opslagplaats bevat een README-bestand met aanwijzingen voor ontwikkelaars. Tevens is er documentatie voor gebeurtenissen en API-referentiemateriaal. Het gebruikersvriendelijkere API-referentiemateriaal wordt afzonderlijk gehost via github.io.

U kunt ook de voorbeeldapplicatie bekijken. Hiermee kunt u de chat uitproberen en de corresponderende broncode bekijken.

Ontwikkelaars importeren de SDK als een NPM-pakket. Het pakket-item op npmjs.com bevat dezelfde content en instructies voor configureren en bouwen met de SDK.

Belangrijke termen

Thread: Een conversatie via de chat-app. Het eerste bericht dat door de agent of het contact De persoon die contact heeft met een agent, IVR of bot in uw contactcenter. wordt verzonden, start een thread. Alle hieropvolgende berichten in de conversatie worden aan de thread toegevoegd. Threads zijn objecten die elk bericht bevatten. Berichten worden gestructureerd door de auteur van het bericht. Een threadId identificeert een volledige conversatie, en alle berichten in een conversatie hebben een bericht-ID. Een thread eindigt wanneer de conversatie eindigt.
Single-Thread: Een appontwerp waarbij het contact slechts één conversatie tegelijk kan voeren.
Multi-Thread: Een appontwerp waarbij het contact meerdere conversaties tegelijk kan voeren.
Kanaal: In de context van Digital Experience heeft kanaal betrekking op het type messaging of het platform dat voor communicatie wordt gebruikt. U kunt bijvoorbeeld een WhatsApp-kanaal voor realtime messaging hebben. Met de Mobile SDK kunt u een chatberichtenkanaal toevoegen aan uw mobiele app. Er wordt een kanaal gemaakt in het CXone-platform. Dit bepaalt de instellingen van het kanaal en een kanaal ID. U gebruikt deze ID om het chatkanaal te starten wanneer een appgebruiker de chat opent.
ChannelId: De ID van het digitale chatkanaal dat in het Digitaal-gedeelte van CXone is gemaakt. Deze ID is te vinden in de instellingen van het chatkanaal in CXone (ACD > Digitaal > Digitale contactpunten > Chat > Initialisatie en test).
BrandId: Dit is als het ware een tenant Een organisatorische eenheid die wordt gebruikt om technische ondersteuning, facturering en globale instellingen voor uw CXone-omgeving te beheren-ID voor Digital Experience. Hiermee wordt de chat geïnitialiseerd. Deze ID is te vinden in de instellingen van het chatkanaal in CXone (ACD > Digitaal > Digitale contactpunten > Chat > Initialisatie en test).
CustomerId: De unieke ID van de chat-eindgebruiker. De SDK maakt deze ID wanneer de chat wordt geïnitialiseerd. Als OAuth op uw systeem is geïnstalleerd, blijft deze ID voor alle contacten op al hun respectieve apparaten hetzelfde. Als OAuth niet is geïnstalleerd, is deze ID voor elk apparaat anders. De ID werkt dan min of meer als een gast-login.
Regio of omgeving: De geografische locatie waar uw CXone-implementatie wordt gehost. Dit kunnen de volgende regio's zijn: Australië (AU1), Canada (CA1), Europa (EU1), Japan (JP1), Noord-Amerika (NA1) of Verenigd Koninkrijk (UK1). De ontwikkelaar moet gebruikmaken van de regio waar uw CXone-systeem wordt gehost. Anders wordt de chatverbinding geweigerd.
Contact, klant en gebruiker: Al deze termen hebben betrekking op de eindgebruiker van de mobiele app. In de online help wordt meestal de term contact gebruikt. In de SDK-documentatie en code-opmerkingen ziet u waarschijnlijk customer (klant) en user (gebruiker).
CXone: Het kernplatform waar u alle klantervaringstools van NICE CXone kunt beheren en oproepen. Afhankelijk van de chatfuncties die u in uw mobiele app wilt aanbieden, moet een beheerder met de nodige gebruikersaccountmachtigingen verschillende configuratietaken in CXone uitvoeren.
Digital Experience: Het gedeelte van CXone waar u alles over digitale kanalen kunt beheren.

Voordat u begint met ontwikkelen

Stel uzelf de volgende vragen voordat u aan de slag gaat met de mobiele SDK:

Hebt u zowel een beheerdersaccount als een agentaccount in CXone? Kan een beheerder u helpen bij het instellen van de nodige functies in het CXone-platform?
Hebt u bestaande chatkanalen of wilt u een nieuw chatkanaal maken?
Wilt u single-thread or multi-thread conversaties aanbieden?
Welke typen rijke berichten wilt u instellen? In welke use cases kunt u deze interactieve berichten zoal gebruiken?
Gaat u proactieve acties zoals pop-ups of welkomstberichten gebruiken?