Callback API 0.3

Обновлено 22 сентября 2026 г. · ≈ 3 мин чтения

Скачать: PDF Word HTML
Содержание 5

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

Ваши вопросы по работе с API пишите на почту: support@onlinepbx.ru.


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

Стандартный код виджета —

data-атрибуты⁠⁠

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

Пример:

data-dest = "номер назначения"
<script src="https://callback3.onlinepbx.ru/?cb-id=ID\_ВИДЖЕТА" data-dest="100">
data-webrtc-dest = "номер назначения"
<script src="https://callback3.onlinepbx.ru/?cb-id=ID\_ВИДЖЕТА" data-webrtc-dest="5001">
Оба атрибута
<script src="https://callback3.onlinepbx.ru/?cb-id=ID\_ВИДЖЕТА" data-dest="100" data-webrtc-dest="5001">

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

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

⁠Пример:

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


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

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

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

⁠

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

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

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


• * *

• * *

Была ли статья полезной?