SDK de JavaScript

API para desarrolladores

Una API de JavaScript sencilla pero potente que te ofrece un control total sobre el comportamiento, el estilo y las integraciones de tu widget de chat.

Comenzar Obtener fragmento de código

Configuración sencilla

Solo tienes que añadir nuestro fragmento de código a tu página. La API estará disponible automáticamente una vez que se cargue el script.

Control total

Mostrar, ocultar y personalizar el widget de chat. Rellenar previamente la información del usuario y añadir parámetros personalizados.

Devoluciones de llamada de eventos

Reacciona a eventos de chat como abrir, cerrar y finalizar con funciones de devolución de llamada personalizadas.

Introducción

Asegúrate de tener el fragmento de código de Social Intents instalado en tu página. Una vez cargado, puedes utilizar cualquiera de los métodos siguientes a través de SI_API objeto.

callback onSIApiReady()

Esta llamada de retorno notifica a tu página cuando la API Social Intents ha terminado de cargarse. Dado que los scripts se cargan de forma asíncrona, envuelve tu lógica de inicialización en esta función.

JavaScript

function onSIApiReady() {
  // API is ready - initialize your logic
  SI_API.showTab();
}

Control de widgets

método SI_API.showInvite(mensaje)

Muestra la invitación proactiva al chat con un mensaje personalizado. Ideal para crear mensajes de invitación específicos para cada página y aumentar las conversiones.

JavaScript

function onSIApiReady() {
  SI_API.showInvite('Questions about our products? I can help!');
}

método SI_API.showPopup() / SI_API.hidePopup()

Mostrar u ocultar la ventana de chat mediante programación. Utilícelas para reglas de visualización personalizadas o para cerrar automáticamente después de un período de tiempo.

JavaScript

// Mostrar la ventana de chat.
SI_API.showPopup();

// Ocultar la ventana de chat.
SI_API.hidePopup();

método SI_API.showTab() / SI_API.hideTab()

Mostrar u ocultar el botón de la pestaña de chat. Mostrarlo tras un retraso personalizado, en páginas específicas o tras determinadas acciones del usuario.

JavaScript

function onSIApiReady() {
  // Show tab after 5 seconds
  setTimeout(() => {
    SI_API.showTab();
  }, 5000);
}

Datos y parámetros del usuario

método SI_API.setChatInfo(nombre, correo electrónico, teléfono, grupo, pregunta)

Rellene previamente la información del visitante. Perfecto para sitios web de miembros en los que ya ha recopilado datos de los usuarios. Desactive los campos en la configuración para evitar que los visitantes cambien los valores rellenados previamente.

JavaScript

function onSIApiReady() {
  SI_API.setChatInfo(
    'John Doe',           // name
    'john@example.com',    // email
    '(123) 456-7890',      // phone
    'Sales',               // group/department
    'Question about pricing' // initial question
  );
}

method SI_API.setGroup(group)

Route the next chat to a specific group or department without supplying the other pre-chat values. Pass the department name exactly as configured under Pre-chat form, Groups / departments. The chat is delivered to the Slack, Microsoft Teams, Zoom, Webex or Google Chat channel that department is mapped to, and to any web agents assigned to it. You can turn the department dropdown off so visitors never see it.

JavaScript

function onSIApiReady() {
  // route this page to the Support department
  SI_API.setGroup('Support');
}

método SI_API.addParams(params)

Añade parámetros clave-valor personalizados a cada solicitud de chat. Envía información del cliente, números de pedido, contexto de la página o cualquier otro dato que necesiten tus agentes.

JavaScript

function onSIApiReady() {
  var params = [];
  params.push({ name: 'Member ID', value: 'abc123' });
  params.push({ name: 'Order Number', value: 'ORD-1000' });
  params.push({ name: 'Plan', value: 'Enterprise' });
  
  SI_API.addParams(params);
}

Devoluciones de llamada de eventos

Reacciona a las interacciones de los usuarios con el widget de chat utilizando estos métodos de devolución de llamada.

callback SI_API.onChatOpened

Se activa cuando se hace clic en el botón de chat y aparece la ventana de chat.

JavaScript

function onSIApiReady() {
  SI_API.onChatOpened = function() {
    // Track in analytics
    gtag('event', 'chat_opened');
  };
}

callback SI_API.onChatStarted

Triggered when the visitor sends their first message, without waiting for an agent to respond. Fires once per chat session, which makes it a good fit for conversion tracking.

JavaScript

function onSIApiReady() {
  SI_API.onChatStarted = function() {
    // Track the conversion
    gtag('event', 'chat_started');
  };
}

callback SI_API.onChatClosed

Se activa cuando se minimiza la ventana de chat.

JavaScript

function onSIApiReady() {
  SI_API.onChatClosed = function() {
    console.log('Chat minimized');
  };
}

callback SI_API.onChatEnded

Se activa cuando finaliza una sesión de chat activa.

JavaScript

function onSIApiReady() {
  SI_API.onChatEnded = function() {
    // Show feedback survey
    showSurveyModal();
  };
}

¿Listo para integrarse?

Comience su prueba gratuita y obtenga su fragmento de código para empezar a utilizar la API.

Comience la prueba gratuita Ver Centro de ayuda