How to set up Voice Authentication for x-hoppers

Introduction

x-hoppers allows to configure the logic of assigning headsets to users via:

1. Voice, so that staff can take the headset from charger, pronounce their names and automatically get assigned to the headset

2. Pre-saved voice footprint, when the system compares the voice of the user with user voices (voice footprints) previously saved in the system and in case of a match, allows authentication, which eliminates the risk of user logging in under a different name

Requirements 

• WMS 6.05.20240119.1 or higher

Authorization via Voice

 By default, the feature is disabled. To enable it, add the parameter --xhop_voice_login true to the /etc/systemd/system/pbx-data-engine.service.d/override.conf file. The parameter should be added to the line "ExecStart=/usr/sbin/pbx_data_engine.py --daemon --mode calls presence -cr": 

Make sure to reload systemd and restart the service to apply the changes:

When enabled, each time the headset is placed into the charger, user gets unassigned and gets Service license type in the system. When a user lifts the headset from the charger:

1. The user is asked to say their name

2. The user should pronounce the name and surname 

3. The system looks for the user and assigns the headset to the user
   
   

Authentication via Voice Footprint

When this feature is enabled, during user authentication the system compares the voice of the user with user voices previously saved in the system and in case of a match, allows authentication. 

To set up the feature, see instructions below:

1. Make sure your PBX is updated to min. WMS 6.06

2. To configure authorization via voice footprint, download the following Dialplan and upload it on your PBX in the tab Dialplan rules:

3. Add the following variable to WMS -> Dialplan -> General Settings -> Set dialplan variables field and click Save:

   XHOP_VOICE_AUTH=yes 

When the feature is enabled, upon lifting the headset, users are prompted to say the phrase “with x-hoppers, my voice is my password“ to access broadcasts. If the voice authentication attempt fails, they are prompted to provide their extension and name. In case voice footprint is missing, users are suggested to record it. There are 3 attempts with 3 retries each to record the footprint.

The system matches the pronunciation with user records and assigns the headset. Each time the headset is placed into the charger, it gets unassigned and gets Service license type.

Voice authentication for specific Departments only 

Starting from WMS 6.07, it is possible to ​​enable user verification by voice for users of specific Departments only. For this, follow the below steps:

1. Modify the following line in /etc/systemd/system/pbx-data-engine.service.d/override.conf file by adding “department” value after --xhop_voice_login:

   When the value “department” is set, the list of departments from the environment variable XHOP_VOICE_AUTH_DEPS_LIST (see step 2) is used for verification by voice.

2. Add the following line to /etc/systemd/system/pbx-data-engine.service.d/override.conf file, indicating the list of departments, where verification by voice should be used:

Where “Sales, Support” is the list of required departments, separated by comma.

Configure virtual users 

Starting from WMS 6.07, it is possible to configure dummy (virtual) users for assigning a headset in case a user could not be verified by voice after 3 attempts. To set a list of dummy users for assigning a headset in case of voice authentication failure:

1. Create the file with the following name:

2. In this file, add the list of dummy user extensions, for example:

When dummy users are configured, and a user fails to complete verification by voice, the headset gets automatically assigned to an available dummy user. 

Customize prompts used during voice verification 

It is possible to customize prompts pronounced during user verification by voice. 

For this, add the following variable(s) to WMS -> Dialplan -> General Settings -> Set dialplan variables field:

1. To set your custom prompt instead of the default voice footprint message “After the beep please say with x-hoppers: my voice is my password“:

2. To set a custom prompt instead of “Please say your first and last name to use the device“. For example, as long as it is possible to login via extension number, you can change the prompt to “Say your extension”.

3. To skip the playback message “Please hold to use the device, or say cancel to search again“: 

   By default, the value is yes. 

4. To set a custom x-hoppers message instead of the default “Thank you”, pronounced at the end of voice verification, when a user needs to wait till the headset joins the conference:

Battery Level Announcement

By default, during voice authorization, a message with information about battery level of x-hoppers headsets is played to users. 

Customize battery level announcement

If you want to customize the default message “Battery level is”, add the following variable to WMS -> Dialplan -> General settings -> Set dialplan variables:

Where "%s" stands for battery level and can be used to pronounce the battery level information in the needed place.

Disable battery level announcement

To disable battery level announcement, add the following variable to WMS -> Dialplan -> General settings -> Set dialplan variables: