SDK CXone Agent

Langage du SDK : Typescript

Version actuelle : 24.3

Date de parution de la version actuelle : 15 octobre 2024

Disponibilité : toutes les régions et tous les segments métier

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

Référentiel du SDK : GitHub

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

Un kit de développement logiciel (SDK) est comparable à une boîte à outils pour les développeurs. Il réunit les outils et les ressources qui facilitent la création d’applications. Cela est comparable à un ensemble de briques préconçues. Ces briques disposent de leur propre fonctionnalité. Vos développeurs peuvent utiliser ces blocs prédéfinis pour ne pas avoir à recréer la fonctionnalité de A à Z. Les trois avantages généraux de l'utilisation d'un SDK sont les suivants :

  1. Efficacité : le SDK apporte des outils et des composants prédéfinis qui réduisent le temps nécessaire au développement. Au lieu de réinventer la roue, les développeurs peuvent se concentrer sur les aspects essentiels 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 créent une expérience uniforme pour les utilisateurs.

  3. Assurance qualité : le fichier journal permet aux développeurs de vérifier leur code, d’identifier les bugs facilement et de produire des logiciels plus fiables.

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

Le SDK CXone Agent permet de créer une application d’agent. Il permet également d’intégrer la fonctionnalité CXone Agent dans une application existante. Au lieu d’utiliser les API CXone directement, les développeurs peuvent utiliser la fonctionnalité prédéfinie par l’intermédiaire du SDK. Cela accélère le développement et réduit les ressources. Vos développeurs ne doivent pas nécessairement connaître tout le détail du fonctionnement des API CXone. En effet, le SDK permet d’utiliser des groupes d’API dans des wrappers JavaScript consommables.

Le SDK CXA est une compilation de plusieurs SDK spécialisés. Chaque SDK spécialisé permet de se concentrer sur un aspect donné de la fonctionnalité, comme l’authentification ou les contrôles d’appel. Pour satisfaire votre cas d’utilisation, vous pouvez utiliser uniquement les SDK dont vous avez besoin. Par exemple, vous pouvez ne pas avoir besoin du SDK vocal, qui fournit la fonctionnalité WebRTC pour un Softphone intégré. Cela signifie également que les développeurs doivent seulement installer les SDK requis pour votre cas d’utilisation.

Points à retenir sur le SDK CXA :

  • Le SDK parcourt les abonnements aux événements. Les données de la plateforme CXone sont publiées avec un événement. Pour utiliser ces données, votre application doit s’abonner à ces événements.

  • Toutes les fonctionnalités de CXone Agent sont disponibles à travers ce SDK.

  • Vous devez enregistrer l’application avec laquelle vous allez utiliser le SDK. Complétez le formulaire d’enregistrement pour recevoir des informations d’authentification pour cette application. La page de prise en main du portail des développeurs détaille les étapes d’enregistrement de votre application et de configuration de l’authentification.

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

Cas d’utilisation du SDK CXA

Vous trouverez ci-dessous trois cas d’utilisation communs du SDK CXA.

  • Client d’agent personnalisé :
    Dans ce cas, vous avez une fonctionnalité ou un critère unique que CXone Agent ne fournit pas déjà. Également, il est possible que vous ne puissiez pas intégrer la fonctionnalité requise dans CXone Agent. Par exemple, il peut être nécessaire de limiter la visibilité des agents aux informations de contact. Cela peut être dû à des critères de sécurité spécifiques. Il peut être nécessaire de masquer toutes les données de contact pour qu’elles ne soient pas visibles par les agents, ce que seul un client personnalisé peut faire.

  • Intégrer un client d’agent avec une application tierce :
    Dans ce cas, vous ne pouvez pas intégrer l’l’application d’agent dans une autre application. Les autres applications sont souvent des CRM, des sites bancaires en ligne ou un système de réservation d’hôtel en ligne. Ce cas d'utilisation intervient lorsque vous recherchez la fonctionnalité d’un client d’agent, mais n’avez pas forcément besoin de l’interface utilisateur du client. En utilisant le SDK, vous pouvez créer une fonctionnalité dans une autre application. En prenant comme exemple le système de réservation d’hôtel, le personnel peut appeler une chambre spécifique depuis le système de réservation.

  • Abonnement à un événement pour une application intégrée :
    Cela est fréquemment utilisé pour se conformer à certaines restrictions de sécurité du navigateur. Par exemple, Google bloque la publication de données dans une fenêtre créée avec iframe, depuis un autre site Web. Cela complique le partage de messages ou de données entre deux cadres de différentes fenêtres. Par exemple, si vous avez une application de santé que vous placez dans CXone Agent en utilisant un iframe. Lorsque l’agent accepte un contact, vous pouvez utiliser le numéro de téléphone de ce contact pour rechercher ses informations dans votre application de santé. Cela vous permet de présenter automatiquement les informations de contact à l’agent. Si les agents utilisent Google Chrome, l’application de santé ne peut pas obtenir le numéro de téléphone du contact depuis CXone Agent. Pour cela, il doit s’abonner au flux d’événements VC, qui est le même que celui CXone Agent utilise.

Composition du SDK

Le SDK CXA est une compilation de plusieurs SDK spécialisés.

SDK Détails
ACD

Ce SDK inclut des fonctionnalités pour traiter les appels vocaux, la messagerie vocale et les éléments de travailFermé Méthode personnalisable de livraison de contacts à un agent via des scripts Studio.. Par exemple :

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

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

  • Pour les éléments de travail, vous pouvez automatiser la distribution des éléments de travail aux agents. Cela optimise la charge de travail de l’agent au moyen de règles et de critères prédéfinis.

Vous trouverez ci-dessous des informations techniques clés sur le SDK ACD.

  • Une fois l’authentification terminée, vous pouvez appeler initAcdEngagement() pour créer une instance de ce module et créer des fonctionnalités ACD.

  • Vous pouvez établir une session entre un agent et un contact en utilisant les 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 numérotation, les transferts, les conférences, etc.

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

Ce SDK sert à traiter les événements de la session. Il permet de démarrer des sessions, de rejoindre une session en cours, etc. Ses objectifs principaux sont :

  • La boucle get-next-event ;

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

Ce SDK facilite l’authentification et l’autorisation sécurisées. Il permet essentiellement de configurer un flux de connexion en utilisant l’authentification globale de CXone. Le flux d’authentification pris en charge est OpenID Connect avec PKCE. Les utilisateurs doivent s’authentifier avec un compte CXone. Cela permet de vérifier les identités de l’utilisateur et leurs autorisations en fonction de leur rôleFermé Recherche des indices laissant supposer que le client est frustré. Ces indices incluent des mots et des expressions tels que « Je suis très en colère ». La frustration ne doit pas être confondue avec un sentiment négatif. Les indices de frustration indiquent que le client est contrarié et ne parle pas simplement de quelque chose de négatif. CXone.

Les caractéristiques clés incluent :

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

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

Vous trouverez ci-dessous des informations techniques clés sur le SDK Auth.

  • Appelez cxoneAuth.init() pour transférer cxoneHostname, clientId et redirectUri au SDK.

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

  • Lorsque l’utilisateur entre les informations d’authentification et amorce l’authentification, un objet AuthSettings est créé avec ses informations utilisateur. L’instance CXoneAuth est initialisée avec AuthSettings.

  • Utilisez getAccessTokebByCode() pour capturer le code renvoyé et générer un jeton d’authentification. Cela enregistre également les informations de l'utilisateur.

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

Ce SDK permet d’intégrer des canaux de communication numériques. Vous pouvez utiliser des canaux numériques standard comme l’e-mail, le chat et les SMS, ainsi que des plateformes de réseaux sociaux, telles que WhatsApp. Selon le nombre de canaux que vous avez configurés, vous pouvez créer des communications multicanales.

Vous trouverez ci-dessous des informations techniques clés sur le SDK Digital.

  • Une fois l’authentification réalisée, vous pouvez appeler CXoneDigitalClient.instance.initDigitalEngagement(). Cela crée une instance des composants nécessaires pour la messagerie numérique et établit une connexion WebSocket numérique.

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

  • Votre application peut s’appuyer sur les messages numériques avec la méthode reply().

  • Vous pouvez également déclencher une nouvelle interaction sortante avec la méthode reply().
Voix Ce SDK fournit la fonctionnalité Softphone intégré. Il s’agit d’un wrapper pour WebRTC.

Ressources

Un SDK vous permet de créer votre propre fonctionnalité personnalisée, ce qui permet de mettre en place des ressources d’assistance essentiellement en libre-service. Vos options d’assistance technique dépendent du contrat d’assistance technique de votre organisation passé avec NICE. Contactez votre Représentant de compte CXone pour plus d'informations sur les options d’assistance.

En supplément de cette page, votre contenu en libre-service porte essentiellement sur les ressources des développeurs. Le package du SDK inclut ce qui suit :

  • Fichiers README de chaque SDK spécialisé comportant des informations de prise en main.

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

  • Exemples d’utilisation avec des extraits de code depuis l’exemple d’application.

  • Commentaires de code.

Évènements

Vous trouverez ci-dessous des événements que votre application peut écouter. Ces é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 les événements liés aux appels de conférence.

 

onDispositionEvent

Gère les événements liés aux dispositionsFermé Les résultats affectés 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 les mises à jour des contacts vocaux.

 

voiceMailContactUpdateEvent

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

 

workItemContactUpdateEvent

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

CXoneAcdClient.instance.notification

onUpdateMessageEvent

Écoute les nouveaux messages ou les notifications pour l’agent.

CXoneAcdClient.instance.screenPop

agentAssistSubject

Gère les événements liés à l’assistance à l’agent ou aux applications Copilot.

 

contactScreenPopSubject

Gère les événements liés aux fenêtres contextuelles 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’affichage des URL dans une nouvelle fenêtre ou un nouvel onglet contextuel.

 

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 à la partieFermé La partie d’une interaction qui se déroule entre CXone et l’agent. agent de la session.

 

agentStateSubject

Événement observable qui émet les événements liés aux modifications de l’état de l’agent, comme par exemple un changement d’état de Disponible vers Non disponible.

 

naturalCallingSkillListSubject

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

Les types d’événement incluent : SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS et JOIN_SESSION_FAILURE.

 

networkOfflineSubject

Écoute les événements liés aux problèmes de connectivité 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énement incluent : SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS et JOIN_SESSION_FAILURE.

CXoneAcdClient.instance.session.agentStateService

agentStateSubject

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

SDK 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 les métriques de performance depuis l’API CXone.

CXoneClient.instance.agentSession

agentSessionEndSubject

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

CXoneClient.instance.agentSetting

mchAgentSettingsChangeEvent

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

CXoneClient.instance.autoSummaryService

onAutoSummaryReceived

Événement observable déclenché lorsqu’un résumé auto-généré est reçu pour un contact.

CXoneClient.instance.commitment

onCommitmentEvent

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

 

onCommitmentStatusEvent

Écoute les modifications de l’état des engagements de l’agent.

 

onUpdateCommitments

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

CXoneClient.instance.contactManager

onDigitalContactEvent

Fournit des mises à jour sur les interactions des contacts numériques comme les sessions de chat et les messages sortants dans CXone.

 

onDispositionEvent

Fournit des mises à jour sur l’état de la disposition d’appel une fois l’appel terminé.

 

voiceContactUpdateEvent

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

CXoneClient.instance.copilotNotificationClient

onMessageNotification

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

Les types d’événement incluent : 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 les événements liés au répertoire, tels que les agents, les équipes ou les compétences.

Fournit des mises à jour sur les modifications des données du répertoire, telles que les nouveaux contacts, les mises à jour et les modifications d’autorisation dans CXone.

 

onUpdateSkillsEvent

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

CXoneClient.instance.directory.dynamicDirectory

searchDirectoryResult

Attend que les résultats d’une recherche, telle qu’une recherche de personne ou de service dans un répertoire du système.

CXoneClient.instance.indicator

agentIndicatorsEvent

Événement fournissant des mises à jour sur les indicateurs d’un agent, comme la disponibilité, l’activité en cours et les indicateurs d’état de l’agent personnalisé.

 

contactIndicatorsEvent

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

CXoneClient.instance.notification

onCXoneNotificationEvent

Écoute les notifications provenant de la plateforme CXone.

CXoneClient.instance.screenPop

contactScreenPopSubject

Événement déclenchant l’ouverture d’une page Web avec 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 en relation avec un appel existant.

 

runAppSubject

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

CXoneClient.instance.session

agentLegEvent

Écoute les mises à jour d’une partie spécifique de l’appel de l’agent, telle qu’un appel entrant ou sortant.

CXoneClient.instance.session.agentStateService

agentStateSubject

Événements fournissant des mises à jour en direct du statut de disponibilité de l’agent et des changements d’état dans CXone.

CXoneClient.instance.skillActivityQueue

agentQueueSubject

Événement fournissant des mises à jour sur les informations relatives à la file d’attente affectée aux agents, telles qu’un nom de file d'attente, un nombre d’appels et la disponibilité de l’agent.

 

agentQueuesDetailSubject

Événement fournissant des mises à jour sur les files d’attente affectées à l’agent, avec des métriques telles que le temps moyen d’attente, les contrats de niveau de service (SLA) et les performances des agents.

 

skillActivityEvent

Événement fournissant des mises à jour sur des métriques d’activité relatives aux compétences, telles que la longueur de la file d’attente, le temps moyen d’attente 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énement incluent : AUTHENTICATED,AUTHENTICATING, NOT_AUTHENTICATED, AUTHENTICATION_FAILED et REFRESH_TOKEN_SUCCESS

SDK numériques

Instance Événement Description

CXoneDigitalClient.instance.digitalContactManager

onDigitalContactEvent

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

Les types d’événement incluent : 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 les nouveaux événements provenant des contacts numériques.

 

onDigitalContactUserTypingPreviewEvent

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

Les types d’événement incluent : 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 Voice

Instance Événement Description

CXoneVoiceClientWrapper.instance

onCallStatusChanged

Gère les événements liés aux modifications du statut d’appel.

 

onConnectionStatusChanged

Gère les événements liés aux modifications du statut de connexion vocale.