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 Mpower gebruiken in een gebruikersinterface van uw keuze. Dit is een op JavaScript gebaseerde SDK die zowel LiveChat als Chat Messaging ondersteunt, zowel synchrone als asynchrone berichten. U kunt ook single-thread In een single-threaded app, heeft elk contact een chatthread die elke interactie die deze met uw organisatie heeft, afhandelt. 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 Mpower 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 Mpower 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

Term	Details
Thread	Een gesprek binnen 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 app ontwerp waarbij het contact slechts één gesprek tegelijk kan voeren.
Multi-thread	Een app ontwerp waarbij de contactpersoon meerdere gesprekken tegelijk kan voeren.
Kanaal	In de context van Digital Experienceverwijst kanaal naar het type berichtgeving of het platform dat wordt gebruikt voor communicatie. 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 Mpower-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.
Kanaal-ID	De ID van het digitale chatkanaal dat is aangemaakt in sectie Digital van CXone Mpower. Deze ID is te vinden in de instellingen van het chatkanaal in CXone Mpower (ACD > Digital > Digitale contactpunten > Chat > Initialisatie en test).
Merk-ID	Dit is als een tenant Een organisatorische eenheid op hoog niveau die wordt gebruikt om technische ondersteuning, facturering en globale instellingen voor uw CXone Mpower-systeem 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 Mpower (ACD > Digital > Digitale contactpunten > Chat > Initialisatie en test).
Klant-ID	De unieke ID van de chatgebruiker. 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 locatie waar uw CXone Mpower-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 Mpower-systeem wordt gehost. Anders wordt de chatverbinding geweigerd.
Contact, klant en gebruiker	Deze termen verwijzen allemaal naar 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 Mpower	De kern platform waar u alle tools voor klantervaringen die CXone Mpower biedt, beheert en gebruikt. Afhankelijk van de chatfuncties die u in uw mobiele app wilt aanbieden, moet een beheerder met de nodige gebruikersaccountmachtigingen verschillende configuratietaken in CXone Mpower uitvoeren.
Digital Experience	Het gedeelte van CXone Mpower waar u alles over digitale kanalenkunt beheren.

Voordat u begint met ontwikkelen

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

Hebt u zowel een beheerdersaccount als een agentaccount in CXone Mpower? Kan een beheerder u helpen bij het instellen van de nodige functies in het CXone Mpower-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?

Chat correct initialiseren

Uw ontwikkelaars moeten uw app verbinden met CXone Mpower om communicatie heen en weer te kunnen starten. Hierdoor ontstaat een WebSocket verbinding. Ontwikkelaars kunnen dit doen door await sdk.connect() aan te roepen. Zorg ervoor dat u uw ontwikkelaars opdracht geeft dit alleen te doen voor actieve chatgesprekken. Hierdoor wordt ervoor gezorgd dat de WebSocket alleen draait als dat nodig is.