Keyda Business
ItalyEnglish Accedi Inizia gratis
Documentazione di Keyda BusinessRiferimento

API del widget

Per gli sviluppatori o chiunque voglia che la chat si apra da un proprio pulsante.

Installazione

<script src="https://keyda.in/business/widget.js"
        data-key="kb_live_your_key_here" async></script>

Il tag dello script richiede solo src e data-key. Tutto il resto — colori, posizione, saluto, lingue — proviene dalla tua dashboard, così non dovrai mai ripubblicare il tuo sito per modificarli.

Modalità

Fluttuante (predefinito). Un pulsante di avvio nell'angolo che apre un pannello di chat.

Incorporato. Inserisci un contenitore vuoto nella pagina e la chat lo riempirà:

<div data-keyda-bot style="height:520px"></div>

Il contenitore ha bisogno di un'altezza. Nella modalità in linea la chat è sempre visibile, quindi non c'è nulla da aprire o chiudere.

API JavaScript

Disponibile su window.KeydaBot una volta caricato lo script:

ChiamaCosa fa
KeydaBot.open()Apre il pannello della chat
KeydaBot.close()Lo chiude
KeydaBot.toggle()Apre o chiude
KeydaBot.expand()Rende il pannello alto quanto la finestra e largo fino a 760px
KeydaBot.shrink()Torna alla scheda standard
KeydaBot.isOpentrue quando la chat è visibile
KeydaBot.isExpandedtrue mentre il pannello è espanso
KeydaBot.clientIdIl client id utilizzato da questa pagina

Esempio: apri la chat dal tuo pulsante "Chatta con noi":

<button onclick="KeydaBot.open()">Chat with us</button>
Lo script si carica in modo asincrono, quindi window.KeydaBot potrebbe non esistere per un istante subito dopo il caricamento della pagina. Associa i gestori a un evento di click anziché eseguirlo mentre la pagina viene analizzata.

Come si comporta sulla tua pagina

  • Il pannello si apre sopra il pulsante di attivazione, che rimane dov'è e diventa il controllo di chiusura. Toccandolo di nuovo, la ✕ nell'intestazione o premendo Esc chiude la chat.
  • Un visitatore può espandere il pannello dall'intestazione — questo si estende fino all'altezza della finestra e fino a 760px di larghezza — e la preferenza viene salvata nel browser. Sui telefoni il pannello occupa già tutto lo schermo, quindi questo comando non viene mostrato.
  • L'impostazione delle dimensioni del logo modifica il logo, non il pulsante: il launcher è una pillola fissa di 52px (58px per le forme rotonde e quadrate) e il logo si ingrandisce al suo interno.
  • Tutto viene eseguito all'interno di uno shadow root, in modo che il tuo CSS non possa compromettere il widget e il CSS del widget non possa toccare il tuo sito.
  • Il pannello si carica solo quando un visitatore lo apre, quindi non rallenta la pagina.
  • La conversazione di un visitatore continua per 24 ore se torna, poi ricomincia da capo.
  • Se non è possibile raggiungere l'assistente, il widget mostra un breve messaggio e non genera mai errori nella pagina.
Next: App SDKs →