Creating preconfigured links to launch conferences via Infinity Connect

You can construct URLs or hyperlinks that may be used to automatically launch the Infinity Connect client and take the user directly into a specific conference. If required it can also pass in any necessary information such as the caller's name or the PIN needed to enter the meeting.

The URLs are in two formats: one that can be used to launch the web app, and one for use with the desktop and mobile clients. The parameters that can included in the link are the same for both link types (with the exception of address/domain and callType).

Links to the web app

To open an instance of the Infinity Connect web app in the user's default browser and take them to the home screen (not into a specific conference), use the following link:

https://<address>/webapp/home

where <address> 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).

To provide users with a URL that, when clicked, takes them straight into a specific conference, construct a URL in the format:

https://<address>/webapp/conference/<alias>?name=<name>&pin=<PIN>&role=<role>&muteMicrophone=<muteMicrophone>&muteCamera=<muteCamera>&callType=<callType>&extension=<extension>&bandwidth=<bandwidth>

where:

  • <address> 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).
  • <alias> is one of the aliases for the conference or service the user will join.
  • <name> is the name of the user who is joining the conference.
  • <PIN> is either the Host PIN or Guest PIN, if required.
  • <role> is guest if you want to allow Guests to automatically join a conference that allows Guests but has no Guest PIN. In all other cases, participants are asked to enter a PIN to join the conference (unless there is no Host PIN, or the URL already specifies a <PIN>); the PIN determines the participant's role and the <role> is ignored. Note that if role=host, participants are still prompted to enter the Host PIN to join the conference; this parameter cannot be used to bypass PIN entry requirements.
  • <muteMicrophone> is true to join without sending audio (the user will still receive audio, and send and receive video).
  • <muteCamera> is true to join without sending video (the user will still receive video, and send and receive audio).

  • <callType> is one of:

    • none to join as a presentation and control-only participant, i.e. the user will not send or receive any audio or video. They can still access the conference controls and send and receive presentations.
    • audioonly to join as an audio-only participant, i.e. the user will send and receive audio but will not send or receive video.
    • video (the default) to join as a full (send and receive) audio and video participant.
  • <extension> is the Virtual Reception extension, or the Microsoft Skype for Business / Lync Conference ID.
  • <bandwidth> is the maximum bandwidth for the call, and the bandwidth at which the initial call attempt will be made, in kbps. It can be any number between 256 and 2464.

The URL must always include https://<address>/webapp/conference/<alias>; the remainder of the fields are optional. If a field is not specified in the URL but is required when joining (i.e. name, and PIN if the conference uses PINs, or extension if one is requested), the participant will have to provide the information themselves before they can join the conference.

Examples

Assuming the domain name of your Conferencing Node is vc.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://vc.example.com/webapp/conference/meet.alice?name=Bob

If we then gave the same Virtual Meeting Room a Host PIN of 1234, and allowed Guests to join without a PIN:

  • the URL for Bob to join it directly as a Host would be:

    https://vc.example.com/webapp/conference/meet.alice?name=Bob&pin=1234

  • the URL for Bob to join it directly as a Guest would be:

    https://vc.example.com/webapp/conference/meet.alice?name=Bob&role=guest

  • the URL for Bob to join it directly as an audio-only Guest would be:

    https://vc.example.com/webapp/conference/meet.alice?name=Bob&role=guest&callType=audioonly

Alternative structure to join with an invitation card

You can use an alternative URL structure in the format:

https://<address>/webapp/home?conference=<alias>

In this case the web app will launch with an invitation to join the nominated <alias>, and it gives the user an opportunity to modify their settings (such as camera, mic and so on) before joining the conference, and they can select whether they want to join with video, voice, or content and control only.

This can be useful in scenarios where a user has previously set their camera to None, and are unable to modify their device settings if they have been taken directly into a conference.

Links to the desktop and mobile clients

You can create a URL that, when clicked, opens the Infinity Connect client on that device, and takes the participant into the nominated conference. 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).

The Infinity Connect desktop or mobile client must already be installed on the device.

The URL is in the format:

pexip://<alias>?host=<domain>&name=<name>&pin=<PIN>&role=<role>&muteMicrophone=<muteMicrophone>&muteCamera=<muteCamera>&extension=<extension>&bandwidth=<bandwidth>

where:

  • <alias> is one of the aliases for the conference or service the user will join.
  • <domain> 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) the client should connect to in order to place the call. Note that this will be ignored if the client is registered and Route calls via registrar has been enabled.
  • <name> is the name of the user who is joining the conference.
  • <PIN> is either the Host PIN or Guest PIN, if required.
  • <role> is guest if you want to allow Guests to automatically join a conference that allows Guests but has no Guest PIN. In all other cases, participants are asked to enter a PIN to join the conference (unless there is no Host PIN, or the URL already specifies a <PIN>); the PIN determines the participant's role and the <role> is ignored. Note that if role=host, participants are still prompted to enter the Host PIN to join the conference; this parameter cannot be used to bypass PIN entry requirements.
  • <muteMicrophone> is true to join without sending audio (the user will still receive audio, and send and receive video).
  • <muteCamera> is true to join without sending video (the user will still receive video, and send and receive audio).
  • <extension> is the Virtual Reception extension, or the Microsoft Skype for Business / Lync Conference ID.
  • <bandwidth> is the maximum bandwidth for the call, and the bandwidth at which the initial call attempt will be made, in kbps. It can be any number between 256 and 2464.

The URL must always include pexip://<alias>; the remainder of the fields are optional. If a field is not specified in the URL but is required when joining (i.e. name, and PIN if the conference uses PINs, or extension if one is requested), the participant will have to provide the information themselves before they can join the conference.

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: <a href="pexip://meet.alice@example.com">meet.alice@example.com</a>

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 Alice's email, their client will open automatically with an invitation to join meet.alice@example.com, and all they need to do is select whether they want to join with video, voice, or content and control only:

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 join with microphone muted

If you want the participant to join a meeting with a PIN of 1234, and you want their microphone to be muted on joining, the URL would be: pexip://meet.alice@example.com?pin=1234&muteMicrophone=true

Links to the legacy Infinity Connect clients

For information on creating links to legacy clients, see the v17 documentation.