API онлайн консультанта

Открытие модуля

Метод, служащий для открытия модуля

supportAPI.openSupport(); 

Пример использования:

<a href="#" onClick="supportAPI.openSupport(); return false;">Задать вопрос</a>

Результат:

Задать вопрос

 

Открытие модуля по ссылке на картинку

        <a href="#" onClick="supportAPI.openSupport(); return false;"><img src="URL"></a>,

где URL — ссылка на изображение.

 

Открытие вкладки «Отзывы»

        <a href="#" onClick="supportAPI.openReviewsTab(); return false;">Оставить отзыв</a>
        

 

Открытие любой вкладки

        <a href="#" onClick="supportAPI.openTab(index); return false;">Ваш текст или картинка</a>,

где index — номер вкладки по порядку (нумерация с 0).

Подробнее о том, как добавлять свои вкладки на форму, читайте в нашей статье «Добавление вкладок на форму онлайн-чата».

 

---

 

Внешний вид

Скрыть стандартный ярлык

Добавьте в стили css вашего сайта строку

        <style>#supportTrigger, #supportTriggerMobile{ display:none !important; }</style>
        

 

Замена стандартного ярлыка на свой

Стандартный ярлык онлайн консультанта задается в CSS как

div.supportTrigger{ background-image:url('.....')...}

Соответственно, если вы хотите оставить ярлык на том же самом месте, но изменить саму картинку, то вы можете в CSS вашего сайта прописать:

div.supportTrigger{ background-image:url('.....') !important; background-size: 100px 100px 
!important; width:100px !important; height:100px !important; },

где url(‘…..’) — путь до изображения, width — ширина вашей картинки, а height — её высота.

 

Изменение цвета отзывов на сайте

Для того, чтобы изменить цвет отзывов на вашем сайте, необходимо перейти в раздел «Online чат — ваш сайт — Настройки — Основные настройки» и выбрать «Свой дизайн — Свой CSS внутри модуля». В открывшемся окошке нужно прописать стили:

div.ajax.greenAjax{ background: #eeeeee; } — это положительные отзывы
        div.ajax.redAjax{ background: #aaaaaa; } — это отрицательные

Вместо #eeeeee и #aaaaaa подставьте нужный код цвета.

 

Изменение позиции окна чата

supportAPI.setPosition(x, y);

Пример использования:

В коде вызова онлайн-чата, который вы разместили на сайте, найдите строки:

var callback = function(){
                /*
                        Здесь вы можете вызывать API. Например, чтобы изменить отступ по высоте:
                        supportAPI.setSupportTop(200);
                */
        };

и замените на:

var callback = function(){
                supportAPI.setPosition(100, 200);
        };

 

---

 

Всплывающие уведомления

Вызов всплывающего уведомления

$SA.support.rpcActions.showNewMessage({name:"Имя оператора", message:"Текст сообщения",avatar:"http://"})

Такие уведомления отображаются на сайте, но не сохраняются в системе и не отображаются в истории общения.

Если вы хотите настроить стандартные автоприглашения, то сделайте это в личном кабинете в разделе «Автоприветствие». Инструкции в нашей статье «Автоприветствие (вовлечение в диалог)».

 

Изменение цвета всплывающего уведомления

supportAPI.setNewMessageColors("rgba( 0, 0, 0, 0.80)", "#000", "#fff");

Первый параметр — это background для современных браузеров, поддерживающих прозрачность (включает в себя альфа-канал, задающий прозрачность элемента, значение 0 соответствует полной прозрачности, 1 — непрозрачности).

Второй параметр — фон для старых версий IE, не поддерживающих rgba цвета с прозрачностью.

Третий параметр — цвет текста.

 

Изменение расположения окна уведомления

Для того, чтобы изменить расположение всплывающего окна (окна автоприглашения) нужно добавить стили на вашем сайте:

<style>
                #supportNewMessage{ 
                top:30px; bottom:auto; left:30px; right:auto;
                }
        </style>

 

---

 

Данные о посетителях и операторах

Изменение имени посетителя

Вы можете назначать имена своим посетителям в зависимости от того, кто именно авторизован на сайте в данный момент с помощью кода:

<script>
                supportAPI.setName("Новое имя посетителя");
        </script>

 

Изменение контактов посетителя

Вы можете назначать контактный телефон и email своим посетителям в зависимости от того, кто именно авторизован на сайте в данный момент с помощью кода:

<script>
                supportAPI.changeContacts("Новые контакты посетителя");
        </script>

 

Получение данных пользователя (имя/телефон/email)

Если вы хотите получить данные пользователя, которые он ввел в форму, чтобы использовать их для своих целей, используйте метод:

<script>
                supportAPI.getContacts(function(data){ console.log(data); });
        </script>

В функцию, в переменную data вам вернется:

Object {name: "Имя клиента", phone: "Телефон", email: "Емайл"}

 

Назначение целевых посетителей

В разделе «Целевые посетители» вы сможете настроить уведомления о наиболее важных посетителях вашего сайта по ряду параметров. Подробнее о настройке в нашей статье «Целевые посетители».

Если вы хотите задать более сложные условия определения целевых посетителей, то воспользуйтесь методом:

<script>
                supportAPI.setTarget("Здесь указывается причина, почему посетитель целевой");
        </script>

 

Подмена имени оператора

Если вы хотите изменить имя оператора только на одном из используемых сайтов, то добавьте следующий скрипт перед кодом вызова чата:

<script type='text/javascript'>
                var customSupportOperatorNames = {login:"Желаемое имя оператора"};
        </script>

где login — логин оператора в системе.

 

Отслеживание статусов операторов

supportAPI.listenOperatorsStatus(callback);

Пример использования:

<script>
                supportAPI.listenOperatorsStatus(function(onlineOperators){
                        if (onlineOperators.length){
                                alert("Сейчас онлайн "+onlineOperators.length+" операторов");
                        }
                        else{
                                alert("Все операторы offline");
                        }
                });
        </script>

 

Выбор любого оператора

С помощью этого метода вы можете назначить посетителю любого оператора, находящегося в сети:

<script>
                supportAPI.setOperator("логин оператора");
        </script>

 

---

 

Автоматическая отправка сообщений

Отправка сообщения оператору от клиента

Данный метод позволяет имитировать отправку вопроса оператору от клиента. Вы можете реализовать следующий сценарий: в описание товара разместите ссылку на открытие чата, например, «Уточнить наличие товара». По клику открывается онлайн-чат и оператору автоматически отправляется шаблонное сообщение вида: «Здравствуйте, уточните наличие товара AB057». Реализуется это следующим образом:

<script>
                supportAPI.sendMessage("Здравствуйте, уточните наличие товара AB057");
        </script>

 

Отправка автоответа клиенту от оператора

Оператор может автоматически «ответить» на вопрос шаблонным текстом, например «Здравствуйте! Сейчас я уточню наличие данного товара, пожалуйста, подождите». Эта фраза удержит посетителя и даст оператору время на поиск нужной информации. Реализуется это следующим образом:

<script>
                supportAPI.receiveMessage("Текст сообщения", "логин оператора");
        </script>

«логин оператора» — этот параметр можно убрать, тогда ответ будет отправлен от выбранного в чате оператора.

 

Пример использования:

function simulateChat(){
                supportAPI.sendMessage("Здравствуйте, уточните наличие товара AB057.");
                setTimeout(function(){
                supportAPI.receiveMessage("Здравствуйте! Сейчас я уточню наличие данного товара, пожалуйста, подождите.");
                },5000);
        }

Функцию simulateChat() можно использовать на событие onClick.

 

---

 

Интеграция с Яндекс.Метрикой

Найдите в вашем коде строку вызова функции “callback” и добавьте соответствующий код.

1. Событие, связанное с отправкой сообщения оператору:

        var callback = function(){
                supportAPI.clientSendMessageCallback = function(){
                yaCounterXXXXXX.reachGoal('online_chat');
                };
        };
        

2. Событие, связанное с открытием чата:

        var callback = function(){
                supportAPI.openSupportCallback = function(){
                yaCounterXXXXXX.reachGoal('online_chat');
                };
        };
        

где:

• XXXXXX — номер вашего счётчика;
• online_chat — идентификатор вашей цели.

Подробнее о настройке в статье «Интеграция Suo.Chat с Яндекс.Метрикой и Google Analytics».

 

Интеграция с Google Analytics:

Найдите в вашем коде строку вызова функции “callback” и добавьте соответствующий код.

1. Событие, связанное с отправкой сообщения оператору:

        var callback = function(){
                supportAPI.clientSendMessageCallback = function(){
                _gaq.push(['_trackEvent', 'category', 'action', 'opt_label', 'opt_value', 'opt_noninteraction']);
                };
        };
        

2. Событие, связанное с открытием чата:

        var callback = function(){
                supportAPI.openSupportCallback = function(){
                _gaq.push(['_trackEvent', 'category', 'action', 'opt_label', 'opt_value', 'opt_noninteraction']);
                };
        };
        

 

---

 

Если вам нужен ещё какой-либо API-метод, не стесняйтесь просить его у техподдержки!