API je tu od toho, abyste si váš live chat mohli individuálně nastavit opravdu tak, jak potřebujete. Nutno podotknout, že veškeré úpravy je potřeba provést na vaší straně za pomoci programátora, či jiných kolegů z IT oddělení. 

Aktuálně můžete pomocí API dosáhnout následujícího: 

  • Zobrazit live chat – otevřít okno k zahájení chatování na základě nějaké konkrétní akce, kterou zákazník provede (například kliknutím na konkrétní odkaz).

  • Schovat live chat – neboli zavřít live chat jako když jej zákazník křížkem zavře.

  • Live chat schovat úplně – live chat můžete schovat (všude, nebo jen na některých stránkách), jako kdyby tam vůbec nebyl a nebude vidět ani zelená tečka, jako ukazatel online stavu.  

  • Zjistit stav operátorů, zda je někdo online

  • Poslání variables (mít hodnoty v parametrech dynamicky). 

  • Poslání zprávy – jako kdyby ji zaslal sám operátor live chatu. 

Nastavení a pokyny pro programátory 

Realizace

Je vytvářen samostatný objekt *window.supportBoxApi = *ChatBoxApiBridge, který obsahuje metody s voláním našich vlastních metod.

Rozšíření kódu pro implementaci na webu

var supportBoxChatRunAsHidden = true; Umožňuje nezobrazení celého chatu včetně tlačítka po načtení. Zobrazení lze následně ovládat pomocí window.supportBoxApi.show() a window.supportBoxApi.hide()

Metody window.supportBoxApi

Po vytvoření objektu je odeslána událost supportBox:api:initialized

Příklad použití:

window.addEventListener('supportBox:api:initialized', function (e) {
  console.log('supportBoxApi.isShow()', window.supportBoxApi.isShow());
}

.isRunAsHidden()

je chat spuštěn s nastavením nezobrazení celého chatu (var supportBoxChatRunAsHidden = true;)?

.isShow()

je chat zobrazen?

window.addEventListener('supportBox:api:initialized', function (e) {
	document.getElementById('isShow').value = window.supportBoxApi.isShow();
	window.addEventListener('supportBox:view:change', function (e) {
		document.getElementById('isShow').value = window.supportBoxApi.isShow();
	});
});

.show()

zobrazit chat

<a href="#" onclick="window.supportBoxApi.show(); return false;">Zobrazit chatbox</a>

.hide()

skrýt chat

<a href="#" onclick="window.supportBoxApi.hide(); return false;">Skrýt chatbox</a>

.isOnline()

je chat online?

window.addEventListener('supportBox:api:initialized', function (e) {
  document.getElementById('isOnline').value = window.supportBoxApi.isOnline();
  window.addEventListener('supportBox:status:change', function (e) {
    document.getElementById('isOnline').value = window.supportBoxApi.isOnline();
  });
});

.open()

otevřít okno chatu

.close()

zavřít okno chatu

Události posílané z chatu (javascript)

Pro běžné použití např. v GA:

  • supportBox:create
  • supportBox:message:receive
  • supportBox:message:send
  • supportBox:status:change
  • supportBox:view {offline: boolean}
  • supportBox:close

Další pomocné, zejména pro API:

  • supportBox:api:initialized
  • supportBox:view:change

Příklad použití: 

window.addEventListener('supportBox:create', function (e) {
    window.addEventListener('supportBox:message:send', function (e) {
        alert('Message sended');
    });
});

Pokud je vám cokoliv nejasného, dejte nám vědět, rádi vám vše vysvětlíme a s nastavením vám pomůžeme.