Keyda API do widget
Para desenvolvedores, ou qualquer pessoa que queira que o chat abra a partir do seu próprio botão.
Instalando
<script src="https://keyda.in/business/widget.js"
data-key="kb_live_your_key_here" async></script>A tag de script precisa apenas de src e data-key. Todo o resto — cores, posição, saudação, idiomas — vem do seu painel, para que você nunca precise reimplantar seu site para alterá-los.
Modos
Flutuante (padrão). Um botão disparador no canto que abre um painel de chat.
Embutido. Coloque um container vazio na página e o chat o preencherá:
<div data-keyda-bot style="height:520px"></div>O container precisa de uma altura. No modo embutido, o chat está sempre visível, portanto não há nada para abrir ou fechar.
API de JavaScript
Disponível em window.KeydaBot assim que o script carregar:
| Ligar | O que ele faz |
|---|---|
KeydaBot.open() | Abre o painel de chat |
KeydaBot.close() | Fecha |
KeydaBot.toggle() | Abre ou fecha |
KeydaBot.expand() | Deixa o painel com a altura da janela e até 760px de largura |
KeydaBot.shrink() | Voltar para o cartão padrão |
KeydaBot.isOpen | true quando o chat estiver visível |
KeydaBot.isExpanded | true enquanto o painel estiver expandido |
KeydaBot.clientId | O client id que esta página está usando |
Exemplo — abra o chat a partir do seu próprio botão "Fale conosco":
<button onclick="KeydaBot.open()">Chat with us</button>O script é carregado de forma assíncrona, portanto
window.KeydaBot pode não existir por um momento após o carregamento da página. Anexe manipuladores a um clique em vez de chamá-lo enquanto a página é analisada.Como ele se comporta na sua página
- O painel abre acima do botão do disparador, que permanece onde está e se torna o controle de fechar. Tocar nele novamente, no ✕ no cabeçalho ou pressionar Esc fecha o chat.
- Um visitante pode expandir o painel a partir do cabeçalho — ele se ajusta à altura da janela e até 760px de largura — e a escolha é lembrada no navegador dele. Em celulares, o painel já ocupa a tela inteira, portanto esse controle não é exibido lá.
- A configuração do tamanho do logotipo altera o logotipo, não o botão: o iniciador é uma pílula fixa de 52px (58px para os formatos redondo e quadrado) e o logotipo cresce dentro dele.
- Tudo é renderizado dentro de um shadow root, para que o seu CSS não quebre o widget e o CSS do widget não afete o seu site.
- O painel carrega apenas quando um visitante o abre, portanto não deixa sua página mais lenta.
- A conversa de um visitante continua por 24 horas caso ele retorne; depois, ela é reiniciada.
- Se o assistente estiver inacessível, o widget exibe uma breve mensagem e nunca gera um erro na sua página.