CXone Agent SDK

Deze pagina heeft betrekking op een product of functie in Controlled Release. Als u geen deel uitmaakt van de CR-groep en meer informatie wilt, neem dan contact op met uw CXone-accountmanager.

SDK taal: machineschrift

Huidige versie: 24.3

Releasedatum van huidige versie: 23 juli 2024

Beschikbaarheid: alle regio's en bedrijfssegmenten

Browserondersteuning: Google Chrome, Microsoft Edge, Island Enterprise

SDK-opslagruimte: vraag uw CXone-accountmanager naar een koppeling met de opslagplaats

Een SDK ofwel Software Development Kit is een 'gereedschapskist' voor ontwikkelaars. SDK's leveren een set tools en middelen die het bouwen van software-applicaties vergemakkelijken. Een SDK is als het ware een verzameling kant-en-klare bouwstenen. Deze bouwstenen hebben bestaande functionaliteit. Uw ontwikkelaars kunnen deze bestaande stenen gebruiken in plaats van de functionaliteit vanaf nul op te bouwen. Vier algemene voordelen van het gebruik van een SDK zijn:

  1. Efficiëntie: De SDK levert kant-en-klare tools en componenten die ontwikkelaars tijd besparen. In plaats van het wiel opnieuw uit te vinden, kunnen zij zich richten op de unieke aspecten van hun app.

  2. Consistentie: De SDK garandeert consistentie in verschillende apps. Door dezelfde set tools en bibliotheken te gebruiken, zorgen ontwikkelaars voor een uniforme gebruikerservaring.

  3. Platformcompatibiliteit: de SDK's van iOS en Android zijn op maat gemaakt voor hun respectieve platform. Zij rekenen af met platformspecifieke complexiteiten en maken het makkelijker om apps voor verschillende platforms te creëren.

  4. Kwaliteitsborging: Met de functie voor logboekregistratie kunnen ontwikkelaars hun code verifiëren, fouten in een vroeg stadium opsporen en betrouwbaardere software leveren.

Kortom, een SDK vereenvoudigt het ontwikkelingsproces, garandeert kwaliteit en bevordert samenwerking, en is daarmee een essentiële tool voor het maken van apps.

Met de SDK van CXone Agent kunt u een agentapplicatieGesloten Een manier om datums en tijden weer te geven als drijvendekommagetallen. Duidt het aantal dagen sinds 30 december 1899 aan. bouwen. Hiermee kunt u ook de functionaliteit CXone Agent integreren in een bestaande applicatie. In plaats van CXone API's direct te gebruiken, kunnen ontwikkelaars de vooraf gemaakte functionaliteit gebruiken via de SDK. Dit versnelt de ontwikkelingstijd en slaat materiaal op. Het is niet vereist dat uw ontwikkelaars begrijpen hoe alle CXone API's werken. In plaats daarvan laat de SDK u groepen API's gebruiken in bruikbare JavaScript-wrappers.

De CXA SDK is een compilatie van kleinere SDK's. Elke kleinere SDK richt zich op een specifiek aspect van de functionaliteit, zoals authenticatie of oproepfuncties. Om te voldoen aan uw use case kunt u alleen de SDK's kiezen die u nodig hebt. U hebt bijvoorbeeld de Spraak-SDK die de WebRTC-functionaliteit biedt voor een Integrated Softphone, niet nodig. Dit betekent ook dat ontwikkelaar alleen de benodigde SDK's moeten installeren voor uw use case.

Belangrijke informatie over de CXA SDK:

  • De SDK werkt via gebeurtenisabonnementen. Data van de CXone platform worden gepubliceerd met een gebeurtenis. Om de gegevens te gebruiken, moet uw app zich abonneren op deze gebeurtenissen.

  • Alle functies van CXone Agent zijn beschikbaar via deze SDK.

  • U moet de applicatie waarmee u de SDK zult gebruiken, registreren. Vul het registratieformulier in om referenties te ontvangen voor deze app. De pagina Aan de slag van de ontwikkelaarsportal begeleidt u bij het registreren van uw app en het instellen van de authenticatie.

  • De SDK ondersteunt OpenID Connect met PKCE-authenticatieflow.

CXA SDK use cases

Hieronder vindt u drie algemene use cases van de CXA SDK.

  • Aangepaste agentklant:
    In dit geval hebt u een unieke functie of vereiste dat de native CXone Agent nog niet geeft. U kunt uw vereiste functie daarnaast misschien niet gewoon insluiten in CXone Agent. Het zal bijvoorbeeld nodig zijn om te beperken wat de agents kunnen zien in contactgegevens. Dit kan gebeuren voor een specifieke beveiligingsvereiste. U moet mogelijk alle contactgegevens van de agents verbergen, wat alleen een aangepaste klant mogelijk kan maken.

  • Een Agentklant integreren met een applicatie van derden:
    In dit geval kunt u de agentapplicatie niet insluiten in een andere app. Andere app zijn vaak CRM's, sites voor online bankieren of hotelboekingsystemen. Deze use case is wanneer u de functionaliteit van een agentklant wilt, maar niet noodzakelijkerwijze de klant-UI nodig heeft. Met de SDK kunt u een stuk functionaliteit in een andere applicatie inbouwen. Met het hotelsysteem als voorbeeld, kan het personeel een specifieke kamer bellen via het boekingssysteem.

  • Gebeurtenissenabonnemer voor ingesloten applicaties:
    Dit wordt doorgaans gebruik om te voldoen aan bepaalde beveiligingsbeperkingen van de browser. Google verhindert bijvoorbeeld het publiceren van data in een iframed venster vanaf een andere website. Dit compliceert de manier waarop vensters berichten of gegevens kunnen delen tussen de twee frames. Als u bijvoorbeeld een gezondheidszorg app hebt die u in een iframe in CXone Agent wilt plaatsen. Wanneer de agent een contact accepteert, wilt u mogelijk het telefoonnummer van het contact gebruiken om hun informatie op te zoeken in de app van uw gezondheidszorg. Hiermee kunt u automatisch contactgegevens weergeven voor de agent. Als de agents Google Chrome gebruiken, kan de gezondheidszorg app het telefoonnummer van het contact niet verkrijgen van CXone Agent. In plaats daarvan moet worden geabonneerd op de VC-gebeurtenissenstroom, wat hetzelfde is als dat wat CXone Agent gebruikt.

SDK-opsplitsing

De CXA SDK bestaat uit de volgende kleinere SDK's:

SDK Details
ACD

Deze SDK biedt functies voor het afhandelen van spraakoproepen, voicemails en werkitemsGesloten Aanpasbare methode voor het aanleveren van contacten bij agents via Studio-scripts.. Bijvoorbeeld:

  • Voor spraakoproepen kunt u de oproepen initiëren, ontvangen, doorschakelen en in conferentie gebruiken.

  • Voor voicemail kunt u voicemails ontvangen, opslaan en beheren.

  • Voor werkitems kunt u de distributie van werkitems bij agents automatiseren. Dit optimaliseert de agentworkload met vooraf gedefinieerde regels en criteria.

Hieronder vindt u belangrijke technische details over de ACD SDK:

  • Na de gelukte authenticatie, kunt u initAcdEngagement() bellen om deze module te instantiëren en ACD functies bouwen.

  • U kunt een sessie tot stand brengen tussen een agent en contact met de methoden startSession en joinSession.

  • Nadat de sessie tot stand is gebracht, kan uw app andere methoden oproepen voor functies zoals kiezen, overdragen, conferenties voeren enz.

  • Het oproepen van de methoden van deze module, produceert ACD gebeurtenissen.
Agent

Deze SDK is voor het afhandelen van sessiegebeurtenissen. Hiermee kunt sessies starten, deelnemen aan een lopende sessie enz. De hoofdfocussen zijn:

  • De lus get-next-event

  • Alles wat gemeenschappelijk is voor de gebieden ACD en Digital Experience van de CXone platform, zoals WEM of meldingen.
Auth

Deze SDK vergemakkelijkt beveiligde authenticatie en autorisatie. Hiermee kunt u in de eerste plaats een aanmeldingsstroom instellen met de CXone globale authenticatie . De ondersteunde authenticatiestroom is OpenID Connect met PKCE. Gebruikers moeten authenticeren met een CXone-account. Hiermee kunt u gebruikersidentiteiten en hun machtigingen controleren op basis van hun CXone rolGesloten Zoekt naar signalen van frustratie bij de klant. Dit kunnen woorden of woordgroepen zoals "ik ben boos" zijn. Frustratie is niet synoniem met negatief sentiment. Gefrustreerde klanten hebben niet alleen iets negatiefs te bespreken, ze maken zich ergens druk over..

Enkele belangrijke functies zijn:

  • Automatisch vernieuwen van auth tokens. Hiermee kan de gebruiker ingelogd blijven tot de app wordt gesloten of tot wordt uitgelogd.

  • Beheer en validatie tokens Als een gebruiker al is aangemeld bij CXone, kunt u de geldig auth-token doorgeven naar uw app.

Hieronder vindt u belangrijke technische details over de Auth SDK:

  • Bel cxoneAuth.init() om cxoneHostname, clientId en redirectUri door te geven aan de SDK.

  • Roep de getAuthorizeUrl()-methode aan om de gebruiker om te leiden naar de globale CXone authenticatiepagina. Na het inloggen worden ze terug omgeleid naar uw app.

  • Wanneer de gebruiker de referenties invoert en de authenticatie start, wordt een AuthSettings-object gemaakt met hun gebruikersinformatie. De CXoneAuth-instantie wordt geïnitialiseerd met AuthSettings.

  • Gebruik getAccessTokebByCode() om de geretourneerde code vast te leggen en een authenticatietoken te genereren. Dit slaat ook de gebruikersinformatie op.

  • Abonneer op onAuthStatusChange die gebeurtenissen produceert over de verificatie zoals AUTHENTICATED of AUTHENTICATEDFAILED. In het geval van AUTHENTICATED wordt de de vernieuwingsstroom automatisch geactiveerd zodat de gebruiker ingelogd blijft.
Digitaal

Met deze SDK kunt u digitale communicatiekanalen integreren. U kunt standaard digitale kanalen gebruiken, zoals e-mail, chat en sms, plus sociale mediaplatforms zoals WhatsApp. Afhankelijk van het aantal kanalen dat u hebt ingesteld, kunt u meerkanaals communicatie maken.

Hieronder vindt u belangrijke technische details over de digitale SDK:

  • Na de gelukte authenticatie, kunt u CXoneDigitalClient.instance.initDigitalEngagement() bellen. Dit start de nodige componenten voor statistieken van digitale agentberichten en brengt een digitale WebSocket-verbinding tot stand.

  • Gebruik digitale gebeurtenissen om reeds toegewezen casussen en hun bestaande berichtenthreads te ontvangen.

  • Uw app kan digitale berichten beantwoorden met de reply()-methode.

  • U kunt ook een nieuwe outbound interactie starten met de reply()-methode.
Spraak Deze SDK biedt u de Integrated Softphone-functionaliteit. Dit is een wrapper voor WebRTC.

Materiaal

Met een SDK kunt u uw eigen aangepaste functionaliteit maken. Daarom zijn uw ondersteuningsbronnen voornamelijk selfservice-inhoud. Uw technische ondersteuningsopties zijn gebaseerd op de ondersteuningsovereenkomst van de organisatie met NICE. Neem voor meer informatie over uw ondersteuningsopties, contact op met uw CXone-accountmanager.

Naast deze pagina, richt uw selfservice inhoud zich op ontwikkelaarsmateriaal. Het SDK-pakket bevat de volgende informatie:

  • README's voor elke individuele SDK die informatie biedt om aan de slag te gaan.

  • Een voorbeeld applicatie om de basisfunctionaliteit onder de aandacht te brengen.

  • Gebruiksvoorbeelden met code-uittreksels van het voorbeeld applicatie.

  • Code-opmerkingen

Gebeurtenissen

Het volgende zijn gebeurtenissen waarnaar uw app kan luisteren. De gebeurtenissen worden in categorieën opgesplitst volgens de module waarin ze beschikbaar zijn.

ACD-SDK

Exemplaar Event Beschrijving

CXoneAcdClient.instance.contactManager

conferenceCallEvent

Luistert naar gebeurtenissen die betrekking hebben op conferentiegesprekken.

 

onDispositionEvent

Handelt gebeurtenissen af die betrekking hebben op dispositiesGesloten Resultaat dat wordt toegewezen door de agent of het systeem aan het einde van een spraakinteractie (dispositie) of digitale (status)interactie. van interacties.

 

onTagsEvent

Beheert gebeurtenissen die betrekking hebben op tags die gekoppeld zijn met interacties.

 

voiceContactUpdateEvent

Luistert naar updates voor spraakcontacten.

 

voiceMailContactUpdateEvent

Luistert naar updates voor voicemailcontacten.

 

workItemContactUpdateEvent

Luistert naar updates voor werkitemcontacten.

CXoneAcdClient.instance.notification

onUpdateMessageEvent

Luistert naar nieuwe berichten of meldingen voor de agent.

CXoneAcdClient.instance.screenPop

agentAssistSubject

Handelt gebeurtenissen af die betrekking hebben op agentassistentie- of copilot-applicaties.

 

contactScreenPopSubject

Handelt gebeurtenissen af die betrekking hebben op schermen die verschijnen voor binnenkomende contacten.

 

pageOpenSubject

Handelt gebeurtenissen af die betrekking hebben op het openen van webpagina's.

 

popUrlSubject

Handelt gebeurtenissen af die betrekking hebben tot het verschijnen van URL's in een nieuw venster of tabblad.

 

runAppSubject

Handelt gebeurtenissen af die betrekking hebben op het uitvoeren van applicaties of het openen van aangepaste formulieren.

CXoneAcdClient.instance.session

agentLegEvent

Luistert naar gebeurtenissen die betrekking hebben op de linkGesloten Het deel van een interactie die plaatsvindt tussen CXone en de agent. van de agent in de sessie.

 

agentStateSubject

Fenomeen dat gebeurtenissen uitzendt die betrekking hebben op wijzigingen in de status van de agent, zoals Beschikbaar of Niet beschikbaar.

 

naturalCallingSkillListSubject

Luistert naar updates van de lijst van skills die zijn ingeschakeld voor natuurlijk bellen.

De gebeurtenistypes omvatten: SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS en JOIN_SESSION_FAILURE.

 

networkOfflineSubject

Luistert naar gebeurtenissen die betrekking hebben op problemen met de netwerkverbinding.

 

onAgentSessionChange

Luistert naar wijzigingen in de status van de agentsessie, zoals start of einde.

De gebeurtenistypes omvatten: SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS en JOIN_SESSION_FAILURE.

CXoneAcdClient.instance.session.agentStateService

agentStateSubject

Fenomeen dat updates uitzendt die betrekking hebben op wijzigingen in de status van de agent.

Agent SDK

Exemplaar Event Beschrijving

CXoneClient.instance

autoSummaryService

Service voor het beheren van automatische overzichten.

 

copilotNotificationClient

Vergemakkelijkt het ontvangen van meldingen in realtime voor Agent Copilot.

 

cxoneApiPerformanceMetrics

Luistert naar metrics over de prestaties vanaf de CXone API.

CXoneClient.instance.agentSession

agentSessionEndSubject

Zendt een gebeurtenis uit wanneer de huidige sessie van de agent eindigt.

CXoneClient.instance.agentSetting

mchAgentSettingsChangeEvent

Luistert naar wijzigingen in de MCH-instellingen (Make Call Heard) van de agent.

CXoneClient.instance.autoSummaryService

onAutoSummaryReceived

Waarneembare gebeurtenis die wordt geactiveerd wanneer een automatisch gegenereerde samenvatting wordt ontvangen voor een contact.

CXoneClient.instance.commitment

onCommitmentEvent

Luistert naar gebeurtenissen die betrekking hebben op de toezeggingen van de agent.

 

onCommitmentStatusEvent

Luistert naar wijzigingen in de status van de toezeggingen van de agent.

 

onUpdateCommitments

Luistert naar updates aan de toezeggingen van de agent.

CXoneClient.instance.contactManager

onDigitalContactEvent

Biedt updates over digitale contactinteracties zoals chatsessies en outbound berichten in CXone.

 

onDispositionEvent

Biedt updates over de dispositiestatus van de oproep nadat de oproep is beëindigd.

 

voiceContactUpdateEvent

Biedt realtime updates van details van lopende spraakoproepen zoals de naam van de beller en het telefoonnummer.

CXoneClient.instance.copilotNotificationClient

onMessageNotification

Zender fenomeen/gebeurtenis, gebruikt voor het abonneren op binnenkomende copilot-berichten of meldingen.

De gebeurtenistypes omvatten: 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 en AGENT_COPILOT.

CXoneClient.instance.directory

directoryEvent

Luistert naar gebeurtenissen die betrekking hebben op de directory, zoals agents, teams of skills.

Biedt updates over wijzigingen aan de mapgegevens, zoals nieuwe contacten, updates en machtigingswijzigingen in CXone.

 

onUpdateSkillsEvent

Luistert naar updates aan de toegewezen skills van de agent.

CXoneClient.instance.directory.dynamicDirectory

searchDirectoryResult

Wacht tot resultaten worden geretourneerd nadat u iets hebt opgezocht, zoals een persoon of afdeling in een directory binnen het systeem.

CXoneClient.instance.indicator

agentIndicatorsEvent

Gebeurtenis die updates geeft over agentindicators, zoals de statusindicators van beschikbaarheid, huidige activiteit en aangepaste agentstatus.

 

contactIndicatorsEvent

Gebeurtenis die updates geeft over contactindicators die acties kunnen triggeren, zoals het weergeven van aangepaste formulieren om extra informatie te verzamelen.

CXoneClient.instance.notification

onCXoneNotificationEvent

Luistert naar meldingen van de CXone platform.

CXoneClient.instance.screenPop

contactScreenPopSubject

Gebeurtenis die het openen van een webpagina triggert met bellerinformatie voor een bestaande oproep.

 

pageOpenSubject

Gebeurtenis die het openen van een webpagina triggert die niet noodzakelijkerwijze verwant is met de huidige oproep.

 

popUrlSubject

Gebeurtenis die het openen van de relevante webpagina voor bestaande oproep triggert.

 

runAppSubject

Gebeurtenis die de start van een app of de weergave van een aangepast formulier voor een oproep triggert.

CXoneClient.instance.session

agentLegEvent

Luistert naar updates over een specifieke oproeplink van de agent, zoals een inkomende of uitgaande oproep.

CXoneClient.instance.session.agentStateService

agentStateSubject

Gebeurtenis die live updates biedt over de beschikbaarheidsstatus en de statuswijzigingen van de agent in CXone.

CXoneClient.instance.skillActivityQueue

agentQueueSubject

Gebeurtenis die updates biedt over de toegewezen wachtrijgegevens van de agent, zoals wachtrijnaam, aantal oproepen en beschikbaarheid agent.

 

agentQueuesDetailSubject

Gebeurtenis die gedetailleerde updates biedt over de toegewezen wachtrijen de agent, zoals de gemiddelde wachttijd, SLA's (Service level agreements) en agentprestaties.

 

skillActivityEvent

Gebeurtenis die updates biedt van metrics van de skillactiviteit, zoals lengte wachtrij, gemiddelde wachttijd en beschikbare agents.

Auth SDK

Exemplaar Event Beschrijving

CXoneAuth.instance

onAuthStatusChange

Fenomeen dat luistert naar de statuswijzigingen van de gebruikersauthenticatie.

De gebeurtenistypes omvatten: AUTHENTICATED,AUTHENTICATING, NOT_AUTHENTICATED, AUTHENTICATION_FAILED en REFRESH_TOKEN_SUCCESS

Digitale SDK

Exemplaar Event Beschrijving

CXoneDigitalClient.instance.digitalContactManager

onDigitalContactEvent

Luistert naar gebeurtenissen die betrekking hebben op digitale contacten.

De gebeurtenistypes omvatten: 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 en MESSAGE_PREVIEW.

 

onDigitalContactNewMessageEvent

Luistert naar nieuwe berichten van digitale contacten.

 

onDigitalContactUserTypingPreviewEvent

Luistert naar gebeurtenissen voor typerende voorbeeldgebeurtenissen van digitale contacten.

De gebeurtenistypes omvatten: 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 en MESSAGE_PREVIEW.

Spraak SDK

Exemplaar Event Beschrijving

CXoneVoiceClientWrapper.instance

onCallStatusChanged

Handelt gebeurtenissen af die betrekking hebben op wijzigingen aan de oproepstatus.

 

onConnectionStatusChanged

Handelt gebeurtenissen af die betrekking hebben op wijzigingen aan de status van de spraakverbinding.