Format JSON
Les déclencheurs sont représentés comme des objets JSON avec les attributs suivants.
| Nom | Type | Lecture seule | Description |
| name | chaîne | Non | Nom du déclencheur |
| enabled | entier | Non | Indique si le déclencheur est activé ou non |
| description | chaîne | Non | Description du déclencheur |
| definition | objet | non | Définition du déclencheur Pour en savoir plus, consultez Définitions des déclencheurs ci-dessous. |
Définitions des déclencheurs
Remarque - Les définitions ne sont pas modifiables dans Update Trigger.
Pour une description détaillée de chaque déclencheur, consultez Conditions et actions des déclencheurs - Référence.
Les déclencheurs sont simplement définis en utilisant JSON. Chaque déclencheur est un objet JSON avec trois clés :
| Clés de définition des déclencheurs | Description |
| event | (chaîne JSON) Type d’événement pour lequel ce déclencheur est activé. Pour voir une liste des événements, consultez Événements des déclencheurs. |
| condition | (liste JSON) Condition devant être remplie pour que ce déclencheur effectue ses actions. Pour en savoir plus, consultez Types de condition. |
| action | (liste JSON) Liste des actions à effectuer quand les conditions sont remplies. Pour en savoir plus, consultez Actions des déclencheurs. |
Événements des déclencheurs
Vous pouvez utiliser les événements suivants :
| Événement du déclencheur | Description |
| page_enter | Cet événement est déclenché quand un visiteur a chargé le widget de chat. |
| chat_requested | Cet événement est déclenché quand un visiteur fait une demande de chat. |
| chat_message | Cet événement est déclenché quand un visiteur envoie un message de chat. |
Événements des conditions
Vous pouvez utiliser les conditions suivantes :
| Type de condition | Description |
| or | Vérifie qu’une des conditions est remplie. |
| and | Vérifie que toutes les conditions sont remplies. |
Opérateurs des variables de condition
Vous pouvez utiliser les opérateurs suivants pour les variables de vos conditions : Il est possible qu’aucun opérateur ne soit disponible pour certaines variables.
| Opérateur | Description |
| eq | Égal à |
| neq | Pas égal à |
| lt | Inférieur à |
| gt | Supérieur à |
| lte | Inférieur ou égal à |
| gte | Supérieur ou égal à |
| icontains | Contient |
| nicontains | Ne contient pas |
| contains | Contient (sensible à la casse) |
| ncontains | Ne contient pas (sensible à la casse) |
| regex | Correspond à une expression rationnelle (sensible à la casse) |
| iregex | Expression régulière |
Variables de condition
Vous pouvez utiliser les variables suivantes :
Variables d’heure et de date
| Type | Description |
| @hour_of_day | Heure de la journée (UTC), 0 à 23 |
| @day_of_week | Jour de la semaine. 0 = lundi, 6 = dimanche |
| @visitor_time_on_page | Nombre de secondes pendant lesquelles le visiteur est resté sur la page actuelle |
| @visitor_time_on_site | Nombre de secondes pendant lesquelles le visiteur est resté sur le site |
| stillOnSite | Délai (en s.) avant la vérification de la condition suivante |
| stillOnPage | Délai (en s.) avant la vérification de la condition suivante |
Emplacement du visiteur
| Type | Description |
| @visitor_ip | Adresse IP du visiteur (xxx.xxx.xxx.xxx) |
| @visitor_hostname | Nom d’hôte de l’adresse IP du visiteur |
| @visitor_city | Ville d’où vient le visiteur |
| @visitor_region | Région d’où vient le visiteur |
| @visitor_country_code | Code à 2 lettres représentant le pays du visiteur |
| @visitor_country_name | Pays d’où vient le visiteur |
Informations sur les visites précédentes
| Type | Description |
| @visitor_previous_visits | Nb de visites précédentes effectuées par le visiteur. Nouvelles visites = 0 |
| @visitor_previous_chats | Nb de fois que le visiteur a chatté avec les agents. Nouveaux chats = 0 |
Informations sur la page
| Type | Description |
| @visitor_page_url | URL de la page sur laquelle se trouve actuellement le visiteur |
| @visitor_page_title | Titre de la page sur laquelle se trouve actuellement le visiteur |
| @visitor_page_count | Nb de pages qu’a consultées le visiteur. Première page = 1 |
| @referrer | URL de la page précédente sur laquelle se trouvait le visiteur |
Informations visiteurs
| Type | Description |
| @visitor_name | Nom du visiteur |
| @visitor_email | Adresse e-mail du visiteur |
| @visitor_referrer | URL référente du visiteur (quand il est entré sur votre site) |
| @visitor_search_engine | Moteur de recherche référent, le cas échéant. |
| @visitor_search_terms | Terme de recherche référent, le cas échéant |
| @visitor_tags | Nom du marqueur (défini par l’action « Définir le marqueur ») |
| @visitor_triggered | « vrai » si le visiteur a été déclenché (défini par l’action « Définir sur Déclenché ») |
| @visitor_department_id | Service du visiteur (configuré par le biais de l’action « Configurer le service du visiteur » ou l’API JavaScript) |
Logiciels/Matériel du visiteur
| Type | Description |
| @visitor_user_agent | Chaîne d’agent utilisateur du navigateur du visiteur |
| @visitor_browser | Navigateur du visiteur |
| @visitor_platform | Système d’exploitation/Plateforme du visiteur |
Statuts en ligne
| Type | Description |
| @account_status | Statut de votre compte (en ligne/absent/hors ligne) |
| @visitor_status | Statut du visiteur (en ligne/inactif/hors ligne) |
Informations associées au chat
| Type | Description |
| @visitor_requesting_chat | « vrai » si le visiteur fait une demande de chat |
| @visitor_served | « vrai » si les agents s’occupent actuellement du visiteur |
| @department | Service (nom) que le visiteur choisit sur le formulaire de demande de chat |
| @visitor_served | « vrai » si les agents s’occupent actuellement du visiteur |
| @sender | Nom de l’expéditeur du message |
| @sender_type | Soit agent soit visitor |
| @message | Le message en cours d’envoi |
Actions de déclencheur
| Action | Paramètres | Description |
| sendMessageToVisitor | Nom de l’agent et message (chaîne) | Envoie un message au visiteur |
| setTriggered | Vrai/faux (booléen) | Définit le marqueur « déclenché » du visiteur |
| wait | Durée (en s) (nombre) | Attend un nombre défini de secondes, puis effectue l’action suivante dans la liste si le visiteur est toujours en ligne |
| addTag | Nom du marqueur (chaîne) | Ajoute un marqueur au visiteur, visible dans la liste des visiteurs du tableau de bord |
| removeTag | Nom du marqueur (chaîne) | Supprime un marqueur de la session du visiteur |
| banVisitor | Raison (chaîne) | Interdire le visiteur avec une raison |
| banIp | Raison (chaîne) | Interdire l’adresse IP du visiteur avec une raison |
| setName | Nom du visiteur (chaîne) | Définit le nom du visiteur |
| setDepartment | ID du service (nombre) | Définit le service actuel du visiteur |
| setNote | Note (chaîne) | Définit une note pour le visiteur, visible dans le tableau de bord et permanente |
| appendNote | Note (chaîne) | Ajoute une note à la fin de la note actuelle du visiteur |
Obtenir tous les déclencheurs
GET /api/v2/triggers
Répertorie tous les déclencheurs d’un compte.
Autorisé pour
Owner
Administrator
Utilisation de cURL
curl https://www.zopim.com/api/v2/triggers \
-v -u {email_address}:{password}
Exemple de réponse
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"name" : "Good Trigger",
"enabled" : 1,
"description" : "Visitor entered page"
},
{
"name" : "Better Trigger",
"enabled" : 1,
"description" : "Visitor requested chat"
}
]
Obtenir un déclencheur
GET /api/v2/triggers/{trigger_name}
Permet au propriétaire ou à l’administrateur d’un compte de récupérer un déclencheur par nom.
Autorisé pour
Owner
Administrator
Utilisation de cURL
curl https://www.zopim.com/api/v2/triggers/{trigger_name} \
-v -u {email_address}:{password}
Exemple de réponse
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "Good Trigger",
"enabled" : 1,
"description" : "Visitor requested chat",
}
Créer un déclencheur
POST /api/v2/triggers
Permet au propriétaire ou à l’administrateur d’un compte d’ajouter un déclencheur au compte.
Autorisé pour
Owner
Administrator
Utilisation de cURL
curl https://www.zopim.com/api/v2/triggers \
-d '{
"name" : "Good Trigger",
"enabled" : 1,
"description" : "Visitor requested chat"
}' \
-v -u {email_address}:{password} \
-X POST -H "Content-Type: application/json"
Exemple de réponse
HTTP/1.1 201 Created
Content-Type: application/json
{
"name" : "Good Trigger",
"enabled" : 1,
"description" : "Visitor requested chat",
}
Envoyer des messages à une page ou un répertoire spécifique
Envoie un message automatisé à une URL ou un répertoire spécifique
curl https://www.zopim.com/api/v2/triggers \
-d '{
"name" : "Stripe Shoe",
"enabled" : 1,
"description" : "Send discount code for Stripe Shoe",
"definition" : {
"event" : "page_enter",
"condition" : [
"and",
[
"icontains",
"@visitor_page_url",
"stripshoe"
],
[
"stillOnPage",
20
]
],
"actions" : [
[
"sendMessageToVisitor",
"Timmy",
"We have a discount code for you! Use DISCOUNT10 on your next checkout"
]
]
}
}' \
-v -u {email_address}:{password} \
-X POST -H "Content-Type: application/json"
Pour la configuration détaillée des déclencheurs, allez à la page des déclencheurs du compte
Mettre un déclencheur à jour
PUT /api/v2/triggers/{trigger_name}
Permet au propriétaire ou à l’administrateur d’un compte de mettre les données d’un déclencheur à jour.
Autorisé pour
Owner
Administrator
Utilisation de cURL
curl https://www.zopim.com/api/v2/triggers/{trigger_name} \
-d '{
"name" : « Best Trigger",
"description" : "Visitor requested new chat"
}' \
-v -u {email_address}:{password} \
-X PUT -H "Content-Type: application/json"
Exemple de réponse
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "Best Trigger",
"enabled" : 1,
"description" : "Visitor requested new chat",
}
Supprimer un déclencheur
DELETE /api/v2/triggers/{trigger_name}
Permet au propriétaire ou à l’administrateur d’un compte de supprimer un déclencheur.
Autorisé pour
Owner
Administrator
Utilisation de cURL
curl https://www.zopim.com/api/v2/triggers/{trigger_name} \
-v -u {email_address}:{password} -X DELETE
Exemple de réponse
HTTP/1.1 204 OK
Content-Type: application/json