Base de connaissance

Ce cas d'utilisation décrit un exemple de mise en œuvre de la méthode SDK "Action Rule Matched".

L'exemple présente un bouton sur le site Web, qui, s'il est cliqué, vérifie si une ActionRule a correspondu. Si c'est le cas, un badge s'affiche.

1. Implémentez la méthode SDK sur votre site web

Tout d'abord, nous devons mettre en œuvre la méthode API "Has Action Rule Matched" sur le site Web. La documentation relative à cette méthode se trouve ici.

HTML

Nous créons ici le badge, qui sera affiché sur le site si une ActionRule correspond.

    <span style="background-color:#93beff; display:none" id="actionRuleMatched">ActionRule Matched!</span>

Nous avons également besoin du bouton, qui appellera une méthode js vérifiant les ActionRules correspondantes.

    <button onclick="checkActionRulesMatched()">Check ActionRules matched</button>

JavaScript

C'est ici que nous mettons en œuvre la méthode SDK.

Puisqu'elle renvoie un tableau, nous savons qu'au moins une règle a correspondu si la taille du résultat est supérieure à 1. Dans ce cas, le badge est défini comme étant visible.

/** 
* perform check for matched ActionRules, show badge if any have matched, hide if none
*/
function checkActionRulesMatched() {
    // Action Rule Listeners
    CV.api.hasActionRuleMatched(function (result) {
        var notificationElement = document.getElementById("actionRuleMatched");
        if (result.length > 0) {
            notificationElement.style.display = "inline";
        } else {
            notificationElement.style.display = "none";
        }
    });
}

Le résultat renvoyé est un tableau de chaînes de caractères, de sorte que vous pouvez également vérifier une chaîne de caractères spécifique. De cette façon, il peut y avoir plusieurs ActionRules, chacune d'entre elles pouvant provoquer un événement différent.

Si la vérification des ActionRules correspondantes doit également être effectuée automatiquement une fois que la page et le Chatvisor ont été chargés, nous pouvons ajouter un Event Listener pour exécuter la méthode une fois que ces conditions ont été remplies.

/** 
* perform check for matched ActionRules once page and CV loaded
*/
window.addEventListener('load', function () {
    if (!window.CVLoaded) {
        window.CVLoaded = checkActionRulesMatched;
    } else {
        checkActionRulesMatched();
    }
})

Gardez à l'esprit que, comme cette vérification a lieu juste après le chargement, certaines ActionRules qui ne correspondent que plus tard ne seront pas affichées. Par exemple, une ActionRule dont la condition est "L'utilisateur est sur la page pendant X secondes" ne correspondra qu'au bout de X secondes, moment auquel ce listener aura déjà exécuté la méthode.

2. Mise en place d'une ActionRule

Nous devons maintenant mettre en place une règle pour utiliser l'API. Des informations sur la mise en place des ActionRules peuvent être trouvées ici.

Condition

Dans cet exemple, la règle comporte la condition "Inside Opening Hours", qui est remplie si l'heure actuelle est comprise dans les heures d'ouverture sélectionnées. Vous trouverez des informations sur cette fonctionnalité ici.

Vous pouvez bien entendu choisir la combinaison de conditions qui vous convient le mieux.

Action

Pour que cette ActionRule soit ajoutée au tableau des règles correspondantes, l'action "Événement Javascript" est requise.

C'est ainsi que la règle est configurée dans cet exemple. Si l'heure actuelle est comprise dans les heures d'ouverture, la règle est marquée comme étant "adaptée" et figurera désormais dans le tableau des résultats lors de l'exécution de la méthode SDK.

3. Vérifier le résultat

Le badge d'exemple, qui avait à l'origine le style "display : none", est maintenant visible lors des visites pendant les heures d'ouverture.

Autres cas possibles

Le cas d'utilisation décrit ici est bien sûr très minime, mais comme les conditions et les actions de l'ActionRule peuvent être combinées de nombreuses façons, le SDK Javascript pourrait par exemple également être utilisé :

• Affichez un badge si les agents sont en ligne mais occupés.
• Déclenchez une autre fonction dans votre code javascript si le client visite un sous-domaine spécifique et envoie un message via le Chatvisor LiveChat.
• Redirigez automatiquement les visiteurs s'ils se rendent en dehors de vos heures d'ouverture.