Mobile SDK

Supported Operating Systems:
  • Android v7 ou version ultérieure, écrit en Kotlin v2.x ou version ultérieure
  • iOS v15.0 ou version ultérieure, écrit en Swift
  • Les frameworks Hybride ne sont pas pris en charge
Current Version:
API References:

Pour vous aider à vous lancer dans l’implémentation du SDK mobile, vous devez acheter le package 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 également acheter des heures de Services Professionnel auprès de NiCE pour les questions qui se situent 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 de dialoguer avec les agents et les bots de votre centre de contact via les canaux de chat digitalClosed Tout canal, contact ou compétence associé à 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, telles que 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 requiert une version minimum Android de 7.0 et une version minimum iOS de 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émo Ce lien s'ouvre dans une nouvelle fenêtre..

Ressources du SDK

Télécharger les emballages SDK depuis les dépôts GitHub publics (Android Ce lien ouvre une nouvelle fenêtre iOS Ce lien ouvre 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 This link opens in a new window plateformes. Cela permet aux développeurs de disposer d’exemples de fonctionnalités implémentées.

Mobile SDK Gestion des versions

Les versions du SDK sont généralement mises à jour en même temps que les NiCE CXone principales versions marketing, comme 25.4, 26.1, et ainsi de suite. Dans GitHub, chaque version de version est étiquetée selon la gestion sémantique des versions expliquée ci-dessous.

Vous êtes responsable de la mise à jour de votre application au fur et à mesure que le SDK est également mis à 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 plus, l'erreur sdkVersionNotSupported vous indique que votre version de SDK est obsolète et que vous devez la mettre à jour.

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

NiCE prend en charge la version majeure actuelle ainsi que la version majeure précédente du SDK. Par exemple, si la version actuelle est 2.2, NiCE prend en charge les versions 2.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 indique une modification non critique. Souvent, les nouvelles fonctionnalités sont ajoutées sous forme de modifications non critiques.

  • 2.0.1 : Le troisième chiffre indique une correction de bug. Celles-ci sont toujours Compatible avec les versions antérieures.

Corrections de bugs

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

Par ailleurs, tout bogue est corrigé dans les versions actuellement prises en charge. Par exemple, si la version actuelle est la version 3.0, les deux versions prises en charge sont alors la version 3.0 et la version 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 Mobile SDK s'intègre dans Digital Experience (DX)

Le Mobile SDK est un moyen d'étendre Digital Experience (DX) et de fournir un clavardage numérique dans les applications mobiles. Digital Experience (DX) est la partie de NiCE CXone qui prend en charge digital channels. Les exemples de digital channels sont WhatsApp, les publications sur Facebook ou le clavardage numérique. Pour ajouter 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. Celles-ci vous offrent diverses options pour optimiser 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 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, tel que :

L'application exemple Mobile SDK présente l'interface utilisateur/expérience utilisateur (UI/UX) par défaut. La documentation du Module UI/UX se trouve dans le Module lui-même, à l'intention de vos développeurs qui peuvent la consulter.

Personnalisation des couleurs

Vous pouvez choisir les couleurs de 33 parties différentes de l'interface utilisateur du 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 ne fournit pas de soutien pour celle-ci.

De même, vous pourriez vouloir 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 afin de 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.

AI Étiquettes de l'Assistant dans Mobile SDK

Pour se conformer aux réglementations mondiales en matière de transparence des AI (telles que l'EU AI Act), le CXone Mobile SDK 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 robots ou des systèmes automatisés affichent une étiquette « Assistant AI » dans l'interface de chat.

Caractéristiques clé

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

  • Conception axée sur la conformité : si le système ne parvient 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 afin de 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 via les paramètres de localisation.

Conditions préalables

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

  • Fonctionnalité : featureAiGeneratedMessageFlag doit être activé pour votre locataire. Contactez 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 des termes Alternative 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 (Data Transfer Object) du message.

  • Propriété : isAiGenerated

  • Type : Booléen

  • Comportement : si la valeur est vraie, l'interface utilisateur doit afficher l'indicateur d'auteur AI. Si la bascule de fonctionnalité est désactivée, cette propriété est omise de la charge utile du Message afin d'éviter tout impact sur le code personnalisé existant.

Mobile SDK

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 toute question relative à la configuration en dehors de 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 frameworks non natifs ou hybrides ne sont pas pris en charge, tels que React Native.

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

  • Le Mobile SDK met en cache les informations de canal pendant 5 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.

Avant de Démarrer le 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 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 ?
  • Allez-vous utiliser OAuth pour authentifier les utilisateurs de votre application ? Si oui, quel fournisseur OAuth allez-vous utiliser ?
  • Souhaitez-vous faire l'offre de 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 ?

Mots-clés

Terme Détails
Thread Une conversation au sein de l'application de chat. 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. 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 d'application selon laquelle le contact ne peut avoir qu'une seule conversation à la fois.
Canal de messagerie (multi-thread) Canal asynchrone dans lequel un client peut tenir plusieurs conversations durables à la fois. Le SDK expose ici getThreadList(), la dénomination des threads 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 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.
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 of Contact Digital > Chat > Initialization & Test).
BrandId Il s'agit d'un identifiant similaire à un locataireClosed 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). Cela est utilisé pour initialiser le chat. Vous trouverez cela dans les paramètres du canal de chat dans NiCE CXone (ACD > Digital > Points of Contact Digital > Chat > Initialization & Test).
CustomerId L'id unique de l'utilisateur final du chat. Le SDK crée cet ID lorsque le chat 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 configuré OAuth, cet ID est différent pour chaque appareil ; l'ID devient alors comme une connexion invité.
Région ou Environnement 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 Utilisateur Ces 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 CXone La plateforme centrale où vous gérez et accédez à tous les outils d'expérience client proposés par 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.
Marque Votre entreprise/compte dans CXone, identifié par un ID de marque numérique. Toute la configuration du chat se trouve sous une marque.
Canal Livechat (session unique) Il s'agit d'une session synchrone, acheminée vers un 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 renvoie un LivechatThread pour ces canaux.
Thread Une conversation au sein d'un canal, identifiée par un id du fil. Elle contient l'historique des messages et constitue votre principal moyen d'envoyer et de recevoir des messages.
Contact (alias cas) Une interaction acheminée unique créée à partir d'un fil de discussion — l'unité qu'un agent prend réellement en charge et traite. Un même fil de discussion peut générer plusieurs contacts au cours de son cycle de vie (par exemple, un nouveau contact chaque fois que le client reprend contact après une clôture).
Message Un seul élément d'un fil de discussion — texte, pièce jointe ou contenu enrichi — rédigé par le client ou un Agent.
Agent Un humain (ou un bot) du côté de CXone qui traite le contact. L'affectation de l'Agent et la frappe apparaissent sous forme d'événements.
Visiteur / visite Identifiants analytiques légers pour la personne qui navigue (identifiant du visiteur) et sa session de navigation actuelle (visitId). Ils sont générés pour vous si vous ne les fournissez pas et sont principalement importants pour le chat proactif et l'analytique.