Documentation (Russian)

Модуль click2call.js

Модуль click2call.js добавляет в браузер глобальный объект c2c c методом newUserAgent создающим объект UserAgent. В качестве параметра метод принимает настройки необходимые для осуществления звонка.

• from. Номер или имя пользователя, от имени которого производится вызов.
• to. Номер, на который совершается вызов.
• params. Объект содержащий параметры вызова и значения. Может быть передана функция, которая возвращает вычисленный объект. Вычисление функции происходит в момент совершения вызова (Опциональный).
• domain. Адрес SIP сервера.
• password. Пароль пользователя. Может быть опущен, если используется digest или разрешены звонки без регистрации (Опциональный).
• digest. Дайджест пользователя, полученный согласно спецификации RFC 2069. Может быть опущен, если используется password или разрешены звонки без регистрации (Опциональный).
• sipProxy. Адрес OverSIP сервера.
• stunServers. Список STUN серверов (Опциональный).

UserAgent

Объект UserAgent позволяет осуществлять вызовы и управление ими. Для этого объект содержит методы:

• init. Инициализация библиотеки sipml5 в браузере.
• start. Запуск sipml5 и соединение с sip-proxy.
• register. Регистрация на SIP сервере.
• callto. Совершение вызова. Звонок осуществляется на номер, указанный в параметре to. Запуск и регистрация происходит в автоматическом режиме, если это не было выполнено в ручном режиме.
• drop. Завершение текущего вызова.

Для отслеживания состояния могут использоваться флаги, а также подписка на изменение состояния.

• connecting. Флаг определяет происходит ли в данный момент инициализация звонка.
• connected. Флаг определяет существует ли в данный момент активный вызов.
• statusText. Текстовое описание состояния UserAgent.
• onChange. Метод позволяет зарегистрировать метод, который будет вызываться при каждом изменении состояния UserAgent.

Модуль click2call-button.js

Модуль click2call-button.js добавляет в объект c2c дополнительный метод newButton, который позволяет создавать простейшую кнопку звонка и выводить состояние звонка в строку статуса. В качестве параметра метод принимает целевые элементы страницы и настройки необходимые для осуществления звонка.

• button. Кнопка для осуществления звонка.
• status. Элемент для вывода состояния и результата звонка.
• userAgentSettings. Параметры аналогичные аргументам для метода newUserAgent.