Parameters of Get for web client control

Материал из База знаний VINTEO

Get parameters allow at the stage of loading the web client to manage its functionality such as automatic filling of authorization fields, calling to a conference at startup, as well as restricting user access to various components of the application, for example, hiding the chat or access to audio channel settings.

Parameter Description Type
conference Fills in the "Conference number" field when starting the web client String
displayName Fills in the "Display name" field when the web client starts String
pin Encrypted PIN code for joining a close conference String
call Calling a conference when launching the web client Yes/No
lock Locks the conference number field for editing Yes/No
nocontrols Allows you to restrict user access to various components of the application String
inputchannels List of incoming audio channel IDs comma separated String
outputchannels List of outgoing audio channel IDs comma separated String
number Login name String
password Password for authorization with encrypted https://www.base64encode.org/ base64
licence Type of license used in the call AUDIO AUDIOPLUSPRESENTATION

The nocontrols parameter has several valid values ​​for the names of hidden application components separated by commas.

Parameter Description
chat Chat and list of conference participants
channels Audio channel settings
clipboard Button to copy conference link
fullscreen Fullscreen mode icon
hangup End call button
mic Microphone on/off button
logo Logo
callinfo Call information
recording Conference recording button
participantrequestwordindicator Word request indicator
offerdesktop Skipping the step with the offer to download the desktop version of the application
offermobile Skipping step with the offer to download mobile version of the application
statistics Current call bitrate statistics
usermedia Window for viewing video from the user's webcam
videocam Camera on/off button
screenshare Screen sharing
sharesecondcam Presentation of the second camera
dtmfdialpad DTMF Dialpad
sharefile File sharing
avatar Using an avatar
conferenceparticipants List of participants
navigation Navigation bar (on the left)
pip PiP button on incoming video
lang Interface language switch
all Hides all the above components

Примеры

Заполнить поля авторизации:

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&outputchannels=0,2