Phones - XML Configuration 4.15.2+

config_server_url

The URL of the DPMA / Switchvox config server in the format:
sip:proxy@host:port;transport=xyz

or:

[protocol://][user:password@]server[:port][/path] 

For phones attached to DPMA or Switchvox, contains the URL path to the config server. Transport type is dependent upon model and firmware version. sip:proxy is a literal.

Specifies the URL string that the Sangoma phone's cURL application will call in order to retrieve the phone's configuration file.

No default. 

P310, P315, P320, P325, P330, P370

pbx_credentials

value as string
account_id per Switchvox
host as the Switchvox hostname
user as the Switchvox account username
pass as the Switchvox account API password 

For Switchvox-connected phones only, specifies the set of credentials used by an application when the use_pbx_credentials appconfig parameter is true. This should be omitted for phones connecting to something other than Switchvox.

No default.

P310, P315, P320, P325, P330, P370

login_password

Integer, e.g. 789

Sets the Admin Password for logging into Web UI or Admin Settings Section on Phone Menu.

Defaults to 789

P310, P315, P320, P325, P330, P370

send_mac_with_useragent

boolean

If 1, the phone will send its MAC address long with its Model and Firmware version in any cURL User-Agent requests that it makes.

Defaults to 0.

P310, P315, P320, P325, P330, P370

use_secure_labels

boolean

If 1, the phone will replace the config fetch URL with "Server" or "Fetching" onboot.

Defaults to 1

P310, P315, P320, P325, P330

time_zone

Timezone String, e.g. America/Chicago

Sets the time zone for the phone.

Defaults to America/Los_Angeles

P310, P315, P320, P325, P330, P370

ntp_server

Hostname or IP address, e.g. 0.digium.pool.ntp.org

Sets the NTP server to which the phone will synchronize itself.

Defaults to 0.digium.pool.ntp.org

P310, P315, P320, P325, P330, P370

ntp_resync

Seconds as integer, e.g. 86400

Sets the interval between NTP synchronization.

Defaults to 86400.

P310, P315, P320, P325, P330, P370

ntp_prefer_option42

boolean

If 1, the phone will prefer and use an IPv4 address, not host name, NTP server, first server only and not multiple servers, as provided by DHCP Option 42. If 0, the phone will ignore DHCP Option 42.

Defaults to 1.

P310, P315, P320, P325, P330, P370

accept_local_calls

any / host

Sets whether to accept calls from any source or only from hosts to which the phone is registered.

Defaults to any.

P310, P315, P320, P325, P330, P370

compact_sip_headers

boolean, Defaults to 0

If enabled, causes the phone to utilize the compact form of SIP headers, rather than the expanded form, as well as causing the phone not to enumerate the statically defined codec payload types

P310, P315, P320, P325, P330, P370

transport_udp_enabled

boolean

If 1, enables UDP SIP transport. If 0, disables UDP SIP transport.

Defaults to 1

P310, P315, P320, P325, P330, P370

transport_udp_port

Valid integer for ports (1-65535)

Sets the local UDP SIP port.

Defaults to 5060

P310, P315, P320, P325, P330, P370

transport_tcp_enabled

boolean

If 1, enables TCP SIP transport. If 0, disables TCP SIP transport.

Defaults to 1

P310, P315, P320, P325, P330, P370

transport_tcp_port

Valid integer for ports (1-65535 )

Sets the local TCP SIP port.

Defaults to 5060

P310, P315, P320, P325, P330, P370

transport_tls_allowed

boolean

If 1, enables TLS SIP transport. If 0, disables TLS SIP transport.

Defaults to 1

P310, P315, P320, P325, P330, P370

transport_tls_port

Valid integer for ports (1-65535)

Sets the local TLS SIP port.

Defaults to 5061

P310, P315, P320, P325, P330, P370

tls_allow_wildcard_certs

boolean, defaults to 1

When enabled, SIP TLS signaling will accept a wildcard certificate as valid, contrary to RFC 5922 section 7.2

P310, P315, P320, P325, P330, P370

udp_ka_interval

integer, in seconds

Sets the UDP keep alive interval, at which the phone will send CR-LF to the registered server.

Defaults to 0, never.

P310, P315, P320, P325, P330, P370

call_rejection_code_dnd

integer

Specifies the SIP code to be returned when this account returns DND state on an incoming call.
Defaults to 486
Can also be set globally as a setting

P310, P315, P320, P325, P330, P370 (4_14_0)

call_rejection_code_ignore

integer

Specifies the SIP code to be returned when the user Ignores an incoming call to this account.
Defaults to 603
Can also be set globally as a setting

P310, P315, P320, P325, P330, P370 (4_14_0)

logo_file

value as "factory" or "user"
path as location on disk of file
url as optional location to fetch a logo in PNG format
md5 as optional when url is used to determine if logo has changed to avoid re-fetching 

Sets the idle screen logo
value defaults to factory
path defaults to "/factory_asterisk.png" and should be "/user_image.png" for custom

300x170 pixels for P320 and P325
144x86 pixels for P330 
800x1280 pixels for P370 

P310, P315, P320, P325, P330 (4_9_0)
P370 (4_11_1) 

wallpaper_file

value as "factory" or "user"
path as location on disk of file
url as optional location to fetch a logo
md5 as optional when url is used to determine if wallpaper has changed to avoid re-fetching

Sets the wallpaper.
value defaults to factory.
path defaults to "/factory_wallpaper.png" and should be "/user_wallpaper.png" for custom

P310, P315, P320, P325, P330 (4_14_0)

display_mc_notification

boolean

If 1, enables display of missed calls. If 0, disables display of missed calls.

Defaults to 1

P310, P315, P320, P325, P330, P370

hide_completed_elsewhere

boolean

If 1, the phone to not register a call, missed or otherwise, when receiving RFC 3326 "Call completed elsewhere" SIP Reason. If 0, all calls that are canceled from the remote side before answer by the local phone will show as missed.

Defaults to 0.

P310, P315, P320, P325, P330, P370 (4_11_1)

idle_company_text

string

When set, the phone will display this string in its status bar while idle and no other status notification icons are active.

No default.

P310, P315, P320, P325, P330

brightness

integer (1-10)

Sets the LCD screen brightness

Defaults to 5

P310, P315, P320, P325, P330, P370

enable_check_sync

boolean

If 1, the phone will perform a reconfigure when sent a check-sync SIP NOTIFY Event from the server to which it is registered. This option is affected by the accept_calls_option. When the accept_any_calls option is set to "host," only check-sync Events from registered hosts will be acted upon. When the accept_any_calls option is set to "any," any check-sync Event from any host will be acted upon. If 0, the phone will ignore check-sync events.

Defaults to 1.

P310, P315, P320, P325, P330, P370

dim_backlight

boolean

If 1, the screen will dim after the backlight timeout has been reached and phone is otherwise idle. If 0, the phone will not dim the screen.

Defaults to 1

P310, P315, P320, P325, P330, P370

backlight_timeout

integer (0-3200)

Time, in seconds, before backlight is set to backlight_dim_level while phone is idle; setting to 0 disables backlight timeout.

Defaults to 0

P310, P315, P320, P325, P330, P370

backlight_dim_level

integer (0-10)

Brightness level dims to when when dim_backlight is true.

Defaults to 2

P310, P315, P320, P325, P330, P370

blf_page_return_timeout

integer (0-60)

Time, in seconds, that elapses before a D65 will return to its first page of rapid dial favorites.

Defaults to 0 (never return).

P310, P315, P320, P325, P330 (4_7_0)

idle_return_timer

integer

Time, in seconds, at which phone, if idle, will return from a foregrounded app to the home screen.

Defaults to 120

P310, P315, P320, P325, P330 (4_9_0)

locale

de_DE, en_AU, en_CA, en_GB, en_NZ, en_US, es_ES, es_MX, fr_BE, fr_CA, fr_FR, it_IT, nl_BE, nl_NL, pt_BR, pt_PT, ru_RU

Specifies the locale used by the phone.

Defaults to en_US.

P310, P315, P320, P325, P330, P370

time_short_format

an ICU date/time pattern

Sets the time format used by the phone when displaying the small clock. This setting is normally controlled by the phone's configured locale.

Defaults to h:mm a

P310, P315, P320, P325, P330, P370

date_short_format

an ICU date/time pattern

Sets the date format used by the phone when displaying the short date. This setting is normally controlled by the phone's configured locale.

Defaults to M/d/yy

P310, P315, P320, P325, P330, P370

date_time_format

string

Sets the date and time format used by the phone. This setting is normally controlled by the phone's configured locale. {0} represents time, and {1} represents the date.

Defaults to {1}, {0}

P310, P315, P320, P325, P330, P370

date_long_format

an ICU date/time pattern

Sets the date format used by the phone on its idle screen. This setting is normally controlled by the phone's configured locale.
Defaults to EEE, MMM d 

P310, P315, P320, P325, P330, P370

ringer_volume

integer (0-10)

Sets the ringer volume.

Defaults to 5

P310, P315, P320, P325, P330, P370

speaker_volume

integer (1-10)

Sets the speaker volume.

Defaults to 5

P310, P315, P320, P325, P330, P370

handset_volume

integer (1-10)

Sets the handset volume.

Defaults to 5

P310, P315, P320, P325, P330, P370

headset_volume

integer (1-10)

Sets the headset_volume.

Defaults to 5

P310, P315, P320, P325, P330, P370

reset_call_volume

boolean

If 1, volume changes made during a call do not persist to the next call. If 0, volume changes made during a call persist for subsequent calls.

Defaults to 0

P310, P315, P320, P325, P330, P370

active_ringtone

Tone ID from <tones> provided to phone

Sets the current user-selected ringtone.

Defaults to Sangoma

P310, P315, P320, P325, P330, P370

headset_answer

boolean

If 1, the phone will use direct calls answered using the Answer soft key to the headset, rather than the handsfree speaker. If 0, the phone will direct calls answered using the Answer soft key to the handsfree speaker.

Defaults to 0

P310, P315, P320, P325, P330, P370

ring_headset_only

boolean

If 1, the phone will play ringing tones out the headset interface. If 0, the phone will play ringing tones out the handsfree speaker.

Defaults to 0

P310, P315, P320, P325, P330, P370

call_waiting_tone

boolean

If 1, the phone will play a call waiting tone when other calls are received. If 0, the phone phone will not playback a call waiting tone

Defaults to 1.

P310, P315, P320, P325, P330, P370

ehs

auto, jabra_iq, plantronics

Defines the Electronics Hookswitch type to support.

Defaults to auto.

P310, P315, P320, P325, P330, P370

parking_lot_extension

string

For Switchvox and DPMA environments, specifies the lot in which a call is transferred using the Park soft key. This option must be defined also, duplicating the account-level parking_lot_extension setting.

No default.

P310, P315, P320, P325, P330, P370

parking_lot_enable_blind_transfer

boolean

For Switchvox and DPMA environments, specifies the type of call parking transfer to perform. If 1, a blind transfer will be performed. If 0, an attended transfer will be performed. This option must be defined also, duplicating the account-level parking_lot_enable_blind_transfer setting.

Defaults to 0.

P310, P315, P320, P325, P330, P370

contacts_max_subscriptions

integer, e.g. 40

Sets the maximum number of SUBSCRIBEs the phone will perform for contacts.

Defaults to 40.

P310, P315, P320, P325, P330, P370

name_format

first_last, last_first

Formats the display of contact names.

Defaults to first_last

P310, P315, P320, P325, P330, P370

blf_contact_group

Any group_name from the loaded contacts

The group_name of the contact list group to which the phone will subscribe. If this setting is blank, the phone will not subscribe for any indicators and no device state LEDs will light nor presence update.

No default.

P310, P315, P320, P325, P330, P370

expansion_enable

boolean

If enabled, configures telephone to support expansion modules

P330, P370 (4_11_4)

sidecar_class_c_net

value as dotted IPv4 address, defaults to 172.20.0.0

Sets the Class C IPv4 network to be used when communicating with expansion modules, default to 172.20.0.0

P330, P370

network_enable_dhcp

boolean

If 1, enables DHCPv4/v6 network configuration. If 0, DHCP configuration is not used.

Defaults to 1

P310, P315, P320, P325, P330, P370

network_static_ip_address

IPv4 address

Defines the network address for the phone.

No default.

P310, P315, P320, P325, P330, P370

network_subnet_mask

IPv4 netmask

Defines the netmask for the phone.

No default.

P310, P315, P320, P325, P330, P370

network_default_gateway

IPv4 address

Defines the network gateway for the phone.

No default.

P310, P315, P320, P325, P330, P370

network_primary_dns_server

IPv4 address

Defines the primary DNS server for the phone.

No default.

P310, P315, P320, P325, P330, P370

network_secondary_dns_server

IPv4 address

Defines the secondary DNS server for the phone.

No default.

P310, P315, P320, P325, P330, P370

network_disable_arping 

boolean

If 1, causes the phone to not ARP for an in-use address as-provided by a DHCP server, before using it. If 0, the phone will ARP for other devices responding to the same IP address before accepting the address from the DHCP server.

Defaults to 0.

P310, P315, P320, P325, P330, P370

allow_insecure_ssl

boolean

By default, phones will not, using SSL, connect to self-signed servers. Instead, they will only connect to publicly-signed server. To allow the phone to connect to a self-signed server, set this option to 1.

Defaults to false.

P310, P315, P320, P325, P330, P370

enable_tcp_sack

boolean, Defaults to 0

If enabled, causes phone to enable TCP SACK processing. Defaults too disabled.

P310, P315, P320, P325, P330, P370

network_vlan_discovery_mode

NONE, MANUAL, LLDP

Sets use of none, manual, or LLDP discovered VLAN and, if MANUAL, defines the network.

Defaults to LLDP

P310, P315, P320, P325, P330, P370

network_vlan_id

integer (0-4095)

Sets the VLAN ID. VLAN ID 3182 is reserved ifexpansion_enable is enabled for D65 model phones.

No default.

P310, P315, P320, P325, P330, P370

pc_vlan_id

integer (0-4095)

Sets the VLAN ID of the PC port; untagged traffic from the PC port to the LAN port will be tagged with this VLAN ID.

No default.

P310, P315, P320, P325, P330, P370

log_level

error, warning, debug, information

Sets the logging level.

Defaults to information

P310, P315, P320, P325, P330, P370

log_server

IPv4 address of syslog server

Specifies remote syslog server.

No default.

P310, P315, P320, P325, P330, P370

log_port

port as integer

Specifies port of remote syslog server.

No default.

P310, P315, P320, P325, P330, P370

enable_logging

boolean

If 1, the phone will send log events to a remove syslog server. If 0, the phone will not send log events to a remote syslog server.

Defaults to 0

P310, P315, P320, P325, P330, P370

web_ui_enabled

boolean

If 1, enables the phone's built-in web interface. If 0, disables the phone's built-in web interface.

Defaults to 1 (Enabled)

P310, P315, P320, P325, P330, P370

sip_qos

integer (0-7)

Sets the SIP signaling QOS level

Defaults to 3.

P310, P315, P320, P325, P330, P370

rtp_qos

integer (0-7)

Sets the RTP media QOS level.

Defaults to 6.

P310, P315, P320, P325, P330, P370

pc_qos

integer (0-7)

Sets the QOS level for traffic from the PC port to the LAN port.

No default.

P310, P315, P320, P325, P330, P370

sip_dscp

integer (0-63)

Specifies the DSCP field of the DiffServ byte for SIP Signaling QoS.

Defaults to 24

P310, P315, P320, P325, P330, P370

rtp_dscp

integer (0-63)

Specifies the DSCP field of the DiffServ byte for RTP Media QoS.

Defaults to 46

P310, P315, P320, P325, P330, P370

in_switchvox_environment

boolean, Defaults to 0

If 1, informs the phone that it should operate as though it is connected to Switchvox, as opposed to any other server type.

Defaults to 0

P310, P315, P320, P325, P330, P370

server_environment

empty string, DPMA, Switchvox.

Defines the server environment under which the phone should be operating. Phones not attached to DPMA or Switchvox need not define this. Phones attached to DPMA should define DPMA. Phones attached to Switchvox should define Switchvox.

Defaults to empty string

P310, P315, P320, P325, P330, P370

handshake_timeout

time in seconds

For phones connected to Switchvox and/or DPMA, specifies a default timeout at which the phone should reissue a handshake, regardless of any external commands to otherwise issue one.

Defaults to 86400

P310, P315, P320, P325, P330, P370

retransmit_until_response

boolean

If 1, causes the phone to continue sending requests to the proxy, should the proxy not respond. If 0, the phone will re-send the request only once. It is not recommended to enable this option.

Defaults to 0.

P310, P315, P320, P325, P330, P370

sip_notify_call_control

boolean

If 1, causes the phone to respond to in-dialog SIP NOTIFY talk and hold Events to answer, hold, and resume calls.

Defaults to 0.

P310, P315, P320, P325, P330, P370 (4_8_0)