Mobile SDK

Supported Operating Systems:
  • Android v7 ou supérieur, écrit en Kotlin v2.x ou supérieur
  • iOS v15.0 ou supérieur, écrit en Swift
  • Les cadriciels hybrides ne sont pas pris en charge
Current Version:
API References:

Pour vous aider à commencer 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 pourriez aussi vouloir acheter des heures Professionnel Services de NiCE pour les questions qui se situent en dehors du Mobile SDK.

Mobile SDK vous permet d'intégrer le clavardage numérique NiCE CXone dans vos applications mobiles d'entreprise. Cela permet aux utilisateurs de l'application de clavarder avec vos agents et robots de centre de contacts par l'entremise des canaux de clavardage numériqueClosed Tout canal, contact ou compétence associé à Digital Experience (DX).. Le SDK simplifie le processus d'implémentation du clavardage numérique; les développeurs n'ont pas besoin de gérer l'implémentation de la logique d'affaires. 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 Éléments de la messagerie numérique tels que les boutons, les images, les menus et les sélecteurs d’Option..

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 exige une version minimum de Android de 7.0 et une version minimum de iOS de 15.0.

Avec Mobile SDK :

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

Ressources SDK

Téléchargez les emballages du SDK à partir des référentiels GitHub Public (Android Ce lien s’ouvre dans une nouvelle fenêtre iOS Ce lien s’ouvre dans une nouvelle fenêtre). Les deux référentiels contiennent un fichier README pour vous aider à démarrer le développement. Ils offrent également des cas d'utilisation avec des exemples de code en /docs. Utilisez-les comme source d'inspiration pour développer votre clavardage. Les deux référentiels comprennent également des journaux des modifications.

Vous pouvez accéder aux références de l'API dans votre navigateur (Android Ce lien s’ouvre dans une nouvelle fenêtre iOS Ce lien s’ouvre dans une nouvelle fenêtre).

Vos développeurs peuvent également consulter des exemples d'applications pour les plateformes Android Ce lien s’ouvre dans une nouvelle fenêtre et iOS Ce lien s’ouvre dans une nouvelle fenêtre. Ces exemples aident les développeurs à voir des exemples de fonctionnalités implémentées.

Gestion des versions Mobile SDK

Les versions du SDK sont généralement mises à jour en même temps que les versions Marketing majeures de NiCE CXone, comme 25.4, 26.1, etc. Dans GitHub, chaque version de publication est balisée selon le versionnage sémantique expliqué ci-dessous.

Vous êtes responsable de maintenir votre Application à jour à mesure que le SDK est également mis à jour. La Section Ressources du SDK ci-dessus fournit des liens vers les ressources les plus à jour. Dans les référentiels SDK, vous pouvez utiliser les balises pour trouver les versions précédentes du SDK. De plus, l'erreur sdkVersionNotSupported vous indique que votre version du SDK est obsolète et que vous devez la mettre à jour.

Sachez que le SDK est rétrocompatible avec 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 la v2.2 et la v1.3 (la plus récente 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 modification :

  • 2.0.0 : le premier chiffre indique la modification majeure de l’API.

  • 2.1.0 : le deuxième chiffre indique une modification sans rupture de compatibilité. Souvent, de nouvelles fonctionnalités sont ajoutées sous forme de modifications sans rupture de compatibilité.

  • 2.0.1 : le troisième chiffre indique un correctif de bogue. Ces correctifs sont toujours rétrocompatibles.

Correctifs de bogues

Les Services professionnels de NiCE collaborent avec vous sur les correctifs de bogues. Vous pouvez leur soumettre des bogues (ou au partenaire d’implémentation), et ils vous communiquent les correctifs 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 alors 3.0 et 2.3 (la version la plus récente de la série 2.x). Si vous trouviez un bogue dans la v2.1, NiCE le corrigerait pour les versions 2.3 et 3.0, mais pas pour la 2.1 ou la 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 fournir le clavardage numérique dans les applications mobiles. Digital Experience (DX) est la partie de NiCE CXone qui prend en charge Digital Channels. Voici des exemples de canaux numériques : WhatsApp, les publications sur Facebook ou le clavardage numérique. Pour ajouter le clavardage numérique NiCE CXone à 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 vous les utilisez.

Par exemple, une partie du processus de démarrage consiste à configurer un canal de clavardage numérique dans NiCE CXone. Ensuite, votre application doit créer une connexion WebSocket avec le canal de clavardage numérique que vous avez créé. Vous pourriez également configurer des fonctionnalités avancées comme des messages de bienvenue ou des sondages préalables au clavardage. Celles-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, et ainsi de suite. Ces fonctionnalités sont initialement configurées dans NiCE CXone, que vous pouvez ensuite utiliser avec le SDK.

Diagramme de l’infrastructure SDK mobile

Interface utilisateur du clavardage

Le Mobile SDK est fourni avec un module d’IU/UX 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’IU par défaut

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

L'application exemple Mobile SDK présente l'interface utilisateur/expérience utilisateur par défaut. La documentation du module d'interface utilisateur/expérience utilisateur se trouve dans le module même, pour que vos développeurs puissent la revoir.

Personnalisation des couleurs

Vous pouvez choisir les couleurs de 33 parties différentes de l'interface utilisateur de clavardage, allant des titres aux boutons. Cela comprend 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 de 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évelopper 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/expérience utilisateur par défaut. Si vous utilisez votre propre interface utilisateur (ou un progiciel d'interface utilisateur de troisième partie), NiCE ne fournit pas de soutien pour celle-ci.

De même, vous voudrez peut-être 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, assurez-vous de tester toutes les zones de l'interface utilisateur pour garantir que l'affichage est traité de manière appropriée.

Si vos développeurs apportent des personnalisations supplémentaires à l'interface utilisateur/expérience utilisateur Standard, NiCE ne fournit pas de soutien pour ces modifications.

Étiquettes de l'assistant AI dans Mobile SDK

Pour se conformer aux réglementations mondiales de transparence en matière de AI (comme la loi européenne sur l'IA), le CXone Mobile SDK peut désormais identifier automatiquement quand un contact interagit avec une IA plutôt qu'avec un agent humain.

Lorsque cette fonctionnalité est activée, les messages envoyés par des robots logiciels ou des systèmes automatisés affichent une étiquette « AI Assistant » dans l'interface de clavardage.

Fonctionnalités principales

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

  • Conception axée sur la conformité : si le système ne peut pas vérifier qu'un message a été envoyé par un humain (comme les messages générés par le système ou anonymisés), il affiche par défaut l'étiquette AI pour garantir la conformité réglementaire.

  • Texte personnalisable : bien que l'étiquette par défaut soit « AI Assistant », vous pouvez personnaliser ce texte pour qu'il corresponde à la voix de votre marque grâce aux paramètres de localisation.

Conditions préalables

  • Mobile SDK : version 26.3 ou supérieure (iOS et Android).

  • Feature Toggle : le featureAiGeneratedMessageFlag doit être activé pour votre locataire. Communiquez avec votre représentant de compte NICE pour activer cette fonctionnalité.

Personnalisation de l'Étiquette

Les développeurs peuvent remplacer le texte par défaut « AI Assistant » en mettant à jour les chaînes de localisation dans le projet d'application mobile. Cela vous permet d'utiliser d'autres termes tels que « Bot », « Assistant virtuel » ou « Chatbot ».

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

  • Propriété : isAiGenerated

  • Type : Booléen

  • Comportement : lorsque la valeur est true, l'interface utilisateur doit afficher l'indicateur d'auteur AI. Si la fonction est désactivée, cette propriété est omise de la charge utile du message pour éviter tout impact sur le code personnalisé existant.

Mobile SDK

Faits clés

  • Pour vous aider à commencer à implémenter le 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 pourriez vouloir acheter des heures de Services Professionnels auprès de NiCE pour des questions sur la configuration en dehors du Mobile SDK.

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

  • Les cadriciels non natifs ou hybrides ne sont pas pris en charge, comme React Native.

  • Ce SDK fonctionne avec le clavardage Digital autonome, et non le clavardage via Guide.

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

Avant de commencer à développer

Tenez compte des éléments suivants avant d’utiliser le SDK mobile :

  • Avez-vous à la fois un compte administrateur et 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 offerte pour iOS (Apple), Android, ou les deux? Vos développeurs connaissent-ils bien les langages Swift et Kotlin?
  • Disposez-vous de canaux de messagerie par clavardage ou souhaitez-vous en créer un nouveau?
  • Utiliserez-vous OAuth pour authentifier les utilisateurs de votre application? Si oui, quel fournisseur OAuth utiliserez-vous?
  • Souhaitez-vous proposer des conversations à un ou plusieurs fils?
  • Utiliserez-vous des actions proactives comme des fenêtres contextuelles ou des messages de bienvenue?
  • Souhaitez-vous utiliser des notifications poussées? Avez-vous déjà des comptes Firebase ou Apple développeurs existants?
  • Quels types de messages enrichis souhaitez-vous configurer? Quels sont les cas d’utilisation où vous pouvez tirer parti de ces messages interactifs?
  • Souhaitez-vous suivre les données des utilisateurs? Comment pouvez-vous utiliser les événements visiteur pour produire des analyses?

Termes Clés

Terme Détails
Fil de discussion Une conversation au sein de l'application de clavardage. Le premier message envoyé par l'agent ou le contactClosed La personne qui interagit avec un agent, un SRVI ou un robot dans votre centre d’appels. commence un fil de discussion. Chaque message consécutif dans la conversation est ajouté au fil de discussion. Les fils de discussion 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 au sein d'une conversation possèdent un ID de message. Un fil de discussion se termine lorsque la conversation se termine.
Fil unique Une conception d'application où le contact ne peut avoir qu'une seule conversation à la fois.
Canal de messagerie (multifils) Un canal asynchrone où un client peut tenir plusieurs conversations de longue durée à la fois. Le SDK expose ici getThreadList(), la dénomination des fils de discussion et l'archivage.
Canal Dans le contexte de Digital Experience (DX), canal désigne le type de messagerie ou la plateforme utilisée pour la communication. Par exemple, vous pourriez avoir un canal de messagerie WhatsApp en temps réel. Le SDK mobile vous permet d'ajouter un canal de messagerie de clavardage à votre application mobile. Un canal est créé dans la plateforme NiCE CXone. Cela détermine les paramètres du canal ainsi que l'ID du canal. Vous utilisez cet ID pour initier le canal de clavardage lorsqu'un utilisateur de l'application ouvre le clavardage.
ChannelId L'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 de contact Digital > Clavardage > Initialisation & Test).
BrandId Ceci est comme un ID de tenantClosed Regroupement organisationnel de haut niveau utilisé pour gérer le soutien technique, la facturation et les paramètres globaux de votre système NiCE CXone. pour Digital Experience (DX). Il est utilisé pour initialiser le clavardage. Vous pouvez le trouver dans les paramètres du canal de clavardage dans NiCE CXone (ACD > Digital > Points de contact Digital > Clavardage > Initialisation & Test).
CustomerId L'id unique de l'utilisateur final du clavardage. Le SDK crée cet ID lorsque le clavardage est initialisé. Si vous avez OAuth configuré, cet ID reste le même pour chaque contact sur tous ses appareils. Si vous n'avez pas OAuth configuré, cet ID est différent pour chaque appareil; l'ID devient comme une connexion invité.
Région ou Environnement L'emplacement dans le monde où votre déploiement NiCE CXone 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 où votre système NiCE CXone est hébergé, sinon la connexion de clavardage est rejetée.
Contact, Client et utilisateur Ces termes font tous référence à 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 êtes susceptible de voir les termes client et utilisateur.
NiCE CXone La plateforme centrale où vous gérez et accédez à tous les outils d'expérience client qu'offre NiCE CXone. Selon les fonctionnalités de clavardage que vous souhaitez offrir 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.
Marque Votre entreprise ou compte dans CXone, identifié par un ID de marque numérique. Toute la configuration de clavardage se trouve sous une marque.
Canal Livechat (session unique) Une session synchrone, acheminée par un agent. Le clavardage 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.
Fil de discussion Une conversation au sein d'un canal, identifiée par un id du fil. Elle contient l'historique des messages et constitue votre point d'accès principal pour l'envoi et la réception des messages.
Contact (aussi appelé cas) Une interaction unique acheminée, créée à partir d'un fil — l'unité qu'un agent prend réellement en charge. Un même fil peut donner lieu à 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 fermeture).
Message Un seul élément dans un fil — texte, pièce jointe ou contenu enrichi — rédigé par le client ou un agent.
Agent Une personne (ou un robot) du côté de CXone qui prend en charge le contact. L'attribution de l'agent et la frappe apparaissent sous forme d'événements.
Visiteur / visite Des identifiants d'analyse légers pour la personne qui navigue (identifiant du visiteur) et sa session de navigation actuelle (identifiant de la visite). Ils sont générés automatiquement pour vous si vous ne les fournissez pas et sont principalement utilisés pour le clavardage proactif et l'analyse.