Api
Интерфейс прикладного программирования
Инициализация
На странице Проекты получаем HTML-код виджета такого вида и вставляем на свою страницу.
Для подключения API перед только что вставленным кодом добавляем код инициализации либо в настройках виджета указать
API Callback где значение имя функции доступной из глобального объекта window.
Например вы объявили функцию
window.testApi = function (){};
, то в настройках указываете testApi
<script type="text/javascript">
var PozvonimcomWidgetConfig = {
ready: function () {}
};
</script>
Теперь вам доступно API виджета. Полный список опций и callback'ов виджета указан в блоке Параметры
Пространство имен и получение объекта виджета
После полной инициализации виджета, он будет доступен в глобальном пространстве имен
PozvonimcomWidget
так же получить доступ можно через объект
window.PozconimcomWidget
, он сообщит вам о готовности. При помощи вызова функции которую вы
указали в переменной
ready
, функция будет вызвана в контексте объекта виджета, то есть по
this
вы можете получить объект виджета
Для примера сделаем чтобы виджет сразу же показался как загрузится
<script type="text/javascript">
var PozvonimcomWidgetConfig = {
ready: function () {
this.api.show();
}
};
</script>
Параметры и события и методы
Ниже перечислены все доступные параметры настройки виджета.
Параметры
-
callback.ready
— Callback готовности умного виджета обратной связиВызывает функцию переданную при событии готовки виджета.
Без параметров
События
-
hide
— Событие закрытие виджетаСобытие закрытие виджета.
Без параметров
-
show
— Событие открытия виджетаСобытие открытия виджета.
Без параметров
-
call
— Событие звонкаСобытие происходит в момент нажатия на кнопку в виджете Жду звонка.
Без параметров
-
call.delayed
— Событие отложенного звонкаСобытие происходит в момент подписки на отложенный звонк.
Без параметров
-
call.delayed.respond
— Событие успешной подписки на отложенный звонокСобытие происходит после того, как пользователь подписался на отложенный звонок.
Без параметров
-
call.blacklist
— Событие заблокированного звонкаСобытие происходит в момент нажатия на кнопку в виджете Жду звонка, если введенный номер в черном списке.
Без параметров
-
call.success
— Событие успешного звонкаСобытие происходит в момент ответа от сервера если ответ успешный.
Без параметров
-
call.success.respond
— Событие успешного звонка, когда сервер начинает звонить менеджеруСобытие происходит после того, как сервер начинает звонить менеджеру
Без параметров
-
call.offline
— Событие отложенного звонкаСобытие происходит в момент нажатия на кнопку в виджете Жду звонка, при не рабочем времени.
Без параметров
-
call.balance
— Событие недостатка средствСобытие происходит в момент нажатия на кнопку в виджете Жду звонка, при недостаточном балансе.
Без параметров
Методы
-
api.show
— Открыть виджетОткрывает виджет, если он закрыт, вне зависимости что в нем происходит и как был открыт.
Без параметров
-
api.hide
— Закрыть виджетЗакрывает виджет, если он открыт, вне зависимости что в нем происходит и как был открыт.
Без параметров
-
api.call
— Выполнить звонок из виджетаВыполнить звонок в обход виджета
Параметр Значение Описание — options[] Параметры звонка - — *options[phone] Номер на который звонить, принимается только +00000000000 формат - — options[region] Филиал в который звонить - — options[delayed] Отложенный звонок, если звонок не отложенный передается false, если отложенный то дата в формате monday:08:00 - -
api.on
— Подписаться на событиеПараметр Значение Описание — name Идентификатор события — *callback Callback-функция -
api.getClient
— Получить информацию о клиентеБез параметров
-
api.getOptions
— Получить настройки виджетаБез параметров
-
api.getPhone
— Получить номер телефонаБез параметров
-
api.setPhone
— Ввести номер телефонаПараметр Значение Описание — *phone Установить значение в поле номер телефона в виджете, в формате +0000000000 - -
api.getDelayed
— Получить дату отложенного звонкаВозвращает значения полей введенные в виджете на когда клиент хочет отложенный звонок в формате monday:08:00
Без параметров
-
api.setDelayed
— Установить дату отложенного звонкаПараметр Значение Описание — *date Установить значение в поля номер телефона в виджете, в формате +0000000000 - — *date[0][0] Установить значение в поле день отложенного звонка - — *date[0][1] Установить значение в поле час отложенного звонка - — *date[0][2] Установить значение в поле минуты отложенного звонка - -
api.Button.show
— Показать кнопкуБез параметров
-
api.Button.hide
— Скрыть кнопкуБез параметров