Parameters of Get for web client control
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 |
Examples
Fill in the authorization fields:
https://[host_name_or_ip]/client?conference=1000&displayName=John
Fill in the authorization fields with conference number blocking:
https://[host_name_or_ip]/client?conference=1000&displayName=John&lock=true
Fill in the authorization fields and start a conference call:
https://[host_name_or_ip]/client?conference=1000&displayName=John&call=true
Fill in the authorization fields and start a call to a closed conference:
https://[host_name_or_ip]/client?conference=1000&displayName=John &pin=YnRvYQ==&call=true
Skip the step with the offer to download the desktop version of the application:
https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop
Skip the step with the offer to download the desktop version of the application and hide the chat from the user during the conference:
https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop,chat
Hide chat and buttons to turn on/off camera and microphone:
https://[host_name_or_ip]/client?conference=1000&nocontrols=chat,mic,videocam
Skip the step with the offer to download the desktop version of the application and hide all the described components:
https://[host_name_or_ip]/client?conference=1000&nocontrols=all
Force specify audio channels for call:
https://[host_name_or_ip]/client?conference=1000&inputchannels=0,1&outputchannels=0,2
