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-метод, не соромтеся просити його у техпідтримки!