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 feature04.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 |
---|
DEPARTMENTS_TREE_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 file /rw2/etc/env.custom.ini file:
Code Block |
---|
CALLCOLLABORATION_CONTROLSHOW_FEATUREALL_COLLEAGUES=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.
...
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 |
---|
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 |
---|
DEPARTMENTSCOLLABORATION_MOBILE_TREEDIRECT_SEPARATORCALL=\xxx,yyy |
Documentation: How to configure Departments tree.
...
Note |
---|
The support starts from WMS 5.04.20220309.1 |
...
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_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 |
---|
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:
...
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! |
To disable the sync:
Add the following parameters to the config file /rw2/etc/pbx/device_sync.conf
Code Block disable_sync_portal=1 disable_sync_manual=1
Available values: 1 – sync is disabled; 0 – sync is enabled.
Modify g729 transcoding for web phone calls to trunks which do not support g711
Warning |
---|
Important:
|
Note |
---|
Note: Feature is supported only on PBXs with modern CPU or Cloud. |
To enable g729 transcoding:
Edit the file /etc/callweaver/sip-general-custom.conf by adding the parameter:
...
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 |
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
Warning |
---|
Important: By default, the sync is enabled. It is necessary to disable it in case of FAILOVER scenario on Failover PBXs! |
To disable the sync:
Add the following parameters to the config file /rw2/etc/pbx/device_sync.conf
Code Block disable_sync_portal=1 disable_sync_manual=1
Available values: 1 – sync is disabled; 0 – sync is enabled.
Modify g729 transcoding for web phone calls to trunks which do not support g711
Warning |
---|
Important:
|
Note |
---|
Note: Feature is supported only on PBXs with modern CPU or Cloud. |
To enable g729 transcoding:
Edit the file /etc/callweaver/sip-general-custom.conf by adding the parameter:
Code Block g729_transcoding=yes
Available values: no – the feature is disabled; yes – the feature is enabled.
Run the command:
Code Block callweaver -rx "sip reload"
Modify HD codecs on PBX
Note |
---|
Supported devices:
The feature also works for PBXs in WMS Network. |
The feature is enabled by default. To disable it:
Edit the file /etc/callweaver/sip-general-custom.conf by adding the following parameters:
Code Block disallow=all allow=alaw:20,ulaw:20,g729:20,vp8,h264,h263,h263p
Run the command:
Code Block callweaver -rx "sip reload"
Manage wideband codecs usage
Starting from WMS 5.04.20220309.1, there is custom provisioning parameter WideNarrowbandUse, which allows to manage wideband codecs usage. By default, the parameter is disabled and wideband codecs are forced for all devices. When the parameter is enabled (WideNarrowbandUse=yes), the previous behaviour remains: all devices use wideband codec priority or narrowband codec priority and remote codecs priority or local codecs.
In case of WideNarrowbandUse=yes, you need to add relevant lines to /etc/callweaver/sip-wideband.conf to set the parameters
To Enable wideband codec usage for all networks:
Code Block forcewideband=yes disableautowideband=yes
To Enable wideband codec usage in LAN:
Code Block forcewideband=no disableautowideband=no
To set Networks where force usage of wideband codecs (i.e. for network 10.100.6.0/16):
Code Block forcewideband=no disableautowideband=yes wideband=10.100.6.0/16
Modify presence status monitoring via BLF keys
Note |
---|
Detailed information about the feature: Presence status monitoring. |
The feature is enabled by default. To disable it:
Edit the file /etc/callweaver/sip-general-custom.conf by adding the following parameter:
Code Block full_presence=no
Available values: no – the feature is disabled; yes – the feature is enabled.
Run the command:
Code Block callweaver -rx "sip reload"
Modify
...
Note |
---|
Supported devices:
The feature also works for PBXs in WMS Network. |
...
the behaviour of Colleague BLF keys if a colleague is a Call group member
The feature is disabled by default . There are two options for its configuration:
1. Disable updates for "ringing" status for "Call All 10" strategy. To enable such behavior:
Edit the file /etc/callweaver/sip-general-custom.confconf by adding the following parametersparameter:
Code Block disallow=all allow=alaw:20,ulaw:20,g729:20,vp8,h264,h263,h263psend_cg_member_ring_notify=yes
Available values:no - the feature is disabled; yes - the feature is enabled.
Run the command:
Code Block callweaver -rx "sip reload"
Manage wideband codecs usage
Starting from WMS 5.04.20220309.1, there is custom provisioning parameter WideNarrowbandUse, which allows to manage wideband codecs usage. By default, the parameter is disabled and wideband codecs are forced for all devices. When the parameter is enabled (WideNarrowbandUse=yes), the previous behaviour remains: all devices use wideband codec priority or narrowband codec priority and remote codecs priority or local codecs.
In case of WideNarrowbandUse=yes, you need to add relevant lines to /etc/callweaver/sip-wideband.conf to set the parameters
To Enable wideband codec usage for all networks:
Code Block |
---|
forcewideband=yes
disableautowideband=yes |
To Enable wideband codec usage in LAN:
Code Block |
---|
forcewideband=no
disableautowideband=no |
To set Networks where force usage of wideband codecs (i.e. for network 10.100.6.0/16):
Code Block |
---|
forcewideband=no
disableautowideband=yes
wideband=10.100.6.0/16 |
Modify presence status monitoring via BLF keys
Note |
---|
Detailed information about the feature: Presence status monitoring. |
...
Edit the file /etc/callweaver/sip-general-custom.conf by adding the following parameter:
Code Block full_presence=no
Available values: no – the feature is disabled; yes – the feature is enabled.
- Run the command
Once it is enabled, Colleague BLF keys do not switch to an active state for incoming calls to Call Group before call answer (only Call group BLF turns on).
2. (available in WMS 5.02) Disable updates for all early statuses including "ringing", "check who is calling", "cancelled" etc for "Call All 10/32" strategies (check the separate Article regarding the feature). To enable the behaviour:
Edit the file /etc/kamailio/cfg.d/host_specific_custom.cfg by adding the parameter:
Code Block modparam("pv", "varset", "skip_cg_members_presence_on_wp=i:1")
Available values: 0 - the feature is disabled; 1- the feature is enabled.
Restart kamailio service:
Code Block /etc/init.d/kamailio restart
Edit the file /etc/callweaver/sip-general-custom.conf by adding the parameter:
Code Block skip_cg_members_presence_on_wp=yes
Available values:no - the feature is disabled; yes - the feature is enabled.
Restart callweaver service:
Code Block callweaver -rx "sip reload"
Modify the behaviour of Colleague BLF keys if a colleague is a Call group member
The feature is disabled by default . There are two options for its configuration:
1. Disable updates for "ringing" status for "Call All 10" strategy. To enable such behavior:
...
...
If the feature is enabled, the default devices mask is:
Code Block |
---|
modparam("pv", "varset", "device_presence_skip_event_dialog=s:(Wildix WP490GR[3|4])") |
It can be changed in the config file /etc/kamailio/cfg.d/host_specific_custom.cfg.
3. Avoid an issue in which WP phones of Call group members continue to ring after the call was answered
Such an issue may occur in case of large amount of call group members with "Colleague" BLF buttons configured.
Edit the file /etc/callweaver/sip-general-custom.conf conf by adding the following parameter:
Code Block sendskip_cg_members_memberearly_ringstate_notifypresence=yes
Available Available values:no - the feature is disabled; yes - the feature is enabled.
Run the command:
When the parameter is enabled, sending PUBLISH messages is skipped.
2. Reload PBX engine:
Code Block |
---|
callweaver -rx "sip reload" |
...
Once it is enabled, Colleague BLF keys do not switch to an active state for incoming calls to Call Group before call answer (only Call group BLF turns on).
...
Modify direct SDES-SRTP
Anchor | ||||
---|---|---|---|---|
|
Note |
---|
Supported devices:
|
The feature is enabled by default. To disable it:
Edit the file /etc/kamailio/cfg.d/host_specific_custom.cfg by adding the parameterfollowing parameters:
Code Block modparam("pv", "varset", "skipdevice_cgcaps_members_presence_on_wp=i:1")
Available values: 0 - the feature is disabled; 1- the feature is enabled.
Restart kamailio service: sdes_srtp=s:(Wildix WP4[8|9]0GR[3|4])|(Wildix .*BRI)|(Wildix Wildix W0[1-2]PRI)|(Wildix W0[2|4]FXSR3)|(Wildix Wildix 3000)|(Wildix WP410R2)") modparam("pv", "varset", "sdes_srtp=i:0")
Available values: "sdes_srtp=i:0" - to disable and "sdes_srtp=i:1" - to enable.
Run the command:
Code Block /etc/init.d/kamailio restart
Edit the file /etc/callweaver/sip-general-custom.conf by adding the parameter:
Available values:no - the feature is disabled; yes - the feature is enabled.Code Block skip_cg_members_presence_on_wp=yes
Restart callweaver service:
Code Block |
---|
callweaver -rx "sip reload" |
If the feature is enabled, the default devices mask is:
Code Block |
---|
modparam("pv", "varset", "device_presence_skip_event_dialog=s:(Wildix WP490GR[3|4])") |
...
3. Avoid an issue in which WP phones of Call group members continue to ring after the call was answered
Such an issue may occur in case of large amount of call group members with "Colleague" BLF buttons configured.
Edit the file /etc/callweaver/sip-general-custom.conf by adding the parameter:
Code Block |
---|
skip_cg_members_early_state_presence=yes |
...
2. Reload PBX engine:
Code Block |
---|
callweaver -rx "sip reload" |
...
Note |
---|
Supported devices:
|
The feature is enabled by default. To disable it:
...
Edit the file /etc/kamailio/cfg.d/host_specific_custom.cfg by adding the following parameters:
Code Block |
---|
modparam("pv", "varset", "device_caps_sdes_srtp=s:(Wildix WP4[8|9]0GR[3|4])|(Wildix .*BRI)|(Wildix Wildix W0[1-2]PRI)|(Wildix W0[2|4]FXSR3)|(Wildix Wildix 3000)|(Wildix WP410R2)")
modparam("pv", "varset", "sdes_srtp=i:0") |
Available values: "sdes_srtp=i:0" - to disable and "sdes_srtp=i:1" - to enable.
Run the command:
Code Block |
---|
/etc/init.d/kamailio restart |
...
(only for BRI/ PRI mgw) Add a custom provisioning parameter SRTPForceUse to [wildixgw] section of the file /rw2/etc/provision.conf
...
Note |
---|
During ongoing calls, a lock on a phone's screen indicates that Direct SDES-SRTP is established. |
...
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 |
Modify geolocation sharing on PBX
Note |
---|
The support starts from WMS 5.02. |
Specifically this option can be used to block geolocation on Vision/ SuperVision phones since the ACL "Can/cannot - View geolocation via Collaboration - Group" can't be applied.
To block geolocation sharing:
Edit the file /rw2/etc/ejabberd/ejabberd_mod_wildix_presence.yml by changing the following parameter to false:
Code Block allow_location: false
Available values: true - location is allowed, false - location is blocked.
Restart the server:
Code Block |
---|
/etc/init.d/ejabberd restart |
...
Notes:
...
(only for BRI/ PRI mgw) Add a custom provisioning parameter SRTPForceUse to [wildixgw] section of the file /rw2/etc/provision.conf
- Send the new configuration to devices via Configure / Sync device option in WMS -> Devices
Note |
---|
During ongoing calls, a lock on a phone's screen indicates that Direct SDES-SRTP is established. |
Select a specific GSM gateway
Anchor | ||||
---|---|---|---|---|
|
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
Modify geolocation sharing on PBX
Note |
---|
The support starts from WMS 5.02. |
Specifically this option can be used to block geolocation on Vision/ SuperVision phones since the ACL "Can/cannot - View geolocation via Collaboration - Group" can't be applied.
To block geolocation sharing:
Edit the file /rw2/etc/ejabberd/ejabberd_mod_wildix_presence.yml by changing the following parameter to false:
Code Block allow_location: false
Available values: true - location is allowed, false - location is blocked.
Restart the server:
Code Block /etc/init.d/ejabberd restart
Note |
---|
Notes:
|
Configure FXS to recognize pulse dialing
Note |
---|
Note: The support starts from WMS 6.06.20240425.1. |
It is possible 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.
...
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
Code Block echo mode | socat - UNIX-CONNECT:/var/run/data_engine/data_engine.sock
...
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
...
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 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/envprovision.custom.iniconf file:
Code Block |
---|
ORIGINATE_VIA_ANY_DEVICE_TRANSFER=falseSupportObsoleteRepeater = 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 | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...