x-hoppers Custom Settings

Created by

Ksenia Babych

Last updated: 22 December 2025, 10:05

This document provides an overview of customizable x-hoppers settings.

Created: November 2024

Updated: December 2025

Allow W-PA 2 to send notifications to the broadcast
Configure dynamic detection of speaker’s language
Control x-hoppers headsets charging behaviour
Create multiple broadcasts
Manage unmuted announcement
Adjust headset audio levels
Increase volume for noisy environments
Join a broadcast from other devices
Modify the timeout of broadcast mute
Modify the timeout for resuming a call on hold
Pick up a call put on hold by x-hoppers broadcast user
Set custom prompt played when answering a call

Allow W-PA 2 to send notifications to the broadcast

It is possible to allow W-PA 2 Public Announcer to send notifications to x-hoppers broadcast. For this, follow the steps below:

Add Wildix W-PA2 to the following line in the file /etc/systemd/system/pbx-data-engine.service.d/override.conf

nano-tiny /etc/systemd/system/pbx-data-engine.service.d/override.conf[Service]Environment='XHOP_USER_AGENT=Wildix W-AIR-SP/HS,Wildix W-AIR-SBR2/HS,Wildix W-PA2'

Reload systemd and restart the service to apply the changes
```
systemctl daemon-reloadsystemctl restart pbx-data-engine
```

Configure dynamic detection of speaker’s language

In case a user in the broadcast speaks several different languages, e.g. English and Italian, for better transcription accuracy you can configure dynamic detection of the speaker's language.

Add the -tl parameter with the necessary languages to the /etc/systemd/system/pbx-data-engine.service.d/override.conf file.

nano-tiny /etc/systemd/system/pbx-data-engine.service.d/override.conf[Service]ExecStart=ExecStart=/usr/sbin/pbx_data_engine.py --daemon  -tl "en,it"

Where “en,it” after the -tl parameter are the languages, which you can substitute with the preferred ones.

Reload systemd and restart the service to apply the changes
```
systemctl daemon-reloadsystemctl restart pbx-data-engine
```

Note:

The following languages are supported: English (en), US English (en-us), Italian (it), French (fr), German (de), Swiss German (de-ch), Spanish (es), US Spanish (es-us), Portuguese (pt), Dutch (nl), Arabic (ar), Catalan (ca), Danish (da), Swedish (sv).
It is recommended to use maximum three languages for the best recognition results.
In case only one language is indicated, the setting is ignored.
In case the language of the user indicated in WMS -> Users is not included in the language list inside the -tl parameter, language detection is not applied.
Only one dialect per language is allowed (e.g., “en”, cannot be set together with “en-us”). In case of setting different dialects of the same language, the dynamic language detection is not applied.
The support starts from WMS 7.01.20250407.1.

Limitations:

Short phrases (e.g. which last less than 3 seconds) may not be recognized and transcribed using the user language in WMS.
In case of a long phrase, if the user switches to another language in the middle of the phrase, the phrase is transcribed in the first language, that was recognized at the beginning of the phrase.

Control x-hoppers headsets charging behaviour

By default, there is only LED indication while charging x-hoppers headsets. You have the option to set headsets to have both LED indication and audio while charging and configure them to be disconnected without possibility to receive calls while charging.

Access the following file via SSH as root
```
nano-tiny /rw2/etc/provision.conf
```
Add the following parameter to the section [wildixair]
```
WairSilentcharging =on|off|deactivated
```

Where on implies that only LED indication is used while charging; off suggests normal mode with LED indication and audio while charging; deactivated means headset is disconnected and can’t receive calls while charging.

Create multiple broadcasts

To set up multiple x-hoppers broadcasts, you need to create separate Dialplans:

Navigate to x-hoppers admin -> Dialplan menu, Dialplan rules tab and make sure each x-hoppers Dialplan contains both *Wairhotline* and *wair* called numbers described in x-hoppers Admin Guide

Manage unmuted announcement

You can manage the logic of notifying a user that a headset is unmuted. By default, it is enabled and user is automatically notified that a headset is unmuted after 30 seconds timeout. You can modify the timeout. Example: the timeout is 60 seconds; user hears a beep in case he has been talking for 60 seconds and the headset was unmuted. There are no alerts in case the headset is unmuted, but no talking is detected.

Add the following line to the /rw2/etc/env.custom.ini file:
```
Environment='XHOP_UNMUTE_ANNOUNCE_TIMEOUT=X'
```

Where X is a value in seconds.

By default, the user is notified with a beep. To set up a custom alert, use the following parameter:
```
Environment='XHOP_UNMUTE_ANNOUNCE_SOUND=00000/u_unmuted'
```

Where u_unmuted is the name of the file placed in the 00000 folder on the PBX.

Reload systemd and restart the service to apply the changes:
```
systemctl daemon-reloadsystemctl restart pbx-data-engine
```

Adjust headset audio levels

You can use the following dialplan variables for adjusting headset audio levels:

BROADCAST_LISTENING_VOLUME: controls the audio playback (listening) volume
BROADCAST_TALKING_VOLUME: controls the microphone (speaking) volume

You can use these variables directly in the Dialplan or set globally via WMS -> Dialplan -> General settings -> Set dialplan variables:

Note:

The default value is 0.
The minimum value is -10, maximum value is 10.

Increase volume for noisy environments

In case of noisy environment, you can increase x-hoppers volume.

Access the following file via SSH as root
```
nano-tiny /etc/callweaver/confbridge.conf
```
Add the following parameter to the section [default_bridge]
```
default_listening_volume=6 
```

Where 6 is the preferred volume. The maximum value is 10. The default value is 0.

Join a broadcast from other devices

Wildix desk phones can also join a broadcast, as long as they are connected to the same PBX.

Configure Dialplan by adding a called number and Broadcast Dialplan application with a selected broadcast. When users dial a certain number, e.g. 333, the call is automatically put into that broadcast

Documentation:

Modify the timeout of broadcast mute

Users have possibility to mute the broadcast by double-pressing the Push-to-talk button. By default, the broadcast gets muted for 60 seconds. If user wants to unmute the broadcast before the 60-second timeout, user can double-press the Push-to-talk button again. The default timeout can be customized.

Add the following line to the file /etc/systemd/system/pbx-data-engine.service.d/override.conf

nano-tiny /etc/systemd/system/pbx-data-engine.service.d/override.conf[Service]Environment='XHOP_UNHOLD_TIMEOUT=120'

Where 120 is the custom timeout. If you want to disable the timeout, set the value to 0:

Environment='XHOP_UNHOLD_TIMEOUT=0'

Reload systemd and restart the service to apply the changes
```
systemctl daemon-reloadsystemctl restart pbx-data-engine
```

Modify the timeout for resuming a call on hold

Starting from WMS 7.05.20251124.1, it is possible to configure a timeout for calls placed on hold. After the configured timeout expires, the call is automatically resumed. By default, the option is disabled and a call remains on hold until resumed by an agent. To enable the timeout:

Add the following variables to the /rw2/etc/env.custom.ini file:

XHOP_CALL_SWAP_TIMEOUT_SEC=40XHOP_CALL_SWAP_MESSAGE="The call was on hold too long and will be resumed now"

Where “40” in the first variable is the preferred timeout (in seconds). In the second variable, you can define the message played to the user when the call is automatically resumed.

Note: The minimum allowed timeout is 30 seconds.

Pick up a call put on hold by x-hoppers broadcast user

It is possible to pick up a call which was put on hold by any x-hoppers broadcast user. To configure the option, follow the steps described below:

Navigate to x-hoppers admin -> Dialplan menu, Dialplan rules tab and modify the users Dialplan
Add a called number with Custom application and the following variable:
```
Macro(xhop_pickup_held_call,74shfw802ns,3) 
```

Where:

xhop_pickup_held_call - name of the macros, should not be changed
74shfw802ns - broadcast ID. To get broadcast ID, open the necessary broadcast in WMS and copy its ID from the URL (the last part of the URL)
3 - the maximum number of calls on hold that are announced to the user in the first batch (in case there are more calls on hold, the user can say “Next” to get the list of other calls)

To pick up a call, broadcast users can dial a Voice bot by double-pressing the AUX Function button from their headset and say “Pickup” (the Voice bot should be configured to transfer the calls to the Dialplan where the macros is configured). Other users, e.g. having a WP phone or using a web app, can simply dial the number where the macro is configured.

Set custom prompt played when answering a call

Starting from WMS 7.04.20250902.1, you can add a custom prompt which is played to a user who answers a call coming through Smart Notifications feature. To set custom prompt, add the following variable to x-hoppers admin -> Dialplan -> General Settings -> Set dialplan variables field:

SN_CALL_PICKUP_SOUND=unmute to start talking

Where “unmute to start talking” is the text of the custom notification played to a user.