JavaScript API
Globalne metody dostępne po załadowaniu skryptu widgetu.
Respondo.init(config)
Inicjalizuje i montuje widget. Musi być wywołane raz. Zwraca instancję widgetu.
const widget = Respondo.init({
agentId: 'YOUR_AGENT_ID'
});Respondo.identify(identity)
Dołącza tożsamość użytkownika do bieżącej sesji. Wywołaj po zalogowaniu. Z adresem e-mail lub userId od razu tworzy kontakt, nawet jeśli użytkownik nigdy nie otworzy czatu. signedUpAt (Date, sekundy Unix lub ciąg ISO 8601) to moment rejestracji użytkownika w Twoim produkcie; bez niego data rejestracji kontaktu pozostaje pusta.
Respondo.identify({
email: 'user@example.com',
name: 'John Doe',
userId: 'usr_123',
signedUpAt: '2024-05-31T10:00:00Z',
userHash: 'hmac_sha256_signature', // opcjonalne, do weryfikacji tożsamości
metadata: { plan: 'pro' },
properties: { // niestandardowe właściwości kontaktu
account_type: 'enterprise', // klucze zdefiniowane w ustawieniach agenta
region: 'eu-west'
}
});Respondo.track(name, properties?)
Rejestruje zdarzenie po stronie klienta dla bieżącego odwiedzającego (np. zakup, zmiana planu na wyższy). Zdarzenia mogą uruchamiać przewodniki (Tours) wyzwalane zdarzeniami i zaliczać się do celów przewodników. Dostarczanie na zasadzie best-effort z keepalive, więc zdarzenia wysłane tuż przed nawigacją (przekierowanie do kasy) i tak docierają. Wywołuj po init().
Zdarzenia otwierają też ankiety pop-up, które na nie czekają (When and where): od razu na pasującej stronie albo po wejściu na nią w ciągu 30 minut, na przykład po przekierowaniu.
Respondo.track('purchase_completed', {
plan: 'pro',
amount: 49
});Respondo.startSurvey(surveyId)
Otwiera teraz aktywną ankietę pop-up na dowolnej stronie, pomijając Show on, reguły stron, czas na stronie, zdarzenie wyzwalające i grupę odbiorców. Identyfikator skopiuj z edytora ankiety (Additional ways to share). Ankieta, na którą odwiedzający już odpowiedział, nie pojawi się ponownie. Można wywołać, zanim widżet się wczyta.
Respondo.startSurvey('<survey-id>');Respondo.open(message?) / Respondo.close()
Otwiera lub zamyka messenger z Twoich własnych przycisków. Przekaż ciąg znaków do open, aby pole wiadomości było od razu wypełnione. Wywołuj po Respondo.init(); wywołanie wykonane, gdy launcher dopiero się pojawia, zostanie zastosowane, gdy tylko się pojawi.
Respondo.open();
Respondo.open('I have a question about my invoice');
Respondo.close();Respondo.destroy()
Usuwa widget ze strony. Przydatne w SPA przy przechodzeniu na strony, na których widget nie powinien się pojawiać. Nie czyści tożsamości odwiedzającego ani zapisanej rozmowy — do wylogowania użyj Respondo.reset().
// Usuń widget ze strony
Respondo.destroy();
// Zainicjalizuj ponownie w razie potrzeby (wznawia tę samą rozmowę)
Respondo.init({ agentId: 'YOUR_AGENT_ID' });Respondo.reset()
Wylogowanie / przekazanie współdzielonego urządzenia. Czyści z przeglądarki anonimowy identyfikator odwiedzającego, zapisaną rozmowę i token sesji, unieważnia token sesji po stronie serwera, dzięki czemu jego kopie przestają działać, i montuje ponownie świeży anonimowy widget. Wywołuj z hooka wylogowania w Twojej aplikacji.
// Przy wylogowaniu — wyczyść tożsamość, rozmowę i sesję, zacznij od nowa
Respondo.reset();Automatyczne zbieranie danych
Widget automatycznie przechwytuje i zapisuje wraz z każdą rozmową:
| Dane | Źródło |
|---|---|
| IP klienta | Nagłówki HTTP |
| Przeglądarka / OS | Nagłówek User-Agent |
| Język | Nagłówek Accept-Language |
| Strefa czasowa | API Intl (JavaScript) |
| URL strony | window.location |
| Strona odsyłająca | Nagłówek Referer |