JivoSite API для разработчиков

JivoSite предоставляет разработчикам два набора инструментов для интеграции:

Клиентская часть - JavaScript API виджета, позволяющее управлять виджетом, который отображается пользователю. С помощью него можно управлять окном чата, а так же передавать произвольную информацию со страницы, на которой размещено окно чата, в приложение оператора (например, можно передать дополнительную информацию о пользователе, которая так же будет сохранена в журнале диалогов).

Серверная часть - Webhooks API, позволяющее получать уведомления о начале или завершении чата на стороне вашего сервера, а так же передавать в JivoSite дополнительную информацию для отображения в приложени оператора в ответе на HTTP-запросы.

JavaScript API

Methods and functions

JivoSite вызывает перечисленные ниже функции на странице, чтобы сообщить о возникновении события. Вы можете объявить на странице любую из этих функций и выполнять в ней логику обработки возникшего события. Например, по событию jivo_onIntroduction вы можете получить введенные клиентом контактные данные.

Сallback-функции
Название	Тип	Описание
jivo_onLoadCallback	void	Вызывается при завершении инициализации виджета JivoSite
jivo_onOpen	void	Вызывается при открытии окна диалога JivoSite
jivo_onClose	void	Сворачивание окна диалога JivoSite
jivo_onIntroduction	void	Посетитель ввёл контактные данные
jivo_onResizeCallback	void	Коллбек, срабатывающий при любом изменении размеров виджета

chatMode

С помощью этого метогода можно получить текущее состояние операторов.

jivo_api.chatMode();

getContactInfo

Считывает данные посетителя в виде структуры contact_info, которые посетитель ввел в форме представления. Если посетитель не заполнил какие-либо поля, в их значении будет null.

function jivo_onCallEnd(res) {
  if (res.result == 'ok') {
  // call finished successfully
  }
  if (res.result == 'fail') {
  // call finished with errors or can not started
  console.log(res.reason); // reason for the unsuccessfull call
  }
}