GET parameters for web client control

Control the web client at load time with URL parameters

bg-dots
bg-dots

GET parameters are set in the Web client (/client) URL and at load time fill fields, start a call and hide interface components.

GET parameters

Parameter Description Type
conference Fills “Conference number” when the web client starts; when set, the number field may be hidden on the form String
displayName Fills “Display name” when the web client starts String
pin PIN for a closed conference String
call Places a call when the web client starts Yes/No
lock Locks the conference number field Yes/No
nocontrols Restricts access to application components (also accepted as noControls) String
inputchannels Incoming audio channel IDs, comma-separated String
outputchannels Outgoing audio channel IDs, comma-separated String
number Login for authorization String
password Authorization password in Base64 encoding base64
license License type for the call AUDIO, AUDIOPLUSPRESENTATION
autoShareSecondCam Starts second-camera presentation when the call begins Yes/No
isEnabledRemoteControlCamera Allows the moderator to enable and disable the user camera Yes/No
isEnabledRemoteControlMicrophone Allows the moderator to enable and disable the user microphone Yes/No

nocontrols parameter

Values are specified as a comma-separated list.

Parameter Description
chat Chat and conference participant list
clipboard Button for copying the conference link
fullscreen Fullscreen icon
hangup End-call button
mic Microphone on/off button
recording Conference recording button
offerdesktop Skips the desktop application download prompt
offermobile Skips the mobile application download prompt
statistics Bitrate statistics of the current call
usermedia Local webcam preview
videocam Camera on/off button
channels Audio channel settings
screenshare Screen sharing
sharefile File presentation
sharesecondcam Second camera presentation
dtmfdialpad DTMF dial pad
avatar Avatar usage
logo Logo
callinfo Call information
conferenceparticipants Participant list
navigation Left navigation panel
pip PiP button on incoming video
lang Interface language switcher
ptz PTZ controls
reactions Reactions
secondtabwarning Disables the warning that the application is already open in another tab
secondcampreview Hides the second camera preview
controlwebccall Web-C call controls
all Hides all listed components

The parameter nocontrols=offerdesktop skips the VinteoDesktop offer and opens the “Connection settings” form.

Examples

Fill fields:

https://[host_name_or_ip]/client?conference=1000&displayName=John

Fill fields and lock the conference number:

https://[host_name_or_ip]/client?conference=1000&displayName=John&lock=true

Fill fields and start a call:

https://[host_name_or_ip]/client?conference=1000&displayName=John&call=true

Fill fields and join a closed conference:

https://[host_name_or_ip]/client?conference=1000&displayName=John&pin=YnRvYQ==&call=true

Skip the desktop download prompt:

https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop

Skip the desktop prompt and hide chat:

https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop,chat

Hide chat and camera/microphone buttons:

https://[host_name_or_ip]/client?conference=1000&nocontrols=chat,mic,videocam

Hide all listed components:

https://[host_name_or_ip]/client?conference=1000&nocontrols=all

Force audio channels:

https://[host_name_or_ip]/client?conference=1000&inputchannels=0,1&outputchannels=0,2
Web client browser compatibility