Dokumentacja

Metody API udostępnione przez czat

Autor: Łukasz Strumiński

Utworzono: 2019-10-24. Aktualizacja: 2022-02-07.

Widżet czata udostępnia kilka metod API, które pomagają w dostosowaniu go do specyficznych potrzeb klienta.

Lista metod:

• Otwarcie czata

• Metoda pozwala na otwarcie widżetu czat.

  _tc('open_chat');   

• Metoda pozwala na otwarcie formularza czat.

  _tc('open_chat_form');  

• Metoda pozwala na otwarcie zminimalizowanego okna lub otwarcie nowego okna widgetu.

  _tc('open');    

• Otwarcie oddzwonienia

  Metoda pozwala na otwarcie widżetu oddzwonienia.

  _tc('open_callback');

  Metoda pozwala na otwarcie formularza widżetu oddzwonienia.

  _tc('open_callback_form');

• Otwarcie wiadomości email

  Metoda pozwala na otwarcie widżetu wiadomości email.

  _tc('open_email');

• Zamknięcie widżetu

  Metoda pozwala na zamknięcie otwartego widżetu.

  _tc('close');

• Minimalizowanie okienka konwersacji

  Metoda pozwala na zminimalizowanie okna konwersacji.

  _tc('minimalize');

• Ustawianie domyślnych danych klienta (Imię, adres email, kolejkę czat, numer telefonu, kolejkę oddzwonień)

  Metoda pozwala na ustawienie domyślnego imienia, emaila i numeru telefonu klienta oraz wybrania kolejki dla czatów i oddzwonień.

  _tc('set_user', 'name', 'email_address', topicId, 'phone', queueId);

• Ustawianie elementu w którym zostanie umieszczony widżet

  Metoda pozwala na wybranie elementu do którego zostanie dołączony widżet (domyślnie BODY). Jako parametr przyjmuje identyfikator (id) odpowiedniego elementu.

  _tc('set_container', 'element-id');

• Nasłuchiwanie na zdarzenia (np. rozpoczęcie konwersacji)

  Metoda pozwala na uruchomienie kodu po określonym zdarzeniu (np. rozpoczęciu konwersacji).

  _tc('event_listener', function(event) {
      alert('Zdarzenie: ' + event);
  });

  Obsługiwane zdarzenia:

  • conversation_created - rozpoczęcie rozmowy
  • conversation_finished - zakończenie rozmowy
  • callback_created - zamówione oddzwonienie na teraz
  • callback_finished - zakończone oddzwonienie
  • callback_scheduled - zamówione oddzwonienie na wybraną datę
  • ticket_created - zostawiona wiadomość
  • poke_showed - pokazana zaczepka
  • minimized - zminimalizowano okno widgetu poprzez przycisk "_"
  • closed - zamknięto okno przysickiem "x"
  • opened - otwarto zminimalizowany bądź zamknięty widget

Przykładowe użycie:

Ustawienie danych klienta i otwarcie czatu po kliknięcki na link na stronie

HTML:

<a href="#" id="open-chat-link">otwórz czat</a>

JavaScript:

window.addEventListener('load', function () {
    window._tc = window._tc || function () {
        (_tc.q = _tc.q || []).push(arguments);
    };

    document
        .getElementById('open-chat-link')
        .addEventListener('click', function () {
            _tc('set_user', 'Janko Walski', 'janko@wals.ki');
            _tc('open_chat');
        });
});