Integracja JavaScript

Użyj JavaScript SDK do integracji z React, Meteor, Angular JS i innych. Wejdź, aby zobaczyć, jak używać metod widżetów, włączać wydarzenia itp.

Pobierz klucz API

Widget

Metody widżetu są dostępne poprzez globalne okno przeglądarki UE. Aby włączyć zdarzenia, przekaż je jako własności do konfiguracji głównego widżetu.

Zwróć uwagę, że jest to dokumentacjaJavaScript API/SDK. Dokumentacja REST API znajduje się tutaj.

Użyj atrybutów

W ciągu UE.init(), UE.refresh() i UE.pageHit() metody możesz używać tych samych atrybutów co w window.civchat obiekt (w tym atrybuty niestandardowe).

Lista standardowych atrybutów, których możesz użyć

Metody

Wycofane metody:
UE.init() oraz UE.refresh(). Zostały połączone w jedną metodę: UE.pageHit(). Pozostałe nie uległy zmianie.

UE.pageHit( )

Zainicjuj widget lub wyślij sygnał PING do głównego serwera. Jest to równoznaczne z przejściem do nowej strony w instalacji "standard" HTTP .

<script>
  UE.pageHit({
    apiKey: 'YOUR_API_KEY',
    name: "John Doe",
    email: "myemail@example.org",
    gender: 2,
    status: 2,
    phone_number: "+48754123434", // Must be a valid E.164 format
    score: 0,
    company: {
      revenue: "$239.9 billion",
      employees: 32
    },
    source_context: {
      foo: "bar",
      john: "doe"
    }
  });
</script>

UE.destroy( )

Usuń dotychczasowy przykład widgetu i usuń okienko z DOM. Ta metoda nie opiera się na żadnych argumentach.

UE.destroy({});

UE.resetAuth(data)

Ta funkcja resetuje__ca__chat cookie, a następnie zakłada nowy lub przypisuje już istniejący na podstawie adresu email (jeśli jest dostępny). Parametr dane to obiekt JSON z kluczem i wartością e-mail.

Technicznie rzecz ujmując, możesz usunąć plik cookie używając tej funkcjonalności i stworzyć od razu nowy.

UE.resetAuth({
  apiKey: "YOUR_API_KEY",
  email: "johndoe@mydomain.com"
});

Event'y

onLoad( )

Wyzwalanie kiedy otwierane jest okienko widgetu.

UE.pageHit({
  apiKey: "YOUR_API_KEY",
  email: "johndoe@example.com",
  name: "John Doe",
  phone_number: "+48123456789",
  source_context: {
    foo: "bar",
    john: "doe"
  },
  onLoad() {
    alert("Widget loaded!");
  }
});

onMessage( )

Działa dla każdej przychodzącej wiadomości. Obiekt wiadomości będzie przekazany wewnątrz wyzwolonej funkcji.

UE.init({
  apiKey: "YOUR_API_KEY",
  email: "johndoe@example.com",
  name: "John Doe",
  phone_number: "+48123456789",
  source_context: {
    foo: "bar",
    john: "doe"
  },
  onMessage() {
    alert("Received a message!");
  }
});

Przykłady obiektu wiadomości:

{
  content: "Hello, world!",
  isAdmin: false
}

Jeśli isAdmin jest ustawiony do true, oznacza to, że wiadomość pochodzi od strony zaplecza, w przeciwnym razie zostanie ustawiona na false a to oznacza, że wiadomość pochodzi z widgetu front-end.

onOpen( )

Włączony kiedy otwierane jest okienko widgetu.

UE.pageHit({
  apiKey: "YOUR_API_KEY",
  email: "johndoe@example.com",
  name: "John Doe",
  phone_number: "+48123456789",
  source_context: {
    foo: "bar",
    john: "doe"
  },
  onOpen() {
    alert("Opened a chat!");
  }
});

onClose( )

Włączony kiedy zamykane jest okienko widgetu.

UE.pageHit({
  apiKey: "YOUR_API_KEY",
  email: "johndoe@example.com",
  name: "John Doe",
  phone_number: "+48123456789",
  onClose() {
    alert("Closed a chat!");
  }
});