SDK JavaScript

API para desenvolvedores

Uma API JavaScript simples, mas poderosa, que lhe dá controle total sobre o comportamento, o estilo e as integrações do seu widget de chat.

Começar a usar Obter trecho de código

Configuração fácil

Basta adicionar nosso snippet à sua página. A API fica automaticamente disponível assim que o script é carregado.

Controle total

Mostre, oculte e personalize o widget de chat. Preencha previamente as informações do usuário e adicione parâmetros personalizados.

Retornos de chamada de eventos

Reaja a eventos de chat, como abrir, fechar e encerrar, com funções de retorno de chamada personalizadas.

Introdução

Certifique-se de que o trecho de código do Social Intents esteja instalado em sua página. Depois de carregado, você pode usar qualquer um dos métodos abaixo por meio do SI_API objeto.

retorno de chamada onSIApiReady()

Essa chamada de retorno notifica sua página quando a API Social Intents termina de carregar. Como os scripts são carregados de forma assíncrona, envolva sua lógica de inicialização nesta função.

JavaScript

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

Controle de Widget

método SI_API.showInvite(mensagem)

Exiba o convite proativo para chat com uma mensagem personalizada. Ótimo para criar mensagens de convite específicas para cada página, a fim de aumentar as conversões.

JavaScript

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

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

Mostre ou oculte a janela de bate-papo programaticamente. Use isso para regras de exibição personalizadas ou para fechar automaticamente após um período de tempo.

JavaScript

// Mostrar a janela de bate-papo
SI_API.showPopup();

// Ocultar a janela de bate-papo
SI_API.hidePopup();

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

Mostre ou oculte o botão da guia de bate-papo. Exiba-o após um atraso personalizado, em páginas específicas ou após determinadas ações do usuário.

JavaScript

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

Dados e parâmetros do usuário

método SI_API.setChatInfo(nome, e-mail, telefone, grupo, pergunta)

Preencha previamente as informações do visitante. Ideal para sites de membros onde você já coletou dados do usuário. Desative campos nas suas configurações para impedir que os visitantes alterem os valores pré-preenchidos.

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
  );
}

método SI_API.addParams(parâmetros)

Adicione parâmetros personalizados de chave-valor a cada solicitação de chat. Envie informações do cliente, números de pedidos, contexto da página ou quaisquer outros dados de que seus agentes precisem.

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);
}

Retornos de chamada de eventos

Reaja às interações do usuário com o widget de chat usando esses métodos de retorno de chamada.

callback SI_API.onChatOpened

Acionado quando o botão de chat é clicado e a janela de chat aparece.

JavaScript

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

callback SI_API.onChatClosed

Acionado quando a janela de chat é minimizada.

JavaScript

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

callback SI_API.onChatEnded

Acionado quando uma sessão de chat ativa é encerrada.

JavaScript

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

Pronto para integrar?

Inicie sua avaliação gratuita e obtenha seu trecho de código para começar a usar a API.

Iniciar avaliação gratuita Ver Central de Ajuda