JavaScript Integrationen

JavaScript SDK will let you integrate with React, Meteor, Angular.JS and more. Enter to see how to use widget methods, enable events etc.

GET MY API KEY

Widget

Widget-Methoden sind über das globale EU -Browserfenster verfügbar. Um Ereignisse zu aktivieren, übergeben Sie sie als Eigenschaften an die Widget-Hauptkonfiguration.

Beachten Sie, dass dies die JavaScript API/SDK-Dokumentation ist. Die REST-API-Dokumentation befindet sich diese url.

Attribute verwenden

Within UE.init(), UE.refresh() und UE.pageHit() methods you can use the same attributes as in window.civchat object (including custom attributes).

Hier ist eine Liste von nur wenigen Attributen, die Sie verwenden können (Standard)

Methoden

Zurückgezogene Methoden:
UE.init() und UE.refresh(). Wurden zu einer Methode zusammengefasst: UE.pageHit(). Der Rest bleibt so wie er ist.

UE.pageHit( )

Initialisieren Sie das Widget oder senden Sie ein Ping-Signal an den Hauptserver. Dies entspricht dem Wechsel zu einer neuen Seite bei der Installation von "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( )

Zerstören Sie aktuelle Widget-Instanz und entfernen Sie Fenster vom DOM. Diese Methode erwartet keine Argumente.

UE.destroy({});

UE.resetAuth(data)

Diese Funktion setzt zurück__ca__chat cookie, und richtet dann einen neuen ein oder weist einen bestehenden basierend auf der E-Mail-Adresse zu (falls verfügbar). Parameter Daten ist ein JSON-Objekt mit einem Schlüssel und einem E-mail Wert.

Technisch gesehen, Sie können Cookie mit dieser Funktion löschen und neue sofort erstellen.

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

Veranstaltungen

onLoad( )

Es wird ausgelöst, wenn das Widget-Fenster geladen wird.

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( )

Es wird für jede eingehende Nachricht ausgelöst. Message-Objekt wird an ausgelöste Funktion übergeben werden.

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!");
  }
});

Muster-Message-Objekt:

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

If isAdmin is set to true, it means that message came from backend side, otherwise it will be set to false and it means that message came from front-end widget.

onOpen()

Es wird ausgelöst, wenn das Widget-Fenster geöffnet wird.

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()

Es wird ausgelöst, wenn das Widget-Fenster geschlossen wird.

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