Configurações | Integrações | Client SDK JavaScript

O Client SDK permite que seja criado um chat totalmente personalizado dentro de seu site ou app mobile. Através do Client SDK, é possível iniciar uma conversa com sua empresa de forma totalmente integrada dentro de seu portal ou aplicativo.

Também é possível desenvolver a sua própria aparência, deixando o chat com a cara de sua empresa. Para começar, veja a documentação completa abaixo e depois baixe a versão que você for utilizar em sua conta, acessando Configurações > Integrações > ClientSDK.


omz-chat-api-js

SDK JavaScript para interações via chat.


Uso

  • Importar o SDK no projeto e instanciar passando o token da account como parâmetro:
omz = new OmnizeApi(token);
* Todos os campos enviados são do tipo “String”

Funções de envio

  • Iniciar interação com department_id:
omz.sendDepartment(department_id);
  • Criar interação com department_id e formulário de pré-atendimento:
omz.sendInfo({ department_id: “”, customer_name: ””, customer_email: “”, custumer_phone: “”, customer_cpf: “”);
O campo customer_cpf é condicional à configuração de aparência: “Exibir campo CPF no pré atendimento?
  • Enviar mensagens:
omz.sendMessage(message);
  • Enviar o formulário de recados:
omz.sendOffContact(name, email, phone, department_id, observation);
  • Enviar aviso de "Digitando":
omz.sendTyping();
  • Enviar aviso de input vazio:
omz.sendCleared();
  • Encerrar o atendimento:
omz.sendFinish();
  • Se a pesquisa de satisfação estiver ativa:
Enviar feedback positivo: omz.sendFeedbackPositive();
Enviar feedback negativo: omz.sendFeedbackNegative();
  • Se a transcrição de chat estiver ativa:
Envia conversa por e-mail: omz.sendTranscription(email);
Pular o envio: omz.skipTranscription();

Funções de retorno que devem ser implementadas

Retorno do envio do token

Quando existem departamentos, retorna um array (ex: [{ id: 1, name: "Atendimento" }, { id: 2, name: "Suporte" }]) e dois booleans, se o formulário de pré-atendimento e o campo de CPF estão ativos:

omz.on('departmentsList', function(dpts, preCare, cpf){});
  • Se não existir departamentos:
omz.on('departmentsEmpty', function(){});

Eventos criados após envio do sendInfo

  • Tentando conectar com algum operador (chamando):
omz.on('waiting', function(){});
  • Caso não tenha atendente online ou ninguém atenda:
omz.on('unavailable', function(){});
  • Atendente aceita:
omz.on('accepted', function(){});
  • Atendente digitando:
omz.on('typing', function(){});
  • Atendente apaga a mensagem:
omz.on('cleared', function(){});
  • Mensagem enviada pelo atendente:
omz.on('newMessage', function(message){});
  • Quando a pesquisa de satisfação está ativa e tenta encerrar o atendimento:
omz.on('feedback', function(){});
  • Quando o envio de conversa por e-mail ativo e tenta encerrar o atendimento:
omz.on('transcription', function(){});
  • Quando o atendimento é encerrado pelo atendente:
omz.on('finished', function(){});