SDK : GitHub 
Référence API : Pages GitHub
Exemple d’application : GitHub
Package NPM : npmjs.com
Le SDK de clavardage Web vous permet de créer votre propre application de clavardage numérique ou d’ajouter un clavardage numérique dans une application Web existante. Il vous permet d’utiliser l’infrastructure numérique CXone Mpower dans l’interface utilisateur de votre choix. Il s'agit d'un SDK basé sur JavaScript qui prend en charge à la fois LiveChat et Chat Messaging, à la fois la messagerie synchrone et asynchrone. Vous pouvez également configurer la messagerie à fil unique
Dans une application à fil unique, chaque contact dispose d’un fil de clavardage qui gère toutes les interactions qu’il a avec votre organisation. ou multifils Dans une application multi-fils, les contacts peuvent créer autant de fils de discussion qu’ils le souhaitent pour discuter de nouveaux sujets. Ces fils peuvent être actifs en même temps.. Ce SDK vous permet de mieux contrôler CXone Mpower sur votre site Web. Il vous permet d’éviter certaines limitations techniques de certains sites Web. Par exemple, il se peut que votre site n’autorise pas le code externe, ce qui pourrait empêcher l’exécution du clavardage numérique CXone Mpower natif.
Le SDK prend en charge les fonctionnalités suivantes :
- Messagerie par clavardage numérique
- OAuth2.0 pour l’autorisation
- Champs d’identification des contacts et champs personnalisés
- Liste des fils et récupération des fils
- Pièces jointes
- Messages enrichis
- Indicateurs de frappe, de message vu et de message délivré
- Messages système tels que les événements relatifs à l’état d’un cas ou les événements d’assignation
- Événements relatifs à la position dans la file d’attente
Ce SDK est écrit en TypeScript 4.9+. Vous devez également utiliser un application personnalisé
Ressources SDK
Le haut de cette page ou la liste déroulante ci-dessous fournissent des liens vers les différentes ressources SDK.
Vos développeurs peuvent obtenir le SDK sur GitHub. Le référentiel contient un fichier LISEZ-MOI qui aide le développeur à démarrer. Il contient également de la documentation sur les événements et la référence API. La référence API, plus conviviale, est hébergée séparément sur github.io.
Vous pouvez également consulter l’exemple d’application. Il vous permet d’essayer le clavardage et de consulter le code source correspondant.
Les développeurs importent le SDK sous la forme d’un package NPM. L’entrée du package sur npmjs.com contient le même contenu et les mêmes instructions pour la configuration et la construction avec le SDK.
Termes clés
| Terme | Détails |
|---|---|
| Fil | Une conversation dans le clavardage application. Le premier message envoyé par l’agent ou le contact La personne qui interagit avec un agent, un IVR ou un robot dans votre centre d’appels. commence un fil de discussion. Chaque message consécutif de la conversation est ajouté au fil. Les fils sont des objets qui contiennent chaque message. Les messages sont structurés par l’auteur du message. Un threadId identifie une conversation entière, et tous les messages d’une conversation ont un ID de message. Un fil se termine lorsque la conversation prend fin. |
| Fil unique | Une conception application où le contact ne peut avoir qu'une seule conversation à la fois. |
| Multi-fils | Une conception application où le contact peut avoir plusieurs conversations à la fois. |
| Canal | Dans le contexte de Digital Experience, canal fait référence au type de courriel ou au plateforme utilisé pour la communication. Par exemple, vous pourriez avoir un canal de messagerie en temps réel WhatsApp. Le SDK mobile vous permet d’ajouter un canal de messagerie par clavardage à votre application mobile. Un canal est créé dans la plateforme CXone Mpower. Cela détermine les paramètres du canal ainsi que l’ID du canal. Vous utilisez cet ID pour lancer le canal de clavardage lorsqu’un utilisateur de application ouvre le clavardage. |
| Identifiant de canal | L'ID du canal de discussion numérique créé dans la section Digital de CXone Mpower. Vous trouverez ces informations dans les paramètres du canal de clavardage dans CXone Mpower (ACD > Digital > Points d’accès numériques > Clavardage > Initialisation et test). |
| Identifiant de marque | Il s'agit d'un identificateur de locataire pour Digital Experience. Il est utilisé pour initialiser le clavardage. Vous trouverez ces informations dans les paramètres du canal de clavardage dans CXone Mpower (ACD > Digital > Points d’accès numériques > Clavardage > Initialisation et test). |
| ID client | L'identifiant unique de l'utilisateur final du chat. Le SDK crée cet ID lors de l’initialisation du clavardage. Si vous avez configuré OAuth, cet ID reste le même pour chaque contact sur tous ses appareils. Si vous n’avez pas configuré OAuth, cet ID est différent pour chaque appareil; l’ID devient similaire à un identifiant d’invité. |
| Région ou environnement | L’endroit dans le monde où votre déploiement CXone Mpower est hébergé. Les options sont : Australie (AU1), Canada (CA1), Europe (EU1), Japon (JP1), Amérique du Nord (NA1) ou Royaume-Uni (UK1). Le développeur doit utiliser la même région que celle où votre système CXone Mpower est hébergé, sans quoi la connexion au clavardage est rejetée. |
| Contact, client et utilisateur | Ces termes font tous référence à l'utilisateur final du mobile application. L’aide en ligne utilise généralement le terme contact. Dans la documentation du SDK et dans les commentaires de code, vous verrez probablement les termes client et utilisateur. |
| CXone Mpower | Le cœur plateforme où vous gérez et accédez à tous les outils d'expérience client offerts par CXone Mpower. En fonction des fonctions de clavardage que vous souhaitez proposer dans votre application mobile, un administrateur disposant des autorisations nécessaires pour le compte d’utilisateur doit effectuer plusieurs tâches de configuration dans CXone Mpower. |
| Digital Experience | La section de CXone Mpower où vous pouvez gérer tout ce qui concerne les chaînes numériques. |
Avant de commencer à développer
Tenez compte des éléments suivants avant d’utiliser le SDK mobile :
- Disposez-vous d’un compte d’administrateur et d’un compte d’agent dans CXone Mpower? Un administrateur peut-il vous aider à configurer les fonctionnalités nécessaires dans la plateforme CXone Mpower?
- Avez-vous déjà des canaux de clavardage, ou souhaitez-vous en créer un nouveau?
- Souhaitez-vous proposer des conversations à fil unique ou multi-fils?
- Quels types de messages enrichis souhaitez-vous configurer? Quels sont les cas d’utilisation où vous pouvez tirer parti de ces messages interactifs?
- Utiliserez-vous des actions proactives comme des fenêtres contextuelles ou des messages de bienvenue?
Initialiser correctement le clavardage
Vos développeurs doivent connecter votre application à CXone Mpower pour commencer la communication dans les deux sens. Ça crée une connexion WebSocket. Les développeurs peuvent le faire en appelant await sdk.connect(). Assurez-vous de demander à vos développeurs de le faire uniquement pour les conversations de clavardage actives. Cela garantit que le WebSocket ne s'exécute que lorsque nécessaire.