Goodbye, Skype for Business! Time for Virola. Learn more

Deep links in Virola client app

A deep link is a specific type of link that directs users to a particular location or piece of content within the Virola client app. By using Virola deep links, your users can save time and effort during onboarding and while communicating later on.

Virola deep links start with virola:// and can either execute a command or lead directly to a specific message, group chat room, or user profile.

Commands supported by Virola deep links

All commands are executed using the link format virola://command?action={command-name}, followed by a parameter string if needed. They work properly both inside and outside the Virola client app.

There are three commands currently supported in Virola:

Virola client app activation

The command virola://command?action=activate

  • Starts the Virola client app if it's not running
  • Restores the Virola client app window if it is minimized
  • Makes Virola blink in the taskbar if its window is already restored but hidden behind other windows

This command doesn't require any parameters.

Login to the Virola client app

The command virola://command?action=login allows users to log into the Virola client using the parametes provided in the link. It can also be used to reset a user's password.

To work properly, login command requires the following parameters:

  • host - the server host name
  • port - the server port
  • un - the username of the user logging in
  • pw - the password of this user

Example: virola://command?action=login&host=127.0.0.1&port=7777&un=dan&pw=123

In this example, the user with the username dan will log into the server listening on IP 127.0.0.1 and port 7777.

Optional parameters

A set of optional parameters can be passed to login command. These parameters define the Viorla client configuration and behavior after login:

  • profile - the name of a new application profile. It will be used when the command execution includes a new application profile creation. If the profile with this name already exists, it will not be used
  • Proxy parameters:
    • xhost - required for correct proxy setup
    • xport - required for correct proxy setup
    • xun - optional for correct proxy setup
    • xpw - optional for correct proxy setup
  • room - the ID of the room that will automatically open in the Virola client once the user is logged in
  • icom - intercom configuration for the room specified in the room parameter. This is an arbitrary combination of 4 letters, each representing a specific intercom function:
    • l - listening: enables speaker/headphones
    • t - talking: enables the microphone
    • w - watching: displays other room participants' video streams in the sidebar
    • s - streaming: enables the camera and starts streaming video

Example: virola://command?action=login&host=127.0.0.1&port=7777&un=dan&pw=123&room=5&icom=lw

In this example, the user with the username dan will log into the server listening on IP 127.0.0.1 and port 7777. After logging in, the room with ID 5 will open, and the user will automatically start listening and watching in this room.

Resetting user password with the login command

The login command can also be used to reset a user's password. The link with this command is generated automatically when the server аdmin resets a user's password. To generate a password reset link, the Virola admin needs to follow these steps:

  1. Go to Administration / Manage Users
  2. Find the user whose password needs to be reset
  3. Right-click on the user and select "Reset User Password"
  4. Confirm the password reset
  5. Copy the reset password link and provide it to the user

The password reset link will contain a temporary user password. When opened with this link, the Virola client app will prompt the user to enter a new password.

User self-registration

The command virola://command?action=self-registration allows users to create their own profiles on a server. It only works if user self-registration is enabled in the server settings. The command starts or restores the Virola client app with the self-registration wizard open, prompting the user to define their username and password for registration.

To work properly, self-registration command requires the following parameters:

  • host - the server host name
  • port - the server port

Example: virola://command?action=self-registration&host=127.0.0.1&port=7777

A set of optional parameters can be passed to self-registration command:

  • profile - the name of a new application profile. It will be used when the command execution includes a new application profile creation. If the profile with this name already exists, it will not be used
  • Proxy parameters:
    • xhost - required for correct proxy setup
    • xport - required for correct proxy setup
    • xun - optional for correct proxy setup
    • xpw - optional for correct proxy setup

Navigational deep links

Navigational deep links allow to easily get to the needed message, group chat room, or user profile. They only work when clicked within Vrola client app.

Group chat room link

This link has the following look virola:///room/{room-id}. It is used to invite users to a group chat. To do this:

  1. Right-click the group room tab
  2. Select "Copy Room Link" menu item
  3. Send the copied link to the user you want to invite

After clicking such a link, a user will be automatically added to the group chat room.

However, an option to allow users to add themselves to a group chat room should be enabled in the Chat Room Options for the group chat room where you would like to invite new users. Otherwise, these users will get an error that the chat room was not found.

User profile link

A user profile link has the following look virola:///user/{user-id} and opens a user profile. To get a user profile link you need to:

  1. Right-click on the user
  2. Select "Copy link to user" menu item

However, if the permission "See other users' personal details" is restricted, it will be impossible to get a user profile link.

The ability to share links to user profiles is useful if you need to introduce a new team member or share information about an expert in your company with your co-workers.

Message link

A message link has the following look virola:///message/{message-id} and navigates to the specified message. To get a message link you need to:

  1. Right-click on the message
  2. Select "Copy Message Link" menu item

You can share this link in other chats, both private and group. However, if a user has no access to the chat room where the message was sent, that user will get "Message not found" error.

Attachment link

An attachment link has the following look virola:///attachment/{attachment-id} and navigates to the specified attachment. To get an attachment link you need to:

  1. Right-click on the attachment
  2. Select "Copy Attachment Link" menu item

You can share this link in other chats, both private and group. However, if a user has no access to the chat room where the attachment was sent, that user will get "Attachment not found" error.