Mobile SDK

Supported Operating Systems:
  • Android v7 ou version supérieure, écrit en Kotlin v2.x ou version supérieure
  • iOS v15.0 ou version supérieure, écrit en Swift
  • Les frameworks hybrides ne sont pas pris en charge

Version actuelle :

Références de l’API :

Pour vous aider à démarrer l'implémentation du Mobile SDK, vous devez acheter le progiciel d'implémentation de base auprès de NiCE. Un partenaire de NiCE vous guide tout au long de l'implémentation.

Vous souhaiterez peut-être également acheter des heures de Services Professionnels auprès de NiCE pour les questions relatives à la configuration en dehors du Mobile SDK.

Mobile SDK vous permet d'intégrer NiCE CXone clavardage numérique dans vos applications mobiles d'entreprise. Cela permet aux utilisateurs de l'application (contactsClosed The person interacting with an agent, IVR, or bot in your contact center.) de discuter avec les agents de votre centre de contact et les agents virtuelsClosed A software application that handles customer interactions in place of a live human agent. via les canauxClosed Various voice and digital communication mediums that facilitate customer interactions in a contact center. de chat numériquesClosed Any channel, contact, or skill associated with Digital Experience (DX).. Le SDK simplifie le processus d’implémentation du chat numérique ; les développeurs ne doivent pas nécessairement traiter l’implémentation de la logique métier. La tâche principale de vos développeurs consiste à afficher visuellement et à gérer les fonctionnalités que vous configurez dans NiCE CXone, comme les notifications poussées ou les messages enrichisClosed Elements in digital messaging such as buttons, images, menus, and option pickers..

Le SDK prend en charge les applications iOS et Android. Les applications iOS doivent être écrites en Swift Ce lien s'ouvre dans une nouvelle fenêtre. et les applications Android doivent être écrites en Kotlin Ce lien s'ouvre dans une nouvelle fenêtre.. De plus, le SDK nécessite une version minimum de Android 7.0 et une version minimum de iOS 15.0.

Avec Mobile SDK:

Pour un aperçu rapide des avantages du SDK, vous pouvez consulter la fiche technique Mobile SDK Ce lien s'ouvre dans une nouvelle fenêtre.. Vous pouvez également regarder une courte vidéo de démonstration Ce lien s'ouvre dans une nouvelle fenêtre..

Ressources du SDK

Téléchargez les emballages SDK depuis les dépôts public GitHub (Android Ce lien ouvre une nouvelle fenêtre iOS Ce lien s'ouvre dans une nouvelle fenêtre). Ces deux référentiels contiennent un fichier README pour en faciliter les premières étapes du développement. Ils proposent également des cas d'utilisation avec des exemples de code dans /docs. Vous pouvez utiliser cela comme modèle pour développer votre solution de chat. Les deux référentiels incluent également des journaux de modification.

Vous pouvez accéder aux références de l'API dans votre navigateur (Android This link opens in a new window iOS This link opens in a new window).

Vos développeurs peuvent également consulter des exemples d'applications pour les deux Android Ce lien s'ouvre dans une nouvelle fenêtre et iOS Ce lien ouvre une nouvelle fenêtre plates-formes. Cela permet aux développeurs de disposer d’exemples de fonctionnalités implémentées.

Mobile SDK Versioning

Les versions du SDK sont généralement mises à jour avec les versions marketing majeures NiCE CXone, telles que 25.4, 26.1, et ainsi de suite. Dans GitHub, chaque version de release est balisée conformément au versionnage sémantique expliqué ci-dessous.

Vous êtes responsable de la mise à jour de votre application à mesure que le SDK se met également à jour. La section Ressources du SDK ci-dessus comporte des liens vers les ressources les plus à jour. Dans les référentiels du SDK, vous pouvez utiliser les balises pour trouver les versions précédentes du SDK. De même, l'erreur sdkVersionNotSupported vous informe que votre version du SDK est obsolète et que vous devez la mettre à jour.

Sachez que le SDK est rétrocompatible sur les deux dernières versions majeures.

NiCE prend en charge la version majeure actuelle et la version majeure précédente du SDK. Par exemple, si la version actuelle est 2.2, NiCE prend en charge les versions v2.2 et 1.3 (la dernière version 1.x.x).

Modifications de version

Lorsque la version du SDK change d'une version à l'autre, le numéro de version indique le type de changement :

  • 2.0.0 : le premier chiffre indique le changement majeur de l'API.

  • 2.1.0 : Le deuxième chiffre désigne une modification non disruptive. Souvent, les nouvelles fonctionnalités sont ajoutées sous forme de modifications non disruptives.

  • 2.0.1 : le troisième numéro indique une correction de bug. Elles sont toujours rétrocompatibles.

Corrections de bugs

NiCE Services professionnel collabore avec vous sur les corrections de bugs. Vous pouvez soumettre des bugs par leur intermédiaire (ou par le partenaire d'implémentation), et ils vous communiquent les corrections en plus du journal des modifications du SDK.

De plus, tous les bogues sont corrigés dans les versions actuellement prises en charge. Par exemple, si la version actuelle est 3.0, les deux versions prises en charge sont 3.0 et 2.3 (la dernière version de la série 2.x). Si vous avez trouvé un bogue dans la version 2.1, NiCE le corrigerait pour les versions 2.3 et 3.0, mais pas pour les versions 2.1 ou 2.2.

Comment le Mobile SDK s'intègre dans Digital Experience (DX)

Le Mobile SDK est un moyen d'étendre Digital Experience (DX) et de proposer le clavardage numérique dans les applications mobiles. Digital Experience (DX) est la partie de NiCE CXone qui prend en charge digital channels. Des exemples de digital channels sont WhatsApp, les publications sur Facebook, ou le clavardage numérique. Pour ajouter le NiCE CXone clavardage numérique à vos applications, vous devez configurer certaines fonctionnalités dans la section Digital Experience (DX) de l'interface NiCE CXone. Ensuite, avec le SDK, vous accédez aux fonctionnalités que vous avez configurées dans NiCE CXone et pouvez les utiliser.

Par exemple, une partie du processus de prise en main consiste à configurer un canal de chat numérique dans NiCE CXone. Ensuite, votre application doit créer une connexion WebSocket avec le canal clavardage numérique que vous avez créé. Vous pouvez également configurer des fonctionnalités avancées, telles que les messages de bienvenue ou les sondages de préparation au chat. Ceux-ci vous offrent diverses options pour simplifier l'expérience des utilisateurs de votre application. Les utilisateurs peuvent fournir des informations initiales sur leur problème ou leur demande, entrer des données personnelles de base, etc. Ces fonctionnalités sont d’abord configurées dans NiCE CXone, puis peuvent être utilisées dans le SDK.

Schéma de l'infrastructure du SDK mobile

Chat UI

Le Mobile SDK est fourni avec un module d'interface utilisateur/expérience utilisateur par défaut. Vous pouvez choisir de l'implémenter dans le cadre du progiciel d'implémentation standard. Cela réduit considérablement le temps d'implémentation.

Module d'UI par défaut

Le module par défaut gère automatiquement toutes les fonctionnalités de chat, ce qui réduit le besoin de tout développement supplémentaire de votre part, comme :

L'Mobile SDK application exemple présente l'UI/UX par défaut. La documentation relative au module UI/UX se trouve dans le Module lui-même, afin que vos développeurs puissent la consulter.

Personnalisation des couleurs

Vous pouvez choisir les couleurs de 33 parties différentes de l'interface utilisateur de chat, allant des titres aux boutons. Cela inclut à la fois le mode clair et le mode sombre. Dans le cadre du progiciel d'implémentation Standard, vous définissez ces couleurs. Les couleurs par défaut suivent l'image de marque NiCE, que vous pouvez modifier.

Après l'implémentation, vos développeurs peuvent contrôler les couleurs à l'aide d'un gestionnaire de couleurs dans la classe ChatStyle.

Développez votre propre interface utilisateur

Vous pouvez également choisir d'utiliser ou de développer votre propre interface utilisateur ; vous n'êtes pas obligé d'utiliser l'interface utilisateur/l'expérience utilisateur par défaut. Si vous utilisez votre propre interface utilisateur (ou un progiciel d'interface utilisateur tiers), NiCE n'assure aucun soutien pour celle-ci.

De même, vous pouvez souhaiter apporter certaines personnalisations de configurations à l'interface utilisateur par défaut, comme la localisation, les notifications poussées et l'authentification OAuth. Si vous souhaitez prendre en charge une langue autre que Anglais, vous devez fournir des traductions pour les chaînes de texte. Si vous implémentez une langue autre que Anglais, veillez à tester toutes les zones de l'interface utilisateur pour vous assurer que l'affichage est géré de manière appropriée.

Si vos développeurs effectuent des personnalisations supplémentaires en plus de l'interface utilisateur/expérience utilisateur standard, NiCE ne fournit pas de soutien pour ces modifications.

Étiquettes de l'assistant IA dans Mobile SDK

Pour se conformer aux réglementations mondiales en matière de transparence de l'IA (telles que l'EU AI Act), le Mobile SDK CXone peut désormais identifier automatiquement si un contact interagit avec une IA plutôt qu'avec un agent humain.

Lorsque cette option est activée, les messages envoyés par des agents virtuelsClosed A software application that handles customer interactions in place of a live human agent. ou des systèmes automatisés affichent une étiquette « AI Assistant » dans l'interface de chat.

Caractéristiques clés

  • Identification automatique : le SDK détecte les messages générés par l'IA et applique l'étiquette de divulgation automatiquement.

  • Texte personnalisable : l'étiquette par défaut est « AI Assistant ». Pour DX Chat, vous pouvez personnaliser ce texte via les paramètres Translations. Pour les implémentations Mobile SDK, le texte de l'étiquette doit être codé en dur directement dans le projet d'application mobile, car le Mobile SDK n'utilise pas les paramètres de traduction/localisation.

Conditions préalables

  • Mobile SDK : version 4.0 (version 26.3) (iOS et Android).

  • Pour activer ou désactiver l'indicateur IA, accédez à ACD > Points of Contact Digital > Chat > Basics > AI settings et sélectionnez ou désélectionnez la case à cocher indicateur IA.

Personnalisation de l'Étiquette

Dans les canaux de chat DX, vous pouvez personnaliser le texte de l'étiquette « AI Assistant » via les paramètres de traduction (ACD > Points de contact Digital > Chat > Traductions).

Pour les implémentations Mobile SDK, le texte de l'étiquette doit être codé en dur dans le projet d'application mobile. Le Mobile SDK n'utilise pas les paramètres de traduction/localisation. Pour utiliser des termes alternative tels que « Bot », « Assistant virtuel » ou « Chatbot », vos développeurs doivent mettre à jour la chaîne codée en dur directement dans le code de l'application.

Pour les développeurs qui créent des interfaces personnalisées, la propriété booléenne isAiGenerated est disponible dans le DTO (Data Transfer Object) du message.

  • Propriété : isAiGenerated

  • Type : booléen

  • Comportement : Lorsque la case à cocher indicateur IA est sélectionnée dans les paramètres du canal, le SDK inclut la propriété isAiGenerated dans la charge utile du message. Si elle est vraie, l'interface utilisateur affiche l'étiquette « AI Assistant » à côté du message. Si la case à cocher est désélectionnée, cette propriété est omise de la charge utile du message afin d'éviter tout impact sur le code personnalisé existant.

Faits clés

  • Pour vous aider à démarrer l'implémentation du Mobile SDK, vous devez acheter le progiciel d'implémentation de base auprès de NiCE. Un partenaire de NiCE vous accompagne tout au long de l'implémentation.

  • Vous souhaiterez peut-être acheter des heures de Services Professionnel auprès de NiCE pour des questions concernant la configuration en dehors du Mobile SDK.

  • Le SDK ne peut pas être utilisé sans une application mobile existante. Vous devez disposer de votre propre application écrite nativement en Kotlin ou en Swift.

  • Les infrastructures non natives ou hybrides ne sont pas prises en charge, telles que React Native.

  • Ce SDK fonctionne avec le clavardage numérique autonome, pas avec le clavardage via Guide.

  • Le Mobile SDK met en cache les informations de canal pendant cinq minutes. Lorsque l'utilisateur réduit l'application ou passe à un autre écran puis revient, le SDK utilise les informations de canal stockées au lieu de les demander à nouveau.

    • Si vous modifiez les paramètres d'un canal dans NiCE CXone, la mise à jour peut prendre jusqu'à cinq minutes pour apparaître dans l'application, car le SDK utilise toujours sa copie mise en cache des informations du canal.

    • Le SDK efface immédiatement les informations de canal mises en cache lorsqu'un contact se déconnecte ou lorsque l'application se réinitialise avec un ID de canal différent. Le cache n'est pas effacé lorsque l'application passe en arrière-plan ou au premier plan ; l'expiration de cinq minutes couvre ce cas.

Avant de Démarrer le développement

Tenez compte des éléments suivants avant de créer avec le Mobile SDK :

  • Disposez-vous à la fois d’un compte administrateur et d’un compte agent dans NiCE CXone ? Un administrateur peut-il vous aider à configurer les fonctionnalités nécessaires dans la plateforme NiCE CXone ?
  • Votre application mobile est-elle disponible pour iOS (Apple), Android, ou les deux ? Vos développeurs connaissent-ils les langages Swift et Kotlin ?
  • Disposez-vous de canaux de messagerie instantanée ou voulez-vous en créer un ?
  • Utiliserez-vous OAuth pour authentifier les utilisateurs de votre application ? Si oui, quel fournisseur OAuth utiliserez-vous ?
  • Voulez-vous OFFRIR des conversations à fil unique ou à fils multiples ?
  • Utiliserez-vous des actions proactives, telles que des fenêtres contextuelles, ou des messages de bienvenue ?
  • Souhaitez-vous utiliser les notifications poussées ? Disposez-vous d’un compte Firebase ou Apple Developer ?
  • Quels types de messages enrichis voulez-vous configurer ? Quels sont les cas d’utilisation où vous pouvez exploiter ces messages interactifs ?
  • Voulez-vous suivre les données utilisateur ? Comment pouvez-vous utiliser les événements relatifs au visiteur pour produire des analyses ?

Clé mots-clés

TermeDétails
Thread Une conversation au sein de l'application de chat. Le premier message envoyé par l’agent ou le contactClosed The person interacting with an agent, IVR, or bot in your contact center. 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 uniqueConception d'application dans laquelle le contact ne peut avoir qu’une seule conversation à la fois.
Canal de messagerie (multithread)Un canal asynchrone où le client peut tenir plusieurs conversations de longue durée à la fois. Le SDK expose getThreadList(), la désignation des fils de discussion et l'archivage ici.
CanalDans le contexte de Digital Experience (DX), canal désigne le type de messagerie ou la plateforme utilisée pour la communication. Par exemple, vous pouvez avoir un canal WhatsApp de messagerie en temps réel. Le Mobile SDK vous permet d'ajouter un canal de messagerie de chat à votre application mobile. Un canal est créé dans la plateforme NiCE CXone. Ceci détermine les paramètres du canal ainsi qu'un ID de canal. Vous utilisez cet ID pour lancer le canal de chat lorsqu'un utilisateur de l'application ouvre le chat.
ChannelIdL'ID du canal de clavardage numérique créé dans la section Digital de NiCE CXone. Vous pouvez le trouver dans les paramètres du canal de clavardage dans NiCE CXone (ACD > Digital > Points of Contact Digital > Chat > Initialization & Test).
BrandIdIl s'agit d'un équivalent de l'ID de locataireClosed High-level organizational grouping used to manage technical support, billing, and global settings for your NiCE CXone system. pour Digital Experience (DX). Cela est utilisé pour initialiser le chat. Vous pouvez trouver cette information dans les paramètres du canal de chat dans NiCE CXone (ACD > Digital > Points of Contact Digital > Chat > Initialization & Test).
CustomerIdL'id unique de l'utilisateur final du chat. Le SDK crée cet ID lorsque le chat est initialisé. Si vous disposez de OAuth configuré(e), 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 alors comme une connexion invité.
Région ou EnvironnementL'emplacement dans le monde où votre déploiement NiCE CXone 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 NiCE CXone est hébergé, sinon la connexion de chat est rejetée.
Contact, Client et UtilisateurCes termes désignent tous l'utilisateur final de l'application mobile. 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.
NiCE CXoneLa plateforme principale où vous gérez et accédez à tous les outils d'expérience client qu'offre NiCE CXone. Selon les fonctionnalités de chat que vous souhaitez proposer dans votre application mobile, un administrateur disposant des autorisations de compte utilisateur nécessaires doit effectuer plusieurs tâches de configuration dans NiCE CXone.
Digital Experience (DX)La section de NiCE CXone où vous pouvez gérer tout ce qui concerne digital channels.
MarqueVotre entreprise ou compte dans NiCE CXone, identifié par un brandId numérique. Toute la configuration de chat se trouve sous une marque.
Canal Livechat (session unique)Session synchrone, routée par Agent. Le chat doit être démarré explicitement (startChat()) et peut être terminé (endChat()), et le client peut attendre dans une file d'attente. Le SDK retourne un LivechatThread pour ces canaux.
ThreadUne conversation au sein d'un canal, identifiée par un id du fil. Elle contient l'historique des messages et constitue votre principal point d'accès pour l'envoi et la réception de messages.
Contact, cas et interaction

Une interactionClosed The full conversation with an agent through a channel. For example, an interaction can be a voice call, email, chat, or social media conversation. routée unique créée à partir d'un fil de discussion. Il s'agit de l'unité que l'Agent prend réellement en charge et avec laquelle il travaille. Un même fil de discussion peut produire plusieurs contacts au cours de sa durée de vie (par exemple, un nouveau contact chaque fois que le client reprend contact après une clôture).

Dans l'aide en ligne NiCE CXone, le terme interaction est utilisé le plus souvent. Le terme case est utilisé dans certaines pages d'aide Digital Experience (DX). Contact est utilisé dans des contextes techniques tels que le SDK ou le contenu d'aide Studio, et fait souvent référence à l'ID que NiCE CXone attribue à un segment de toute une conversation ou interaction (contactId).

MessageUn seul élément d'un fil de discussion — texte, pièce jointe ou contenu enrichi — rédigé par le client ou un agent.
AgentUn humain (ou un bot) du côté NiCE CXone qui traite le contact. L'attribution et le typage de l'Agent apparaissent sous forme d'événements.
Visiteur ou visiteIdentifiants d'analyse légers pour la personne en navigation (visitorId) et sa session de navigation en cours (visitId). Ils sont générés pour vous si vous ne les fournissez pas et concernent principalement le chat proactif et l'analyse.