La API de Assistant JS expone los siguientes métodos al objeto global: Assistant. Puedes usarlos para controlar tu Asistente programáticamente.

Assistant('init', assistantId)

Llama a este método para cargar el Asistente

Assistant('init', 'YOUR_ASSISTANT_ID_HERE');

Ejemplo de caso de uso:

<a href="#" onclick="Assistant('init', 'YOUR_ASSISTANT_ID_HERE')"></a>

N.B Puedes usar esto de cualquier manera que desees con tu propia lógica y todo.

Assistant('trigger-less-init', assistantId)

Si deseas inicializar el asistente sin un lanzador o botón de activación, entonces usa esto.

Assistant('trigger-less-init', 'YOUR_ASSISTANT_ID_HERE');

Ejemplo de caso de uso:

<a href="#" onclick="Assistant('trigger-less-init', 'YOUR_ASSISTANT_ID_HERE')"></a>

N.B Puedes usar esto de cualquier manera que desees con tu propia lógica y todo.

Assistant('triggerLess')

Llama a este método para ocultar/deshabilitar el botón de activación/lanzador para el Asistente. Puede que desees usar esta función si intentas activar el asistente programáticamente y no quieres mostrar el botón de lanzador en la parte inferior.

Assistant('triggerLess');

Ejemplo de caso de uso:

<a href="#" onclick="Assistant('triggerLess')"></a>

N.B Puedes usar esto de cualquier manera que desees con tu propia lógica y todo.

Assistant('open')

Usa este método para abrir manualmente el Asistente

Assistant('open');

Ejemplo de caso de uso:

<a href="#" onclick="Assistant('open')"></a>

N.B Puedes usar esto de cualquier manera que desees con tu propia lógica y todo.

Assistant('close')

Usa este método para cerrar manualmente el Asistente

Assistant('close');

Ejemplo de caso de uso:

<a href="#" onclick="Assistant('close')"></a>

N.B Puedes usar esto de cualquier manera que desees con tu propia lógica y todo.

Assistant('toggle')

Usa este método para alternar manualmente el Asistente

Assistant('toggle');

Ejemplo de caso de uso:

<a href="#" onclick="Assistant('toggle')"></a>

N.B Puedes usar esto de cualquier manera que desees con tu propia lógica y todo.

Assistant('chat')

Usa este método para abrir manualmente el chat. Debes tener la opción Chat habilitada desde tu panel de configuración. De lo contrario, este comando no funcionará.

Assistant('chat');

Ejemplo de caso de uso:

<a href="#" onclick="Assistant('chat')"></a>

N.B Puedes usar esto de cualquier manera que desees con tu propia lógica y todo.

Assistant('contact')

Usa estos métodos para abrir manualmente el contacto. Puedes pasar cualquier asunto y cuerpo que se autocompletarán en el formulario, que se puede editar. Debes tener habilitada la opción Contact desde tu panel de configuración. De lo contrario, este comando no funcionará.

Assistant('contact', {
    subject: 'Título del problema',
    body: 'Detalles del problema',
});

Ejemplo de caso de uso:

<a href="#" onclick="Assistant('contact', {
    subject: 'Título del problema',
    body: 'Detalles del problema',
})"></a>

N.B Puedes usar esto de cualquier manera que desees con tu propia lógica y todo.

Assistant('order-status')

Usa estos métodos para abrir manualmente el contacto. Debes tener habilitada la opción OrderStatus desde tu panel de configuración. De lo contrario, este comando no funcionará.

Assistant('order-status');

Ejemplo de caso de uso:

<a href="#" onclick="Assistant('order-status')"></a>

N.B Puedes usar esto de cualquier manera que desees con tu propia lógica y todo.

Assistant('identify', userObject)

Le dice a Assistant que conocemos el nombre y la dirección de correo electrónico del visitante. Usamos su nombre y dirección de correo electrónico para completar y ocultar los campos en la pantalla del Contact Form. También usamos su nombre y dirección de correo electrónico para omitir algunas preguntas al inicio de un chat con Assistant.

Assistant('identify', {
  name: 'Parvez Akhter',
  email: 'demo@email.com',
});

Ejemplo de caso de uso:

<a href="#" onclick="Assistant('identify', {
  name: 'Parvez Akhter',
  email: 'demo@email.com',
})"></a>

N.B Puedes usar esto de cualquier manera que desees con tu propia lógica y todo.

Assistant('article')

Hay dos formas de abrir un artículo de la Base de Conocimientos usando el método Assistant('article') en tu sitio. Este método te permite mostrar un artículo ya sea dentro del Assistant o en una barra lateral, dependiendo de tus necesidades.

Todo lo que necesitarás es el ID del artículo, que se puede encontrar en Thrivedesk navegando a la documentación, abriendo el artículo en el editor y copiando el ID desde allí.

Este método article es útil cuando:

  • El desencadenante no es una interacción directa del usuario con el Assistant.

  • Quieres mostrar un artículo automáticamente usando tu lógica personalizada.

Si usas el método estándar article (sin opciones adicionales), abrirá automáticamente la interfaz del Assistant.

Ejemplos

Abrir un artículo en el Assistant:

Assistant('article', 'ARTICLE_ID');

o

<a href="javascript:void(0)" onclick="Assistant('article', 'ARTICLE_ID')"></a>

Abrir un artículo en la barra lateral:

Assistant('article', {
  articleId: 'ARTICLE_ID',
  mode: 'sidebar'
});

o

<a href="javascript:void(0)" onclick="Assistant('article', {
    articleId: 'ARTICLE_ID',
    mode: 'sidebar'
    })" ></a>

Uso de la demostración

  • Utiliza Assistant('article') para mostrar un artículo directamente en el Asistente.

  • Agrega la opción mode: 'sidebar' para mostrar el artículo en una barra lateral en su lugar.

Assistant.clearSession()

Elimina la sesión del Asistente y restablece el asistente a un estado fresco. Este método elimina todo el historial de chat, mensajes y contexto de conversación de la sesión actual.

Assistant.clearSession()

Uso

Si necesitas un estado fresco del asistente en cada cierre de sesión o para cualquier necesidad personalizada, puedes llamar a este método junto con tu llamada de cierre de sesión, y se eliminará el estado, proporcionando una experiencia de chat en vivo fresca.

Ejemplo

function handleLogout() {
  // Limpiar el estado del asistente
  Assistant.clearSession();
  
  // Proceder con tu lógica de cierre de sesión
  logoutUser();
}

Assistant('ready')

Registra una función de callback que se ejecutará cuando el widget del Asistente esté completamente inicializado y listo para usar.

Assistant('ready', callback: () => void)

Parámetros:

  • callback (función) — Una función a ejecutar cuando el Asistente esté listo

Uso

Utiliza este método cuando necesites realizar acciones solo después de que el Asistente se haya cargado completamente. Esto asegura que el Asistente esté disponible antes de intentar interactuar con él (por ejemplo, abrir el widget de chat, identificar usuarios, etc.).

// Esperar a que el Asistente esté listo, luego abrir el chat
Assistant('ready', () => {
  console.log(' El asistente está listo, abre el chat');
  Assistant('open');
});