API JavaScript de Live Chat

Use a API JavaScript do onWebChat para personalizar o seu widget de chat e automatizar fluxos. Pode passar dados do visitante, definir o idioma do widget, maximizar ou ocultar o widget e mais.

Por exemplo, pode enviar os detalhes do visitante para o chat, definir o idioma por página ou abrir o widget de forma programática quando um utilizador clica num botão.

Adicione o seu código API logo abaixo do script do widget de chat, como mostrado à direita.





    <script type='text/javascript'>
        ... onWebChat widget code ...
    </script>
    <script type='text/javascript'>
        ... API functions goes here ...
    </script>

Definir Informação do Visitante

Pode definir os dados do visitante antes ou durante uma sessão de chat. Por exemplo, definir o nome ajuda a sua equipa a identificar contactos na lista de visitantes.

Use estas chamadas API para definir nome, email, telefone e notas do visitante:



    onWebChat.set("name","John");
    onWebChat.set("email","john@mail.com");
    onWebChat.set("phone","1234567890");
    onWebChat.set("notes","notes for visitor ..");

Obter Informação do Visitante

Também pode recuperar os detalhes do visitante definidos pela API, pelo formulário pré-chat ou pelas atualizações dos agentes.

Chame estas funções após o widget estar completamente carregado. Exemplo:
onWebChat.set("onWebChatLoaded", function() { console.log("visitor name: " + onWebChat.get("name")); });



    onWebChat.get("name");
    onWebChat.get("email");
    onWebChat.get("phone");
    onWebChat.get("notes");

Definir Idioma do Widget

Defina o idioma do widget usando o código de idioma para qualquer idioma ativado no seu painel.

Por exemplo, "pt" para português, "en" para inglês e "es" para espanhol. Se o código não estiver ativado, o widget usa o seu idioma predefinido. Pode alterar o idioma em Definições > Idiomas.

Códigos de idioma disponíveis:

am ar az be bg bn bs ca cs da de dv dz el en es et fa fi fil fo fr he hi hr ht hu hy id is it ja ka kk kl km ko ky la lb lo lt lv mg mk mn ms mt my ne nl no pl ps pt ro ru rw si sk sl sm so sq sr sv sw tg th ti tk to tr uk ur uz vi zh zh-TW





    onWebChat.set("language","es");

Definir Aparência do Widget

Pode controlar as definições principais de exibição do widget:

Use o parâmetro max com 0 para minimizar ou 1 para maximizar o widget.

Para ocultar o widget, use a função set com o parâmetro show e valor 0. Use 1 para voltar a mostrar.





    onWebChat.set("max",1);

    onWebChat.set("show",0);

Definir Informação da Página

Pode sobrescrever a URL e o título da página atual enviados ao onWebChat:

Use o parâmetro pageUrl para definir um URL personalizado visível para os agentes na consola de chat. Útil para aplicações de página única (SPA) ou roteamento personalizado.

Use o parâmetro pageTitle para definir um título personalizado que os agentes verão em vez do título da página do navegador.





    onWebChat.set("pageUrl","https://onwebchat.com/newPage");

    onWebChat.set("pageTitle","New title");

Obter Estado do Widget

Para obter o estado do widget do onWebChat:

A função devolve "online" ou "offline" consoante a disponibilidade atual do seu chat.

Chame esta função após o widget carregar. Exemplo:
onWebChat.set("onWebChatLoaded", function() { console.log("chat status: " + onWebChat.get("status")); });






    onWebChat.get("status");

Funções Callback

Pode executar funções callback quando ocorrem eventos específicos do chat:

onClick executa quando o visitante clica no widget de chat

onMaximize executa quando o widget é maximizado

onMinimize executa quando o widget é minimizado

onTrigger executa quando um trigger é ativado

onStartWriting executa quando o visitante começa a escrever

onWebChatLoaded executa quando o widget de chat termina de carregar




    onWebChat.set("onClick",function(){ alert('chat widget is clicked'); });

    onWebChat.set("onMaximize",function(){ alert('chat maximized'); });

    onWebChat.set("onMinimize",function(){ alert('chat maximized'); });

    onWebChat.set("onTrigger",function(){ alert('trigger activated'); });

    onWebChat.set("onStartWriting",function(){ alert('visitor is writing'); });

    onWebChat.set("onWebChatLoaded",function(){ alert('chat widget is loaded'); });

Voltar ao Suporte