Info |
---|
This guide explains how to configure voice authorization authentication for assigning x-hoppers headsets to users. Created: June 2024 Updated: October 2024 Permalink: https://x-hoppers.atlassian.net/wiki/x/AwAU |
Table of Contents | ||
---|---|---|
|
Introduction
x-hoppers allows to configure the logic of assigning headsets to users via:
Voice, so that staff can take the headset from charger, pronounce their names and automatically get assigned to the headset
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 authorisationauthentication, 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":
...
Note |
---|
Important: For the feature to start working on the headsets, follow one of the following procedures:
|
...
Authentication via Voice Footprint
When this feature is enabled, during user authorisation authentication the system compares the voice of the user with user voices previously saved in the system and in case of a match, allows authorisationauthentication.
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Note: The support starts from WMS 6.06 |
...
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 authorization 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:
...
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 authorization authentication failure:
Create the file with the following name:
Code Block /rw2/etc/pbx/x-hoppers_dummy_users.json
In this file, add the list of dummy user extensions, for example:
Code Block [703, 706, 702]
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.
...
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“:
Code Block XHOPPERS_VOICEFOOTPRINT_PROMPT=your custom prompt
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”.
Code Block XHOPPERS_LOGIN_PROMPT=custom login message
To skip the playback message “Please hold to use the device, or say cancel to search again“:
Code Block XHOPPERS_CONFIRMATION_PROMPT=no
By default, the value is yes.
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:
Code Block XHOPPERS_FINISH_PROMPT=your custom prompt
...
Battery Level Announcement
By default, during voice authorization, a message with information about battery level of x-hoppers headsets is played to users.
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Note: Battery level announcement is played starting from WMS 6.07.20240806.1. |
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:
...