Custom config parameters List

To make any changes to config files, access them via SSH as root:

nano-tiny /etc/<sub-directory>/<config file name>

Call Groups

Check registration status of Call group members during call distribution

The feature is enabled by default and it prevents unavailable Call group members (means no registered devices or no push for mobile apps) from receiving calls from a queue. The logic is applied only for Call group calls!

To disable it:

• Edit the file /etc/callweaver/sip-general-custom.conf by adding the parameter: 

  send_regevent_devstate = no

  Available values: no – the feature is disabled; yes – the feature is enabled.

• Reload SIP by running the command: 

  callweaver -rx 'sip reload'

Allow overriding of Global Call groups settings 

The option allows overriding of Global Call groups settings (see the chapter below) and saving custom parameters after each system upgrade.

To override Global Call group settings, you need to edit queues-general-custom.conf which is included in file queues.conf.

• Add a custom parameter, for example: autofill = yes (by default, the file queues.conf contains autofill = no parameter) 

• Run the following command:
  

  callweaver -x "reload"

  
  

Global Call groups settings

Global Call group settings are defined and configured in [general] section of the configuration file queues.conf (the path to the file: /rw2/etc/callweaver/queues.conf).

[general] section

The section contains global settings that are applied to all Call groups.

• persistentmembers = yes 

With persistentmembers enabled, all dynamically added Call group members (via Feature code "Call group management" 97, WebAPI "Call group login" and Contact center feature in Collaboration) are stored in their Call groups and therefore saved after the system restart. 

• autofill = no 

With autofill disabled, a Call group attempts to deliver calls to members in a serial manner. This means only one call is attempted to be distributed to members at a time. Additional callers are not distributed to members until that caller is connected to a member. With autofill enabled, callers are distributed to available agents simultaneously. The parameter allows you to more efficiently distribute calls between Call group members, especially if there are several callers in a queue and several members can accept a call. 

Collaboration 

Disable file transfer in Collaboration chat messages 

This feature blocks the possibility of transferring files in Collaboration chat messages for all PBX users. 

To disable file transfer, edit the file /rw2/etc/env.custom.ini by adding the following line: 

COLLABORATION_FILE_TRANSFER_ALLOW=false

Disable Chat and Post-It functionality in Collaboration 

This feature disables access to Chat and Post-It functionality throughout Collaboration. It removes the Chat tab and disables Chat and Post-It options in Colleagues, Fn keys, History tabs, as well as in Search and via Add button. With disabled chats, users also don't receive Kite chat requests.

To disable Chat and Post-It, edit the config file /rw2/etc/env.custom.ini by adding the following line: 

COLLABORATION_CHAT_ALLOW=false

Change the default Departments tree separator

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.

To change the default separator to another character ("\" or "|"), edit the following parameter in the /rw2/etc/env.custom.ini:

DEPARTMENTS_TREE_SEPARATOR=\

Documentation: How to configure Departments tree.

Display all PBX users on the Colleagues tab 

By default, only people added to roster are 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:

COLLABORATION_SHOW_ALL_COLLEAGUES=true

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:

COLLABORATION_NOISE_SUPPRESSION=true

Enable Relay candidates only for all PBX users 

COLLABORATION_WEBRTC_RELAYCANDIDATESONLY=true

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.  

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

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). 

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

To disable the sync:

• Add the following parameters to the config file /rw2/etc/pbx/device_sync.conf 

  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

To enable g729 transcoding:

• Edit the file /etc/callweaver/sip-general-custom.conf by adding the parameter: 

  g729_transcoding=yes

  Available values: no – the feature is disabled; yes – the feature is enabled.
  
  

• Run the command:
  

  callweaver -rx "sip reload"

Modify HD codecs on PBX 

The feature is enabled by default. To disable it:

• Edit the file /etc/callweaver/sip-general-custom.conf by adding the following parameters: 

  disallow=all
  allow=alaw:20,ulaw:20,g729:20,vp8,h264,h263,h263p

• Run the command: 

  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:
  

  forcewideband=yes
  disableautowideband=yes

• To Enable wideband codec usage in LAN:

  forcewideband=no
  disableautowideband=no

• To set Networks where force usage of wideband codecs (i.e. for network 10.100.6.0/16):

  forcewideband=no
  disableautowideband=yes
  wideband=10.100.6.0/16

Modify presence status monitoring via BLF keys

The feature is enabled by default. To disable it:

• Edit the file /etc/callweaver/sip-general-custom.conf by adding the following parameter: 

  full_presence=no

  Available values: no – the feature is disabled; yes – the feature is enabled.

• Run the command: 

  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: 

• Edit the file /etc/callweaver/sip-general-custom.conf by adding the following parameter:

  send_cg_member_ring_notify=yes

   Available values: no - the feature is disabled; yes - the feature is enabled.
  
  

• Run the command:
  

  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).

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: 

  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: 

  /etc/init.d/kamailio restart

• Edit the file /etc/callweaver/sip-general-custom.conf by adding the parameter:

  skip_cg_members_presence_on_wp=yes

   Available values: no - the feature is disabled; yes - the feature is enabled.

• Restart callweaver service: 

  callweaver -rx "sip reload"

If the feature is enabled, the default devices mask is:


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 by adding the parameter: 

  skip_cg_members_early_state_presence=yes

  Available values: no - the feature is disabled; yes - the feature is enabled. When the parameter is enabled, sending PUBLISH messages is skipped.

2. Reload PBX engine:

callweaver -rx "sip reload"

Modify direct SDES-SRTP  

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: 

  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:

  /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

• Send the new configuration to devices via Configure / Sync device option in WMS -> Devices

Select a specific GSM gateway 

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:

  101,9c7533014b00
  102,9c7533014b00
  103,9c7533014b00
  104,9c7533014b01

Modify geolocation sharing on PBX

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: 

  allow_location: false

  Available values: true - location is allowed, false - location is blocked.

• Restart the server: 

  /etc/init.d/ejabberd restart

Configure FXS to recognize pulse dialing

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:

 UseFlashHookTime={"9C750430060a": {"min": 150,"max": 400},"9C71153200DC": {"min": 300,"max": 500}}

You can set as many devices as you need. 

Security

Enable SSL connection to remote MySQL server

It is possible to configure SSL connection for sending CDR data to external MySQL server. 

1. Upload the following three files to the PBX:
   

   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
     
     

2. Place the files into the directory /etc/callweaver/certs (the directory should be created beforehand) or any other directory on the PBX.

3. Make changes in the file /etc/callweaver/cdr_mysql.conf by adding/ editing the following rows: 
   

   ssl_cert = /etc/callweaver/certs/client-cert.pem
   ssl_key = /etc/callweaver/certs/client-key.pem
   ssl_ca = /etc/callweaver/certs/ca.pem

4. Run the following command:
   

   callweaver -x'reload cdr_mysql.so'

   
   

5. In the file /rw2/etc/ejabberd/ejabberd_mod_mam.yml, edit the following line:
   

   sql_ssl: true

Enable location-based MFA 

It is possible to enable the location-based multi-factor authentication that requests user to confirm IP address via email when logging in to Collaboration or using basic authorization from a new IP address.

The feature is disabled by default. To activate it, set the following parameter in /rw2/etc/env.custom.ini file:

MFA_SERVICE_ENABLE=true 

Dialplan

Exit code 0 from voicemail 

Support for exit code 0 from voicemail allowing caller to speak with an operator was added.

How to use:

• Add the letter ‘o’ as called number to the Dialplan context (that is where the “0” key sends the caller)

How to enable:

• Add the parameter operator=yes to the file voicemail.conf. It allows sender to hit 0 before/ after/ during leaving a voicemail to reach an operator

Use online streaming of mp3 http/ https sources as music on hold 

The feature is disabled by default. When enabled, it allows setting online streaming of mp3 http/ https sources as music on hold.

To enable:

• Add the following parameters to the file /rw2/etc/callweaver/musiconhold-stream.conf:

  [radio]
  mode=custom
  application=/usr/sbin/cw_play_http_stream.sh http://stream.104.6rtl.com/rtl-live/mp3-192

  where http://stream.104.6rtl.com/rtl-live/mp3-192 is your stream source.

• Run the command: 

  callweaver -rx "moh reload"

• Add Dialplan application Set -> Music on hold -> radio

x-caracal

Change time range limit for reports

Starting from WMS 5.04, depending on the PBX load, some limits of allowed days range apply when generating x-caracal reports. Learn more in x-caracal documentation.

To set custom limit (for example 50 days), add the following parameter to /var/www/x-caracal/.env file:

MAX_ALLOWED_DAY_RANGE=50

Modify Inactivity Timer

By default, after 10 minutes of inactivity, x-caracal page needs to be refreshed. Starting from WMS 6.03, it is possible to modify its inactivity timeout.

To modify the timeout, add the following parameter to