Page tree
Skip to end of metadata
Go to start of metadata

Callback API — предназначен для получения событий и управления виджетом обратного звонка на вашем сайте.

(warning) Ваши вопросы по работе с API вы можете задать, написав на почту: support@onlinepbx.ru.



Подключение и настройки

Стандартный код виджета — <script src="https://callback3.onlinepbx.ru/?cb-id=ID_ВИДЖЕТА"></script>

data-атрибуты

атрибутописание атрибута
data-destНомер назначения (с этой страницы звонки будут совершаться на другой номер). В зависимости от режима (как входящий или как исходящий) можно указывать разные номера услуг. Как входящий — группы или пользователи, как исходящий — любой внутренний номер.
data-webrtc-dest

Номер назначения прямого звонка (с этой страницы звонки будут совершаться на другой номер).

Пример:

data-dest = "номер назначения"

<script src="https://callback3.onlinepbx.ru/?cb-id=ID_ВИДЖЕТА" data-dest="100"></script>

data-webrtc-dest = "номер назначения"

<script src="https://callback3.onlinepbx.ru/?cb-id=ID_ВИДЖЕТА" data-webrtc-dest="5001"></script>

Оба атрибута

<script src="https://callback3.onlinepbx.ru/?cb-id=ID_ВИДЖЕТА" data-dest="100" data-webrtc-dest="5001"></script>



Управление виджетом

Метод управления виджетомОписание
OnlinePBXWebWidget.expand()Принудительно развернуть виджет.
OnlinePBXWebWidget.collapse()Принудительно свернуть развёрнутый виджет.
OnlinePBXWebWidget.enable()Показать спрятанный виджет.
OnlinePBXWebWidget.disable()Спрятать виджет.
OnlinePBXWebWidget.destroy()Убрать код виджета из страницы и удалить OnlinePBXWebWidget из объекта window.


Пример:

До передачи команды OnlinePBXWebWidget.expand()


После передачи команды OnlinePBXWebWidget.expand()

К содержанию



События виджета

События виджета, которые срабатывают при взаимодействии клиента с виджетом.

(warning) Размещаются до кода виджета.

СобытиеПараметрыОписание
OnlinePBXWebWidget.events.init
Вызывается, когда виджет завершил инициализацию.
OnlinePBXWebWidget.events.expandclick
Вызывается, когда пользователь нажимает на кнопку виджета сам , при закрытом состоянии.
OnlinePBXWebWidget.events.collapseclick
Вызывается, когда пользователь нажимает закрывает виджет (нажал на крестик в углу виджета).
OnlinePBXWebWidget.events.callrequestnumberВызывается, когда пользователь ввёл свой номер в форму и нажал на кнопку «Жду звонка». number - номер телефона, который ввёл пользователь.
OnlinePBXWebWidget.events.callsuccessnumberВызывается при успешном звонке. number — номер телефона, который ввёл пользователь.
OnlinePBXWebWidget.events.callfailnumber, reasonВызывается, если пользователь запросил звонок, но мы не смогли ему позвонить. number — номер телефона, который ввёл пользователь, reason — причина почему не смогли позвонить пользователю.
OnlinePBXWebWidget.events.webrtccallrequest
Вызывается, когда пользователь нажал на кнопку «Позвонить бесплатно».
OnlinePBXWebWidget.events.webrtccallanswer
Вызывается, когда пользователю ответили.
OnlinePBXWebWidget.events.webrtccallend
Вызывается, когда завершился звонок.


К содержанию

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

(warning) Текст зелёного цвета — // комментарий к событию. В код комментарии не вставлять!

<script type="text/javascript">
if (typeof OnlinePBXWebWidget == 'undefined') {
OnlinePBXWebWidget = {events:{}};
}

OnlinePBXWebWidget.events.init = function() { 

// Виджет отдаст событие по завершении инициализации 

console.log('events.init');  

};

// В консоли браузера отобразится сообщение «events.init»

</script>


<script type="text/javascript">
if (typeof OnlinePBXWebWidget == 'undefined') {
OnlinePBXWebWidget = {events:{}};
}


OnlinePBXWebWidget.events.callrequest = function(number) {    

// Виджет передаст событие, когда клиент ввёл свой номер в форму и нажал кнопку «позвонить».

yaCounter12345678.reachGoal('goalname');           
};
// Передача события в ЯндексМетрику. Goalname — название цели в ЯндексМетрике.
</script>


<script type="text/javascript">
if (typeof OnlinePBXWebWidget == 'undefined') {
OnlinePBXWebWidget = {events:{}};
}


OnlinePBXWebWidget.events.webrtccallanswer = function() { 

// Виджет отдаст событие, когда сотрудник ответит на звонок с сайта.

console.log('events.webrtccallanswer');  

};

// В консоли браузера отобразится сообщение «events.webrtccallanswer».

</script>


Вы не нашли ответ на свой вопрос?

Обратитесь в нашу техническую поддержку:

+7 (495) 669-67-21
+7 (343) 302-01-37
+7 (343) 646-51-40

Почта — support@onlinepbx.ru

Write a comment…