Scroll export button | ||||||||
---|---|---|---|---|---|---|---|---|
|
Info |
---|
The List of custom config parameters that allow changing various settings in config files. Created: August 2018 Updated: October 2023May 2024 Permalink: https://wildix.atlassian.net/wiki/x/Fh3OAQ |
Table of Contents |
---|
To make any changes to config files, access them via SSH as root:
...
Note |
---|
|
Collaboration
Disable file transfer in Collaboration chat messages
...
Note |
---|
Use case: This feature is useful for teams4Wildix integration, as long as Microsoft Teams offers its own chat. Disabling chat functionality in Collaboration helps users to avoid confusion between these two systems and use one chat instead of two. |
...
Change the default Departments tree separator Anchor
...
departmentsastree
departmentsastree |
...
Note:
...
departmentsastree
departmentsastree |
Starting from WMS 5.
...
By default, only 1 active Collaboration session is permitted. However, there is an option to allow the second Collaboration tab – in Call Control mode. This can be used, for example, for media devices when connecting via remote desktop. The option is particularly practical for teams4Wildix integration.
To activate this feature, add the following line to the file04.20220309.1, the Colleagues tab in Collaboration shows only the list of Departments and there is possibility to create a multilevel hierarchy of Departments and display them in a tree view.
When indicating the Department path in WMS -> Users -> Edit User -> Department field, the default separator "/" should be used. For example: Department: UK/ Marketing.
To change the default separator to another character ("\" or "|"), edit the following parameter in the /rw2/etc/env.custom.ini:
Code Block |
---|
CALLDEPARTMENTS_CONTROLTREE_FEATURE=true |
Once the feature is activated, an additional option appears on the Collaboration login window – Call Control only. Tick this checkbox off to log into Collaboration in Call Control mode.
Note |
---|
Use case: User can set "Call control only" mode to be automatically enabled by adding a parameter in the URI (useful when it is needed to share the link among all employees or bookmark the page) How-to: add ?sip=no to PBX domain name -> https://pbxname.wildixin.com/collaboration/?sip=no |
...
Starting from WMS 5.04.20220309.1, the Colleagues tab in Collaboration shows only the list of Departments and there is possibility to create a multilevel hierarchy of Departments and display them in a tree view.
When indicating the Department path in WMS -> Users -> Edit User -> Department field, the default separator "/" should be used. For example: Department: UK/ Marketing.
...
SEPARATOR=\ |
Documentation: How to configure Departments tree.
Display all PBX users on the Colleagues tab Anchor showallcolleagues showallcolleagues
showallcolleagues | |
showallcolleagues |
Note |
---|
The support starts from WMS 5.04.20220309.1 |
By default, only people added to rosterare shown on the Colleagues tab. To display all users registered on the PBX, add the following line to the /rw2/etc/env.custom.ini file:
Code Block |
---|
COLLABORATION_SHOW_ALL_COLLEAGUES=true |
Warning |
---|
Current limitation: The status of users that are not added to the roster is not displayed. |
Enable Noise suppression on the PBX level
Starting from WMS 6.04, Collaboration users can enable Noise suppression in Collaboration Settings -> Web Phone. To enable Noise suppression on the PBX level for all users, edit the following parameter in the /rw2/etc/env.custom.ini file:
Code Block |
---|
DEPARTMENTSCOLLABORATION_TREENOISE_SEPARATORSUPPRESSION=\true |
Documentation: How to configure Departments tree.
...
Note |
---|
The support starts from WMS 5.04.20220309.1 |
...
...
Note |
---|
Note: The settings are applied to all PBX users except for those, who enabled/ disabled Noise suppression in Collaboration settings. |
Collaboration Mobile App
Configure which numbers on mobile should be directed to native dialler
Starting from WMS v. 6.02.20230306.1, it is possible to configure that certain numbers dialled via mobile Collaboration app are automatically forwarded to native dialler (call via Mobile network) for all PBX users.
Note |
---|
Note: The support of the feature on mobile starts from Android Collaboration app v. 5.11; iOS Collaboration app v. 8.11. |
Add the following parameter to /rw2/etc/env.custom.ini file:
Code Block |
---|
COLLABORATION_SHOWMOBILE_ALLDIRECT_COLLEAGUESCALL=true |
Warning |
---|
Current limitation: The status of users that are not added to the roster is not displayed. |
Enable Noise suppression on the PBX level
...
xxx,yyy |
Where xxx, yyy are the extensions/ numbers, calls to which should be automatically forwarded to the native dialler. By default, the field is empty.
Configure Advanced settings in Collaboration app on mobile (Android)
Starting from Android app v. 5.13.05, it is possible to predefine on PBX the values for Advanced settings in Collaboration mobile app (Android).
Note |
---|
Note: The support starts from WMS Beta 6.04.20230724.1. |
For this, set the following parameters in the /rw2/etc/env.custom.ini file:
Code Block |
---|
COLLABORATION_NOISE_SUPPRESSION=true |
Note |
---|
Note: The settings are applied to all PBX users except for those, who enabled/ disabled Noise suppression in Collaboration settings. |
Collaboration Mobile App
Configure which numbers on mobile should be directed to native dialler
Starting from WMS v. 6.02.20230306.1, it is possible to configure that certain numbers dialled via mobile Collaboration app are automatically forwarded to native dialler (call via Mobile network) for all PBX users.
Note |
---|
Note: The support of the feature on mobile starts from Android Collaboration app v. 5.11; iOS Collaboration app v. 8.11. |
Add the following parameter to /rw2/etc/env.custom.ini file:
Code Block |
---|
COLLABORATION_MOBILE_DIRECT_CALL=xxx,yyy |
Where xxx, yyy are the extensions/ numbers, calls to which should be automatically forwarded to the native dialler. By default, the field is empty.
Configure Advanced settings in Collaboration app on mobile (Android)
Starting from Android app v. 5.13.05, it is possible to predefine on PBX the values for Advanced settings in Collaboration mobile app (Android).
Note |
---|
Note: The support starts from WMS Beta 6.04.20230724.1. |
For this, set the following parameters in the /rw2/etc/env.custom.ini file:
...
Setting on mobile | Parameter | Default value | Possible values | ||||
---|---|---|---|---|---|---|---|
Disable SIP mode | COLLABORATION_MOBILE_DISABLE_SIP_MODE | false | true | false | ||||
Enable WebRTC | COLLABORATION_MOBILE_ENABLE_WEBRTC | false | true | false | ||||
Firewall bypass (beta) | COLLABORATION_MOBILE_FIREWALL_BYPASS | off | auto | on | off | ||||
Outgoing calls via Wildix | COLLABORATION_MOBILE_OUTGOING_CALLS_VIA_WILDIX | false | true | false | ||||
Run in background | COLLABORATION_MOBILE_RUN_IN_BACKGROUND | false | true | false | ||||
User status when talking on mobile | COLLABORATION_MOBILE_USER_STATUS_WHEN_TALKING_ON_MOBILE | false | true | false | ||||
Native Calls Support | COLLABORATION_MOBILE_NATIVE_CALLS_SUPPORT | false | true | false | ||||
Enable WebRTCMic gain | COLLABORATION_MOBILE_ENABLEMIC_WEBRTCGAIN | false | true | false | Firewall bypass (beta)0 | -4..12 | ||
Activate DND mode | COLLABORATION_MOBILE_ | FIREWALL_BYPASSoff | auto | on | off | Outgoing calls via Wildix | COLLABORATION_MOBILE_OUTGOING_CALLS_VIA_WILDIXACTIVATE_DND_MODE | false | true | false |
Run in background | COLLABORATION_MOBILE_RUN_IN_BACKGROUND | false | true | false | ||||
User status when talking on mobile | COLLABORATION_MOBILE_USER_STATUS_WHEN_TALKING_ON_MOBILE | false | true | false | ||||
Native Calls Support | COLLABORATION_MOBILE_NATIVE_CALLS_SUPPORT | false | true | false | ||||
Mic gain | COLLABORATION_MOBILE_MIC_GAIN | 0 | -4..12 | ||||
Activate DND mode | COLLABORATION_MOBILE_ACTIVATE_DND_MODE | false | true | false |
More about advanced settings on mobile: Appendix 3: Advanced Settings
Devices
Modify devices sync
...
More about advanced settings on mobile: Appendix 3: Advanced Settings
Devices
Modify devices sync
Warning |
---|
Important: By default, the sync is enabled. It is necessary to disable it in case of FAILOVER scenario on Failover PBXs! |
...
The option allows setting a specific GSM gateway for SMS sending for each separate user:
Edit the config file /etc/wildix/smsd-route.conf by specifying user extension and MAC address of GSM gateway, for example:
Code Block 101,9c7533014b00 102,9c7533014b00 103,9c7533014b00 104,9c7533014b01
...
Note |
---|
Notes:
|
Security
...
Configure FXS to recognize pulse dialing
Note |
---|
Note: The support starts from WMS 6.06.20240425.1. |
It is possible to configure SSL connection for sending CDR data to external MySQL server.
Upload the following three files to the PBX:
...
to configure FXS to recognize pulse dialing to avoid an issue when phones using pulse dialing only could not make calls. For this, add the following parameter to the /rw2/etc/provision.conf file, indicating the MAC address of the necessary FXS device(s) and minimum and maximum flash hook time:
Code Block |
---|
UseFlashHookTime={"9C750430060a": {"min": 150,"max": 400},"9C71153200DC": {"min": 300,"max": 500}} |
You can set as many devices as you need.
Note |
---|
Note:
|
Security
Enable SSL connection to remote MySQL server
It is possible to configure SSL connection for sending CDR data to external MySQL server.
Upload the following three files to the PBX:
Note Note: The files should be generated by server CA file on MySQL server. For MySQL v. 5.7, you can refer to the following instruction.
- ca.pem
- client-key.pem
client-cert.pem
- Place the files into the directory /etc/callweaver/certs (the directory should be created beforehand) or any other directory on the PBX.
Make changes in the file /etc/callweaver/cdr_mysql.conf by adding/ editing the following rows:
Code Block ssl_cert = /etc/callweaver/certs/client-cert.pem ssl_key = /etc/callweaver/certs/client-key.pem ssl_ca = /etc/callweaver/certs/ca.pem
Run the following command:
Code Block callweaver -x'reload cdr_mysql.so'
In the file /rw2/etc/ejabberd/ejabberd_mod_mam.yml, edit the following line:
Code Block sql_ssl: true
...
Note |
---|
Note: Starting from WMS 6.04.20231020.2, it is possible to manage location-based MFA via WMS -> PBX -> Features. Documentation: WMS Settings Menu - Admin Guide |
Dialplan
Exit code 0 from voicemail
...
Note |
---|
Note: Starting from WMS 5.04.20220309.1, in case you have several streams, modify the parameter [radio] to [radio1], [radio2], etc. in the config file and choose the corresponding option ("radio1", "radio2") when setting music on hold in the Dialplan. |
...
Create a new config file template.conf including GTM ID in the file /rw2/etc/pbx/, for example, use the command:
Code Block echo 'gtm=GTM-12345678' > template.conf
where 123445678 is Google Tag Manager ID.
...
after the <HEAD> section:
Code Block <!-- Google Tag Manager --> <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-XXXX');</script> <!-- End Google Tag Manager -->
after the <BODY> section:
Code Block <!-- Google Tag Manager (noscript) --> <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-XXXX" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <!-- End Google Tag Manager (noscript) -->
Feelingstream
Wildix supports integration with the Feelingstream platform for voice recognition and call recordings in stereo format. Feelingstream allows to conduct STT analysis of stereo recordings received from Wildix PBX.
Requirements:
- Activated Feelingstream account
- Quality of call recordings set to WAV (you can do this in WMS -> Dialplan -> General Settings)
- For HW/ VM: mounted storage for recordings
To enable the integration, create the config file /etc/feelingstream.conf with the following parameters:
Code Block |
---|
host=wildix.feelingstream.com
apikey=fcd4206d-aaab-56cb-bdc8-a33dc4611a4b_ab30ac63-1234-1234-1234-123456789012
bucket=call
lang=en |
Where:
- host – received from Feelingstream side
- apikey – generated using Feelingstream web interface
- bucket – created manually using Feelingstream web interface or API
- lang – optional parameter for setting the language for recognition. If not indicated, the language is set automatically.
To enable stereo mode on the PBX side and improve the quality of recognition, go to WMS -> Dialplan -> General Settings -> Set dialplan variables and add the following Global Dialplan variable: STEREO_RECORDINGS=yes.
Note |
---|
Note: Stereo recordings can be activated and used separately on any PBX, without Feelingstream integration, consult the documentation Custom Global Dialplan Variables List. |
:none;visibility:hidden"></iframe></noscript> <!-- End Google Tag Manager (noscript) -->
Feelingstream
Wildix supports integration with the Feelingstream platform for voice recognition and call recordings in stereo format. Feelingstream allows to conduct STT analysis of stereo recordings received from Wildix PBX.
Requirements:
- Activated Feelingstream account
- Quality of call recordings set to WAV (you can do this in WMS -> Dialplan -> General Settings)
- For HW/ VM: mounted storage for recordings
To enable the integration, create the config file /etc/feelingstream.conf with the following parameters:
Code Block |
---|
host=wildix.feelingstream.com
apikey=fcd4206d-aaab-56cb-bdc8-a33dc4611a4b_ab30ac63-1234-1234-1234-123456789012
bucket=call
lang=en |
Where:
- host – received from Feelingstream side
- apikey – generated using Feelingstream web interface
- bucket – created manually using Feelingstream web interface or API
- lang – optional parameter for setting the language for recognition. If not indicated, the language is set automatically.
To enable stereo mode on the PBX side and improve the quality of recognition, go to WMS -> Dialplan -> General Settings -> Set dialplan variables and add the following Global Dialplan variable: STEREO_RECORDINGS=yes.
Note |
---|
Note: Stereo recordings can be activated and used separately on any PBX, without Feelingstream integration, consult the documentation Custom Global Dialplan Variables List. |
Enable sending presence events to support Microsoft Teams 2-way presence sync Anchor MS Teams presence sync MS Teams presence sync
MS Teams presence sync | |
MS Teams presence sync |
For the correct user presence sync, it is necessary to enable sending of presence events to Analytics on PBXs with UC licenses (for x-bees licenses, it is enabled by default). For this, follow the steps described below:
Create a directory /etc/systemd/system/pbx-data-engine.service.d
Code Block # mkdir /etc/systemd/system/pbx-data-engine.service.d
Create a file /etc/systemd/system/pbx-data-engine.service.d/override.conf and add the following lines
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
Reload systemd and restart the service to apply the changes
Code Block # systemctl daemon-reload # systemctl restart pbx-data-engine
Run the following command to check what events are sent to Analytics
Code Block echo mode | socat - UNIX-CONNECT:/var/run/data_engine/data_engine.sock
Fax Server
Adjust the resolution of outgoing faxes
...
Note |
---|
Note: The support starts from WMS 5.04.20220309.1. |
ECM is enabled by default. To disable it, add the following line in /etc/callweaver/res_fax_custom.conf:
...
Note |
---|
Note: The support starts from WMS 5.04.20220309.1. |
Maximum transmission speed
...
Add the below line to /etc/kamailio/cfg.d/host_specific_custom.cfg file:
Code Block modparam("pv", "varset", "allow_users_and_trunks_behind_same_nat=i:1")
Available values: 1 - enabled; 0 - disabled.
Run the command:
Code Block systemctl restart kamailio.service
Users
2 PBXs in WMS Network, each with its own Active Directory for users
Note |
---|
You need admin access to Active Directory server. |
...
- init: reinitializes the connection. This value is used by default.
- ping: restores the connection by sending a ping request
...
For the correct user presence sync, it is necessary to enable sending of presence events to Analytics on PBXs with UC licenses (for x-bees licenses, it is enabled by default). For this, follow the steps described below:
Create a directory /etc/systemd/system/pbx-data-engine.service.d
Code Block |
---|
# mkdir /etc/systemd/system/pbx-data-engine.service.d |
Create a file /etc/systemd/system/pbx-data-engine.service.d/override.conf and add the following lines
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 |
Reload systemd and restart the service to apply the changes
Code Block |
---|
# systemctl daemon-reload
# systemctl restart pbx-data-engine |
Run the following command to check what events are sent to Analytics
...
Avoid no media issue on some iOS versions
Note |
---|
Note: The support starts from WMS 6.05.20240119.1. |
On some iOS versions, there is an occasional issue of in which there can be no media after answering a call, in case the phone was locked and it is an API call by an external CRM or a call from Collaboration with Any selected as a device. If you encounter such an issue, to avoid it, you can add the following line to the /rw2/etc/env.custom.ini file:
Code Block |
---|
ORIGINATE_VIA_ANY_DEVICE_TRANSFER=false |
Prevent obsolete repeaters from upgrade
Starting from W-AIR firmware v.07.30.xx.xx and higher, old Wildix repeaters are no longer supported and need additional configuration to stay on previous firmwares to continue working. For old repeaters to work, you need to add the following parameter to the /rw2/etc/provision.conf file:
Code Block |
---|
SupportObsoleteRepeater = yes |
The default value is “no”. When the parameter is enabled, the base stations automatically switch to the previous firmware on which the obsolete repeaters are supported (v. 06.xx.xx.xx)
Note |
---|
Note: To differentiate between obsolete and supported repeaters, check out the document How to Identify Obsolete Wildix Repeaters |
Macrosuite divider macro | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...