Scroll export button | ||||||||
---|---|---|---|---|---|---|---|---|
|
Info |
---|
In this Admin Guide you can find the list of custom parameters which can help you to change provisioning settings of Wildix devices. Updated: August 2023 Permalink: https://wildix.atlassian.net/wiki/x/XB3OAQ |
When provisioning Wildix devices, you can set custom parameters to change different settings in the provisioning file.
...
Parameters | Values | Description | SIPServerPort|||
---|---|---|---|---|---|
AuthLockTimeout | = | 0-65535 set SIP Server Port of the device registered to the account | SIPServerPortRemote | >=0 | -65535set SIP Server Port of the device behind NAT registered to the account |
SIPTransport | =UDP|TCP|TLS | set SIP transport protocol of the device registered to the account | |||
SIPTransportRemote | =UDP|TCP|TLS | set SIP transport protocol of the registered account in the device, located behind NAT | |||
HTTPForceUse | =yes|no | disable/ enable force HTTP protocol instead HTTPS for all requests from the device, like provision, phonebook, features, etc. Supported only by WP and WP480R2. After the parameter is applied, a device should be re-provisioned. | |||
RawScan | =enable|disable | only for [general] section. Disable/ enable raw scanning method in case of automatic provision of devices (the parameter is useful for PBXs inside chroot environment) | |||
only for [general] section. The parameter allows setting the desired timeout for storing PIN for Voicemail menu on WP phone (example: AuthLockTimeout=300). By default, the value is 30 seconds. Once the timeout is reached, a user needs to re-enter the PIN code. Note: the parameter is available starting from WMS 5.03. | |||||
BaseMaxSIPReg | =4-30 | only for [wildixair] section. Prior to 5.04, the default value is 20 accounts per 1 base. Starting from 5.04, the distribution is as follows:
Edit it in case you need to change the number of SIP accounts before distributed load per base station (min. value = 4, max. value = 30). | |||
BLFNotifyType | =ActiveCall|ActiveAndIncomingCall | only for [wildixp2] section. The default value is "ActiveCall". Set "ActiveAndIncomingCall" value to make BLF keys blink when a monitored user has active call+incoming call. | |||
BLFTransType | =attended|blind | only for [wildixp] section. Set BLF transfer type. Supported only by WP480, WP490, WorkForce, WelcomeConsole and WP600. | |||
TrustLocalDeviceDelayAfterOffhook | =yes|no1-255 | only for [ generalwildixfxo3] section. Enable/ disable an automatic adding of local devices to the provisioning database (for 2 hours) (Note: for W-AIR you have create network manually via WMS interface) POWER_LEDThe parameter allows controlling the duration of the delay before answering an outbound call on W04FXO r3. Note: the parameter is available starting from WMS 5.04. | |||
DisableCodecG729 | =yes|no | only for [ wildixp2wildixair] section. This parameter allows disabling the missed call LED on WP4X0 2015 phones, WorkForce, WelcomeConsole (this setting is normally applied in Hotels). Enable/ disable WP 2015 Power LED ("noDisable g729 codecs ("yes" - disable, " yesno" - enable) ; you can also change the behavior of the power LED by using the parameter PowerLEDBlinkTime (described below) | PowerLEDBlinkTime | =0-14400 . The parameter is applied only to W-AIR Small Business Bases. Note: Starting from WMS 6.02.20230306.1, the parameter is no longer available and removed from the system. | |
DisableShowUsername | =yes|no | only for[wildixp2] section section. This parameter allows changing the behavior of missed call LED on WP4X0 2015 phones, WorkForce, WelcomeConsole. Set the time in seconds during which the LED of a missed event (call or voice mail) will blink. Value "0" means blink always, "1" - blink only once | |||
HIDE_DTMF | =yes|no | hide/ show DTMF dialpad on the phones' displays ("no" - show, "yes" - hide) | |||
g711onlyThe parameter is disabled by default (yes - enable, no - disable). Enable it in case you need to show only internal numbers (extensions) (old behavior). | |||||
EnableMWISubscribe | =yes|no | only for [wildixfxs2] section. Enable subscription for MWI (Message Waiting Indicator, shows voicemail LED notifications). The parameter is disabled by default. Supported only by W24FXS 2015. | |||
EnableReasonCause | =yes|no | only for [wildixair] section. Set only g711 codecs ("yes" wildixp2] section and WP480/ 490 r3 phones (2017), WorkForce, WelcomeConsole. The parameter is enabled by default (yes - enable, " no " - disable). The parameter is applied only to W-AIR Bases Note: Starting from WMS 6.02.20230306.1, the parameter is no longer available and removed from the system. | ResetHandset | =yes|noIt disables/ enables displaying detailed hangup reasons. | |
FailoverPbxIp | =<IP address> | only for [wildixair] section. The parameter is disabled by default wildixp2] section. Force the switch from Main PBX to Failover PBX (SIP Server 2). Use only IP address. | |||
g711only | =yes|no | only for [wildixair] section. Set only g711 codecs ("yes" - enable, "no" - disable). Enable it in case you need to delete a Handset IPEI from W-AIR SB and allow to reuse the slot. When it is done, you need to disable itDisableCodecG729The parameter is applied only to W-AIR Bases. Note: Starting from WMS 6.02.20230306.1, the parameter is no longer available and removed from the system. | |||
HIDE_DTMF | =yes|no | only for [wildixair] section. Disable g729 codecs ("yes" - disable, "no" - enable). The parameter is applied only to W-AIR Small Business Bases Note: Starting from WMS 6.02.20230306.1, the parameter is no longer available and removed from the system. | |||
LossPktRateMin | =0-100 | set the parameter to control Packet Loss. "1-99" - Network Problem Threshold, "100" - disable. Supported only by WP4x0, WelcomeConsole. After the parameter is applied, the device should be re-provisioned. | |||
LossPktRateMax | =0-100 | set the parameter to control Packet Loss. "1-99" - Critical Network Problem Threshold, "100" - disable. Supported only by WP4x0, WelcomeConsole. After the parameter is applied, the device should be re-provisioned. | |||
BLFNotifyType | =ActiveCall|ActiveAndIncomingCall | only for [wildixp2] section. The default value is "ActiveCall". Set "ActiveAndIncomingCall" value to make BLF keys blink when a monitored user has active call+incoming call | |||
FailoverPbxIp | =<IP address> | only for [wildixp2] section. Force the switch from Main PBX to Failover PBX (SIP Server 2). Use only IP address | |||
EnableMWISubscribe | =yes|no | enable subscription for MWI (Message Waiting Indicator, shows voicemail LED notifications). The parameter is disabled by default. Supported only by W24FXS 2015 | |||
DisableShowUsername | =yes|no | only for [wildixp2] section. The parameter is disabled by default (yes - enable, no - disable). Enable it in case you need to show only internal number (extension) (old behavior) | |||
BaseMaxSIPReg | =4-30 | only for [wildixair] section. Prior to 5.04, the default value is 20 accounts per 1 base. Starting from 5.04, the distribution is as follows:
| hide/ show DTMF dialpad on the phones' displays ("no" - show, "yes" - hide). | ||
HTTPForceUse | =yes|no | disable/ enable force HTTP protocol instead HTTPS for all requests from the device, like provision, phonebook, features, etc. After the parameter is applied, a device should be re-provisioned (the parameter is not applicable to GSM media gateways of old generation) | |||
LLDP | =yes|no | only for [wildixp2] section and only for WP480/ 490 r3, WorkForce, WelcomeConsole. The parameter is disabled by default (yes - enable, no - disable). It allows Wildix devices to advertise information to their directly connected peers when enabled through nano-tiny /rw2/etc/provision.conf. Note: the parameter is available starting from WMS 5.03. | |||
LLDPInterval | =10-3600 | only for [wildixp2] section and only for WP480/ 490 r3, WorkForce, WelcomeConsole. The default interval is 30. It allows setting LLDP interval. Note: the parameter is available starting from WMS 5.03. | |||
LossPktRateMax | =0-100 | set the parameter to control Packet Loss. "1-99" - Critical Network Problem Threshold, "100" - disable. Supported only by WP4x0, WelcomeConsole. After the parameter is applied, the device should be re-provisioned. | |||
LossPktRateMin | =0-100 | set the parameter to control Packet Loss. "1-99" - Network Problem Threshold, "100" - disable. Supported only by WP4x0, WelcomeConsole. After the parameter is applied, the device should be re-provisioned. | |||
MelodyBLF | =yes|no | only for [wildixp2] section. Supported by Start, WP480/ 490 r3, WorkForce, WelcomeConsole. The parameter is disabled by default ("yes" - enable, "no" - disable). It enables a ringtone to be played instead of a beep for WP BLFs if audio notification is enabled. | |||
OffHookDialOut | =yes|no | only for [wildixp2] section and WP480/ 490 r3 phones (2017), WorkForce, WelcomeConsole. The parameter is enabled by default ("yes" - enable, "no" - disable). It disables/ enables auto call generation on a handset pickup when pressing “History”, “Phonebook”, “Redial” keys. | |||
SidetoneHandsetPOWER_LED | =0-7yes|no | only for [wildixp2] section and WP480/ 490 r3 phones (2017). This parameter allows disabling the missed call LED on WP4X0 2015 phones, WorkForce, WelcomeConsole . The parameter is disabled by default. It enables handset sidetone feature (sidetone is the sound of your own voice that you hear from handset or headset when making a call) (disabled = 0, min. level = 1, max. level = 7) | SidetoneHeadset | =0-7(this setting is normally applied in Hotels). Enable/ disable WP 2015 Power LED ("no" - disable, "yes" - enable); you can also change the behavior of the power LED by using the parameter PowerLEDBlinkTime (described below). | |
PowerLEDBlinkTime | =0-14400 | w-air-sb-pin | =0000-9999 | only for [wildixp2] section and WP480/ 490 r3 phones (2017), WorkForce, WelcomeConsole. The parameter is disabled by default. It enables headset sidetone feature (disabled = 0, min. level = 1, max. level = 7) | |
EnableReasonCause | =yes|no | only for [wildixp2] section and WP480/ 490 r3 phones (2017), WorkForce, WelcomeConsole. The parameter is enabled by default (yes - enable, no - disable). It disables/ enables displaying detailed hangup reasons | |||
only for [wildixair. This parameter allows changing the behavior of missed call LED on WP4X0 2015 phones, WorkForce, WelcomeConsole. Set the time in seconds during which the LED of a missed event (call or voice mail) will blink. Value "0" means blink always, "1" - blink only once. | |||||
RawScan | =enable|disable | only for [general] section. Disable/ enable raw scanning method in case of automatic provision of devices (the parameter is useful for PBXs inside chroot environment). | |||
ResetHandset | =yes|no | only for [wildixair] section. The parameter is disabled by default ("yes" - enable, "no" - disable). Enable it in case you need to delete a Handset IPEI from W-AIR SB and allow to reuse the slot. When it is done, you need to disable it. | |||
RXgain | =-10-10 | only for [wildixfxs2] section. The parameter allows changing the default PIN code for W-AIR SB | MelodyBLF | =yes|no | add to [wildixp2] section. Supported by Start, WP480/ 490 r3 modifying the RX gain level on FXS r3 media gateways. The default value is -2 dB. Note: the support starts from WMS 6.01. |
SidetoneHandset | =0-7 | LLDPInterval | =10-3600 | only for [wildixp2] section and WP480/ 490 r3 phones (2017), WorkForce, WelcomeConsole. The The parameter is disabled by default (yes - enable, no - disable). It enables a ringtone to be played instead of a beep for WP BLFs if audio notification is enabled | |
SRTPForceUse | =yes|no | only for [wildixgw], [wildixfxo3] and [wildixfxs2] sections. The parameter is enabled by default for [wildixgw] starting from WMS version 5.01 and for [wildixfxo3] and [wildixfxs2] sections - starting from WMS version 5.03 (no - disable, yes - enable). It enables Direct SDES-SRTP support between BRI/ PRI media gateways (EOL) | |||
LLDP | =yes|no | only for [wildixp2] section and only for WP480/ 490 r3, WorkForce, WelcomeConsole. The parameter is disabled by default (yes - enable, no - disable). It allows Wildix devices to advertise information to their directly connected peers when enabled through nano-tiny /rw2/etc/provision.conf. (Note: the parameter is available starting from WMS 5.03) | |||
only for [wildixp2] section and only for WP480/ 490 r3, WorkForce, WelcomeConsole. The default interval is 30. It allows setting LLDP interval. (Note: . It enables handset sidetone feature (sidetone is the sound of your own voice that you hear from handset or headset when making a call) (disabled = 0, min. level = 1, max. level = 7). | |||||
SidetoneHeadset | =0-7 | only for [wildixp2] section and WP480/ 490 r3 phones (2017), WorkForce, WelcomeConsole. The parameter is disabled by default. It enables headset sidetone feature (disabled = 0, min. level = 1, max. level = 7). | |||
SIPServerPort | =0-65535 | set SIP Server Port of the device registered to the account. | |||
SIPServerPortRemote | =0-65535 | set SIP Server Port of the device behind NAT registered to the account. | |||
SIPTransport | =UDP|TCP|TLS | set SIP transport protocol of the device registered to the account. | |||
SIPTransportRemote | =UDP|TCP|TLS | set SIP transport protocol of the registered account in the device, located behind NAT. | |||
SpeakerDisable | =yes|no|<list of extensions> | only for [wildixp2] section. The parameter allows disabling speaker mode on WorkForce. By default, the speaker mode is on ("yes" - disable the speaker mode for all WorkForce devices, "no" - enable it,<list of extensions> (e.g. SpeakerDisable=380,240,220) - disable the speaker mode for the mentioned extensions only). Note: the parameter is available starting from WMS 5. 03) | |||
AuthLockTimeout | =>=0 | only for [general] section. The parameter allows setting the desired timeout for storing PIN for Voicemail menu on WP phone (example: AuthLockTimeout=300). By default, the value is 30 seconds. Once the timeout is reached, a user needs to re-enter the PIN code. Note: the parameter is available starting from WMS 5.03. | |||
DelayAfterOffhook | =1-255 | only for [wildixfxo3] section. The parameter lets to control the duration of the delay before answering an outbound call on W04FXO r3. Note: the parameter is available starting 04. | |||
SRTPForceUse | =yes|no | only for [wildixgw], [wildixfxo3] and [wildixfxs2] sections. The parameter is enabled by default for [wildixgw] starting from WMS version 5.01 and for [wildixfxo3] and [wildixfxs2] sections - starting from WMS version 5.03 ("no" - disable, "yes" - enable). It enables Direct SDES-SRTP support between BRI/ PRI media gateways (EOL). | |||
ToneDetectByPeer | =yes|no | only for [wildixfxs2] section. When enabled, the parameter fixes an issue of slow fax reception speed which sometimes occurs in US/ Canada on FXSR3 devices. By default, the parameter is disabled. Note: the support starts from WMS 5.04. | |||
SpeakerDisableTrustLocalDevice | =yes|no|<list of extensions> | only for [wildixp2general] section. The parameter allows disabling speaker mode on WorkForce. By default, the speaker mode is on (yes - disable the speaker mode for all WorkForce devices, no - enable it, <list of extensions> (e.g. SpeakerDisable=380,240,220) - disable the speaker mode for the mentioned extensions only). Note: the parameter is available starting from WMS 5.04. | |||
WideNarrowbandUse | =yes|no | only for [general] section. The parameter allows managing 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. Notes: In case of WideNarrowbandUse=yes, you need to add relevant lines to etc/callweaver/sip-wideband.conf to set the parameters (see more in Custom config parameters List - Manage wideband codecs usage) Note: the parameter is available starting from WMS 5.04. | |||
ToneDetectByPeer | =yes|no | only for [wildixfxs2] section. When enabled, the parameter fixes an issue of slow fax reception speed which sometimes occurs in US/ Canada on FXSR3 devices. By default, the parameter is disabled. Note: the support starts from WMS 5.04. | |||
RXgain | =-10-10 | only for [wildixfxs2] section. The parameter allows modifying the RX gain level on FXS r3 media gateways. The default value is -2 dB. Note: the support starts from WMS 6.01. | |||
TXgain | =-10-10 | only for [wildixfxs2] section. The parameter allows modifying the TX gain level on FXS r3 media gateways. The default value is 0 dB. Note: the support starts from WMS 6.01. | |||
WairSilentcharging | =on | off | deactivated | only for [wildixair] section. The parameter allows controlling silent charging setting for x-hoppers headsets. Value "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. Note: the support starts from WMS 6.01.20221122.1. | |||
WairMulticastSync | =yes | no | only for [wildixair] section on a HW/ VM PBX. When enabled and Primary Base IP parameter is not set in WMS -> Devices -> W-AIR Networks, Multicast data sync is used instead of Peer to Peer (the setting on a base station's web interface). Note: the support starts from WMS 6.04.20230815.1Enable/ disable an automatic adding of local devices to the provisioning database (for 2 hours) (Note: for W-AIR you have create network manually via WMS interface). | |||
TXgain | =-10-10 | only for [wildixfxs2] section. The parameter allows modifying the TX gain level on FXS r3 media gateways. The default value is 0 dB. Note: the support starts from WMS 6.01. | |||
WairMulticastSync | =yes|no | only for [wildixair] section on a HW/ VM PBX. When enabled and Primary Base IP parameter is not set in WMS -> Devices -> W-AIR Networks, Multicast data sync is used instead of Peer to Peer (the setting on a base station's web interface). Note: the support starts from WMS 6.04.20230815.1. | |||
w-air-sb-pin | =0000-9999 | only for [wildixair] section. The parameter allows changing the default PIN code for W-AIR SB. | |||
WairSilentcharging | =on|off|deactivated | only for [wildixair] section. The parameter allows controlling silent charging setting for x-hoppers headsets. Value "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. Note: the support starts from WMS 6.01.20221122.1. | |||
WideNarrowbandUse | =yes|no | only for [general] section. The parameter allows managing 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. Notes: In case of WideNarrowbandUse=yes, you need to add relevant lines to etc/callweaver/sip-wideband.conf to set the parameters (see more in Custom config parameters List - Manage wideband codecs usage) Note: the parameter is available starting from WMS 5.04. |
Macrosuite divider macro | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...