Основная библиотека для взаимодействия с системой на стороне браузера. Код для подключения, который выдается при регистрации сайта, асинхронно загружает эту библиотеку (https://cdn.carrotquest.io/api.min.js).
После размещения кода на сайте будет создан глобальный объект carrotquest, к которому нужно обращаться для взаимодействия с JavaScript API.
Например, для вызова метода track нужно написать carrotquest.track(...).
| Метод | Описание |
|---|---|
| connect | Соединение с системой |
| track | Отслеживание события |
| identify | Идентификация (запись свойства пользователя) |
| auth | Передача User ID |
| open | Программное открытие чата |
| onReady | Поставить callback, который будет вызван после загрузки скрипта |
| addCallback | Установить callback |
| removeCallback | Удалить callback |
| trackMessageInteraction | Отслеживание взаимодействия с сообщением (прочтение, клик, ответ) |
В Carrot quest есть возможность добавить свои функции-обработчики, которые будут вызваны при наступлении определенных условий. Например, при открытии чата, получении автосообщения, отправке сообщения в диалог, при начале диалога и т.д. Мы называем такие функции callbacks.
Используйте метод addCallback чтобы установить callback и removeCallback чтобы удалить.
После того, как скрипт загружен и соединение с системой установлено,
у каждого пользователя появляется ID. Он хранится в куке
carrotquest_uid.
Вы можете записывать этот идентификатор к себе, чтобы в дальнейшем обращаться к Web API.
Важно! Обратите внимание, что carrotquest_uid может измениться в процессе работы чата,
если была вызвана склейка пользователя