Table of Contents
Creating preconfigured links to launch conferences
Links to the Atea Anywhere Web App
You can provide conference participants with a URL that, when clicked, will open an instance of WebTRC interface in their default browser. You can format the URL with query string parameters so that it pre-fills some or all of the required fields and allows the participant to review these before joining, or you can format the URL so the participant is taken straight into the conference.
The URL is in the format:
https://
/?conference=&name=&bw=&pin=&join=&role=&media=&audioonly=&escalate=&extension=
where:
- is the IP address or domain name of the Conferencing Node (or reverse proxy if, for example, it is being used to host a customized version of the Web App).
- is one of the aliases for the Virtual Meeting Room or Virtual Auditorium the user will join.
- is the name of the user who is joining the conference.
- is the bandwidth in kbps, and can be any number between 256 and 1864.
- is either the Host PIN or Guest PIN, if required.
- is 1 if you want the participant to automatically join the conference. If join=1 but a media option has not been specified in the URL (using audioonly=1 for an audio-only call or media= for a control-only call), the participant will join using the media option that was used the last time they joined that conference; if this is the first time they have joined, the default media option will be used.
- is guest if you want to allow Guests to automatically join a conference that has no Guest PIN. If the URL already specifies a , the PIN will determine the participant's role and the will be ignored. Note that if role=host, participants will still be prompted to enter the Host PIN in order to join the conference.
- is 1 if you want to join with audio and video, or is left empty (media=) if you want to join in presentation and control mode. (If this parameter is not specified, the media option that was used the last time the participant joined that conference will be used again; if this is the first time they have joined, the default media option will be used.)
- is 1 if you want to join with audio but no video.
- is 1 if you want users who have joined control-only to be offered the camera and microphone selection options immediately after joining.
- is the Virtual Reception extension, or the Skype for Business / Lync Conference ID.
- is 1 if you want to withhold Host-level controls (such as muting all guests) even if the participant joins as a Host.
The URL must always include https://
/?; the remainder of the fields are optional, as follows:
- If a field is not specified in the URL but is required when joining (i.e. alias, name, PIN if the conference uses PINs, or extension if one is requested), the participant will be required to provide the information themselves before they can join the conference.
- If the bandwidth is not specified in the URL and the participant has not previously selected a different value, the default of 576 will be used.
Examples
-
If the domain name of your Conferencing Node is conference.example.com, and there is a Virtual Meeting Room with the alias meet.alice, which has no PIN, the URL for Bob to join it directly would be:
https://join.anywhere.vc/?conference=meet.alice&name=Bob&join=1
-
If we then gave the same Virtual Meeting Room a Host PIN of 1234 but no Guest PIN, the URL for Bob to join it directly as a Host would be:
https://join.anywhere.vc/?conference=meet.alice&name=Bob&pin=1234&join=1
and the URL for Bob to join it directly as a guest would be:
https://join.anywhere.vc/?conference=meet.alice&name=Bob&join=1&role=guest
and the URL for Bob to join it directly as an audio-only guest would be:
https://join.anywhere.vc/?conference=meet.alice&name=Bob&join=1&role=guest&audioonly=1
Links to the desktop and mobile clients
You can create a URL that, when clicked, will open the pre-installed Infinity Connect client on that device, with the conference name pre-filled. The same URL can be used for the desktop client and mobile clients for Android and iOS.
This URL can be included in web pages, instant messages or emails (but note that some email clients such as Gmail will strip them out for security reasons).
Android and iOS clients
For Android and iOS clients, the URL is in the format:
pexip://?pin=
Desktop client
For the desktop client, the URL supports some additional parameters, and is in the format:
pexip://?pin=&media=&escalate=&audioonly=
where:
- is one of the aliases for the Virtual Meeting Room or Virtual Auditorium the user will join.
- pin= is optional and is the conference PIN (Host or Guest, depending on the role you want to assign to the participant). For conferences with a Host PIN but no Guest PIN, set this to pin=none to join as a Guest.
- is 1 if you want to join with audio and video, or is left empty (media=) if you want to join in presentation and control mode. (Note that this parameter is ignored if escalate is specified, or if the user has selected the setting to Show media options when connecting.)
- is 1 if you want users to join in control only mode and be offered the camera and microphone selection options immediately upon joining, or left blank (escalate=) to join in presentation and control mode only.
- is 1 if you want users to join with audio but no video, or is left blank (audioonly=) to join with audio and video.
Example - email footer
For example, Alice's personal meeting room has the alias meet.alice@example.com so she includes the following text in her email footer:
- Video: meet.alice@example.com
which displays as:
- Video: meet.alice@example.com
Now, when someone who has an Infinity Connect client installed on their device clicks on the link in her email, the client will open automatically with meet.alice@example.com already entered, and all they need to do is select .
Example - guest PIN
Alice's personal meeting room has a guest PIN of 1234. When Alice is chatting with a colleague using an instant messaging client and she wants to move the conversation to video, she sends them the message pexip://meet.alice@example.com?pin=1234, which automatically appears as a hyperlink. Her colleague clicks on the link and instantly joins Alice's personal meeting room as a guest.
Example - always check camera and mic (desktop client only)
If you want the participant to join a meeting with a PIN of 1234, and you want them to select and check their camera and microphone prior to joining, the URL would be: pexip://meet.alice@example.com?pin=1234&escalate=1