SDK : GitHub 
Référence API : Pages GitHub
Exemple d’application : GitHub
Package NPM : npmjs.com
Le SDK Chat Web permet de créer votre propre application de chat numérique ou d’ajouter le chat numérique dans une application web existante. Il 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 le configurer pour mettre en place une messagerie unique
Dans une application à fil unique, chaque contact à un fil de discussion qui traite toutes les interactions qu’il peut avoir avec votre organisation. ou à fils multiples Dans une application multithread, 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 donne plus de contrôle sur CXone Mpower sur votre site Web. Cela permet d'éviter certaines limitations techniques propres aux sites Web. Par exemple, votre site peut ne pas autoriser le code externe, ce qui peut empêcher l'exécution du chat CXone Mpower numérique natif.
Le SDK prend en charge les fonctionnalités suivantes :
- Messagerie de chat numérique
- OAuth2.0 pour l’autorisation
- Identification du contact et champs personnalisés
- Liste des fils et récupération des fils
- Pièces jointes
- Messages enrichis
- Indicateurs pour la saisie, message vu et message livré
- Messages système comme les événements de statut du cas ou d’affectation
- Événements de position dans la file d’attente
Ce SDK a été écrit en TypeScript 4.9+. Vous pouvez également utiliser un application personnalisé, comme
Ressources du SDK
Le haut de cette page ou la liste déroulante située en dessous comporte des liens vers les différentes ressources du SDK.
Vos développeurs peuvent obtenir le SDK sur GitHub. Le référentiel comporte un fichier README qui permet au développeur de commencer. Il comporte également la documentation pour les événements et la référence d’API. La référence d’API la plus intuitive est hébergée séparément à travers github.io.
Vous pouvez également consulter l’exemple application. Il vous permet d’essayer le chat et d’examiner le code source corrélé.
Les développeurs importent le SDK en tant que package NPM. L’entrée du package sur npmjs.com contient le même contenu et les instructions de configuration et de création avec le SDK.
Mots-clés
| Terme | Détails |
|---|---|
| Fil | Une conversation dans le chat application. Le premier message envoyé par l’agent ou le contact La personne interagissant avec un agent, un serveur vocal interactif (SVI), ou robot dans votre centre de contact. commence un fil. 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 l’ensemble d’une conversation, et tous les messages appartenant à une conversation ont un ID de message. Un fil se termine lorsque la conversation se termine. |
| Fil unique | Une conception application où le contact ne peut avoir qu'une seule conversation à la fois. |
| Multi-fil | 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 messagerie ou au plateforme utilisé pour la communication. Par exemple, vous pouvez avoir un canal WhatsApp de messagerie en temps réel. Le SDK mobile permet d’ajouter un canal de messagerie instantanée à votre application mobile. Un canal est créé dans CXone Mpowerplateforme. Cela détermine les paramètres du canal, ainsi que l’ID de canal. Vous utilisez cet ID pour initier le canal de chat lorsqu’un utilisateur application ouvre le chat. |
| Identifiant de canal | L'ID du canal de discussion numérique créé dans la section Digital de CXone Mpower. Vous trouverez cela dans les paramètres du canal de chat dans CXone Mpower (ACD > Digital > Points de contact numériques > Chat > Initialisation et test). |
| Identifiant de la marque | Il s'agit d'un identifiant de locataire Regroupement organisationnel de haut niveau utilisé pour gérer le support technique, la facturation et les paramètres globaux de votre système CXone Mpower. pour Digital Experience. Cela est utilisé pour initialiser le chat. Vous trouverez cela dans les paramètres du canal de chat dans CXone Mpower (ACD > Digital > Points de contact numériques > Chat > Initialisation et test). |
| ID client | L'ID unique de l'utilisateur final du chat. Le SDK crée cet ID lorsque le chat est initialisé. Si vous avez configuré OAuth, cet ID reste tel quel pour chaque contact sur tous ses périphériques. Si vous n’avez pas configuré OAuth, cet ID est différent pour chaque périphérique ; l’ID se comporte comme un identifiant d’invité. |
| Région ou environnement | La partie du monde où votre déploiement CXone Mpower est hébergé. Cela peut être : Australie (AU1), Canada (CA1), Europe (EU1), Japon (JP1), Amérique du Nord (NA1) ou Royaume-Uni (UK1). Le développeur doit utiliser la région où votre système CXone Mpower est hébergé, sinon la connexion de chat 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 les commentaires du code, vous verrez généralement 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 proposés par CXone Mpower. Selon les fonctionnalités de chat que vous souhaitez offrir dans votre application mobile, un administrateur disposant des autorisations de compte utilisateur nécessaires doit compléter plusieurs tâches 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 procéder au développement
Tenez compte des éléments suivants avant d'utiliser le SDK mobile :
- Disposez-vous à la fois d’un compte administrateur et d’un compte agent dans CXone Mpower ? Un administrateur peut-il vous aider à configurer les fonctionnalités requises dans CXone Mpowerplateforme ?
- Disposez-vous de canaux de chat ou voulez-vous en créer un ?
- Voulez-vous proposer des conversations à fil unique ou à fils multiples ?
- Quels types de messages enrichis voulez-vous configurer ? Quels sont les cas d’utilisation où vous pouvez exploiter ces messages interactifs ?
- Allez-vous utiliser des actions dynamiques, telles que des fenêtres contextuelles ou des messages de bienvenue ?
Initialiser correctement le chat
Vos développeurs doivent connecter votre application à CXone Mpower pour commencer la communication dans les deux sens. Cela crée une connexion WebSocket. Les développeurs peuvent le faire en appelant await sdk.connect(). Assurez-vous d'indiquer à vos développeurs de le faire uniquement pour les conversations de chat actives. Cela garantit que le WebSocket ne s'exécute que lorsque cela est nécessaire.