Formato JSON
Los disparadores se representan como objetos JSON con los atributos siguientes.
| Nombre | Tipo | Solo lectura | Descripción |
| nombre | cadena | No | El nombre del disparador |
| activado | entero | No | Si el disparador está activado o desactivado |
| descripción | cadena | No | La descripción del disparador |
| definición | objeto | no | La definición del disparador. Consulte más detalles en Definiciones de disparadores a continuación. |
Definiciones de disparadores
Nota: En Actualizar disparador, las definiciones no son editables.
Si desea descripciones detalladas de cada disparador, consulte Guía de referencia de las condiciones y acciones de los disparadores.
Los disparadores se definen simplemente usando JSON. Cada disparador es un objeto JSON con tres claves:
| Claves de definiciones de disparadores | Descripción |
| evento | (Cadena JSON) Tipo de evento para el que se activa este disparador. Consulte una lista de los eventos en Eventos de disparador. |
| condición | (Lista JSON) Condición que se debe cumplir para que este disparador ejecute sus acciones. Si desea más detalles, consulte Tipos de condiciones. |
| acción | acción (Lista JSON) Lista de acciones que se deben ejecutar cuando se cumple la condición. Si desea más detalles, consulte Acciones de disparadores. |
Eventos de disparador
Puede usar los eventos siguientes:
| Evento de disparador | Descripción |
| page_enter | Este evento se dispara cuando un visitante carga el widget de Chat. |
| chat_requested | Este evento se dispara cuando un visitante solicita un chat. |
| chat_message | Este evento se dispara cuando un visitante envía un mensaje de chat. |
Eventos de condición
Puede usar las condiciones siguientes:
| Tipo de condición | Descripción |
| o | Verifica que se cumpla cualquiera de las condiciones |
| y | Verifica que se cumplan todas las condiciones |
Operadores de variables de condición
Puede usar los siguientes operadores para las variables de condición. Es posible que no haya operadores para variables distintas.
| Operador | Descripción |
| eq | Igual a |
| neq | No es igual a |
| lt | Menor que |
| gt | Mayor que |
| lte | Menor o igual que |
| gte | Mayor o igual que |
| icontains | Contiene |
| nicontains | No contiene |
| contains | Contiene (distingue mayúsculas o minúsculas) |
| ncontains | No contiene (distingue mayúsculas o minúsculas) |
| regex | Coincidencias de expresiones regulares (distingue mayúsculas o minúsculas) |
| iregex | Expresión regular |
Variables de condiciones
Puede usar las variables siguientes:
Variables de fecha y hora
| Tipo | Descripción |
| @hour_of_day | Hora del día (zona horaria UTC), de 0 a 23 |
| @day_of_week | Día de la semana. 0 = lunes, 6 = domingo |
| @visitor_time_on_page | Número de segundos que el visitante ha permanecido en la página actual |
| @visitor_time_on_site | Número de segundos que el visitante ha permanecido en su sitio |
| stillOnSite | Demora (en segundos) antes de verificar la siguiente condición |
| stillOnPage | Demora (en segundos) antes de verificar la siguiente condición |
Ubicación del visitante
| Tipo | Descripción |
| @visitor_ip | Dirección IP del visitante (xxx.xxx.xxx.xxx) |
| @visitor_hostname | Nombre del host de la dirección IP del visitante |
| @visitor_city | Ciudad de donde es el visitante |
| @visitor_region | Región de donde es el visitante |
| @visitor_country_code | Código de dos letras del país del visitante |
| @visitor_country_name | El país de donde es el visitante |
Información de visita anterior
| Tipo | Descripción |
| @visitor_previous_visits | Número de veces que el visitante ha visitado anteriormente. Nuevas visitas = 0 |
| @visitor_previous_chats | Número de veces que el visitante ha chateado con los agentes. Nuevos chats = 0 |
Información de página
| Tipo | Descripción |
| @visitor_page_url | El URL de la página donde se encuentra actualmente el visitante |
| @visitor_page_title | Título de la página donde se encuentra actualmente el visitante |
| @visitor_page_count | Número de páginas que el visitante ha visto. Primera página = 1 |
| @referrer | URL de la página anterior donde se encontraba el visitante |
Información de visitante
| Tipo | Descripción |
| @visitor_name | Nombre del visitante |
| @visitor_email | Correo electrónico del visitante |
| @visitor_referrer | URL recomendante del visitante (al entrar en su sitio) |
| @visitor_search_engine | Motor de búsqueda recomendante, si se aplica |
| @visitor_search_terms | Término de búsqueda recomendante, si se aplica |
| @visitor_tags | Nombre de la etiqueta (establecido por la acción Establecer etiqueta) |
| @visitor_triggered | 'verdadero’ si el visitante ha sido disparado (establecido por la acción Establecer en disparado) |
| @visitor_department_id | Departamento del visitante (establecido por la acción Establecer departamento del visitante o por la API de Javascript) |
Equipo o software del visitante
| Tipo | Descripción |
| @visitor_user_agent | Cadena de usuario-agente del navegador del visitante |
| @visitor_browser | Navegador del visitante |
| @visitor_platform | Plataforma o sistema operativo del visitante |
Estados conectados
| Tipo | Descripción |
| @account_status | Estado en que se encuentra la cuenta (conectado, ausente o desconectado) |
| @visitor_status | Estado en que se encuentra el visitante (conectado, inactivo o desconectado) |
Información relacionada con el chat
| Tipo | Descripción |
| @visitor_requesting_chat | 'verdadero' si el visitante está solicitando un chat |
| @visitor_served | 'verdadero' si el visitante está siendo atendido por los agentes |
| @department | Departamento (nombre) que el visitante elije en el formulario de solicitud de chat |
| @visitor_served | 'verdadero' si el visitante está siendo atendido por los agentes |
| @sender | Nombre del remitente del mensaje |
| @sender_type | Puede ser 'agent' o 'visitor' |
| @message | El mensaje que se está enviando |
Acciones de disparadores
| Acción | Parámetros | Descripción |
| sendMessageToVisitor | Nombre del agente y mensaje (cadena) | Envía un mensaje al visitante |
| setTriggered | Verdadero o falso (booleano) | Establece la marca "disparado" del visitante |
| wait | Duración (en segundos)(número) | Espera un número especificado de segundos, y luego ejecuta la siguiente acción de la lista si el visitante está aún conectado |
| addTag | Nombre de la etiqueta (cadena) | Agrega una etiqueta al visitante, que se puede ver en el panel Lista de visitantes |
| removeTag | Nombre de la etiqueta (cadena) | Elimina una etiqueta de la sesión del visitante |
| banVisitor | Motivo (cadena) | Prohíbe al visitante con una razón |
| banIp | Motivo (cadena) | Prohíbe la dirección IP del visitante con una razón |
| setName | Nombre del visitante (cadena) | Establece el nombre del visitante |
| setDepartment | ID del departamento (número) | Establece el departamento actual del visitante |
| setNote | Nota (cadena) | Establece una nota para el visitante, que es persistente y se puede ver en el panel |
| appendNote | Nota (cadena) | Anexa una nota al final de la nota actual del visitante |
Obtener todos los disparadores
GET /api/v2/triggers
Lista todos los disparadores de una cuenta.
Permitido para
Owner
Administrator
Utilizar cURL
curl https://www.zopim.com/api/v2/triggers \
-v -u {email_address}:{password}
Respuesta de muestra
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"
}
]
Obtener un disparador
GET /api/v2/triggers/{trigger_name}
Permite al dueño o administrador de una cuenta recuperar un disparador por nombre.
Permitido para
Owner
Administrator
Utilizar cURL
curl https://www.zopim.com/api/v2/triggers/{trigger_name} \
-v -u {email_address}:{password}
Respuesta de muestra
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "Good Trigger",
"enabled" : 1,
"description" : "Visitor requested chat",
}
Crear disparador
POST /api/v2/triggers
Permite al dueño o administrador de una cuenta agregar un disparador a una cuenta.
Permitido para
Owner
Administrator
Utilizar 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"
Respuesta de muestra
HTTP/1.1 201 Created
Content-Type: application/json
{
"name" : "Good Trigger",
"enabled" : 1,
"description" : "Visitor requested chat",
}
Dirige mensajes a una página o directorio específico
Envía un mensaje automatizado a un URL o un directorio específicos
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"
Si desea una configuración detallada de los disparadores, vaya a la página del disparador de la cuenta
Actualizar disparador
PUT /api/v2/triggers/{trigger_name}
Permite al dueño o administrador de una cuenta actualizar los datos de un disparador.
Permitido para
Owner
Administrator
Utilizar 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"
Respuesta de muestra
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "Best Trigger",
"enabled" : 1,
"description" : "Visitor requested new chat",
}
Borrar disparador
DELETE /api/v2/triggers/{trigger_name}
Permite al dueño o administrador de una cuenta borrar un disparador.
Permitido para
Owner
Administrator
Utilizar cURL
curl https://www.zopim.com/api/v2/triggers/{trigger_name} \
-v -u {email_address}:{password} -X DELETE
Respuesta de muestra
HTTP/1.1 204 OK
Content-Type: application/json