Configure auto-invite of participants

Using Vidyo’s Epic Context-Aware Linking (CAL) integration, providers can now invite other participants automatically by invoking a link using a new parameter. By including the parameter inviteID=<entityID> into the Epic CAL CRYPTSTRING, the VidyoPortal will automatically invite that participant into the Epic CAL conference.

• Prerequisites
• Add the InviteID parameter to the CRYPTSTRING
• Test

Invitees can be:

• VidyoConnect registered users
• VidyoRoom registered users
• Custom endpoints based on VidyoClient

Prerequisites

For the required component versions for this feature, see Epic CAL feature compatibility with Vidyo versions.

Add the InviteID parameter to the CRYPTSTRING

The InviteID is an optional CAL link parameter that allows Epic integrations to invite a user into a conference using their entityID.

Parameter	Value
InviteID	Numeric entityID (obtained via SOAP API request on VidyoPortal)

The InviteID parameter must be included inside the CRYPTSTRING as part the encrypted extData that is passed to Vidyo from the Epic FDI record.

Here is an example of a decrypted CRYPTSTRING with the InviteID parameter (with added line breaks for legibility):

Invitees must be online and not in a conference—just as one would need to be to receive a call invite.

directDial versus InviteID parameters

There are some similarities between the directDial and InviteID parameters, but there are some key differences that are important to note.

Item	directDial Parameter	InviteID Parameter
Parameter location	Outside of CRYPTSTRING	Inside of CRYPTSTRING
User type	Registered user only	Guest or registered user
Room	Uses ad-hoc Room	Uses Epic CAL-generated room (CSN-based)
Epic notification	No Epic notification	Triggers Epic SetExternalConnectionStatus API
Disconnection	Auto-disconnect of invitee when call hangs up (standard P2P flow)	Does not auto-disconnect invitee when call hangs up

Test

Use the Context Aware Sample Link Generator in the Tenant Admin to generate a sample Epic CAL URL link with the InviteID parameter.