Javascript SDK
Implémentation du SDK
Afin de pouvoir utiliser le SDK, insérez le code ci-dessous sur votre site.
(function () {
eKonsilio =
window.eKonsilio ||
function () {
(eKonsilio.q = eKonsilio.q || []).push(arguments);
};
var s = document.createElement("script");
s.type = "text/javascript";
s.async = true;
s.src = "https://livechat.ekonsilio.io/sdk.js";
document.getElementsByTagName("body")[0].append(s);
})();
Utilisation du SDK
Ce SDK vous permet les actions suivantes :
- Effectuer une actions (récupérer le statut du service, ouvrir la fenêtre, fermer la fenêtre).
- Écouter des évènements (changement de statut du service, ouverture/fermeture de la fenêtre par le visisteur, démarrage d'une conversation par le visiteur).
Pour utiliser le SDK vous devrez appeler la fonction eKonsilio
.
Celle-ci peut être utilisé avec différents paramètres :
- Pour une action :
action
callback
- Pour un évènement :
- on
event
callback
Actions
status
: Statut du service
La fonction de callback
retourne un objet composé des propriétés suivantes :
- online :
boolean
indiquant si le service est en ligne ou hors ligne - operator :
object
- name :
string
- nom du conseiller - title :
string
- titre du conseiller - picture :
string
- photo du conseiller
- name :
eKonsilio("status", ({online, operator}) => {
console.log(online, operator);
});
maxmize
: Ouverture de la fenêtre
eKonsilio("maxmize");
minimize
: Fermeture de la fenêtre
eKonsilio("minimize");
isMaximized
: Statut d'ouverture de la fenêtre
La fonction de callback
retourne un booléen indiquant si la fenêtre est ouverte ou non.
eKonsilio("isMaximized", (isMaximized) => {
console.log(isMaximized);
});
Évènements
service:status
: Changement de statut du service
La fonction de callback
retourne un objet composé des propriétés suivantes :
- online :
boolean
indiquant si le service est en ligne ou hors ligne - operator :
object
- name :
string
- nom du conseiller - title :
string
- titre du conseiller - picture :
string
- photo du conseiller
- name :
eKonsilio("on", "service:status", (data) => {
console.log("[eKonsilio SDK]", "service:status", data);
});
window:maximized
: Ouverture de la fenêtre
La fonction de callback
peut retourner en premier paramètre l'identifiant de la conversation si une conversation a été démarré par l'
utilisateur, dans le cas contraire le premier paramètre de la fonction sera null
.
eKonsilio("on", "window:maximized", (data) =>
console.log("[eKonsilio SDK]", "window:maximized", data)
);
window:minimized
: Fermeture de la fenêtre
La fonction de callback
peut retourner en premier paramètre l'identifiant de la conversation si une conversation a été démarré par l'
utilisateur, dans le cas contraire le premier paramètre de la fonction sera null
.
eKonsilio("on", "window:minimized", (data) =>
console.log("[eKonsilio SDK]", "window:minimized", data)
);
conversation:new
: Nouvelle conversation
La fonction de callback
retourne en premier paramètre l'identifiant de la conversation.
eKonsilio("on", "conversation:new", (data) =>
console.log("[eKonsilio SDK]", "conversation:new", data)
);