Sales
```
---
### SBChat.offlineMessage()
Comprueba si el mensaje de fuera de línea puede enviarse y lo envía.
**Información**
- **Requisito:**
Debe haber una conversación activa.
---
### SBChat.isInitDashboard()
Comprueba si el panel (dashboard) se muestra por defecto cuando se inicializa el widget de chat.
---
### SBChat.closeChat()
Archiva una conversación y la oculta del widget de chat.
**Parámetros**
- `
update_conversation_status`
: Establézcalo en `
false`
para solo ocultar la conversación del widget de chat sin establecer su estado como archivado. **Por defecto:**
`
true`.
---
### SBChat.flashNotification()
Inicia la notificación parpadeante (flash).
---
### SBChat.playSound()
Reproduce el sonido que suena cuando se recibe un nuevo mensaje.
**Parámetros**
- `
repeat`
: Establézcalo en `
true`
para repetir el sonido tantas veces como se haya configurado en los ajustes. **Por defecto:**
`
false`.
---
### SBChat.automations.runAll()
Comprueba todas las automatizaciones y las ejecuta si las condiciones de activación se validan.
---
# 🧩 JAVASCRIPT API: Apps
Lista de funciones de las aplicaciones de ZampiBot.
### SBApps.is()
Comprueba si una app está disponible.
**Parámetros**
- `
name`
**Requerido**
: El nombre de la app, ej. `
dialogflow`.
---
### SBApps.wordpress.ajax()
Realiza una llamada AJAX de WordPress.
**Parámetros**
- `
action`
**Requerido**
: La acción. Valores disponibles: `
wp-login`
, `
wp-registration`
, `
button-purchase`
. Otros valores pueden estar disponibles, revise el archivo `
main.js`
para todos los valores.
- `
data`
**Requerido**
: Los parámetros de la acción, revise el archivo `
main.js`
para más detalles.
- `
onSuccess`
: Función a ejecutar al completar. Sintaxis: `
function(response) { ... }`
. **Por defecto:**
`
false`.
---
### SBApps.dialogflow.message()
Envía un mensaje a Dialogflow y añade la respuesta de Dialogflow a la conversación activa como un nuevo mensaje.
**Parámetros**
- `
message`: El texto del mensaje.
- `
attachments`
: Array de adjuntos. Sintaxis del array: `
[["nombre", "enlace"], ["nombre", "enlace"], ...]`
. Reemplace `
nombre`
con el nombre del adjunto y `
enlace`
con la URL completa del adjunto.
- `
delay`: Retraso de la respuesta del bot en milisegundos.
- `
parameters`
: Array de información opcional. Sintaxis del array: `
{ "nombre": "valor", "nombre": "valor", ...}`.
- `
audio`
: URL o ruta de un archivo de audio para el reconocimiento de voz. **Por defecto:**
`
false`.
**Información**
- **Requisito:**
La aplicación de Inteligencia Artificial es requerida y Dialogflow debe estar activo en el área de **Configuración**.
- **Requisito:**
El usuario debe estar activo.
-
Use `
SBApps.dialogflow.project_id = AGENT_ID`
para cambiar el agente de Dialogflow por defecto.
---
### SBApps.dialogflow.active()
Comprueba si Dialogflow y OpenAI están activos o los desactiva.
**Parámetros**
- `
active`
: Establézcalo en `
false`
para deshabilitar Dialogflow y OpenAI y detener el chatbot. Establézcalo en `
activate`
para activar el chatbot. **Por defecto:**
`
true`.
- `
check_dialogflow`
: Para verificar solo la activación de OpenAI, cámbielo a `
false`
. **Por defecto:**
`
true`.
- `
check_open_ai`
: Para verificar solo la activación de Dialogflow, cámbielo a `
false`
. **Por defecto:**
`
true`.
**Respuesta**
Devuelve `
true`
si el bot de Dialogflow está activo; de lo contrario, devuelve `
false`.
---
### SBApps.dialogflow.welcome()
Dispara la Intención de Bienvenida (Welcome Intent) de Dialogflow y muestra el mensaje de bienvenida de Dialogflow.
**Información**
- **Requisito:**
La aplicación de Inteligencia Artificial es requerida y Dialogflow debe estar activo en el área de **Configuración**.
---
### SBApps.dialogflow.openAI()
Envía un mensaje a OpenAI (ChatGPT), devuelve la respuesta y opcionalmente añade la respuesta como un nuevo mensaje.
**Parámetros**
- `
message`
**Requerido**: El mensaje.
- `
onSuccess`
: Función a ejecutar al completar. Sintaxis: `
function(response) { ... }`.
- `
audio`
: URL o ruta de un archivo de audio para el reconocimiento de voz. **Por defecto:**
`
false`.
**Información**
- **Requisito:**
La aplicación de Inteligencia Artificial es requerida y `
Configuración > Inteligencia Artificial > OpenAI > Chatbot`
debe estar activo.
- Si hay una conversación activa, la respuesta de OpenAI se añade automáticamente como un nuevo mensaje.
---
### SBApps.dialogflow.typing()
Inicia la animación de "escribiendo" del widget de chat.
---
### SBApps.dialogflow.humanTakeover()
Inicia la toma de control humana (human takeover) de Dialogflow configurada en `
Configuración > Inteligencia Artificial > Toma de control humana`.
---
### SBApps.dialogflow.humanTakeoverActive()
Comprueba si la toma de control humana está activa para la conversación activa.
---
### SBApps.dialogflow.translate()
Traduce múltiples cadenas a través de Google Translate.
**Parámetros**
- `
strings`
**Requerido**
: Array de las cadenas a traducir, ej. `
["Hello world", "How are you?"]`.
- `
language_code`
**Requerido**
: El código de idioma de dos letras al que desea traducir. Para Chino Tradicional use `
zt`
, para Chino Simplificado use `
zh`
, para Portugués Brasileño use `
pt`.
- `
onSuccess`
**Requerido**
: Función a ejecutar al completar. Sintaxis: `
function(response) { ... }`.
---
# 🎫 JAVASCRIPT API: Tickets
Lista de funciones de la App de Tickets.
### SBTickets.showPanel()
Muestra un panel o el área de conversación.
**Parámetros**
- `
name`
: El nombre del panel a mostrar. Nombres disponibles: `
new-ticket`
, `
privacy`
, `
articles`
, `
edit-profile`
, `
login`
, `
registration`. Déjelo vacío para mostrar el área de conversación principal.
- `
title`: El título a mostrar como nombre del panel.
---
### SBTickets.showSidePanels()
Muestra u oculta los paneles laterales.
**Parámetros**
- `
show`
: Establézcalo en `
false`
para ocultar los paneles.
---
### SBTickets.setAgent()
Obtiene los detalles del agente y puebla el área de perfil del agente del panel derecho.
**Parámetros**
- `
agent_id`: El ID del agente.
---
### SBTickets.activateConversation()
Activa y muestra una conversación.
**Parámetros**
- `
conversation`
: La conversación a activar como un objeto `
SBConversation`.
---
### SBTickets.selectConversation()
Establece el estilo de una conversación del panel izquierdo como la conversación activa.
**Parámetros**
- `
conversation_id`: El ID de la conversación.
---
### SBTickets.getActiveConversation()
---
Devuelve el objeto HTML DOM de la conversación activa.
**Parámetros**
- `
type`
: Establézcalo en `
ID`
para obtener solo el ID de la conversación.
---
# 📡 JAVASCRIPT API: Pusher
Lista de funciones para Pusher. Más detalles en `
pusher.com`.
### SBPusher.init()
Inicializa Pusher y opcionalmente ejecuta una función al completar la inicialización.
**Parámetros**
- `
onSuccess`
: Función a ejecutar al completar. Sintaxis: `
function(response) { ... }`.
---
### SBPusher.start()
Inicia Pusher y las notificaciones Push. Ejecute esta función después de `
SBPusher.init()`
y después de que el usuario esté activo.
---
### SBPusher.subscribe()
Suscribe al usuario activo a un canal de Pusher.
**Parámetros**
- `
channel_name`
**Requerido**: El nombre del canal.
- `
onSuccess`
: Función a ejecutar al completar. Sintaxis: `
function(response) { ... }`.
**Información**
- Si Pusher no está inicializado, la función lo inicializa automáticamente.
-
Puede acceder al canal desde `
SBPusher.channels['NOMBRE DEL CANAL']`.
---
### SBPusher.event()
Suscribe al usuario activo a un evento de un canal de Pusher y ejecuta la función dada cuando se recibe el evento.
**Parámetros**
- `
event`
**Requerido**: El nombre del evento.
- `
callback`
**Requerido**
: Función a ejecutar una vez que se recibe el evento. Sintaxis: `
function(response) { ... }`.
- `
channel`
: El nombre del canal. **Por defecto:**
`
private-user-[ID usuario activo]`.
**Información**
- Si Pusher no está inicializado, la función lo inicializa automáticamente.
- Si el usuario no está suscrito al canal, la función suscribe al usuario automáticamente.
---
### SBPusher.trigger()
Dispara un evento en un canal de Pusher.
**Parámetros**
- `
event`
**Requerido**: El nombre del evento.
- `
data`
: Array de valores. Sintaxis: `
{ "nombre": "valor" }`.
- `
channel`
: El nombre del canal. **Por defecto:**
`
private-user-[ID usuario activo]`.
---
### SBPusher.presence()
Suscribe al usuario activo al canal de presencia utilizado para el estado en línea de usuarios y administradores.
**Parámetros**
- `
index`
: El índice del canal de presencia. **Por defecto:**
1.
- `
onSuccess`
: Función a ejecutar al completar. Sintaxis: `
function(response) { ... }`.
**Información**
- Si Pusher no está inicializado, la función lo inicializa automáticamente.
---
### SBPusher.presenceUnsubscribe()
Desuscribe al usuario activo del canal de presencia.
---
### SBF.serviceWorker.pushNotification()
Envía una notificación Push al último agente de la conversación, o a todos los agentes si ningún agente ha respondido aún.
**Parámetros**
- `
message`
**Requerido**: El texto del mensaje.
- `
interests`
: Los destinatarios. Puede ser un ID de usuario o agente, o las siguientes cadenas: `
agents`
, `
department-123`
(reemplace 123 con el ID del departamento). **Por defecto:**
asignado automáticamente a los destinatarios correctos.
**Información**
- Esta función solo funciona si las notificaciones Push están activas en el área de configuración.
- Actualmente, las notificaciones Push solo son compatibles con dispositivos Mac, Windows y Android. Los iPhones y dispositivos iOS no son compatibles.
# ➕ JAVASCRIPT API: Más funciones
Lista de varias funciones que realizan diferentes tareas.
### SBF.translate()
Traduce una cadena al idioma del usuario activo.
**Parámetros**
- `
string`
**Requerido**: La cadena a traducir.
**Información**
- Devuelve la cadena traducida si está disponible; de lo contrario, devuelve la cadena original.
-
Esta función funciona solo para las traducciones del **front-end**.
- Para más detalles sobre el idioma activo, consulte la documentación de traducciones.
---
### SBF.activeUser()
Devuelve el usuario activo como un objeto `
SBUser`
, devuelve `
false`
si no se encuentra el usuario activo.
**Representación JSON del usuario activo:**
JSON
```
{
"details": {
"id": "914",
"profile_image": "https://zampisoft.com/user.svg",
"first_name": "User",
"last_name": "#23262",
"email": null,
"user_type": "visitor",
"token": "bc308e274473fb685a729abe8a4bf82d3c49cd2f"
},
"extra": {},
"conversations": []
}
```
**Información**
-
Para los métodos del usuario y más detalles, consulte la documentación de `
SBUser`.
---
### SBF.getActiveUser()
Activa el usuario conectado (logueado) y devuelve los detalles del usuario.
**Parámetros**
- `
db`
: Establézcalo en `
true`
para verificar que el usuario existe en la base de datos.
- `
onSuccess`
: Función a ejecutar cuando la función se completa. Sintaxis: `
function(response) { ... }`.
**Respuesta**
JSON
```
{
"id": "914",
"profile_image": "https://zampisoft.com/user.svg",
"first_name": "Don",
"last_name": "John",
"email": "hello@example.com",
"user_type": "user",
"token": "bc308e274473fb685a729abe8a4bf82d3c49cd2f"
}
```
**Información**
-
Para los métodos del usuario y más detalles, consulte la documentación de `
SBUser`.
---
### SBF.cors()
Ejecuta una petición HTTP POST o GET a una URL y devuelve la respuesta.
**Parámetros**
- `
method`
: Inserte `
POST`
o `
GET`
. **Por defecto:**
`
GET`.
- `
url`
**Requerido**: Ingrese la URL completa de la petición.
- `
onSuccess`
**Requerido**
: Función a ejecutar cuando la función se completa. Sintaxis: `
function(response) { ... }`.
---
### SBF.null()
Comprueba si una variable existente es nula o vacía.
**Parámetros**
- `
variable`
**Requerido**: La variable a comprobar.
**Información**
-
Devuelve `
true`
si la variable es una cadena vacía, `
null`
, `
'null'`
, o `
undefined`.
---
### SBF.deactivateAll()
Oculta todas las ventanas emergentes (pop-ups) y las ventanas. Esta función se utiliza principalmente en el área de administración.
---
### SBF.getURL()
Busca un parámetro en la URL y devuelve su valor, o devuelve un array con todos los parámetros.
**Parámetros**
- `
name`
: El parámetro a buscar. Devuelve `
false`
si el parámetro no se encuentra. Si no se proporciona el nombre del parámetro, se devuelve un array con todos los parámetros. **Por defecto:**
`
false`.
- `
url`
: La URL de la cual extraer los parámetros. **Por defecto:**
URL actual.
---
### SBF.restoreJson()
Convierte una cadena codificada en JSON a texto normal.
**Parámetros**
- `
value`
**Requerido**: La cadena a convertir.
---
### SBF.stringToSlug()
Convierte una cadena a un slug eliminando todos los caracteres especiales, reemplazando todos los espacios con el carácter `
-`, y convirtiendo la cadena a minúsculas.
**Parámetros**
- `
value`
**Requerido**: La cadena a convertir.
**Información**
-
Utilice la función `
slugToString(slug)`
para convertir un slug de nuevo a una cadena.
---
### SBF.settingsStringToArray()
Convierte una cadena a un array de valores. Formato de la cadena: `
nombre:valor,nombre:valor,...`.
**Parámetros**
- `
value`
**Requerido**: La cadena a convertir.
**Respuesta**
JSON
```
{
"name": "value",
"name": "value",
...
}
```
---
### SBF.random()
Devuelve una cadena alfanumérica aleatoria.
---
### SBF.isAgent()
Comprueba si un tipo de usuario es un agente. Devuelve `
true`
solo si el tipo de usuario es `
agent`
, `
admin`
, o `
bot`.
**Parámetros**
- `
user_type`
**Requerido**: La cadena del tipo de usuario a comprobar.
---
### SBF.error()
Dispara el error de JavaScript personalizado de ZampiBot.
**Parámetros**
- `
message`
**Requerido**
: Cadena con el mensaje de error o un objeto `
Error`.
---
### SBF.errorValidation()
Comprueba si una respuesta de una llamada AJAX es un error de validación.
**Parámetros**
- `
response`
**Requerido**: La respuesta de la llamada AJAX.
### SBF.login()
Inicia sesión de un usuario o un agente. El inicio de sesión se puede completar de dos maneras: vía correo electrónico y contraseña, o vía ID de usuario y token.
**Parámetros**
- `
email`
: El correo electrónico del usuario para iniciar sesión. Si se establece este atributo, también debe establecer la contraseña. **Por defecto:**
cadena vacía.
- `
password`
: La contraseña del usuario para iniciar sesión. Si se establece este atributo, también debe establecer el correo electrónico. **Por defecto:**
cadena vacía.
- `
user_id`
: El ID del usuario para iniciar sesión. Si se establece este atributo, también debe establecer el token. **Por defecto:**
cadena vacía.
- `
token`
: El token del usuario para iniciar sesión. Si se establece este atributo, también debe establecer el ID del usuario. Puede obtener el token desde el área de **Usuarios**
abriendo el cuadro de perfil de un usuario, solo si usted es un administrador. **Por defecto:**
cadena vacía.
- `
onSuccess`
: Función a ejecutar cuando la función se completa. Sintaxis: `
function(response) { ... }`
. **Por defecto:**
`
false`.
**Respuesta**
JSON
```
[
{
"id": "913",
"profile_image": "https://board.support/user.svg",
"first_name": "Don",
"last_name": "John",
"email": "example@domain.com",
"user_type": "user",
"token": "9b25351047ee758aa97ee4868d130cc1ceb8decf"
},
"YXNkWGNSeTdtRTdDYVkxVG8wckN4YWF6V2s0Tk1mczBSVHdQbHBpOWdmejVUTTdOUUxEUENhdUVoYmROWn..."
]
```
Devuelve `
false`
si el inicio de sesión no es exitoso.
---
## SBF.logout()
Cierra la sesión del usuario conectado y recarga la página.
---
### SBF.loginCookie()
Crea o actualiza la cookie de inicio de sesión.
**Parámetros**
- `
value`: La cadena de inicio de sesión encriptada.
---
### SBF.reset()
Cierra la sesión del usuario, elimina todos los datos almacenados de ZampiBot y recarga la página.
---
### SBF.lightbox()
Muestra el contenido dado en una ventana modal (lightbox).
**Parámetros**
- `
content`
: El contenido a mostrar. Puede ser cualquier contenido HTML; para mostrar una imagen use el código `
`.
---
### SBF.storage()
Gestiona el almacenamiento local (Local Storage) de ZampiBot. El almacenamiento local es una tecnología que guarda datos en el navegador de forma permanente.
**Parámetros**
- `
key`
**Requerido**: El ID del valor a establecer o recuperar.
- `
value`: El valor a guardar. Si no se establece, la función devuelve el valor de la clave dada.
---
### SBF.storageTime()
Guarda una clave y la fecha y hora actual en el almacenamiento local para comprobar en el futuro si está dentro del número de horas dado o si ha expirado.
**Parámetros**
- `
key`
**Requerido**: La clave a guardar o comprobar.
- `
hours`: El número de horas para comparar con la fecha y hora guardada.
**Respuesta**
Si el atributo `
hours`
está establecido, devuelve `
true`
si la suma de la fecha guardada y las horas dadas es menor que la fecha y hora actual; de lo contrario, devuelve `
false`
. Ejemplo: si la hora guardada es 5:00 pm, e inserta 3, la función devolverá `
true`
solo si la hora actual es 8:01 pm o más.
---
### SBF.setting()
Devuelve el valor de una configuración, o le asigna un valor.
**Parámetros**
- `
key`
**Requerido**: El nombre de la configuración.
- `
value`
: El valor de la configuración. **Por defecto:**
-1.
**Configuraciones disponibles**
Algunas de las configuraciones disponibles y sus valores se encuentran en la lista a continuación.
JSON
```
{
"registration-required": "",
"registration-timetable": false,
"registration-offline": false,
"registration-link": "",
"visitors-registration": false,
"privacy": false,
"popup": true,
"popup-mobile-hidden": true,
"welcome": false,
"welcome-trigger": "open",
"welcome-delay": 0,
"follow": false,
"follow-delay": "1000",
"chat-manual-init": false,
"chat-login-init": false,
"sound": ["code": "n", "volume": 0.5, "repeat": 5],
"header-name": true,
"desktop-notifications": "all",
"flash-notifications": "all",
"push-notifications": true,
"notifications-icon": "",
"bot-id": "377",
"bot-name": "Bruce Peterson",
"bot-image": "",
"bot-delay": 0,
"dialogflow-office-hours": false,
"dialogflow-active": true,
"dialogflow-human-takeover": false,
"slack-active": false,
"rich-messages": [
"email",
"registration",
"login",
"timetable",
"articles",
"immagine",
"video"
],
"display-users-thumb": true,
"hide-agents-thumb": true,
"notify-user-email": true,
"notify-agent-email": false,
"translations": false,
"auto-open": false,
"office-hours": true,
"disable-office-hours": false,
"disable-offline": false,
"timetable": false,
"timetable-hide": [
false,
"checkbox"
],
"articles": true,
"articles-title": "",
"init-dashboard": false,
"wp": false,
"wp-users-system": "sb",
"queue": false,
"queue-message": "",
"queue-message-success": "",
"queue-response-time": "",
"routing": false,
"webhooks": true,
"agents-online": false,
"timetable-message": "",
"tickets-registration-required": true,
"tickets-registration-redirect": "",
"tickets-default-form": "login",
...
}
```
---
### SBF.shortcode()
Convierte un shortcode en un array que contiene el nombre del shortcode y la configuración del mismo.
**Parámetros**
- `
shortcode`
**Requerido**
: La cadena del shortcode, ej. `
[rating title="Califique su conversación" message="Cuéntenos su experiencia." success="¡Gracias!"]`.
**Respuesta**
JSON
```
[
"rating",
{
"title": "Califique su conversación",
"message": "Cuéntenos su experiencia.",
"success": "¡Gracias!"
}
]
```
---
### SBF.openWindow()
Abre una página web en una nueva ventana.
**Parámetros**
- `
link`
**Requerido**: El enlace a abrir.
- `
width`: El ancho de la ventana en px.
- `
height`: La altura de la ventana en px.
---
### SBF.loadResource()
Incluye un archivo .js o .css en el área `
`
de la página.
**Parámetros**
- `
url`
**Requerido**: La URL del archivo a cargar.
- `
script`
: Establézcalo en `
true`
para archivos .js. **Por defecto:**
archivos .css.
---
### SBF.debounce()
Ejecuta la función dada solo una vez por el tiempo en milisegundos dado; el temporizador se reinicia en cada llamada.
**Parámetros**
- `
bounceFunction`
**Requerido**
: Función a ejecutar cuando la función se completa. Sintaxis: `
function() { ... }`.
- `
id`: Inserte una cadena única y aleatoria nunca usada por otras instancias de debounce. Las cadenas #1, #2, #3, #4, ... están reservadas y no pueden usarse.
- `
interval`
: El tiempo mínimo en milisegundos entre la nueva ejecución y la anterior. **Por defecto:**
500.
---
### SBF.translate()
Traduce una cadena utilizando las traducciones de ZampiBot.
**Parámetros**
- `
string`
**Requerido**: La cadena a traducir.
---
### SBF.escape()
Escapa una cadena (sanitización).
**Parámetros**
- `
string`
**Requerido**: La cadena a escapar.
---
### SBF.convertUTCDateToLocalDate()
Convierte una fecha a la hora local.
**Parámetros**
- `
datetime`
**Requerido**: La cadena de fecha y hora. Formato: Y/m/d H:i:s.
- `
UTCoffset`
: Un desplazamiento UTC. **Por defecto:**
0.
**Respuesta**
`
Mon Jan 30 2023 10:45:00 GMT+0000 (Greenwich Mean Time)`
---
### SBF.getLocationTimeString()
Devuelve una cadena que contiene la ubicación y la hora local actual de la zona horaria dada.
**Parámetros**
- `
details`
**Requerido**
: Array con los detalles de la ubicación, ej. `
{ "timezone" : "", "country" : "", "city" : "" }`
. Esta función acepta el método `
extra`
de cualquier objeto `
SBUser`
, ej. `
SBF.getLocationTimeString(activeUser().extra, function(){})`.
- `
onSuccess`
**Requerido**
: Función a ejecutar cuando la función se completa. Sintaxis: `
function(response) { ... }`.
**Respuesta**
`
05:15 AM in London, United Kingdom`
---
### SBF.beautifyTime()
Convierte una fecha al formato local y realiza otras optimizaciones para hacer la fecha más amigable.
**Parámetros**
- `
date`
**Requerido**: Fecha y hora en el siguiente formato: YYYY-MM-DD HH:MM:SS. Ej. 2020-05-13 13:35:59. Puede eliminar la hora y dejar solo la fecha. Las fechas almacenadas en la base de datos están en UTC+0.
- `
extended`
: Establézcalo en `
true`
para incluir minutos y segundos. **Por defecto:**
`
false`.
- `
future`
: Establézcalo en `
true`
si la fecha es una fecha futura. **Por defecto:**
`
false`.
**Respuesta**
`
30/01/2023`
---
### SBF.dateDB()
Convierte un formato de fecha al formato de fecha de la base de datos y establece el UTC en +0.
**Parámetros**
- `
date`
**Requerido**
: Fecha y hora en el siguiente formato: YYYY-MM-DD HH:MM:SS. Ej. 2020-05-13 13:35:59. Puede eliminar la hora y dejar solo la fecha. Ingrese `
now`
para obtener la fecha y hora actual. Las fechas almacenadas en la base de datos están en UTC+0.
---
### SBF.UTC()
Devuelve la fecha y hora especificada en formato unix utilizando el desplazamiento UTC establecido en `
Configuración > Misceláneas > Zona horaria`.
**Parámetros**
- `
datetime`
**Requerido**: La cadena de fecha y hora.
**Respuesta**
`
1675075500000`
---
### SBF.unix()
Obtiene el valor de la marca de tiempo (timestamp) unix de una cadena de fecha y hora con formato `
yyyy-mm-dd hh:mm:ss`.
**Parámetros**
- `
datetime`
**Requerido**: La cadena de fecha y hora.
**Respuesta**
`
1675075500000`
---
# ⚡ JAVASCRIPT API: Eventos
Los eventos le permiten interceptar las acciones de ZampiBot en tiempo real y ejecutar código JavaScript personalizado cuando se dispara una acción.
### Uso
Utilice el código a continuación y reemplace `
EVENT-NAME`
con el nombre del evento. La `
response`
(respuesta) representa el valor devuelto si solo hay un atributo; de lo contrario, es un array de valores. Se requiere **JQuery**.
JavaScript
```
$(document).on("EVENT-NAME", function (e, response) {
// Su código aquí
});
```
**Ejemplo:**
JavaScript
```
$(document).on("SBMessageSent", function (e, response) {
console.log(response["user_id"]);
console.log(response["conversation_id"]);
console.log(response["message"]);
});
```
---
### SBReady
Evento disparado al cargar la página después de que el script del chat `
main.js`
se haya cargado. Este evento también se dispara en el área de administración.
---
### SBInit
Evento disparado al cargar la página cuando el chat ha completado la inicialización.
---
### SBTicketsInit
Evento disparado al cargar la página cuando el área de tickets ha completado la inicialización. Este evento está disponible solo cuando la App de Tickets está activa.
---
### SBLogout
Evento disparado cuando el usuario activo cierra sesión.
---
### SBError
Evento disparado cuando ocurre un error en ZampiBot.
**Respuesta**
- `
message`: El mensaje de error.
- `
function_name`: El nombre de la función que generó el error.
---
### SBDoubleLoginError
Evento disparado en la inicialización del chat si un agente o un administrador ya ha iniciado sesión.
---
### SBUserDeleted
Evento disparado cuando se elimina un usuario.
**Respuesta**
El ID del usuario que ha sido eliminado.
---
### SBMessageSent
Evento disparado cuando se ha enviado un nuevo mensaje.
**Respuesta**
- `
user_id`: El ID del usuario que envió el mensaje.
- `
user`: El objeto de usuario.
- `
conversation_id`: El ID de la conversación vinculada al mensaje.
- `
conversation_status`: El código de estado de la conversación vinculada al mensaje. (0=activo, 1=esperando usuario, 2=esperando agente, 3=archivo, 4=papelera).
- `
message_id`: El ID del mensaje.
- `
message`: El texto del mensaje.
- `
attachments`: Los adjuntos del mensaje.
- `
conversation_source`
: La fuente de la conversación. Fuentes disponibles: `
em`
(Email), `
tk`
(Ticket), `
wa`
(WhatsApp), `
fb`
(Facebook Messenger), `
ig`
(Instagram), `
tw`
(Twitter), `
wc`
(WeChat), `
tx`
(Mensaje de texto), `
gb`
(Google Business Messages), `
ln`
(LINE), `
vb`
(Viber).
---
### SBBotMessage
Evento disparado cuando el chatbot responde a un mensaje.
**Respuesta**
- `
response`: El array de respuesta en formato JSON de Dialogflow.
- `
message`: El mensaje de entrada del usuario.
---
### SBSlackMessageSent
Evento disparado cuando se envía un mensaje a Slack.
**Respuesta**
- `
message`: El texto del mensaje.
- `
conversation_id`: El ID de la conversación vinculada al mensaje.
---
### SBEmailSent
Evento disparado cuando se envía un correo electrónico de notificación a un usuario o un agente.
**Respuesta**
- `
recipent_id`: El ID del usuario que recibirá el correo.
- `
message`: El mensaje del correo.
- `
attachments`: Los adjuntos del correo.
---
### SBNotificationsUpdate
Evento disparado cuando se actualiza el contador rojo de notificaciones del botón de chat que alerta al usuario de nuevos mensajes y conversaciones.
**Respuesta**
- `
conversation_id`
: La acción puede ser `
add`
si el contador aumenta en 1, o `
remove`
si disminuye en 1.
- `
message_id`
: El ID del mensaje no leído; si se establece, el contador aumenta en 1. Si es `
false`, el contador disminuye en 1.
---
### SBConversationOpen
Evento disparado cuando una conversación está completamente cargada y se abre en el chat.
**Respuesta**
- `
response`
: La conversación como un objeto `
SBConversation`.
---
### SBNewMessagesReceived
Evento disparado cuando hay nuevos mensajes en la conversación activa.
**Respuesta**
- `
messages`
: Array de objetos `
SBMessage`.
- `
conversation_id`: El ID de conversación vinculado a los mensajes.
---
### SBMessageDeleted
Evento disparado cuando se elimina un mensaje.
**Respuesta**
El ID del mensaje que ha sido eliminado.
---
### SBNewConversationReceived
Evento disparado cuando se recibe una nueva conversación.
**Respuesta**
La nueva conversación como un objeto `
SBConversation`.
---
### SBNewConversationCreated
Evento disparado cuando se crea una nueva conversación.
**Respuesta**
La nueva conversación como un objeto `
SBConversation`.
---
### SBActiveConversationChanged
Evento disparado cuando se cambia la conversación activa.
**Respuesta**
La nueva conversación activa como un objeto `
SBConversation`.
---
### SBActiveConversationStatusUpdated
Evento disparado cuando se actualiza el código de estado de la conversación activa.
**Respuesta**
- `
conversation_id`: El ID de la conversación.
- `
status_code`: El nuevo código de estado de la conversación. (0=activo, 1=esperando usuario, 2=esperando agente, 3=archivo, 4=papelera).
---
### SBPopulateConversations
Evento disparado después de que se han obtenido todas las conversaciones del usuario.
**Respuesta**
- `
conversations`
: Array de conversaciones como objetos `
SBConversation`.
---
### SBChatOpen
Evento disparado cuando se abre el chat.
---
### SBChatClose
Evento disparado cuando se cierra el chat.
---
### SBQueueUpdate
Evento disparado cuando se inicia la cola y cada vez que la cola se actualiza.
**Respuesta**
La posición del usuario en la cola. Si la posición es 0, la cola ha terminado y el usuario puede iniciar el chat.
---
### SBBusy
Evento disparado cuando cambia el estado de "ocupado" del chat. El chat está ocupado si está operando, como enviando un mensaje. Cuando el chat está ocupado, algunas funciones no se pueden disparar, como enviar un nuevo mensaje.
**Respuesta**
Devuelve `
true`
si el chat está ocupado, de lo contrario `
false`.
---
### SBDashboard
Evento disparado cuando se muestra el panel de control (dashboard).
---
### SBDashboardClosed
Evento disparado cuando se cierra el panel de control y se muestra una conversación en su lugar.
---
### SBTyping
Evento disparado cuando un usuario o un agente está escribiendo en el editor.
**Respuesta**
Devuelve `
true`
si el usuario o agente está escribiendo, de lo contrario devuelve `
false`.
---
### SBArticles
Evento disparado cuando se muestra el panel de artículos o cuando se abre un solo artículo.
**Respuesta**
- `
id`
: El ID del artículo. Este valor es `
-1`
si se muestra el panel de artículos.
- `
articles`: Puede ser el array con los detalles del artículo individual o el array con la lista de todos los artículos.
---
### SBPrivacy
Evento disparado en la inicialización del chat si se muestra el formulario de privacidad.
---
### SBPopup
Evento disparado cuando se muestra un mensaje emergente (pop-up).
**Respuesta**
El array con el contenido del pop-up: `
{ image: "", title: "", message: "" }`.
---
### SBFollowUp
Evento disparado cuando se envía el mensaje de seguimiento.
---
### SBWelcomeMessage
Evento disparado cuando se envía el mensaje de bienvenida.
---
### SBLoginForm
Evento disparado cuando el usuario inicia sesión correctamente desde el formulario de inicio de sesión del chat. Este evento se dispara solo si el inicio de sesión es exitoso.
**Respuesta**
El usuario como un objeto `
SBUser`.
---
### SBRegistrationForm
Evento disparado cuando el usuario se registra correctamente desde el formulario de registro del chat. Este evento se dispara solo si el registro es exitoso. También se dispara si el registro se actualiza a través del formulario de Mensaje Enriquecido.
**Respuesta**
- `
user`: Array con los detalles del usuario.
- `
extra`: Array con los detalles adicionales del usuario.
---
### SBRichMessageShown
Evento disparado cuando se muestra un Mensaje Enriquecido (Rich Message) cargado asíncronamente.
**Respuesta**
- `
name`: El nombre del Mensaje Enriquecido.
- `
settings`: La configuración del Mensaje Enriquecido.
- `
response`: El código HTML del Mensaje Enriquecido.
---
### SBRichMessageSubmit
Evento disparado cuando se recibe la respuesta de un Mensaje Enriquecido.
**Respuesta**
- `
result`: La respuesta del Mensaje Enriquecido.
- `
data`: Los detalles del Mensaje Enriquecido y los datos enviados por el usuario.
- `
id`: El ID del Mensaje Enriquecido.
---
### SBAttachments
Evento disparado cuando el usuario adjunta un archivo.
---
### SBNewEmailAddress
Evento disparado cuando un usuario registra su correo electrónico a través del mensaje de seguimiento o el formulario de registro.
**Respuesta**
- `
name`: El nombre completo del usuario.
- `
email`: El correo electrónico del usuario.
- `
ID`: El ID del mensaje enriquecido.
---
### SBPanelActive
Evento disparado cuando se abre un panel del área de Tickets. Este evento está disponible solo cuando la App de Tickets está activa.
**Respuesta**
- `
name`
: El nombre del panel activo. Valores: `
new-ticket`
, `
privacy`
, `
articles`
, `
edit-profile`
, `
login`
, `
registration`. Si el valor está vacío, el área de conversación principal está activa.
- `
email`: El correo electrónico del usuario.
---
### SBBotPayload
Evento disparado cuando un mensaje de Dialogflow contiene un Payload de ZampiBot. Ejemplos de payload: `
human-takeover`
, `
redirect`
, `
woocommerce-update-cart`
, `
woocommerce-checkout`.
**Respuesta**
El nombre del payload.
---
### SBBotAction
Evento disparado cuando un mensaje de Dialogflow contiene una acción de Dialogflow. Actualmente solo está disponible la acción `
end`
(Finalizar conversación).
**Respuesta**
El nombre de la acción.
---
### SBSMSSent
Evento disparado cuando se envía una notificación por mensaje de texto a un usuario o un agente.
**Respuesta**
- `
recipent_id`: El ID del usuario que recibirá el mensaje de texto.
- `
message`: El mensaje de texto.
- `
response`: La respuesta de Twilio.
---
### SBActiveUserLoaded
Evento disparado cuando el usuario activo ha sido cargado.
**Respuesta**
- `
recipent_id`: El ID del usuario que recibirá el mensaje de texto.
- `
message`: El mensaje de texto.
- `
response`: La respuesta de Twilio.
---
### SBOpenAIMessage
Evento disparado cuando OpenAI (ChatGPT) devuelve una respuesta.
**Respuesta**
- `
response`: La respuesta de OpenAI.
- `
message`: El mensaje de texto.
- `
response`: La respuesta de Twilio.
---
### SBGetUser
Evento disparado cuando los detalles de un usuario son obtenidos de la base de datos.
**Respuesta**
El usuario como un objeto `
SBUser`.
---
### SBSettingsSaved
Evento disparado cuando se guardan las configuraciones del área de administración.
**Respuesta**
- `
settings`: Las configuraciones.
- `
external_settings`: Configuraciones guardadas en una entrada dedicada de la base de datos.
- `
external_settings_translations`: Traducciones de configuraciones externas.
---
# 🔄 MISCELÁNEOS: AJAX
### Funciones AJAX
Lista de funciones AJAX. Las funciones AJAX son similares a la WEB API: utilizan el mismo nombre de función, los mismos parámetros y devuelven las mismas respuestas.
Utilice la función a continuación para iniciar una llamada AJAX:
JavaScript
```
SBF.ajax({
function: 'NOMBRE-DE-LA-FUNCION',
parameter: value,
parameter: value,
...
}, (response) => {
// Su código va aquí
});
```
Reemplace `
NOMBRE-DE-LA-FUNCION`
con el nombre de una de las funciones a continuación. Reemplace la lista de `
parameter: value`
con los parámetros de la función. Los parámetros y respuestas son los mismos que en la WEB API. La respuesta está en formato JSON.
**¡Advertencia!**
No incluya el token en los parámetros. El token debe mantenerse siempre en secreto.
---
### Lista de Funciones Disponibles
**Las funciones marcadas como "Función de Admin" requieren permisos especiales.**
- **upload-path**: Función de Admin (requiere admin).
- **update-bot**: Función de Admin (requiere admin).
- **get-last-message**: Función de Admin (requiere admin).
- **delete-attachments**: Función de Admin (requiere admin).
- **execute-bot-message**: Si es usuario final, solo conversaciones propias. Si es agente/admin, cualquier conversación.
- **logs**: Función de Admin (requiere agente o admin).
- **newsletter**: Función de Admin (requiere agente o admin).
- **get-last-agent-in-conversation**: Función de Admin (requiere agente o admin).
- **messaging-platforms-send-message**: Función de Admin (requiere agente o admin).
- **aws-s3**: Si es usuario final, solo su ID. Si es agente/admin, cualquier usuario.
- **is-allowed-extension**: Si es usuario final, solo su ID. Si es agente/admin, cualquier usuario.
- **translate-string**: Si es usuario final, solo su ID. Si es agente/admin, cualquier usuario.
- **saved-replies**
- **get-settings**: Función de Admin (requiere admin).
- **save-settings**: Función de Admin (requiere admin).
- **get-multi-setting**: Función de Admin (requiere admin).
- **save-external-setting**: Función de Admin (requiere admin).
- **get-external-setting**: Función de Admin (requiere admin).
- **export-settings**: Función de Admin (requiere admin).
- **import-settings**: Función de Admin (requiere admin).
- **is-online**: Función de Admin (requiere agente o admin).
- **add-user**
: Los atributos principales van en `
settings`
y los extra en `
extra_settings`.
- **add-user-and-login**
- **get-user**: Restringido al propio usuario si no es admin/agente.
- **get-user-by**: Función de Admin (requiere admin).
- **get-users**: Función de Admin (requiere agente o admin).
- **get-new-users**: Función de Admin (requiere agente o admin).
- **get-user-extra**: Restringido al propio usuario si no es admin/agente.
- **get-user-language**: Función de Admin (requiere agente o admin).
- **get-online-users**: Función de Admin (requiere agente o admin).
- **get-user-from-conversation**: Función de Admin (requiere agente o admin).
- **agents-online**
- **search-users**: Función de Admin (requiere agente o admin).
- **delete-user**: Función de Admin (requiere admin).
- **delete-users**: Función de Admin (requiere admin).
- **update-user**
: Los atributos principales van en `
settings`
y los extra en `
extra_settings`. Restringido al propio ID si no es admin/agente.
- **update-user-to-lead**: Restringido al propio ID si no es admin/agente.
- **count-users**: Función de Admin (requiere agente o admin).
- **get-conversations**
: Función de Admin (requiere agente o admin). Argumento `
routing`
disponible.
- **get-new-conversations**
: Función de Admin (requiere agente o admin). Argumento `
queue`
disponible.
- **get-conversation**: Restringido a conversaciones propias si no es admin/agente.
- **get-user-conversations**: Restringido a propias si no es admin/agente.
- **get-new-user-conversations**: Restringido a propias si no es admin/agente.
- **search-conversations**: Función de Admin (requiere agente o admin).
- **search-user-conversations**
: Restringido a propias si no es admin/agente. `
user_id`
no requerido (por defecto usuario activo).
- **new-conversation**: Restringido a propias si no es admin/agente.
- **update-conversation-status**
- **update-conversation-department**: Restringido a propias si no es admin/agente.
- **update-conversation-agent**: Restringido a propias si no es admin/agente.
- **get-new-messages**: Restringido a propias si no es admin/agente.
- **send-message**: Restringido a propias si no es admin/agente.
- **send-email**: Si es usuario final, solo a agentes/admins. Si es agente/admin, a cualquiera.
- **send-slack-message**: Restringido a propias si no es admin/agente.
- **update-message**: Restringido a mensajes propios si no es admin/agente.
- **update-messages-status**: Restringido a mensajes propios si no es admin/agente.
- **delete-message**: Restringido a mensajes propios si no es admin/agente.
- **slack-users**: Función de Admin (requiere agente o admin).
- **archive-slack-channels**: Función de Admin (requiere agente o admin).
- **slack-channels**: Función de Admin (requiere admin).
- **current-url**
- **set-rating**: Restringido a conversaciones propias si no es admin/agente.
- **get-rating**: Función de Admin (requiere agente o admin).
- **get-articles**
- **save-article**: Función de Admin (requiere agente o admin).
- **search-articles**
- **get-articles-categories**: Función de Admin (requiere agente o admin).
- **save-articles-categories**: Función de Admin (requiere agente o admin).
- **article-ratings**
- **get-versions**
- **update**: Función de Admin (requiere agente o admin).
- **app-get-key**: Función de Admin (requiere admin).
- **app-activation**: Función de Admin (requiere admin).
- **csv-users**: Función de Admin (requiere admin o agente).
- **transcript**: Restringido a conversaciones propias si no es admin/agente.
- **is-agent-typing**: Función de Admin (requiere admin o agente).
- **dialogflow-message**: Funciona solo para el usuario activo.
- **dialogflow-get-intents**: Función de Admin (requiere admin).
- **dialogflow-create-intent**: Función de Admin (requiere admin).
- **dialogflow-update-intent**: Función de Admin (requiere admin).
- **dialogflow-entity**: Función de Admin (requiere admin).
- **dialogflow-get-entity**: Función de Admin (requiere admin o agente).
- **google-get-token**
- **dialogflow-get-agent**: Función de Admin (requiere admin o agente).
- **dialogflow-set-active-context**: Restringido a usuario activo si no es admin/agente.
- **dialogflow-curl**: Función de Admin (requiere admin).
- **dialogflow-human-takeover**: Restringido a usuario activo si no es admin/agente.
- **dialogflow-smart-reply**: Función de Admin (requiere admin o agente).
- **cron-jobs**
- **woocommerce-get-customer**: Función de Admin (requiere admin o agente).
- **woocommerce-get-user-orders**: Función de Admin (requiere admin o agente).
- **woocommerce-get-order**: Función de Admin (requiere admin o agente).
- **woocommerce-get-product**: Función de Admin (requiere admin o agente).
- **woocommerce-get-products**: Función de Admin (requiere admin o agente).
- **woocommerce-search-products**: Función de Admin (requiere admin o agente).
- **woocommerce-get-taxonomies**: Función de Admin (requiere admin).
- **woocommerce-get-attributes**: Función de Admin (requiere admin).
- **woocommerce-get-product-id-by-name**: Función de Admin (requiere admin o agente).
- **woocommerce-get-product-images**: Función de Admin (requiere admin o agente).
- **woocommerce-get-product-taxonomies**: Función de Admin (requiere admin o agente).
- **woocommerce-get-attribute-by-term**: Función de Admin (requiere admin o agente).
- **woocommerce-get-attribute-by-name**: Función de Admin (requiere admin o agente).
- **woocommerce-is-in-stock**: Función de Admin (requiere admin o agente).
- **woocommerce-coupon**: Función de Admin (requiere admin o agente).
- **woocommerce-coupon-check**: Función de Admin (requiere admin o agente).
- **woocommerce-coupon-delete-expired**: Función de Admin (requiere admin o agente).
- **woocommerce-get-url**: Función de Admin (requiere admin o agente).
- **woocommerce-get-session**: Función de Admin (requiere admin).
- **woocommerce-get-session-key**: Función de Admin (requiere admin o agente).
- **woocommerce-payment-methods**: Función de Admin (requiere admin o agente).
- **woocommerce-shipping-locations**: Función de Admin (requiere admin o agente).
- **chat-css**
- **get-avatar**: Restringido a usuario activo si no es admin/agente.
- **get-agents-ids**: Función de Admin (requiere admin o agente).
- **get-users-with-details**: Función de Admin (requiere admin o agente).
- **send-custom-email**: Función de Admin (requiere admin o agente).
- **send-sms**: Restringido a usuario activo si no es admin/agente.
- **email-piping**
- **get-notes**: Función de Admin (requiere admin o agente).
- **add-note**: Función de Admin (requiere admin o agente).
- **delete-note**: Función de Admin (requiere admin o agente).
- **automations-get**
- **automations-save**: Función de Admin (requiere admin).
- **automations-validate**
- **automations-run-all**
- **automations-run**
- **automations-is-sent**: Función de Admin (requiere agente o admin).
- **get-agents-in-conversation**: Restringido a conversaciones propias si no es admin/agente.
- **get-departments**
- **login**
- **logout**
- **update-login**: Restringido a conversaciones propias si no es admin/agente.
- **is-typing**
- **set-typing**
- **clean-data**: Función de Admin (requiere admin o agente).
- **get-translation**
- **get-translations**
- **save-translations**: Función de Admin (requiere agente o admin).
- **delete-leads**: Función de Admin (requiere admin).
- **reports**: Función de Admin (requiere admin).
- **reports-update**: Función de Admin (requiere admin).
- **direct-message**: Función de Admin (requiere agente o admin).
- **count-conversations**: Función de Admin (requiere agente o admin).
- **updates-available**: Función de Admin (requiere admin).
- **google-translate**: Función de Admin (requiere admin o agente).
- **google-language-detection-update-user**: Restringido a conversaciones propias si no es admin/agente.
- **check-conversations-assignment**: Función de Admin (requiere admin o agente).
---
### Más funciones AJAX
Las siguientes funciones están disponibles solo a través de AJAX.
## close-message
Envía el mensaje de cierre a una conversación. Puede establecer el mensaje de cierre en el área `
Configuración > Chat`.
**Requisitos**
Esta es una función de administración y funciona solo si el usuario activo es un **agente**.
**Parámetros**
- `
function`
**Requerido**
: Inserte `
close-message`.
- `
bot_id`
**Requerido**
: El ID del bot. Use la función `
SBF.setting("bot-id")`
para obtener el ID del bot. Si está en el área de administración use `
SB_ADMIN_SETTINGS['bot-id']`
en su lugar.
- `
conversation_id`
**Requerido**: El ID de la conversación a la cual enviar el mensaje.
**Respuesta**
JSON
```
{
"success": true,
"response": {
"status": "success",
"message-id": 123456,
"queue": false
}
}
```
---
#### update-user-and-message
Actualiza los detalles de un usuario y el contenido de un mensaje.
**Requisitos**
Si el usuario activo es un **usuario**
, solo se puede actualizar el usuario activo y solo los mensajes vinculados a las conversaciones del usuario. Si el usuario activo es un **agente**
o **admin**, la función funciona para cualquier usuario y cualquier mensaje.
**Parámetros**
- `
function`
**Requerido**
: Ingrese `
update-user-and-message`.
- `
user_id`
**Requerido**: El ID del usuario a actualizar.
- `
settings`
: Array con los detalles del usuario. Ej: `
{ first_name: "Don", last_name: "John", profile_image: "image.jpg", email: "example@gmail.com", user_type: "admin" }`.
- `
settings_extra`
: Array con detalles adicionales del usuario. Sintaxis del array: `
{ "ID": ["valor", "Nombre"], ...}`.
- `
message_id`: El ID del mensaje a actualizar.
- `
message`: El texto del mensaje.
- `
payload`
: Array asociativo conteniendo datos extra, ej. `
{"rich-messages":{"123":{"type":"buttons","result":"Premium Plan"}}}`.
**Respuesta**
`
true`
---
#### get-agent
Devuelve los detalles de un agente, administrador o bot.
**Parámetros**
- `
agent_id`
**Requerido**: El ID del agente.
**Respuesta**
JSON
```
{
"id": "2",
"first_name": "Don",
"last_name": "John",
"department": null,
"flag": "gb.png",
"country_code": "GB",
"details": [
{
"slug": "city",
"name": "City",
"value": "London"
},
{
"slug": "country",
"name": "Country",
"value": "United Kingdom"
},
{
"slug": "sport",
"name": "Sport",
"value": "email@example.com"
},
{
"slug": "timezone",
"name": "Timezone",
"value": "Europe/London"
}
...
]
}
```
---
#### user-autodata
Obtiene los siguientes detalles sobre el usuario activo y actualiza los detalles del usuario: IP, ciudad, ubicación, país, zona horaria, moneda, navegador, idioma del navegador, sistema operativo.
**Parámetros**
- `
user_id`
**Requerido**: El ID del usuario.
**Respuesta**
`
true`
---
#### get-agent-department
Devuelve el departamento del agente o administrador activo.
**Respuesta**
Devuelve el ID del departamento si está establecido; de lo contrario, devuelve `
false`.
# CASOS DE USO
# 📚 Casos de uso (Use cases)
Los casos de uso son ejemplos del mundo real de la API. Pueden ser una combinación de diferentes lenguajes, APIs y configuraciones. Están diseñados para completar tareas específicas.
## 👤 Registrar un usuario personalizado e iniciar sesión
Este caso de uso explica cómo registrar manualmente un usuario personalizado e iniciar sesión antes de iniciar el chat. Se recomiendan los métodos: **VARIABLE JS**
, **API PHP**
y **API PHP + JS + WEB**.
### Método 1: VARIABLE JS
Simplemente ingrese la variable `
SB_DEFAULT_USER`
. **Consulte la documentación de la API JS para más detalles sobre esta variable.**
---
### Método 2: API PHP
**1. Registrar al usuario e iniciar sesión**
Verifique si un usuario activo ya ha iniciado sesión comprobando el correo electrónico. Si es así, inicie sesión; de lo contrario, registre un nuevo usuario.
```php
require_once($_SERVER["DOCUMENT_ROOT"] . "/chatbot.zampisoft.com/include/functions.php");
$active_user = sb_get_active_user();
if (!$active_user || $active_user["email"] != "don.john@email.com") {
$response = sb_add_user_and_login([
"profile_image" => "https://chatbot.zampisoft.com/media/docs/user.png",
"first_name" => "Don",
"last_name" => "John",
"email" => "don.john@email.com",
"password" => "12345678"
], [
"phone" => ["123456789", "Phone"],
"city" => ["London", "City"]
]);
if ($response == "duplicate-email") {
$response = sb_login("don.john@email.com", "12345678");
}
}
```
---
### Método 3: API PHP + JS + WEB
**1. Habilitar la inicialización manual**
Vaya a `
Configuración > Chat`
, marque la opción **Inicialización manual**
y guarde.
**2. Imprimir el código JS para registrar e iniciar sesión**
Genere un código JS para insertar en todas las páginas que contienen el chat.
```php
$existing_user_email = 'don.john@email.com';
$sb_user = supportboard_curl(['function' => 'get-user-by', 'by' => 'email', 'value' => $existing_user_email]);
$code_login_existing_user = '';
if (isset($sb_user['success']) && $sb_user['success']) {
$sb_user = $sb_user['response'];
$code_login_existing_user = 'SBF.login("", "", "' . $sb_user['id'] . '", "' . $sb_user['token'] . '", () => { SBChat.initChat(); });';
}
$code = 'jQuery(document).on("SBReady", function () {
SBF.getActiveUser(true, () => {
if (!SBF.activeUser() || (SBF.activeUser().email != "' . $existing_user_email . '")) {
SBF.ajax({
function: "add-user-and-login",
settings: { profile_image: "https://chatbot.zampisoft.com/media/docs/user.png", first_name: "Don", last_name: "John", email: "don.john@email.com" },
settings_extra: { phone: ["123456789", "Phone"], city: ["London", "City"] }
}, (response) => {
if (!SBF.errorValidation(response)) {
SBF.loginCookie(response[1]);
SBF.activeUser(new SBUser(response[0]));
SBChat.initChat();
} else if (response[1] == "duplicate-email") {
' . $code_login_existing_user . '
} else {
SBChat.initChat();
}
});
}
});
});';
echo $code;
```
---
### Método 4: API JAVASCRIPT
**1. Habilitar la inicialización manual**
Vaya a `
Configuración > Chat`
, marque la opción **Inicialización manual**
y guarde.
**2. Registrar al usuario e iniciar sesión**
**¡Advertencia! Este método no es seguro, la contraseña y los detalles del usuario son visibles para todos.**
```javascript
jQuery(document).on("SBReady", function () {
SBF.getActiveUser(true, () => {
if (!SBF.activeUser() || (SBF.activeUser().email != "don.john@email.com")) {
SBF.ajax({
function: "add-user-and-login",
settings: { profile_image: "https://chatbot.zampisoft.com/media/docs/user.png", first_name: "Don", last_name: "John", email: "don.john@email.com", password: "12345678" },
settings_extra: { phone: ["123456789", "Phone"], city: ["London", "City"] }
}, (response) => {
if (!SBF.errorValidation(response)) {
SBF.loginCookie(response[1]);
SBF.activeUser(new SBUser(response[0]));
SBChat.initChat();
} else if (response[1] == "duplicate-email") {
SBF.login("don.john@email.com", "12345678", "", "", () => { SBChat.initChat(); });
} else console.log(response);
});
} else {
SBChat.initChat();
}
});
});
```
---
## 📄 Mostrar el chat solo en páginas específicas
Este caso de uso explica cómo mostrar el chat solo en páginas específicas.
Este caso de uso explica cómo mostrar el chat únicamente en páginas específicas.
**1. Habilitar la inicialización manual**
Vaya a `
Configuración > Chat`
, marque la opción **Inicialización manual**
y guarde.
**2. Inicializar el chat**
Inicialice el chat con la función `
SBChat.initChat()`
de la **API de JavaScript**
. Puede utilizar la variable JS `
window.location.href`
para obtener la URL y mostrar el chat solo si la URL coincide con sus criterios. Tenga en cuenta que también puede utilizar la variable JavaScript `
SB_DISABLED = true`
para deshabilitar el chat en páginas específicas.
```javascript
$(document).on("SBReady", function () {
// Ejemplo: mostrar el chat solo en la página de contacto
if (window.location.href.indexOf("/contact") > 0) {
SBChat.initChat();
}
// Ejemplo: mostrar el chat solo en la página de inicio
if (window.location.href == "https://example.com") {
SBChat.initChat();
}
});
```
---
## 🖱️ Abrir el chat al hacer clic
Este caso de uso explica cómo abrir el chat solo cuando el usuario hace clic en un botón. La forma más sencilla es añadir la clase o ID `
sb-open-chat`
a cualquier elemento (por ejemplo, un botón) para abrir o cerrar el chat cuando se haga clic en ese elemento.
```
Clic aquí
```
También puede usar la función `
SBChat.open()`:
```
Clic aquí
```
---
## 👁️ Mostrar el chat al hacer clic
Este caso de uso muestra el chat solo después de que el usuario hace clic en un botón.
**1. Habilitar inicialización manual y apertura automática**
Habilite `
Configuración > Chat > Inicialización manual`
y `
Configuración > Chat > Abrir automáticamente`, y guarde.
**2. Mostrar el chat**
Use `
SBChat.initChat()`
. Para abrirlo en móviles, use también `
SBChat.open()`.
```html
Clic aquí
```
---
## 🔄 Mostrar y ocultar el chat al hacer clic
El primer clic muestra el chat, el segundo lo oculta.
**1. Habilitar la inicialización manual**
Vaya a `
Configuración > Chat`
, marque la opción **Inicialización manual**
y guarde.
**2. Añadir el código de eventos de clic**
Reemplace `
button-id`
con el ID de su botón.
```javascript
$("body").on("click", "#button-id", function () {
SBChat.initChat();
$(".sb-chat-btn").show();
setTimeout(function () {
SBChat.open();
}, 500);
});
$("body").on("click", ".sb-chat .sb-chat-btn", function () {
$(this).hide();
});
```
---
## 🏢 Crear conversación y asignar departamento
Este caso de uso explica cómo crear una nueva conversación, asignarle un departamento y abrirla en el chat. Si desea que todas las conversaciones se asignen automáticamente a un departamento fijo, utilice la variable de JavaScript `
SB_DEFAULT_DEPARTMENT`
. Puede obtener los IDs en `
Configuración > Misceláneas > Departamentos`.
**1. Crear una nueva conversación y abrirla**
Cree una nueva conversación con la función `
SBChat.newConversation()`
de la **API de JavaScript**
y pase el ID del departamento `
2`
en los argumentos de la función. Después de crear la conversación, esta se abre con la función `
SBChat.openConversation()`. En el fragmento de código a continuación, la conversación se crea solo si el usuario no tiene otras conversaciones.
```javascript
$(document).on("SBInit", function () {
if (SBF.activeUser() != false && SBF.activeUser().conversations.length == 0) {
// ID de departamento es el primer argumento (2)
SBChat.newConversation(2, -1, "", [ ], 2, null, function (conversation) {
SBChat.openConversation(conversation.id);
});
}
});
```
---
## 🕵️ Crear conversación y asignar agente
Este caso de uso explica cómo crear una nueva conversación, asignarle un agente existente y permitir que solo ese agente vea la conversación en el área de administración.
**1. Habilitar el enrutamiento**
Vaya a `
Configuración > Misceláneas`
, marque la opción **Enrutamiento**
y guarde.
**2. Crear una nueva conversación y abrirla**
Cree una nueva conversación con la función `
SBChat.newConversation()`
de la **API de JavaScript**
y pase el ID del agente `
445`
en los argumentos de la función. Después de crear la conversación, esta se abre con la función `
SBChat.openConversation()`.
```javascript
$(document).on("SBInit", function () {
if (SBF.activeUser() != false && SBF.activeUser().conversations.length == 0) {
// ID de agente es el sexto argumento (445)
SBChat.newConversation(2, -1, "", [], null, 445, function (conversation) {
SBChat.openConversation(conversation.id);
});
}
});
```
---
## 📌 Forzar una conversación específica
Este caso de uso explica cómo establecer una conversación específica cuando se cumple una condición y obliga al usuario a utilizar únicamente dicha conversación mientras la condición siga siendo válida.
El siguiente código utiliza el título de la conversación para identificar cuál es la conversación correcta a utilizar: busca la conversación específica usando su título y, si la encuentra, la abre; de lo contrario, crea una nueva conversación con el título buscado. Este caso de uso se puede utilizar en diferentes escenarios, por ejemplo, si desea obligar al usuario a utilizar una conversación diferente para distintas páginas.
**1. Inserte este código JavaScript en su sitio web**
```javascript
(function ($) {
jQuery(document).on("SBInit", function () {
let conversation_title = "CONVERSATION-NAME";
let conversations = SBF.activeUser().conversations;
if (conversations) {
for (var i = 0; i < conversations.length; i++) {
if (conversations[i].get("title") == conversation_title) {
SBChat.openConversation(conversations[i].id);
return;
}
}
}
SBF.ajax({
function: "new-conversation",
title: conversation_title
}, (response) => {
SBChat.setConversation(new SBConversation([], response["details"]));
});
});
}(jQuery));
```
---
## 🏢 Forzar un departamento específico
Busca una conversación con el departamento deseado, si la encuentra la abre, si no, crea una nueva. Reemplace `
YOUR-DEPARTMENT-ID`
con el ID del departamento.
```javascript
(function ($) {
jQuery(document).on("SBInit", function () {
let active_department = "YOUR-DEPARTMENT-ID";
let conversations = SBF.activeUser().conversations;
SBChat.default_department = active_department;
if (conversations) {
for (var i = 0; i < conversations.length; i++) {
if (conversations[i].get("department") == active_department) {
setTimeout(() => { SBChat.openConversation(conversations[i].id) }, 300);
return;
}
}
}
SBChat.open(false);
SBF.ajax({
function: "new-conversation",
department: active_department
}, (response) => {
SBChat.setConversation(new SBConversation([], response["details"]));
});
});
}(jQuery));
```
---
## 🕵️ Forzar un agente específico
Busca una conversación con el agente deseado (definido en `
SB_DEFAULT_AGENT`), si la encuentra la abre, si no, crea una nueva.
**1. Insertar el código JavaScript**
En cada página, inserte `
`
cambiando 123 por el ID del agente.
```javascript
(function ($) {
if (typeof SB_DEFAULT_AGENT != 'undefined') {
jQuery(document).on("SBInit", function () {
if (!SBF.activeUser()) return;
let conversations = SBF.activeUser().conversations;
if (conversations) {
for (var i = 0; i < conversations.length; i++) {
if (conversations[i].get("agent_id") == SB_DEFAULT_AGENT) {
setTimeout(() => { SBChat.openConversation(conversations[i].id) }, 300);
return;
}
}
}
$('.sb-list').sbLoading(true);
SBChat.open(false);
SBF.ajax({
function: "new-conversation",
agent_id: SB_DEFAULT_AGENT
}, (response) => {
SBChat.clear();
$('.sb-list').sbLoading(false);
SBChat.setConversation(new SBConversation([], response["details"]));
});
});
}
}(jQuery));
```
---
## 📨 Enviar mensaje y abrir chat
Este caso de uso explica cómo enviar un nuevo mensaje y abrir el chat después de que el mensaje haya sido enviado.
**1. Enviar el mensaje y abrir el chat**
Verifique si el mismo mensaje ya existe en la conversación con el método `
searchMessages()`
de la **API de JavaScript**
. Si el mensaje no está en la conversación, envíe un nuevo mensaje con la función `
SBChat.sendMessage()`
. Después de enviar el mensaje, abra la conversación con la función `
SBChat.openConversation()`
, verifique si el chat está abierto y, si no lo está, ábralo con la función `
SBChat.open()`.
```javascript
$(document).on("SBInit", function () {
let message = "¿Desea comprar el producto de esta página?";
if (SBChat.conversation == false || SBChat.conversation.searchMessages(message).length == 0) {
SBChat.sendMessage(SBF.setting("bot-id"), message, [], function (response) {
SBChat.openConversation(response["conversation_id"]);
if (!SBChat.chat_open) {
SBChat.open();
}
});
}
});
```
## 📜 Mostrar pop-up al hacer scroll
Este caso de uso explica cómo mostrar un mensaje emergente (pop-up) cuando el usuario desplaza la página hasta cierta posición; en este ejemplo, cuando el desplazamiento de la página alcanza los 500 px.
**1. Comprobar el desplazamiento de la página y mostrar el pop-up**
Verifique el desplazamiento de la página mediante JavaScript y muestre el pop-up con la función `
popup()`
de la **API de JavaScript**.🎨 Mostrar chat en admin de WordPress
Muestra el chat dentro del área de administración de WordPress e identifica automáticamente al usuario conectado.
**1. Editar `
functions.php`**
Agregue el siguiente código al final del archivo `
functions.php`
de su tema.
```php
$(document).on("SBInit", function () {
var showed = false;
$(window).scroll(function () {
var scroll = $(window).scrollTop();
if (scroll > 500 && !showed) {
SBChat.popup(false, { title: "You reached 500 px!", message: "Insert here your message." });
showed = true;
}
});
});
```
Si tiene configurado un dominio de cookie, añada `
domain=SU-VALOR`
a la cadena de la cookie.
# 📅 Actualizaciones
# 📅 Acualizaciones Dic_2025
## 31/12/2025 | ZampiBot | V 3.8.8
### 🐛 Corrección de errores
- Solucionado un error relacionado con los reportes.
- Corregidos errores menores relacionados con el diseño RTL (derecha a izquierda).
- Solucionado un error que mostraba artículos en todos los idiomas cuando el idioma no estaba definido.
### ✨ Nuevas funcionalidades
-
Añadido soporte **OTP**
(Contraseña de un solo uso) en el mensaje de seguimiento y mensajes enriquecidos de correo electrónico.
-
Ahora se muestra el **nombre del canal**
de la aplicación de mensajería en lugar del nombre genérico de la aplicación.
### 🚀 Optimizaciones
- **Cambio importante:**
Todos los correos electrónicos ahora utilizan la plantilla definida en `
Configuración > Notificaciones > Plantilla de correo electrónico`. Se han eliminado las configuraciones de firma y encabezado de correo electrónico individuales.
- **Nota:**
Es posible que deba actualizar el contenido de su plantilla de correo electrónico.
---
## 31/12/2025 | Aplicación de Inteligencia Artificial | V 1.5.9
### 🐛 Corrección de errores
- Solucionado error en traducciones de cadenas que incluyen mensajes enriquecidos de tipo lista.
- Corregido error relacionado con el retraso del mensaje de bienvenida.
-
Solucionados varios errores relacionados con el **Playground**
(Área de pruebas).
-
Corregido error en la detección de la **toma de control humana**.
- Solucionado problema de información de entrenamiento faltante en archivos CSV.
### ✨ Nuevas funcionalidades
-
Añadido **modo conversacional**
para el mensaje de seguimiento.
- **Análisis de archivos:**
Ahora el chatbot puede analizar archivos adjuntos del usuario en formatos PDF, TXT y otros.
-
Nueva opción para **desactivar la toma de control humana**
fuera del horario de oficina o si todos los agentes están desconectados (offline).
---
## 31/12/2025 | Actualizaciones de Apps de Mensajería
### 📱 WhatsApp App (V 1.3.3)
- **✨ Novedad:**
Añadido soporte para **llamadas de voz de WhatsApp**.
- **🚀 Optimización:**
Los mensajes mostrados en el área de administración ahora coinciden exactamente con los enviados a WhatsApp.
### 💬 Messenger App (V 1.2.5)
- **🐛 Bug:**
Solucionado error relacionado con el mensaje de toma de control humana.
- **✨ Novedad:**
Añadido soporte para **comentarios de Instagram y Facebook**.
- **🚀 Optimización:**
Visualización exacta de mensajes enviados en el panel de administración.
### ✈️ Telegram App (V 1.1.2)
- **🐛 Bug:**
Solucionado error con el mensaje de inicio.
- **✨ Novedades:**
- Notificaciones para agentes.
- Mensaje de bienvenida.
- Opción para banear usuarios.
- **🚀 Optimización:**
Visualización exacta de mensajes enviados en el panel de administración.
---
---
# 📅 Actualizaciones Nov_2025
## 13/11/2025 | ZampiBot | V 3.8.7
### 🐛 Corrección de errores
- Solucionado error en la opción "cerrar chat".
- Corregido error con horarios de oficina incorrectos y horario de verano (DST).
-
Solucionado error relacionado con el **email piping**.
- Corregidos errores visuales en las imágenes de categorías de artículos y mensaje de seguimiento.
### ✨ Nuevas funcionalidades
- Mensajes informativos en el admin para acciones como cambiar estado o asignar conversaciones.
-
Funcionalidad de **"Olvidé mi contraseña"**
en el formulario de inicio de sesión.
- Añadido recordatorio de calificación por correo electrónico.
- **Autoguardado**
automático para mensajes no enviados en el área de administración.
### 🚀 Optimizaciones
- Las notificaciones (email, SMS, push) de conversaciones asignadas a un departamento ahora también se envían a agentes/admins sin departamento asignado.
- Los reportes de tiempos promedios ahora tienen en cuenta la toma de control humana y conversaciones archivadas.
- Sección de reportes mejorada.
-
La configuración de retraso (mensaje de bienvenida/seguimiento) ahora es en **segundos**.
---
## 13/11/2025 | Aplicación de Inteligencia Artificial | V 1.5.8
### 🐛 Corrección de errores
- Restaurado el botón de eliminar faltante en el bloque conector de flujo.
- Corregido error en el mensaje de respaldo de toma de control humana.
- Solucionado error en toma de control humana con traducciones multilingües activas.
### ✨ Nuevas funcionalidades
-
El chatbot ahora reconoce la **fecha y hora actual**
de su zona horaria.
- Soporte multilingüe para mensajes directos de chat, correos directos y SMS directos.
- Soporte multilingüe para automatizaciones.
### 🚀 Optimizaciones
- Respuestas del chatbot mejoradas.
- Mejor integración de prompts personalizados.
-
El ajuste de retraso del chatbot ahora es en **segundos**.
---
## 13/11/2025 | Otras Actualizaciones de Apps
### 📱 WhatsApp App (V 1.3.2)
- **✨ Novedad:**
Soporte para **WhatsApp Embedded Signup**
(Registro integrado).
### 🟣 Viber App (V 1.0.2)
- **🐛 Bugs:**
Solucionados errores relacionados con el perfil del remitente y mensajes enriquecidos.
---
---
# 📅 Actualizaciones Oct_2025
## 31/10/2025 | ZampiBot | V 3.8.6
- **🐛 Bugs:**
- Solucionado error que impedía crear usuarios y agentes.
- Solucionado error de asignación de agentes a calificaciones.
- Solucionado error en la función "responder al mensaje".
- **🚀 Optimización:**
Las respuestas de calificación desde apps de mensajería ya no desarchivan las conversaciones.
## 31/10/2025 | Aplicación de Inteligencia Artificial | V 1.5.7
- **✨ Novedades:**
- Opción dedicada para habilitar traducciones automáticas de artículos.
- Menú de idioma para artículos.
- **🐛 Bug:**
Solucionados varios errores de traducción de artículos.
---
---
## 28/10/2025 | ZampiBot | V 3.8.5
### 🐛 Corrección de errores
- Traducciones de mensajes en el panel izquierdo del admin.
- Notificaciones push no enviadas si el mensaje era muy largo.
- Contenido corrupto en notificaciones de email con listas.
- Enlaces con caracteres unicode y calificaciones de artículos.
- Mensajes automatizados en carga de página no entregados.
### ✨ Nuevas funcionalidades
-
Opción para **fusionar dos usuarios**
en uno.
-
Inicio de sesión y registro con **Google**
(Versión SaaS).
- Navegación de una página para artículos.
- Nuevos bloques de artículo: divisor, caja de información.
- Añadir respuestas guardadas directamente desde el panel.
- Botón para agrandar el widget de chat en escritorio.
-
Mensajes no enviados en admin se guardan como **borradores**.
- Botón para limpiar texto en el editor del admin.
### 🚀 Optimizaciones
- Actualización del ajuste de compensación UTC.
- Mejoras en la función de calificaciones e interfaz de usuario (admin y artículos).
---
## 28/10/2025 | Aplicación de Inteligencia Artificial | V 1.5.6
### 🐛 Corrección de errores
- Contenido faltante en datos de entrenamiento.
- Errores de cierre de sesión y bloqueos en el Playground.
- Mensajes con textos duplicados.
- Flujos y recolección de detalles de usuario.
### ✨ Nuevas funcionalidades
- **Modo de calificación conversacional:**
La IA detecta la calificación en el mensaje del usuario.
- **Mensajes unificados:**
Mensajes consecutivos del usuario se tratan como uno solo para una única respuesta del bot.
-
Integración con **Google Calendar**
y **TidyCal**.
-
Nuevo bloque de flujo: **Conector de flujo**.
- Historial de mensajes en Playground y botón de limpieza automática.
---
## 28/10/2025 | Actualizaciones Varias de Apps
- **Messenger (V 1.2.4):**
Corrección en recepción de mensajes.
- **Telegram (V 1.1.1):**
Opción para ignorar mensaje de inicio automático, corrección de mensajes largos y formato de enlaces.
- **WhatsApp (V 1.3.1):**
Corrección de formato de enlaces, soporte para "responder al mensaje".
- **LINE, Viber, WeChat:**
Correcciones de formato de enlaces y actualizaciones de compatibilidad.