SDK CXone Agent

Langage SDK : Typescript

Version actuelle : 243

Date de publication de la version actuelle : 15 octobre 2024

Disponibilité : Toutes les régions et tous les secteurs d’activité

Navigateurs pris en charge : SECRET Chrome Microsoft Edge, Island Enterprise

Référentiel SDK : GitHub

NPM : ACD , Agent , Auth , Numérique , Voix

Une trousse de développement logiciel (SDK) est une sorte de boîte à outils pour les développeurs. Elle fournit un ensemble d’outils et de ressources qui facilitent la création d’applications logicielles. Vous pouvez la considérer comme une collection de blocs de construction préfabriqués. Ces blocs de construction ont des fonctionnalités existantes. Vos développeurs peuvent utiliser ces blocs existants au lieu de construire eux-mêmes la fonctionnalité en partant de rien. Les trois avantages généraux de l’utilisation d’une trousse SDK sont les suivants :

  1. Efficacité : Le SDK fournit des outils prêts à l’emploi et des composants préconstruits qui permettent aux développeurs de gagner du temps. Au lieu de réinventer la roue, ils peuvent se concentrer sur les aspects uniques de leur application.

  2. Cohérence : Le SDK assure la cohérence entre les différentes applications. En utilisant le même ensemble d’outils et de bibliothèques, les développeurs offrent une expérience uniforme aux utilisateurs.

  3. Assurance qualité : Grâce à l’enregistreur chronologique, les développeurs peuvent vérifier leur code, détecter rapidement les bogues et délivrer des logiciels plus fiables.

En résumé, un SDK simplifie le développement, garantit la qualité et favorise la collaboration, ce qui en fait un outil essentiel pour la création efficace d’applications.

La trousse SDK CXone Agent vous permet de créer une application d’agent. Elle vous permet également d’intégrer la fonctionnalité CXone Agent dans une application existante. Au lieu d’utiliser directement les API CXone, les développeurs peuvent utiliser les fonctionnalités prédéfinies via la trousse SDK. Cela permet d’accélérer le temps de développement et d’économiser des ressources. Vos développeurs ne sont pas tenus de comprendre le fonctionnement de toutes les API de CXone. Au lieu de cela, la trousse SDK vous permet d’utiliser des groupes d’API dans des conteneurs JavaScript consommables.

La trousse SDK CXA est une compilation de trousses SDK plus petites. Chaque trousse SDK plus petite se concentre sur un aspect particulier de la fonctionnalité, comme l’authentification ou les commandes d’appel. Pour répondre à votre cas d’utilisation, vous pouvez choisir uniquement les trousses SDK dont vous avez besoin. Par exemple, vous n’aurez peut-être pas besoin de la trousse SDK pour la voix, qui fournit la fonctionnalité WebRTC pour un Téléphone logiciel intégré. Cela signifie également que les développeurs n’ont qu’à installer les trousses SDK nécessaires pour votre cas d’utilisation.

Faits saillants sur la trousse SDK CXA :

  • La trousse SDK fonctionne par le biais d’abonnements à des événements. Les données de la plateforme CXone sont publiées avec un événement. Pour utiliser les données, votre application doit s’abonner à ces événements.

  • Toutes les fonctionnalités de CXone Agent sont disponibles via cette trousse SDK.

  • Vous devez enregistrer l’application avec laquelle vous utiliserez la trousse SDK. Complétez le formulaire d’enregistrement pour recevoir les informations d’identification pour cette application. La page Démarrage du portail des développeurs vous guide dans le processus d’enregistrement de votre application et de configuration de l’authentification.

  • La trousse SDK prend en charge OpenID Connect avec le flux d’authentification PKCE.

Cas d’utilisation de la trousse SDK CXA

Vous trouverez ci-dessous trois cas d’utilisation courants de la trousse SDK CXA.

  • Client d’agent personnalisé :
    Dans ce cas, vous avez une fonctionnalité ou un besoin unique que CXone Agent n’offre pas encore. Par ailleurs, il se peut que vous ne puissiez pas simplement intégrer la fonctionnalité dont vous avez besoin dans CXone Agent. Par exemple, vous pouvez avoir besoin de limiter la visibilité des agents sur les informations des contacts. Il peut s’agir d’une exigence de sécurité particulière. Vous pouvez avoir besoin de masquer toutes les données des contacts des agents, ce que seul un client personnalisé peut faciliter.

  • Intégrer un client d’agent à une application tierce :
    Dans ce cas, vous ne pouvez pas intégrer l’l’application d’agent dans une autre application. Les autres application sont souvent des CRM, des sites bancaires en ligne ou des systèmes de réservation d’hôtels. Ce cas d’utilisation se présente lorsque vous souhaitez bénéficier des fonctionnalités d’un client d’agent, mais que vous n’avez pas nécessairement besoin de l’interface utilisateur du client. Grâce à la trousse SDK, vous pouvez intégrer un élément de fonctionnalité dans une autre application. Si l’on prend l’exemple du système hôtelier, le personnel peut appeler une chambre spécifique par l’intermédiaire du système de réservation.

  • Abonnement aux événements pour les applications intégrées :
    Cette option est généralement utilisée pour se conformer à certaines restrictions de sécurité des navigateurs. Par exemple, SECRET empêche l’affichage de données dans une fenêtre iframed d’un autre site Web. Cela complique la façon dont les fenêtres peuvent partager des messages ou des données entre les deux cadres. Par exemple, vous disposez d’une application de soins de santé que vous insérez dans un iframe dans CXone Agent. Lorsque l’agent accepte un contact, vous voulez utiliser le numéro de téléphone du contact pour rechercher ses informations dans votre application de soins de santé. Cela vous permet d’afficher automatiquement les informations du contact pour l’agent. Si les agents utilisent SECRET Chrome, l’application de soins de santé ne peut pas obtenir le numéro de téléphone du contact à partir de CXone Agent. Au lieu de cela, il doit s’abonner au flux d’événements VC, qui est le même que celui utilisé par CXone Agent.

Ventilation de la trousse SDK

La trousse SDK CXA est composée des trousses SDK plus petites suivantes :

SDK Détails
ACD

Cette trousse SDK offre des fonctionnalités permettant de gérer les appels vocaux, les messages vocaux et les éléments de travailFermé Une méthode personnalisable de répartition des contacts vers un agent via des scripts Studio.. Par exemple :

  • Pour les appels vocaux, vous pouvez initier, recevoir, transférer et mettre en conférence les appels.

  • Pour la messagerie vocale, vous pouvez recevoir, stocker et gérer les messages vocaux.

  • Pour les éléments de travail, vous pouvez automatiser la distribution des éléments de travail aux agents. Cela permet d’optimiser la charge de travail des agents à l’aide de règles et de critères prédéfinis.

Vous trouverez ci-dessous les principaux détails techniques concernant la trousse SDK ACD :

  • Après avoir réussi à vous authentifier, vous pouvez appeler initAcdEngagement() pour instancier ce module et créer les fonctionnalités ACD.

  • Vous pouvez établir une session entre un agent et un contact à l’aide des méthodes startSession et joinSession.

  • Une fois la session établie, votre application peut appeler d’autres méthodes pour des fonctionnalités telles que la composition, le transfert, la conférence, etc.

  • L’appel réussi des méthodes de ce module produit des événements ACD.
Agent

Cette trousse SDK permet de gérer les événements de session. Elle vous permet de démarrer des sessions, de rejoindre une session en cours, etc. Ses principaux domaines de focalisation sont les suivants :

  • La boucle get-next-event

  • Tout ce que les zones ACD et Digital Experience de la plateforme CXone ont en commun, comme WEM ou les notifications.
Auth

Cette trousse SDK facilite l’authentification et l’autorisation sécurisées. Elle vous permet principalement de configurer un flux de connexion à l’aide de l’authentification globale CXone. Le flux d’authentification pris en charge est OpenID Connect avec PKCE. Les utilisateurs doivent s’authentifier avec un compte CXone. Cela vous permet de vérifier l’identité des utilisateurs et leurs autorisations sur la base de leur rôleFermé Recherche les indices permettant d’identifier la frustration du client. Ces indices comprennent des mots et des phrases comme « Je suis très en colère ». La frustration n’est pas synonyme de sentiment négatif. Les indices de frustration montrent qu’un client est contrarié plutôt que de simplement parler de quelque chose de négatif. CXone.

Les principales fonctionnalités sont les suivantes :

  • Actualisation automatique des jetons auth. Cela permet aux utilisateurs de rester connectés jusqu’à ce qu’ils ferment l’application ou se déconnectent.

  • Gestion et validation des jetons. Si un utilisateur s’est déjà connecté à CXone, vous pouvez transmettre le jeton auth valide à votre application.

Vous trouverez ci-dessous les principaux détails techniques concernant la trousse SDK Auth :

  • Appelez cxoneAuth.init() pour transmettre cxoneHostname, clientId et redirectUri à la trousse SDK.

  • Invoquez la méthode getAuthorizeUrl() pour rediriger l’utilisateur vers la page d’authentification CXone globale. Après s’être connecté, il est redirigé vers votre application.

  • Lorsque l’utilisateur entre ses informations d’identification et lance l’authentification, un objet AuthSettings est créé avec ses informations d’utilisateur. L’instance CXoneAuth est initialisée à l’aide de AuthSettings.

  • Utilisez getAccessTokebByCode() pour capturer le code renvoyé et générer un jeton d’authentification. Cela permet également d’enregistrer les informations relatives à l’utilisateur.

  • Abonnez-vous à onAuthStatusChange, qui produit des événements sur l’authentification comme AUTHENTICATED ou AUTHENTICATEDFAILED. Dans le cas de AUTHENTICATED, cela déclenche automatiquement le flux d’actualisation, ce qui permet à l’utilisateur de rester connecté.
Numérique

Cette trousse SDK vous permet d’intégrer des canaux de communication numériques. Vous pouvez utiliser les canaux numériques standard tels que le courriel, le clavardage et les SMS, ainsi que les plateformes de médias sociaux telles que WhatsApp. En fonction du nombre de canaux que vous avez configurés, vous pouvez créer une communication multicanal.

Vous trouverez ci-dessous les principaux détails techniques concernant la trousse SDK numérique :

  • Après avoir réussi à vous authentifier, vous pouvez appeler CXoneDigitalClient.instance.initDigitalEngagement(). Il instancie les composants nécessaires à la messagerie numérique et établit une connexion numérique WebSocket.

  • Utilisez les événements numériques pour recevoir les cas déjà attribués et leurs fils de messages existants.

  • Votre application peut répondre aux messages numériques avec la méthode reply().

  • Vous pouvez également lancer une nouvelle interaction sortante avec la méthode reply().
Voix Cette trousse SDK vous offre la fonctionnalité Téléphone logiciel intégré. Il s’agit d’un conteneur pour WebRTC.

Ressources

Une trousse SDK vous permet de créer vos propres fonctionnalités personnalisées, ce qui fait que vos ressources de soutien sont principalement du contenu en libre-service. Vos options de soutien technique sont basées sur l’accord de soutien de votre organisation avec NICE. Contactez votre Représentant de compte CXone pour plus d’informations sur vos options de soutien.

En plus de cette page, votre contenu en libre-service se concentre sur les ressources pour les développeurs. La trousse SDK comprend les éléments suivants :

  • Un fichier LISEZMOI pour chaque trousse SDK individuelle qui fournit des informations de démarrage.

  • Un exemple d’application pour présenter les fonctionnalités de base.

  • Des exemples d’utilisation avec des extraits de code de l’exemple application.

  • Des commentaires sur le code.

Événements

Les événements suivants peuvent être écoutés par votre application. Les événements sont classés en fonction du module dans lequel ils sont disponibles.

SDK ACD

Instance Événement Description

CXoneAcdClient.instance.contactManager

conferenceCallEvent

Écoute des événements liés aux conférences téléphoniques.

 

onDispositionEvent

Traite les événements liés aux dispositionsFermé Résultat attribué par l’agent ou le système à la fin d’une interaction vocale (disposition) ou numérique (état). des interactions.

 

onTagsEvent

Gère les événements liés aux balises associées aux interactions.

 

voiceContactUpdateEvent

Écoute des mises à jour des contacts vocaux.

 

voiceMailContactUpdateEvent

Écoute des mises à jour des contacts de la messagerie vocale.

 

workItemContactUpdateEvent

Écoute les mises à jour des contacts des éléments de travail.

CXoneAcdClient.instance.notification

onUpdateMessageEvent

Écoute de nouveaux messages ou notifications de l’agent.

CXoneAcdClient.instance.screenPop

agentAssistSubject

Traite les événements liés aux applications d’aide aux agents ou Copilot.

 

contactScreenPopSubject

Gère les événements liés aux fenêtres contextuelles à l’écran pour les contacts entrants.

 

pageOpenSubject

Gère les événements liés à l’ouverture des pages Web.

 

popUrlSubject

Gère les événements liés à l’ouverture d’URL dans une nouvelle fenêtre ou un nouvel onglet.

 

runAppSubject

Gère les événements liés à l’exécution d’applications ou à l’ouverture de formulaires personnalisés.

CXoneAcdClient.instance.session

agentLegEvent

Écoute les événements liés au segmentFermé La partie d’une interaction qui a lieu entre CXone et l’agent. de l’agent dans la session.

 

agentStateSubject

Événement observable qui émet des événements liés aux changements d’état de l’agent, comme de Disponible à Indisponible.

 

naturalCallingSkillListSubject

Écoute des mises à jour de la liste des compétences activées pour les appels naturels.

Les types d’événements sont les suivants : SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS et JOIN_SESSION_FAILURE.

 

networkOfflineSubject

Écoute des événements liés aux problèmes de connectivité du réseau.

 

onAgentSessionChange

Écoute des changements d’état de la session de l’agent, comme le démarrage ou la fin.

Les types d’événements sont les suivants : SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS et JOIN_SESSION_FAILURE.

CXoneAcdClient.instance.session.agentStateService

agentStateSubject

Événement observable qui émet des mises à jour sur les changements d’état de l’agent.

Trousse SDK de l’agent

Instance Événement Description

CXoneClient.instance

autoSummaryService

Service de gestion des résumés automatiques.

 

copilotNotificationClient

Facilite la réception de notifications en temps réel pour Agent Copilot.

 

cxoneApiPerformanceMetrics

Écoute des métriques de performance provenant de l’API CXone.

CXoneClient.instance.agentSession

agentSessionEndSubject

Émet un événement lorsque la session actuelle de l’agent se termine.

CXoneClient.instance.agentSetting

mchAgentSettingsChangeEvent

Écoute des changements dans les paramètres MCH (Make Call Heard) de l’agent.

CXoneClient.instance.autoSummaryService

onAutoSummaryReceived

Événement observable déclenché par la réception d’un résumé généré automatiquement pour un contact.

CXoneClient.instance.commitment

onCommitmentEvent

Écoute des événements liés aux engagements de l’agent.

 

onCommitmentStatusEvent

Écoute des changements d’état des engagements de l’agent.

 

onUpdateCommitments

Écoute des mises à jour des engagements de l’agent.

CXoneClient.instance.contactManager

onDigitalContactEvent

Fournit des mises à jour sur les interactions de contact numériques telles que les sessions de clavardage et les messages sortants dans CXone.

 

onDispositionEvent

Fournit des mises à jour sur l’état de la disposition de l’appel après la fin de l’appel.

 

voiceContactUpdateEvent

Fournit des mises à jour en temps réel sur les détails d’un appel vocal en cours, comme le nom et le numéro de téléphone de l’appelant.

CXoneClient.instance.copilotNotificationClient

onMessageNotification

Événement observable/émetteur utilisé pour s’abonner aux messages ou notifications entrants de Copilot.

Les types d’événements sont les suivants : 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 et AGENT_COPILOT.

CXoneClient.instance.directory

directoryEvent

Écoute des événements liés à l’annuaire, tels que les agents, les équipes ou les compétences.

Fournit des mises à jour sur les changements apportés aux données de l’annuaire, comme les nouveaux contacts, les mises à jour et les modifications d’autorisation dans CXone.

 

onUpdateSkillsEvent

Écoute des mises à jour des compétences attribuées à l’agent.

CXoneClient.instance.directory.dynamicDirectory

searchDirectoryResult

Attend que les résultats reviennent après que vous avez recherché quelque chose comme une personne ou un service dans un annuaire du système.

CXoneClient.instance.indicator

agentIndicatorsEvent

Événement fournissant des mises à jour sur les indicateurs des agents, tels que la disponibilité, l’activité actuelle et les indicateurs d’état personnalisés des agents.

 

contactIndicatorsEvent

Événement fournissant des mises à jour sur les indicateurs des contacts qui peuvent déclencher des actions telles que l’affichage de formulaires personnalisés pour collecter des informations supplémentaires.

CXoneClient.instance.notification

onCXoneNotificationEvent

Écoute des notifications provenant de la plateforme CXone.

CXoneClient.instance.screenPop

contactScreenPopSubject

Événement déclenchant l’ouverture d’une page Web contenant des informations sur l’appelant pour un appel existant.

 

pageOpenSubject

Événement déclenchant l’ouverture d’une page Web qui n’est pas nécessairement liée à l’appel en cours.

 

popUrlSubject

Événement déclenchant l’ouverture d’une page Web pertinente pour un appel existant.

 

runAppSubject

Événement déclenchant le lancement d’une application ou l’affichage d’un formulaire personnalisé pour un appel.

CXoneClient.instance.session

agentLegEvent

Écoute des mises à jour d’un segment d’appel spécifique de l’agent, comme un appel entrant ou sortant.

CXoneClient.instance.session.agentStateService

agentStateSubject

Événement fournissant des mises à jour en direct sur l’état de disponibilité de l’agent et les changements d’état dans CXone.

CXoneClient.instance.skillActivityQueueue

agentQueueSubject

Événement fournissant des mises à jour sur les informations relatives à la file d’attente assignée à l’agent, telles que le nom de la file d’attente, le nombre d’appels et la disponibilité de l’agent.

 

agentQueuesuesDetailSubject

Événement fournissant des mises à jour détaillées sur les files d’attente assignées à l’agent, y compris des métriques telles que le temps d’attente moyen, les accords de niveau de service (SLA) et la performance de l’agent.

 

skillActivityEvent

Événement fournissant des mises à jour sur les métriques d’activité des compétences comme la longueur de la file d’attente, le temps d’attente moyen et les agents disponibles.

SDK Auth

Instance Événement Description

CXoneAuth.instance

onAuthStatusChange

Événement observable qui écoute des changements d’état de l’authentification de l’utilisateur.

Les types d’événements sont les suivants : AUTHENTICATED, AUTHENTICATING, NOT_AUTHENTICATED, AUTHENTICATION_FAILED et REFRESH_TOKEN_SUCCESS

SDK numérique

Instance Événement Description

CXoneDigitalClient.instance.digitalContactManager

onDigitalContactEvent

Écoute des événements liés aux contacts numériques.

Les types d’événements sont les suivants : 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 et MESSAGE_PREVIEW.

 

onDigitalContactNewMessageEvent

Écoute des nouveaux messages provenant des contacts numériques.

 

onDigitalContactUserTypingPreviewEvent

Écoute des événements d’aperçu de la frappe des contacts numériques.

Les types d’événements sont les suivants : 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 et MESSAGE_PREVIEW.

SDK vocal

Instance Événement Description

CXoneVoiceClientWrapper.instance

onCallStatusChanged

Gère les événements liés aux changements d’état d’appel.

 

onConnectionStatusChanged

Gère les événements liés aux changements d’état de connexion vocale.