Intégration de JavaScript

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

Il existe des méthodes de widget à l’objet fenêtre global UE. Pour activer les événements, les transmettre sous forme de propriétés pour l’objet de configuration du widget principal.

Veuillez noter qu’il s’agit d’une documentation JavaScript API/SDK, pour l’API REST veuillez tête à cette url.

Utiliser des attributs

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

Voici une liste de quelques attributs, vous pouvez utiliser (par défaut ceux)

Méthodes

Obsolète méthodes :
UE.init() et UE.refresh(). Ceux a été fusionnée dans une seule méthode : UE.pageHit(). Le reste rester tel quel.

UE.pageHit( )

Initialiser le widget ou envoyer le signal PING au serveur principal. Équivalent de naviguer vers une nouvelle page dans les installations de HTTP « standard ».

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

Détruire l’instance actuelle de widget et de supprimer la fenêtre de DOM. Cette méthode ne prend aucun argument.

UE.destroy({});

UE.resetAuth(data)

Cette fonction réinitialise __ca__chat cookie, puis créer nouveau ou affectation existante celui basé sur adresse email (si fournis). Données du paramètre est un objet JSON avec email clé / valeur.

Donc, techniquement, vous pouvez supprimer le cookie avec cette fonction et créer nouveau immédiatement.

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

Événements

onLoad( )

Déclenché lors du chargement de la fenêtre de widget.

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

Déclenché pour chaque message entrant. Objet de message est passé dans la fonction déclenchée.

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

Exemple d’objet de message :

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

Déclenché lorsque vous ouvrez la fenêtre du widget.

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

Déclenché avant de fermer la fenêtre du widget.

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