Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

This guide explains how to configure voice authorization for assigning x-hoppers headsets to users. 

Created: June 2024

Updated: August September 2024

Permalink: https://x-hoppers.atlassian.net/wiki/x/AwAU

...

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

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

...

  1. Voice auth-footprint, which allows you to verify users' identity by voice footprint. In this case, the system compares the voice of the user with user voices previously saved in the system and in case of a match, allows authorisation, 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:a)

  • After enabling the feature, when using the headsets for the first time, users need to lift the headsets from the charger -> place into the charger -> lift from the charger again.

b)
  • Alternatively, before performing the upgrade and activating the feature, unassign headsets via WMS (Devices -> choose device and click Assign to user -> in the Extension field, choose “unknown”). Then, when users lift the headsets from the charger, they need to press the Call button first.  

Authorization via Voice Auth-Footprint

...

To set up the feature, see instructions below:

  1. Install the specific libraries to enable verification of identity by voice using the following command: 

    Code Blockpip install librosa

    Make sure your PBX is updated to min. WMS 6.06

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

    View file
    namevoice_auth.bkp

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

    Code Block
    XHOP_VOICE_AUTH=yes 

...

  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:

    Code Block
    # vi  /etc/systemd/system/pbx-data-engine.service.d/override.conf
    
    [Service]
    ExecStart=
    ExecStart=/usr/sbin/pbx_data_engine.py --daemon --mode calls presence -cr --xhop_voice_login department

    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:

    Code Block
    # vi  /etc/systemd/system/pbx-data-engine.service.d/override.conf
    
    [Service]
    ExecStart=
    ExecStart=/usr/sbin/pbx_data_engine.py --daemon --mode calls presence -cr --xhop_voice_login department
    Environment='XHOP_VOICE_AUTH_DEPS_LIST=Sales,Support'

...

  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“:

    Code Block
    XHOPPERS_VOICEFOOTPRINT_PROMPT=your custom prompt
  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”.

    Code Block
    XHOPPERS_LOGIN_PROMPT=custom login message
  3. 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. 

  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:

    Code Block
    XHOPPERS_FINISH_PROMPT=your custom prompt

...