Welcome

Livechat Realtime API

This API is intended to be used for having a Livechat conversation;

  • First of all you need to generate a visitor token (any random string);
  • Call livechat:getInitialData passing visitorToken as first argument, the response will be an object containing a Livechat configuration object with following properties:
Field Type Description
enabled Boolean If whether Livechat is enabled for that server or not
online Boolean If there are Livechat agents online
room String The current conversation room for the current guest user
registrationForm Boolean If the registration form should be displayed or not.
displayOfflineForm Boolean If should show a contact form if no agents online.
triggers Array Array of Livechat triggers.
departments Array Array of Livechat departments.

Table of contents