Get-параметры для управления web-клиентом
Содержание / Веб-клиент / Get-параметры для управления web-клиентом
Get-параметры позволяют, на этапе загрузки веб-клиента, управлять его функционалом, таким как автоматическое заполнение полей авторизации, звонок в конференцию при старте, а также ограничение доступа пользователя к различным компонентам приложения, например, скрытие чата или доступа к настройкам аудиоканалов.
| Параметр | Описание | Тип |
|---|---|---|
| conference | Заполняет поле «Номер конференции» при старте веб-клиента | Строка |
| displayName | Заполняет поле «Отображаемое имя» при старте веб-клиента | Строка |
| pin | Зашифрованный пин-код для подключения в закрытую конференцию | Строка |
| call | Звонок в конференцию при запуске веб-клиента | Да/Нет |
| lock | Блокирует для изменения поле номера конференции | Да/Нет |
| nocontrols | Позволяет ограничивать доступ пользователя к различным компонентам приложения | Строка |
| inputchannels | Список ID входящих аудиоканалов через запятую | Строка |
| outputchannels | Список ID исходящих аудиоканалов через запятую | Строка |
| number | Имя для авторизации | Строĸа |
| password | Пароль для авторизации encrypted https://www.base64encode.org/ | Строка (base64 encoded) |
| licence | Тип использованной лицензии в звонке | AUDIO AUDIOPLUSPRESENTATION |
Параметр nocontrols, в свою очередь, имеет несколько допустимых значений имен скрываемых компонентов приложения, указываемых через запятую.
| Параметр | Описание | |||
|---|---|---|---|---|
| chat | Чат и список участников конференции | |||
| channels | Настройки аудиоканалов | |||
| clipboard | Кнопка копирования ссылки на конференцию | |||
| fullscreen | Иконка полноэкранного режима | |||
| hangup | Кнопка завершения вызова | |||
| mic | Кнопка включения/выключения микрофона | |||
| logo | Логотип | |||
| callinfo | Информация о звонке | recording | Кнопка записи конференции | |
| participantrequestwordindicator | Индикатор запроса слова | |||
| offerdesktop | Пропуск шага с предложением скачать desktop-версию приложения | |||
| offermobile | Пропуск шага с предожением скачать мобильную версию приложения | |||
| statistics | Статистика битрейта текущего звонка | |||
| usermedia | Окно просмотра видео с веб-камеры пользователя | |||
| videocam | Кнопка включения/выключения камеры | |||
| screenshare | Презентация экрана | |||
| sharesecondcam | Презентация второй ĸамеры | |||
| dtmfdialpad | DTMF Dialpad | |||
| sharefile | Презентация файла | |||
| avatar | Использование аватара | |||
| conferenceparticipants | Список участников | |||
| navigation | Навигационная панель (слева) | |||
| pip | Кнопка PiP на входящем видео | |||
| lang | Переключатель языка интерфейса | |||
| all | Скрывает все вышеперечисленные компоненты |
Примеры
Заполнить поля авторизации:
https://[host_name_or_ip]/client?conference=1000&displayName=John
Заполнить поля авторизации с блокировкой номера конференции:
https://[host_name_or_ip]/client?conference=1000&displayName=John&lock=true
Заполнить поля авторизации и запустить звонок в конференцию:
https://[host_name_or_ip]/client?conference=1000&displayName=John&call=true
Заполнить поля авторизации и запустить звонок в закрытую конференцию:
https://[host_name_or_ip]/client?conference=1000&displayName=John&pin=YnRvYQ==&call=true
Пропустить шаг с предложением скачать desktop-версию приложения:
https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop
Пропустить шаг с предложением скачать desktop-версию приложения и скрыть чат у пользователя во время конференции:
https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop,chat
Cкрыть чат и кнопки включения/выключения камер и микрофонов:
https://[host_name_or_ip]/client?conference=1000&nocontrols=chat,mic,videocam
Пропустить шаг с предложением скачать desktop-версию приложения и скрыть все описанные компоненты:
https://[host_name_or_ip]/client?conference=1000&nocontrols=all
Принудительно указать входящие аудиоканалы для звонка:
https://[host_name_or_ip]/client?conference=1000&inputchannels=0,1
Принудительно указать исходящие аудиоканалы для звонка:
https://[host_name_or_ip]/client?conference=1000&outputchannels=0,2
