Personnaliser les canaux de chat avec JavaScript

Vous pouvez personnaliser live chatClosed Agents and contacts interact on a real-time basis. et chat messagingClosed Asynchronous chat in which contacts send a chat message anytime and wait for a reply. avec JavaScript. NiCE CXone fournit des personnalisations par défaut et leurs Appels API correspondants JavaScript. Vous devez inclure ces Appels API dans la balise de script qui ajoute le chat à votre site Web. Pour ajouter ces fonctionnalités, vous devez avoir accès au code de votre site Web. Cette page explique où ajouter le code JavaScript et les lignes de code exactes à inclure. Vous devez également être familiarisé avec JavaScript ou le développement Web pour utiliser en toute confiance les informations contenues dans cette page.

Vous pouvez personnaliser les aspects suivants de vos canauxClosed Various voice and digital communication mediums that facilitate customer interactions in a contact center. de chat :

Actuellement, toutes les API JavaScript prennent en charge un chargeur Brand Embassy pour chaque appel. Si vous utilisez le chat NiCE CXone sur votre site Web, tous ces appels prennent également en charge un nouveau chargeur NiCE CXone. À terme, toutes les API JavaScript pour le chat utiliseront le chargeur NiCE CXone au lieu de Brand Embassy.

La structure de l’appel JavaScript peut varier selon le chargeur utilisé. Vous ne pouvez pas afficher les deux structures en même temps. Utilisez Uniquement l’une ou l’autre selon le chargeur utilisé.

Si vous utilisez NiCE CXone Guide pour implémenter le chat sur votre site Web, utilisez le chargeur NiCE CXone. Tous les appels de cette Page ne sont pas pris en charge dans Guide, mais la documentation Guide répertorie tous les appels JavaScript pris en charge.

Si vous utilisez le chargeur NiCE CXone, que ce soit dans le cadre du chat numérique ou de Guide, structurez les appels de la façon suivante :

cxone('chat','enableChatAlwaysOnline');

Si vous utilisez Guide pour mettre en œuvre le chat, vous devez également structurer les extraits de lancement par défaut comme suit :

cxone('guide','init');

Si vous utilisez le chargeur Brand Embassy, structurez les appels comme suit (true/false est en option) :

brandembassy('enableChatAlwaysOnline',true);

Ajouter des Appels JavaScript à un Canal de chat

Si vous ne l'avez pas encore fait, configurez un chat en direct ou un canal de messagerie par chat. Testez le canal pour vous assurer qu'il fonctionne avec les paramètres par défaut avant d'ajouter des personnalisations. Configurez les personnalisations de chat dans un environnement de test avant de les publier dans votre environnement de production. Cela aidera à minimiser les perturbations pour les visiteurs de votre site Web. Cela vous aidera également à vous assurer que vos personnalisations fonctionnent comme prévu.

Copiez le script et les appels d'API exactement comme indiqué. Tout changement inattendu pourrait entraîner un dysfonctionnement de votre chaîne.

  1. Cliquez sur le sélecteur d'application icon of app selector et sélectionnez ACD.
  2. Accédez à Digital > Points de Contact Digital.

  3. Dans la section Vos canaux, cliquez sur script du site Web.
  4. Copiez le code JavaScript de la page et collez-le dans un programme d'édition de texte tel que Notepad++. Veillez à inclure les balises d'ouverture et de fermeture <script>.
  5. Dans Notepad++, juste au-dessus de la balise fermante </script> du code que vous avez collé, ajoutez les appels JavaScript que vous souhaitez utiliser. Dans l'illustration suivante, le commentaire indique où ajouter des appels. Les appels pris en charge que vous pouvez utiliser sont décrits dans le reste de cette page.

  6. Copiez et collez l'intégralité du script, y compris les balises <script> d'ouverture et de fermeture, dans l'en-tête d'une page de votre site Web.

  7. Ouvrez la page modifiée et envoyez des messages de chat de test pour vous assurer que vos personnalisations fonctionnent comme prévu.

  8. Une fois qu'elles ont été testées et fonctionnent comme prévu, copiez le script final dans l'en-tête de chaque page devant comporter le widget de chat.

Comportement du chat JavaScript Appels

Les appels de cette section vous permettent de modifier le comportement des fenêtres de discussion.

Ouvrir la fenêtre de conversation

Ouvre une fenêtre de discussion automatiquement. Le comportement par défaut est que les fenêtres de discussion s'ouvrent lorsqu'un contact clique sur l'icône de discussion.


cxone('chat', 'openChatWindow');

Fermer la fenêtre de conversation

Ferme la fenêtre de chat automatiquement. Le comportement par défaut est que les fenêtres de chat se ferment lorsqu'un contact clique sur l'icône de chat.


cxone('chat', 'hideChatWindow');

Terminer une session de Chat en direct de manière programmatique

La fermeture de la fenêtre de chat avec hideChatWindow ne fait que la masquer. La session reste active et reprend lorsque le contactClosed The person interacting with an agent, IVR, or bot in your contact center. rouvre le chat ou recharge la page.

Utilisez plutôt endContact lorsque votre site web doit mettre fin à la session lui-même. Par exemple, lorsqu'un contact se déconnecte de votre site ou accède à une Page où le clavardage ne devrait plus être disponible. L'appel endContact met fin à l'interaction active de la même manière que lorsque le contact clique sur Quitter la conversation dans la fenêtre de clavardage. une fois la session de clavardage terminée, la fenêtre de clavardage ne rejoint pas cette session, même si le contact recharge la Page. La session de clavardage suivante démarre uniquement lorsque le contact ou votre site web en lance une, par exemple avec autoStartSession.

La fermeture est confirmée de manière asynchrone par la mise à jour push CaseStatusChanged, à laquelle vous pouvez vous abonner avec onPushUpdate. Lorsqu'une interaction est fermée, le data.case.status de l'événement est closed :


cxone('chat', 'onPushUpdate', ['CaseStatusChanged'], (event) => {
  if (event.data.case.status === 'closed' {
	//the interaction has ended
	}
  });

Cet appel fonctionne uniquement avec live chatClosed Agents and contacts interact on a real-time basis.. . Sur un canal chat messagingClosed Asynchronous chat in which contacts send a chat message anytime and wait for a reply., l'appel provoque une erreur. L'appel provoque également une erreur s'il est appelé avant l'initialisation du chat ou s'il n'y a aucune interaction ouverte ou en file d'attente à terminer.


cxone('chat', 'endContact');

Chat toujours En ligne

Affiche la fenêtre de chat comme si des agents étaient disponibles, y compris lorsqu'aucun agent n'est en ligne.


cxone('chat','enableChatAlwaysOnline');

Persistance des Champs personnalisés du chat précédent

Vous pouvez choisir si les champs personnalisés doivent être persistants ou supprimés définitivement du stockage local une fois l’interaction en cours. Cela permet de sélectionner les champs personnalisés qui continuent à s’afficher lors de chaque interaction avec un contact. Le 'field_id' fait référence à la valeur de Ident champ lorsque vous créez un champ personnalisé.

cxone('chat','enablePrecontactSurveyFieldAutoFill'('field id');

Envoyer les données de postback à partir des cartes adaptatives

Studio actions et bots peuvent envoyer des cartes adaptatives aux contacts via le chat. Pour que le chat numérique envoie des données postback à Studio ou un robot, vous devez activer un gestionnaire. Un gestionnaire de Carte adaptative fonctionne au sein du bot ou de l'action Studio pour gérer et répondre aux interactions avec les Cartes adaptatives. Le gestionnaire s'active lorsqu'un utilisateur interagit avec des composants d'une Adaptive Card, par exemple en cliquant sur un bouton ou en sélectionnant une option dans un menu déroulant. Le gestionnaire déchiffre l’entrée de l’utilisateur et détermine la réponse la mieux adaptée ou l’action à exécuter. Ajoutez la commande du gestionnaire par défaut et la commande envoyer le message, afin que Studio ou les bots puissent répondre en conséquence ou stocker les données de la carte Adaptive Card à des fins de création de rapports. Vous pouvez également remplacer le gestionnaire par défaut par une commande de gestionnaire personnalisé.

Ajouter la commande de gestionnaire de carte adaptative par défaut :


adaptiveCardOnExecuteAction(actionId: string, callback: (action: node_modules/adaptivecards/src/card-elements.ts::Action) => void)

Commande envoyer le message :


 sendMessage(messageContent: MessageContent)

Créer une commande de gestionnaire personnalisé :


{
	"acType": "Action.Execute", // type of action Action.Execute or Action.Submit
	"acVerb": "null|string", // only if `verb` is provided in the Action
	"acActionId": "null|string" // only if id is provided in the Action
	"acData": { // `data` are provided in Action
		"firstName": "Ichabod",
		"lastName": "Crane",
		"_messageText": "Did you fall asleep again?"
	}
}

Définir le code d'autorisation ou le jeton d'accès

Définit l'identifiant pour l'authentification tierce OAuth. Utilisez setAuthorizationCode pour le flux de code d'autorisation, avec un vérificateur de code Proof Key for Code Exchange (PKCE) en option. Utilisez setAccessToken pour le flux implicite lorsque votre site Web possède déjà un jeton d'accès.

OAuth est un protocole d'authentification. Il vous permet de faire interagir une {application} avec une autre en votre nom sans exposer les mots DE passe. Pour utiliser l'authentification OAuth :

  • Passez l'appel avant l'initialisation du chat. Les Appels effectués après l'initialisation sont rejetés.
  • Utilisez uniquement le code d'autorisation ou le jeton d'accès, mais pas les deux. Le deuxième appel est rejeté.
  • Le vérificateur de code PKCE est en option. Si vous en transmettez un, il doit s'agir d'une chaîne non vide et vous devez l'envoyer avec le code d'autorisation pour lequel il a été généré. Vous ne pouvez pas l'utiliser seul.
  • Le jeton d'accès doit être une chaîne non vide. Il s'agit d'un identifiant de support (bearer) actif, et non d'un code à usage unique. NiCE CXone le vérifie auprès de votre fournisseur OAuth chaque fois que le contact envoie un Message, de sorte que les Messages échouent après l'expiration du jeton. La fenêtre de chat ne peut pas actualiser un jeton d'accès expiré et ne peut pas en accepter un nouveau après l'initialisation. Fournissez un jeton qui reste valide pendant la durée prévue du chat. Après un rechargement de la Page, fournissez un nouveau jeton avant de procéder à une nouvelle initialisation.
  • Aucune des deux valeurs n'est écrite dans le stockage du navigateur. Les deux sont masquées dans les journaux de la fenêtre de chat.

Pour utiliser un flux de code d'autorisation :

cxone('chat', 'setAuthorizationCode', 'AUTHORIZATION_CODE');

Pour utiliser un flux de code d'autorisation avec PKCE, transmettez également le vérificateur de code :

cxone('chat', 'setAuthorizationCode', 'AUTHORIZATION_CODE', 'CODE_VERIFIER');

Pour utiliser un flux implicite, où votre site Web dispose déjà d'un jeton d'accès :

cxone('chat', 'setAccessToken', 'ACCESS_TOKEN');

Définir les Champs préremplis du Sondage précontact

Allows previously-entered custom field values to appear as an auto-fill option in later fields or interactions. Specific IDs inform the chat window which custom field values to save. When a contact begins a new conversation, these custom fields from previous conversations are automatically available. This helps save time if a contact needs to enter the same information in a new chat session that they've entered in a previous chat session, such as an email address. If there are multiple fields you want to appear as autofill options, include them all in the same API call.

cxone('chat', 'setPrecontactSurveyPrefilledFields', ['fieldIdent1', 'fieldIdent2']);

Démarrage automatique d'une nouvelle Session de clavardage

Crée une nouvelle session de messagerie instantanéeClosed Asynchronous chat in which contacts send a chat message anytime and wait for a reply. ou de chat en directClosed Agents and contacts interact on a real-time basis. si aucune n'est actuellement en cours. Utilisez cet appel sur les pages à faible trafic de votre site Web pour éviter de submerger vos agents de contacts.

Digital Experience (DX) crée un nouveau cas et l'ajoute à la file d'attente lorsque le premier message de la session de chat est envoyé. Un message masqué et automatisé est envoyé au nom du client lorsque la session de chat démarre. Cela réduit le temps d'attente des contacts pour un agent en démarrant le processus plus tôt. Les sessions de chat démarrent lorsqu'un contact clique sur l'icône de chat pour commencer une conversation ou lorsque la fenêtre de chat s'ouvre pour les sessions de chat démarrées automatiquement. Bien que le message initial soit caché au client, l'agent peut le voir.

Vous pouvez personnaliser le texte du message initial masqué.

Auto-starting a chat session skips the precontact survey form. Because of this, you need to use other methods to collect information about contacts. For example, you can have agents enter the information manually into the customer card. You can also configure customer authentication using an OAuth integration.

Routing pour les cas démarrés automatiquement se produit selon les files d’attente de routageClosed Determine which agents to route digital cases to, using criteria such as the agent having expertise in that type of case. configuré dans Digital Experience (DX). Pour les sessions de chat en direct, si aucun agent n'est disponible, la fenêtre de chat affiche un message En attente d'un agent disponible.

Pour démarrer automatiquement une session de chat, utilisez ces appels dans l'ordre indiqué :


cxone('chat', 'openChatWindow');

cxone('chat', 'autoStartSession');

Si vous ajoutez des appels supplémentaires au script, autoStartSession doit toujours être le dernier appel du script. Par exemple :


// set customer name (as this is required field)
cxone('chat', 'setCustomerName', 'Elizabeth');

// open chat window so user can start to chat
cxone('chat', 'openChatWindow');

// and finally start the new chat session (without the pre-chat form)
cxone('chat', 'autoStartSession');

Activation de sessions de chat concurrentes

Vous pouvez autoriser les contacts à ouvrir plusieurs sessions de chat dans le même navigateur. Si un contact est déjà dans un clavardage actif dans un onglet de navigateur, il peut démarrer un deuxième clavardage dans un nouvel onglet ou une nouvelle fenêtre de navigateur.

Précisez comment les données de chat sont stockées en utilisant l'une des options suivantes :

  • local : les données persistent dans le navigateur après la fermeture de l'onglet ou de la fenêtre. Il s’agit de la méthode de stockage par défaut. Si plusieurs sessions de chat (Multiple Sessions) sont ouvertes simultanément dans différents onglets, elles sont toutes considérées comme la même interaction. L'expérience et la conversation de chat sont les mêmes sur tous les onglets.

  • session : les données sont stockées pour chaque onglet ou fenêtre individuel et sont effacées à la fermeture de l'onglet ou de la fenêtre. Cela permet aux utilisateurs de démarrer plusieurs sessions de clavardage dans différents onglets ou fenêtres. Chaque session de clavardage est traitée comme une interaction distincte.

  • inMemory : sessionId et customerId ne sont utilisés que dans la mémoire de l'application de chat. Les données ne persistent pas dans le navigateur. L'actualisation du navigateur supprime tout l'historique. Cela permet d'avoir plusieurs sessions de chat simultanées lorsqu'elles sont ouvertes dans plusieurs onglets ou fenêtres de navigateur.

Pour activer les séances de chat simultanées, ajoutez la clé storageType avec une valeur de session ou inMemory.

Si vous utilisez storageType: 'local' et que vous souhaitez tout de même éliminer l'historique de conversation, vous pouvez créer un écouteur d'événements qui supprime customerId après la fin du chat.


cxone('chat', 
	'init',
	'MY_BRAND_ID_123',
	'MY_CHANNEL_ID_321',
	undefined,
	{
		storageType: 'session',
	},
);

Éliminer l'historique des conversations

Supprime l'historique de la conversation à la fin d'une session de chat. Cela peut être utile si vous utilisez l’option par défaut de stockage du chat, à savoir le stockage local. Cette option de stockage conserve les données après la fermeture des instances du navigateur. Dans ce cas, vous pouvez spécifiquement supprimer l'historique des conversations en effaçant les customerID du stockage local. L'exemple suivant crée un écouteur d'événements pour écouter l'événement caseStatusChanged provenant du chat. Il indique que la session de chat est terminée. Ensuite, la commande removeItem est appelée, laquelle supprime customerID du stockage local du navigateur.


cxone('chat', 'onPushUpdate', ['CaseStatusChanged'], pushUpdatePayload => { 
	if (typeof pushUpdatePayload === 'undefined' || typeof pushUpdatePayload.data === 'undefined') { 
		return; 
	}  
	const { status } = pushUpdatePayload.data.case || {};   
	if (typeof status === 'undefined') { 
		return; 
	}   
	// When a previous case has been closed, this will set the custom fields again. 
	if (status === 'closed') { 
		localStorage.removeItem('_BECustomerID');  
	} 
}); 

Personnaliser le message de contact automatisé initial

Digital Experience (DX) crée un nouveau cas et l'ajoute à la file d'attente lorsque le premier message de la session de chat est envoyé. Un message masqué et automatisé est envoyé au nom du client lorsque la session de chat démarre. Cela réduit le temps d'attente des contacts pour un agent en démarrant le processus plus tôt. Les sessions de chat démarrent lorsqu'un contact clique sur l'icône de chat pour commencer une conversation ou lorsque la fenêtre de chat s'ouvre pour les sessions de chat démarrées automatiquement. Bien que le message initial soit caché au client, l'agent peut le voir.

Le message par défaut est le texte figurant sur le bouton sur lequel le client clique pour démarrer la conversation. Vous pouvez personnaliser le texte du message initial automatisé de trois manières :

  • Remplacez le texte du bouton par défaut.

cxone('chat', 'sendFirstMessageAutomatically', 'Hello');
  • Modifiez le message initial de manière dynamique.

cxone('chat', 'setFirstAutomatedMessageContent', 'Hello, I have a question');

Rendre le message automatisé initial visible pour les contacts

Si vous souhaitez que le contact puisse voir le message automatisé initial, ajoutez cet appel à votre script :


cxone('chat', 'hideFirstSentMessage', false);

Délai de création de cas

Digital Experience (DX) crée un nouveau cas et l'ajoute à la file d'attente lorsque le premier message de la session de chat est envoyé. Un message masqué et automatisé est envoyé au nom du client lorsque la session de chat démarre. Cela réduit le temps d'attente des contacts pour un agent en démarrant le processus plus tôt. Les sessions de chat démarrent lorsqu'un contact clique sur l'icône de chat pour commencer une conversation ou lorsque la fenêtre de chat s'ouvre pour les sessions de chat démarrées automatiquement. Bien que le message initial soit caché au client, l'agent peut le voir.

Vous pouvez configurer Digital Experience (DX) pour attendre le premier message réel du contact avant de créer une requête à l'aide de cet appel :


cxone('chat', 'sendFirstMessageAutomatically', false);

Activer le mode jeu

Permet aux contacts de jouer au jeu Snake en attendant un Agent.


cxone('chat', 'allowGameMode');

Sondage de satisfaction automatisé

Une enquête de satisfaction peut être automatiquement détectée et affichée dans une fenêtre contextuelle. Cela permet de contrôler l'automatisation des enquêtes de satisfaction.


cxone('chat', 'automatedSatisfactionSurveyModal', true);
cxone('chat', 'automatedSatisfactionSurveyModal', false);
//if not defined, the default is true

Informations de chat JavaScript Appels

Ces appels vous permettent de personnaliser les informations disponibles pour les contacts lors d'une session de chat.

Obtenir l'ID d'identité Client

Renvoie l'identificateur unique du client dans le chat.


cxone('chat', 'getCustomerIdentityId');

Masquer le formulaire de Sondage précontact

Le formulaire d'enquête avant contact apparaît au début d'une session de chatClosed Asynchronous chat in which contacts send a chat message anytime and wait for a reply.. Il collecte des informations sur le contact, telles que son nom. Si vous le souhaitez, vous pouvez masquer le formulaire d'enquête avant contact et faire apparaître la fenêtre de chat dès qu'un contact démarre une session de chat.


cxone('chat', 'hidePreSurvey');

Masquer le Nombre de contacts en attente

Le nombre de contacts en attente permet à un contact de savoir dans combien de temps un agent pourra l'aider, selon sa position dans la file d'attente de l'agent. Vous pouvez masquer le compteur de file d'attente dès que le contact a été transféré à un agent. Cela permet aux agents de supprimer des cartes clients de leur boîte de réception sans que les contacts s'en aperçoivent.


cxone('chat', 'hideQueueCounterAfterAssignment');
cxone('chat', 'hideAssignedAgent');
cxone('chat', 'hideSystemMessages');

Muet audio de notification de chat

Permet de désactiver le son de notification du chat. Le son de notification du chat est activé par défaut. Cela doit être configuré indépendamment des autres paramètres de son du chat. Vous pouvez modifier la valeur à false pour réactiver l'audio de notification du chat.


cxone('chat', 'muteAudioNotification', true);
// OR
cxone('chat', 'muteAudioNotification');

Ignorer la Langue du navigateur pour les traductions

Remplace les paramètres de langue du navigateur de l'utilisateur ou un locale personnalisé par une traduction définie. Par exemple, vous pouvez vous assurer qu'un certain texte s'affiche toujours en anglais, indépendamment des paramètres de langue du navigateur d'un contact.


cxone('guide', 'init', 'brandId', 123, 'locale');

Définir l'État de l'activité

Modifie le message dans la barre d'activité. Par exemple, vous pouvez l'utiliser pour communiquer votre temps de réponse pour une session de messagerie instantanée.Cela peut être utile car la messagerie instantanée est une forme de discussion asynchrone, de sorte que les contacts peuvent devoir attendre d'avoir des nouvelles d'un agent.


cxone('chat', 'setStatusMessage', 'We typically reply within 3 hours.');

Définir l'image de l'Agent

Modifie dynamiquement l'image de l'agent affichée dans la fenêtre de discussion. Par défaut, Digital Experience (DX) utilise l'image présente dans le profil de l'agent.Lorsque vous incluez cet appel dans votre script, il utilise l'image spécifiée par l'URL dans l'extrait de code. Remplacez l'exemple d'URL par l'URL de l'image que vous souhaitez que le chat utilise.


cxone('chat', 'setAgentImage', 'http://classics.com/images/agents/elizabeth_bennet.png');

Définir l'Id client

Définit un identificateur unique pour le client participant au chat.


cxone('chat', 'setCustomerId', 'customer_id');

Définir le Nom du client

Nom du client est un champ du formulaire de sondage précédant le contact, que les contacts doivent remplir avant de dialoguer avec un agent sur un canal chat messagingClosed Asynchronous chat in which contacts send a chat message anytime and wait for a reply.. Cet appel remplit dynamiquement le champ.


cxone('chat', 'setCustomerName', 'Elizabeth');

Définir le Format de date

Peut être défini de façon à utiliser un format de date absolue (03/12/2035) ou relatif (aujourd'hui, Lundi).


cxone('chat', 'setDateFormat', 'date_format');
// date_format can be 'absolute' or 'relative'

Définir les paramètres régionaux

Définit les paramètres régionaux pour les traductions dans la fenêtre de chat.


cxone('chat', 'setLocale', 'locale');

Afficher les Informations sur le cas

Uniquement pour les canaux chat messagingClosed Asynchronous chat in which contacts send a chat message anytime and wait for a reply.. Affiche les informations sur le cas au contact.


cxone('chat', 'showCaseInfo');

Afficher/Masquer le bouton Envoyer la transcription

Si vous rendez le bouton Envoyer transcription visible, vous devez configurer le canal de chat pour permettre aux contacts de s'envoyer la transcription du chat à eux-mêmes.Configurez cette option pour la messagerie instantanée ou le chat en direct.


cxone('chat', 'hideSendTranscript');
cxone('chat', 'showSendTranscript');

Afficher/Masquer les messages Système

Affiche ou masque les messages système, tels que l'historique d'affectation d'un agent.


cxone('chat','hideSystemMessages');
cxone('chat', 'showSystemMessages');

Conditions d'utilisation

Vous pouvez mettre un document de conditions d'utilisation à la disposition des contacts depuis la fenêtre de discussion. Cette fonction ajoute un bouton à la fenêtre.Vous pouvez personnaliser l'étiquette et le style du bouton, ainsi que ce qui se passe lorsque les contacts cliquent dessus. L'action au clic peut afficher les conditions d'utilisation comme :

  • Une fenêtre interne
  • Un lien externe

// Internal Modal Window
cxone('chat', 'showTermsOfUse', 'Show terms of Use', 'modal' , 'Our terms of use are ...');

// External Link
cxone('chat', 'showTermsOfUse', 'Show terms of Use', 'externalLink' , 'http://yourdomain.com/terms-of-use');

// If you want to explicitly disable this feature, you can use
cxone('chat', 'hideTermsOfUse');

Pour personnaliser l'aspect du bouton ou de la fenêtre interne, utilisez les appels d'API CSS décrits sur cette page.

Champs personnalisés, Étiquettes et Phrases

Créer et Remplir des Champs personnalisés

Avant d'utiliser les appels d'API de champ personnalisé ci-dessous, vous devez d'abord créer le champ personnalisé dans NiCE CXone. Créez le champ personnalisé pour un Customer Card ou un Contact, selon le type de champ personnalisé que vous souhaitez remplir via l'API.

La valeur ident que vous attribuez au champ personnalisé lors de sa création est la même valeur que vous référencerez dans l'Appel API. Si le champ personnalisé n'existe pas dans la plateforme, l'Appel API n'aura aucun effet.

Pour obtenir des instructions étape par étape sur la création de champs personnalisés, consultez Gérer les Champs personnalisés.

Utilisez l'API JavaScript CXone Digital Chat pour capturer des données depuis votre page web et les stocker en tant que valeur de champ personnalisé. Cela vous permet de transmettre automatiquement des informations contextuelles, telles que la page sur laquelle se trouve le visiteur, son identifiant de compte, ou toute autre donnée pertinente directement dans NiCE CXone lorsqu'une interaction de chat commence.

Il existe deux méthodes d'API disponibles, selon l'emplacement où vous souhaitez stocker les données du champ personnalisé :

  • setContactCustomField — Stocke la valeur du champ personnalisé sur le Contact, qui représente une seule interaction ou conversation. Utilisez cette option lorsque les données sont spécifiques à cette session de clavardage particulière. Par exemple, l'URL de la page où le clavardage a été initié, un produit sélectionné ou un numéro de référence de formulaire.

    Lorsque vous utilisez setCaseCustomField, il est possible que vous voyiez un avertissement de dépréciation dans la console du navigateur suggérant d'utiliser setContactCustomField à la place.

  • setCustomerCustomField — Enregistre la valeur du champ personnalisé sur Customer Card, qui représente le profil du contact sur l'ensemble des interactions. Utilisez cette fonction lorsque les données sont liées au client lui-même. Par exemple, son ID de compte, son niveau d'adhésion ou sa langue préférée.

Vue d’ensemble de l’implémentation

Le tableau suivant résume les méthodes d'API disponibles pour définir les valeurs de champ personnalisé. Reportez-vous aux exemples de code détaillés sous le tableau pour obtenir des conseils d'implémentation.

example

Méthode API

description

Définir un champ personnalisé de contact uniquesetContactCustomFieldPour renseigner un champ Cas à la fois.
Définir plusieurs champs personnalisés de contact à la foissetContactCustomFieldsMise à jour groupée efficace de plusieurs champs de Case.
Définir un seul champ personnalisé Customer CardsetCustomerCustomFieldPour les champs de profil Customer Card.
Définir plusieurs champs personnalisés Customer Card à la foissetCustomerCustomFieldsMise à jour groupée de plusieurs champs Customer Card.
Exemple d'évaluer statiquesetContactCustomFieldValeur codée en dur, par exemple, 'Contact Us Page'.
Exemple de valeur dynamiquesetContactCustomFieldValeur dynamique, par exemple window.location.href.

Les valeurs des champs personnalisés peuvent être définies de deux manières :

Statistique — La valeur est codée en dur directement dans l'Appel API. Cela est utile lorsque la valeur est toujours la même pour une page donnée, comme l'indication de la page sur laquelle se trouve le widget de chat.

  • Pour définir la valeur du champ personnalisé contact unique

    cxone('chat','setContactCustomField', 'pagesource', 'Contact Us Page');
  • Pour définir la valeur de plus d'un champ personnalisé de contact

    cxone('chat','setContactCustomFields',
       {
       customFieldIdent: 'value',
       secondCustomFieldIdent: 'value'
       } 
       );
     
  • Pour définir la valeur du champ Customer Card unique

    cxone('chat','setCustomerCustomField', 'email', 'leia@starwars.com');
  • Pour définir la valeur de plus qu'un champ Customer Card

    cxone('chat','setCustomerCustomFields',
       {
       customFieldIdent: 'value',
       secondCustomFieldIdent: 'value'
       } 
       );
     
  • Dynamique — La valeur est extraite de la page Web au moment de l'exécution à l'aide de JavaScript. Cela est utile lorsque la valeur varie selon le visiteur ou la session, par exemple pour capturer l'URL de la page actuelle ou l'ID d'un utilisateur connecté.

    cxone('chat','setContactCustomField', 'currentPage', window.location.href);

Si vous utilisez un formulaire précontact pour collecter des informations auprès des visiteurs avant le début du chat, vous n'avez pas besoin d'utiliser ces méthodes API pour capturer les mêmes données. Les champs du formulaire précontact sont automatiquement sauvegardés dans le dossier et la fiche client, comme configuré.

Pour définir la valeur d'un champ personnalisé Customer Card :

cxone('chat','setCustomerCustomField', 'ident_of_custom_field', 'value_of_custom_field');

Les champs personnalisés sont limités à 1024 caractères.

Ajoutez les appels d'API de champ personnalisé au même bloc de script où se trouve le widget Guide est intégré à votre page web. Placez les Appels API juste au-dessus de la balise fermante </script>, après le code d'initialisation du widget. Par exemple :

<script>
   // CXone widget initialization code
   cxone('guide', 'init');
   // Add custom field API calls here
   cxone('chat', 'setCaseCustomField', 'pageSource', 'Contact Us Page');
   cxone('chat', 'setCustomerCustomField', 'accountTier', 'Premium');
   </script>

Pour obtenir des instructions détaillées sur l'intégration du widget et l'emplacement des appels de personnalisation, consultez Personnaliser Guide à l'aide de JavaScript.

Personnaliser les Étiquettes et les expressions de chat

Vous pouvez personnaliser de nombreux libellés et phrases que les canaux chat numériques utilisent, ainsi que définir les personnalisations. Si vous devez modifier dynamiquement les phrases ou les libellés d'écran, utilisez les appels JavaScript suivants.

Pour modifier un seul message ou libellé :


cxone('chat', 'setTranslation', 'key', 'your translation');

Pour modifier plusieurs messages ou libellés :


cxone('chat', 'setTranslations', {
   key1: 'your custom label',
   key2: 'your custom message'
});

Traduire les Champs personnalisés

Vous pouvez traduire les champs personnalisés affichés dans la fenêtre de chat.


cxone('chat', 'setCustomTranslations', {
    myCustomFieldATranslationKey: "Custom field value A",
    myCustomFieldBTranslationKey: "Custom field value B",
});

Appels d'apparence de la fenêtre de chat

Vous pouvez modifier l'apparence de la fenêtre de discussion.

Icône Fermer le chat

Lorsque cette valeur est définie sur vrai, une icône X s'affiche sur la fenêtre à la place de l'option Quitter la conversation dans le menu des paramètres.


cxone('chat', 'enableCloseIcon', true);

Masquer l'Agent assigné


cxone('chat', 'hideAssignedAgent');

Masquer l'en-tête


cxone('chat', 'hideHeader');

Masquer les pop-ups


cxone('chat', 'hidePopups');

Afficher l'avatar du Client


cxone('chat', 'showCustomerAvatar');

Afficher le bouton Envoyer


cxone('chat', 'showSendButton');

Taille

Personnalise la largeur et la hauteur de la fenêtre de discussion. Vous pouvez utiliser des unités absolues ou relatives prises en charge par la spécification CSS.


cxone('chat', 'setWindowWidth', '100%');
cxone('chat', 'setWindowHeight', '100%');

Mode d'affichage plein écran


cxone('chat', 'setFullDisplay');
// OR
cxone('chat', 'setWindowWidth', '100%');
cxone('chat', 'setWindowHeight', '100%');

Position et Décalage

L'setPositionX appel définit le côté gauche ou droit de l'écran comme position de départ. Les appels setOffsetX et setOffsetY définissent respectivement le nombre de pixels de décalage horizontal et vertical de la fenêtre de chat par rapport au point de départ.


// set horizontal starting position
cxone('chat', 'setPositionX', 'right');
													
// set horizontal and vertical offset
cxone('chat', 'setOffsetX', '40'); // default = 20
cxone('chat', 'setOffsetY', '40'); // default = 20

Définir la Limite de caractères pour la boîte de réponse


cxone('chat', 'setReplyBoxLimit', '280'); // default = null

CSS personnalisé avec sélecteurs de données

Vous pouvez personnaliser l'apparence de la fenêtre de chat en ajoutant votre propre CSS. Préciser la partie de la fenêtre de chat que vous souhaitez styliser à l'aide d'un attribut data-selector. La liste déroulante ci-dessous contient la liste de tous les composants que vous pouvez sélectionner avec l'attribut data-selector. Les sélecteurs de données vous permettent de spécifier la partie de la fenêtre de discussion à laquelle vous souhaitez appliquer le CSS personnalisé. Après le data-selector, ajoutez votre style entre accolades. Si vous souhaitez appliquer un style à plusieurs éléments, vous devez ajouter tous vos calques CSS dans un seul appel JavaScript. Si vous utilisez le même appel JavaScript plusieurs fois, le dernier appel JavaScript remplace tous les calques CSS précédents. Vous pouvez également personnaliser le CSS du chat directement dans NiCE CXone.

Pour ajouter du code CSS personnalisé avec des sélecteurs de données, utilisez cet appel JavaScript comme référence :

cxone('chat', 'setCustomCss', '[data-selector="CUSTOMER_MESSAGE_BUBBLE"] {color: white !important; background: black !important} 
[data-selector="CONTENT"] {background: green !important}`);

Les sections suivantes contiennent les sélecteurs de données disponibles.

Core Conteneurs et Disposition

  • MESSAGER
  • L'ONGLET
  • File d’attente DE FENÊTRE
  • TENEUR
  • SCROLL_BOX_WRAPPER
  • Faire défiler le contenu du cadre
  • BOUTON faire défiler VERS LE BAS
  • FAIRE_DÉFILER_VERS_LE_BAS_BADGE_NON_LU

En-tête et navigation

  • ENTÊTE
  • GROUP_CHAT_HEADER_Icône
  • HEADER_ACTION_MENU_BUTTON
  • RÉDUIRE LA FENÊTRE
  • MENU_DÉROULANT
  • Retour à la conversation

Messages

  • CUSTOMER_MESSAGE
  • AGENT_MESSAGE
  • CUSTOMER_MESSAGE_BUBBLE
  • AGENT_MESSAGE_BUBBLE
  • Infobulle MESSAGE_TOOLTIP
  • MESSAGE_État_LINE
  • ESTAMPILLE_TEMPORELLE_DU_MESSAGE
  • EST EN TRAIN D'ÉCRIRE
  • Délimiteur
  • Charger Plus de Messages
  • LOAD_MORE_MESSAGES_BUTTON

Utilisateur et Informations sur l’agent

  • Profil utilisateur
  • USER_NAME
  • État DE L'UTILISATEUR
  • État_UTILISATEUR_point
  • AVATAR
  • DEFAULT_AVATAR
  • END_SESSION
  • FIN_DE_SESSION_nom_AGENT
  • FIN_SESSION_AGENT_Profil
  • Corps_FIN_DE_SESSION
  • END_SESSION_FOOTER

Saisie et Répondre

  • REPLY_BOX
  • Saisie
  • Erreur de saisie
  • TEXTAREA
  • TEXT_BUTTON
  • Primaire_BUTTON
  • SECONDARY_BUTTON
  • Étiquette_BOUTON
  • Bouton annuler
  • BOUTON D'ENVOI
  • UPLOAD_ATTACHMENT_BUTTON_CONTAINER
  • Bouton UPLOAD_ATTACHMENT_BUTTON
  • SEND_TRANSCRIPT
  • Démarrer UNE NOUVELLE CONVERSATION
  • FIN_SESSION_CHAT_BOUTON

Formulaires et enquêtes

  • Conteneur DE Champ DE FORMULAIRE
  • Étiquette DE Champ DE FORMULAIRE
  • Champ_FORMULAIRE_Erreur_MESSAGE
  • PRECONTACT_SURVEY
  • PRECONTACT_SURVEY_DESCRIPTION
  • PRECONTACT_SURVEY_FOOTER
  • PRECONTACT_Sondage_PRINCIPAL_Conteneur
  • SATISFACTION_SURVEY

Fenêtres contextuelles proactives et modales

  • Fenêtre contextuelle de chat proactif
  • PROACTIVE_CHAT_FULL_IMAGE
  • PROACTIVE_CHAT_IMAGE
  • Contenu de chat proactif
  • PROACTIVE_CHAT_HEADING
  • PROACTIVE_CHAT_SUBHEADING
  • PROACTIVE_CHAT_BODY
  • PROACTIVE_CHAT_ACTION_BUTTON
  • PROACTIVE_CHAT_CLOSE_BUTTON
  • Fenêtre contextuelle HTML de chat proactif
  • INACTIVITY_POPUP
  • INACTIVITY_POPUP_HEADING
  • INACTIVITY_POPUP_BODY
  • INACTIVITY_POPUP_CALL_TO_ACTION
  • Fenêtre contextuelle DE MINUTERIE D'INACTIVITÉ
  • État D'INACTIVITÉ
  • État_INACTIVITÉ_FIN_CHAT
  • Conditions d'utilisation
  • TERMS_OF_USE
  • FIN_CHAT_MODAL
  • MODAL_Principale_CONTENT
  • MODAL_ACTIONS
  • Fenêtre contextuelle

État et lien

  • CONNECTION_STATUS
  • Hors ligne
  • Hors ligne_Icône
  • Hors ligne_TEXT
  • SKELETON_LOADER

Divers

  • DROPZONE_WRAPPER
  • TRANSCRIPT

Appliquez les composants CSS personnalisés en utilisant uniquement l'attribut data-selector. Ne l’appliquez pas aux sélecteurs de classes ou d’autres parties du code JavaScript, comme dans cet exemple :

.Widget__Widget___1qQCf { background: red; }

Les composants de fenêtre peuvent être constitués de plusieurs blocs imbriqués. Les sélecteurs de composants répertoriés dans cette section nomment la racine de chaque composant. Si vous souhaitez appliquer le CSS à l'un des blocs imbriqués d'un composant, utilisez la console du développeur pour inspecter le composant afin de pouvoir sélectionner le bloc approprié.

Actions proactives

Les appels de cette section vous permettent de contacter les clients par chat en fonction de leur comportement.

Exécuter le déclencheur

Démarre le déclencheur Workflow Automation défini par le trigger_id.


cxone('chat', 'executeTrigger', 'trigger_id');

Définir un Événement propre au visiteur

Stocke le comportement utilisateur défini (l’événement) pour la génération de rapports. Lorsque cet appel est utilisé avec le Mobile SDK, event_type est remplacé par custom_event_type.


cxone('chat', 'setVisitorEvent', 'event_type', 'custom_event_data');

Définir la Variable du visiteur

Stocke les informations définies par l'utilisateur pour la génération de rapports.


cxone('chat', 'setVisitorVariable', 'variable_identifier', 'variable_value');

Stocker les conversions

Stocke le comportement de l'utilisateur en tant que conversion pour la génération de rapports.


cxone('chat', 'storeConversion', 'conversion_type', 'conversion_value', 'conversion_date'); 
// conversion_date is optional, default is now

Balises de visiteur Web

Le contenu de cette section concerne un produit ou une fonctionnalité qui fait partie d'un programme d'aperçu public. Si vous ne faites pas partie de l'aperçu et souhaitez obtenir plus d'informations, contactez votre représentant de compte.

Vous pouvez créer des balises pour les contacts qui adoptent certains comportements sur votre site Web. Cette fonctionnalité utilise des balises provenant de Digital Experience (DX) et nécessite Guide.

Pour ajouter une balise à un contact :


cxone('chat', 'assignTag', 'tagID');

Pour supprimer une balise pour un contact.


cxone('chat', 'removeTag', 'tagID');

Intégration avec les Applications de Troisième partie

Les appels de cette section vous permettent de recevoir des notifications push lorsque certains événements de chat se produisent.

Reconnaître les discussions actives dans la fenêtre de discussion


cxone('chat', 'getOngoingThreads');

Reconnaître le contact en cours dans la fenêtre de chat


cxone('chat', 'getOngoingContact')

Recevoir une notification push pour des Événements de chat spécifiques

La liste suivante contient les événements compatibles. Utilisez l'une des entrées suivantes pour remplacer « event » dans les exemples ci-dessous.

  • CaseToRoutingQueueAssignmentChanged

  • PageViewCreated

  • MessageCréé

  • MessageDeliveredToUser

  • MessageDeliveredToEndUser

  • MessageVuParUtilisateur

  • MessageVuParEndUser

  • MessageReadChangedMessageReadChanged

  • MessageAddedIntoCaseMessageAddedIntoCase

  • CaseInboxAssigneeChanged

  • CasCréé

  • CaseStatusChanged

  • SenderTypingStarted

  • SenderTypingEnded

  • MessageNoteCreated

  • ContactRecipientsChanged

Pour recevoir une notification pour un événement de chat :


cxone('chat', 'onPushUpdate', 'event', callback);

Pour recevoir une notification pour plus que un événement de chat :


cxone('chat', 'onPushUpdate', ['event', 'event', 'event'], callback);

Pour recevoir une notification pour tous les événements de chat :


cxone('chat', 'onAnyPushUpdate', callback);

Intégration avec Android ou Applications iOS

Vous pouvez intégrer clavardage numérique dans des applications Android ou iOS. L'application native doit utiliser WebView où le code d'initialisation JavaScript est ajouté. Cet exemple de code utilise le JavaScript de cette Page pour modifier l'apparence et le comportement de la fonction de chat :


<script async type="text/javascript">
  (function(i,s,o,r,g,v,a,m){g=v?g+'?v='+v:g;i['BrandEmbassy']=r;
    i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)};i[r].l=+new Date();
    a=s.createElement(o);m=s.getElementsByTagName(o)[0];a.async=1;
    a.src=g+'?'+Math.round(Date.now()/1000/3600);m.parentNode.insertBefore(a,m)
  })(window,document,'script','brandembassy','https://livechat-static.brandembassy.com/3/chat.js');

  //init of Livechat
  cxone('chat', 'init', BRAND_HASH);

  // hiding unwanted UI elements
  cxone('chat', 'hideHeader');
  cxone('chat', 'hidePopups');
 
  // stretching livechat to full width and height
  cxone('chat', 'setFullDisplay');

  // Customer's name
  cxone('chat', 'setCustomerName', 'CUSTOMER_NAME');

  // Other optional Custom Fields
  cxone('chat', 'setCustomField', 'CUSTOM_FIELD_IDENT', 'CUSTOM_FIELD_VALUE');
    
  // Start Chat
  cxone('chat', 'openChatWindow');
  cxone('chat', 'autoStartSession');

</script>