Skip to end of metadata
Go to start of metadata


XML Configuration

This section describes the formatting and options available when creating XML-based configuration files for provisioning Digium phones. Users choosing this method of configuration forgo use of the DPMA, and instead are provisioning phones for use with Asterisk versions that do not support the DPMA.

Icon

The configuration elements provided in this section are subject to change between Digium Phone firmware releases.

  A Complete XML Configuration Example
A Complete XML Configuration Example

Setting Elements

 XML Setting Elements
XML Setting Elements

Each <setting> element represents at least an id and value pair of attributes. Some <setting> tags may have additional attributes.

General (Login)

Option

Values

Description

Models
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 Digium phone's cURL application will call in order to retrieve the phone's configuration file.

No default. 

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
pbx_credentialsvalue 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.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

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

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

send_mac_with_useragentboolean

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.

D40, D45, D50, D60, D62, D65, D70 (2_2_2_3) (tick)

D80 (1_4_3) (tick)

use_secure_labelsboolean

If 1, the phone will replace the config fetch URL with "Server" on boot and will disguise user and password inputs on Bootconfig Server URL entry screen with * characters.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70 (2_2_0_6) (tick)

D80 (Not applicable)

General (Time)

Option

Values

Description

Models

time_zone

Timezone String, e.g. America/Chicago

Sets the time zone for the phone.

Defaults to America/Los_Angeles

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

time_source

"ntp"

Sets the time source for the phone. Currently, the only option is "ntp"

Defaults to ntp.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

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

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

ntp_resync

Seconds as integer, e.g. 86400

Sets the interval between NTP synchronization.

Defaults to 86400.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
ntp_prefer_option42boolean

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.

D40, D45, D50, D60, D62, D65, D70 (2_7_0) (tick)
D80 (error)

General (SIP)

Option

Values

Description

Models

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.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

transport_udp_enabled

boolean

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

Defaults to 1

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

transport_udp_port

Valid integer for ports (1-65535)

Sets the local UDP SIP port.

Defaults to 5060

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

transport_tcp_enabled

boolean

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

Defaults to 1

D40, D45, D50, D60, D62, D65, D70, D80 (1_9_0) (tick)

transport_tcp_port

Valid integer for ports (1-65535 )

Sets the local TCP SIP port.

Defaults to 5060

D40, D45, D50, D60, D62, D65, D70, D80 (1_9_0) (tick)

transport_tls_allowedboolean

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

Defaults to 1

D40, D45, D50, D70, D80 (error)

D60, D62, D65 (2_1_0_6) (tick)

transport_tls_portValid integer for ports (1-65535)

Sets the local TLS SIP port.

Defaults to 5061

D40, D45, D50, D70, D80 (error)

D60, D62, D65 (2_1_0_6) (tick)

udp_ka_intervalinteger, in seconds

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

Defaults to 0, never.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Preferences (Idle Screen)

Option

Values

Description

Models

logo_file

value as "factory" or "user"
path as location on disk of file
url as optional location to fetch a logo
m
d5 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

 

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
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

 

D40, D45, D50, D70, D80 (error)

D60, D62, D65 (2_2_1_0) (tick)

display_mc_notification

boolean

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

Defaults to 1

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
display_pickup_notificationboolean

If 1, enables display of pickup notifications. If 0, disables display of pickup notifications.

Defaults to 1.

D40, D45, D50, D60, D62, D66, D70 (error)

D80 (1_8_0) (tick)

hide_completed_elsewhereboolean

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.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
small_clockboolean

If 1, the phone will display a small time and date on the idle screen. If 0, the regular, large format clock will be displayed on the idle screen. Applies only to D6x models of phones.

Defaults to 0. 

D40, D45, D50, D70, D80 (error)

D60, D62, D65 (2_2_1_0) (tick)

idle_company_textstring

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

No default.

D40, D45, D50, D70, D80 (error)

D60, D62, D65 (2_2_1_4) (tick)

Preferences (Display)

Option

Values

Description

Models

brightness

integer (0-10)

Sets the LCD screen brightness

Defaults to 5

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

contrast

integer (0-10)

Sets the LCD screen contrast

Defaults to 5

D40, D45, D50, D70 (tick)

D60, D62, D65, D80 (Not applicable)

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.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

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

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

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

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

backlight_dim_level

integer (0-10)

Brightness level dims to when when dim_backlight is true.

Defaults to 2

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
blf_page_return_timeoutinteger (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).

D40, D45, D50, D60, D62, D70, D80 (Not applicable)

D65 (2_2_0_6) (tick)

default_fontsizeinteger (10-14)

Sets the default font size for the phone. Caution should be exercised when using this option as larger sizes will cause labels to overrun their allowed space.

D40, D45, and D50 default to 10.

D70 defaults to 11.

D40, D45, D50, D70 (tick)

D60, D62, D65, D80 (Not applicable)

Preferences (Localization)

Option

Values

Description

Models

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. ru_RU applies only to D6x models of phones.

Defaults to en_US.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (1_4_0) (tick)

time_short_formatan 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

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Not applicable)

date_short_formatan 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

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Not applicable)

date_time_formatstring

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}

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Not applicable)

idle_screen_clock_formatan ICU date/time pattern

Sets the clock format used by the phone on its idle screen. This setting is normally controlled by the phone's configured locale.

Defaults to {0} EEE, MMM d

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Not applicable)

ICU Date Patterns

An ICU date/time pattern may contain the following character sequences:

    a : am/pm
    d : day of month (1 - 31)
   dd : day of month (01 - 31)
  EEE : day of week abbreviated
 EEEE : day of week full name 
    h : 12 hour clock hour of day (1 - 12)
   hh : 12 hour clock hour of day (01 - 12)
    m : minutes of hour (00 - 59)
   mm : minutes of hour (00 - 59)
    M : month of year (1 - 12)
   MM : month of year (01 - 12) 
    s : seconds of minute (01 - 59)
   ss : seconds of minute (01 - 59)
   yy : 2 digit year, no century
 yyyy : 4 digit year
  zzz : timezone abbreviation (may not conform to ICU)
 zzzz : timezone full name (may not conform to ICU)
   '' : Characters between single quotes are considered literal strings. No substitutions are performed.

Matching of ICU pattern characters is greedy, e.g. "yyyyy" will be converted to "2012y"

Preferences (Sounds)

Option

Values

Description

Models

ringer_volume

integer (0-10)

Sets the ringer volume.

Defaults to 5

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
lock_ringing_volumeboolean

If 1, the phone's hard ringing key will not change the ringing-volume of the phone. If 0, the hard ringing key will be able to change the ringing-volume of the phone.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70 (2_2_2_3) (tick)

D80 (error)

speaker_volume

integer (0-10)

Sets the speaker volume.

Defaults to 5

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

handset_volume

integer (0-10)

Sets the handset volume.

Defaults to 5

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

headset_volume

integer (0-10)

Sets the headset_volume.

Defaults to 5

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
handset_sidetone_dbInteger, e.g. -25

Sets the gain, in negative dBs, for sidetone presented on the phone's handset. Digium cautions against changing this value.

Defaults to -25.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Not applicable)

headset_sidetone_dbInteger, e.g. -15

Sets the gain, in negative dBs, for sidetone presented on the phone's headset. Digium cautions against changing this value.

Defaults to -15.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Not applicable)

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

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

active_ringtone

Tone ID from <tones> provided to phone

Sets the current user-selected ringtone.

Defaults to Digium

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Preferences (Answering Calls)

Option

Values

Description

Models

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

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
ring_headset_onlyboolean

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

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
call_waiting_toneboolean

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.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

ehs

auto, jabra_iq, plantronics

Defines the Electronics Hookswitch type to support.

Defaults to auto.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
call_control_checkxboolean,

If 1, allows the confirmation key to answer a call and the x-key to reject a call. If 0, the confirmation key will not answer a call nor will the x-key reject a call.

Defaults to 0.

D60, D62, D65 (2_6_6) (tick)

D40, D45, D50, D70, D80 (error)

parking_lot_extensionstring

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.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
parking_lot_enable_blind_transferboolean

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.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Contacts

Option

Values

Description

Models

enable_blf_on_unused_line_keys

boolean

If 1, assigns BLFs beginning with first empty line key. If 0, assigns BLFs beginning with first sidecar key.

Defaults to 0.

D40, D45, D60, D62, D65, D80 (Not applicable)

D50, D70 (tick)

contacts_max_subscriptions

integer, e.g. 40

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

Defaults to 40.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

name_format

first_last, last_first

Formats the display of contact names.

Defaults to first_last

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

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.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Network (IP Settings)

Option

Values

Description

Models

network_enable_dhcp

boolean

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

Defaults to 1

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

network_static_ip_address

IPv4 address

Defines the network address for the phone.

No default.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

network_subnet_mask

IPv4 netmask

Defines the netmask for the phone.

No default.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

network_default_gateway

IPv4 address

Defines the network gateway for the phone.

No default.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

network_primary_dns_server

IPv4 address

Defines the primary DNS server for the phone.

No default.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

network_secondary_dns_server

IPv4 address

Defines the secondary DNS server for the phone.

No default.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
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.

D40, D45, D50, D60, D62, D65, D70 (2_3_6) (tick)

D80 (error)

allow_insecure_sslboolean

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.

D40, D45, D50, D60, D62, D65, D70 (2_3_0) (tick)

D80 (1_5_0) (tick)

network_ipv6_enabledboolean

If 1, the phone will attempt IPv6 networking, in addition to IPv4 networking.

Defaults to 0.

Support for IPv6 is in beta. DHCP IPv4 is still required at present.

D60, D62, D65 (2_5_0) (tick)

D40, D45, D50, D70, D80 (error)

network_ipv6_preferredboolean

If 1, name servers returned by an IPv6 DHCP server will be tried first in the phone's DNS resolution.

Defaults to 0.

Support for IPv6 is in beta. DHCP IPv4 is still required at present.

D60, D62, D65 (2_5_0) (tick)

D40, D45, D50, D70, D80 (error)

network6_static_ip_addressIPv6 address

Defines the phone's IPv6 address, if it is not to be retrieved from a DHCPv6 server.

No default.

Support for IPv6 is in beta. DHCP IPv4 is still required at present.

D60, D62, D65 (2_5_0) (tick)

D40, D45, D50, D70, D80 (error)

network6_maskIPv6 network mask

Defines the phone's IPv6 network mask, if it is not to be retrieved from a DHCPv6 server.

No default.

Support for IPv6 is in beta. DHCP IPv4 is still required at present.

D60, D62, D65 (2_5_0) (tick)

D40, D45, D50, D70, D80 (error)

network6_default_gatewayIPv6 address

Defines the phone's IPv6 default gateway, if it is not to be retrieved from a DHCPv6 server.

No default.

Support for IPv6 is in beta. DHCP IPv4 is still required at present.

D60, D62, D65 (2_5_0) (tick)

D40, D45, D50, D70, D80 (error)

Network (Virtual LAN)

Option

Values

Description

Models

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

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

network_vlan_id

integer (0-4095)

Sets the VLAN ID.

No default.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

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.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Network (Interfaces)

OptionValuesDescriptionModels
lan_port_modeauto, 10hd, 10fd, 100hd, 100fd, 1000fd

Sets the port speed for the phone's LAN port. "auto" will perform auto-negotiation.

Defaults to auto.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

pc_port_modeauto, 10hd, 10fd, 100hd, 100fd, 1000fd, off

Sets the port speed for the phone's PC port. "auto" will perform auto-negotiation; "off" disables the port."

Defaults to auto.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

Logging

Option

Values

Description

Models

log_level

error, warning, debug, information

Sets the logging level.

Defaults to information

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

log_server

IPv4 address of syslog server

Specifies remote syslog server.

No default.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

log_port

port as integer

Specifies port of remote syslog server.

No default.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

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

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

Miscellaneous

Option

Values

Description

Models

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)

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

sip_qos

integer (0-7)

Sets the SIP signaling QOS level

Defaults to 3.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

rtp_qos

integer (0-7)

Sets the RTP media QOS level.

Defaults to 6.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

pc_qos

integer (0-7)

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

No default.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

sip_dscp

integer (0-63)

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

Defaults to 24

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

rtp_dscp

integer (0-63)

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

Defaults to 46

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
in_switchvox_environmentboolean, 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

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
server_environmentempty 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

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
allow_app_devboolean

If 1, turns on the phone's built-in appdev web functionality.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

handshake_timeouttime 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

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
retransmit_until_responseboolean

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.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

802.1X

Option

Values

Description

Models

8021x_passthrough

boolean

If 1, enables pass-through of EAPOL packets from the PC port to the LAN port. If 0, EAPOL packets will be blocked from traversing from the PC port to the LAN port.

Defaults to 0

D40, D45, D50, D70 (2_2_0_6) (tick)

D60, D62, D65 (2_0_3_1) (tick)

D80 (always enabled) (tick)

8021x_eapol_on_disconnect

boolean

If 1, enables sending of EAPOL disconnect on behalf of a PC-port attached device when it disconnects. If 0, EAPOL disconnect not will not be sent on behalf of a PC-port attached device when it disconnects.

Defaults to 0

D40, D45, D50, D70 (2_2_0_6) (tick)

D60, D62, D65 (2_0_3_1) (tick)

D80 (error)

8021x_method

eap-md5, peap-mschap, eap-tls, peap-gtc, ttls-mschap, ttls-gtc

Sets the method of 802.1X authentication for the phone,

Defaults to empty string (none).

D40, D45, D50, D70 (2_2_0_6) (tick)

D60, D62, D65 (2_0_3_1) (tick)

D80 (1_9_0) (tick)

8021x_identity

string

Sets the 802.1X authentication identifier (username),

Defaults to empty string (none).

D40, D45, D50, D70 (2_2_0_6) (tick)

D60, D62, D65 (2_0_3_1) (tick)

D80 (1_9_0) (tick)

8021x_anonymous_identity

string, PHONE_MAC

Sets the 802.1X anonymous authentication identifier (username), can be set to "PHONE_MAC" to pass phone's MAC address.

Defaults to empty string (none).

D40, D45, D50, D70 (2_2_0_6) (tick)

D60, D62, D65 (2_0_3_1) (tick)

D80 (1_9_0) (tick)

8021x_password

string

Sets the 802.1X authentication password

Defaults to empty string (none)

D40, D45, D50, D70 (2_2_0_6) (tick)

D60, D62, D65 (2_0_3_1) (tick)

D80 (1_9_0) (tick)

8021x_client_cert

"value" as label for a defined <clientcert>

Sets the client certificate to be used when performing the 802.1X authentication. Value should be populated with the label of the <clientcert> to be used.

No default.

D40, D45, D50, D60, D62, D65, D70 (2_7_0) (tick)

D80 (1_9_0) (tick)

8021X_client_key

"value" as label for a defined <clientkey>

Sets the client key to be used when performing the 802.1X authentication.  Value should be populated with the label of the <clientkey> to be used.

No default.

D40, D45, D50, D60, D62, D65, D70 (2_7_0) (tick)

D80 (1_9_0) (tick)

8021x_debug-d, -dd

Sets the debug level to be used when troubleshooting 802.1X authentication errors. Phone will generate error report that can be utilized by Digium Support. Phone should not be configured to operate in this mode on an ongoing basis as it will generate excessive messages.

No default.

D40, D45, D50, D70 (2_2_0_6) (tick)

D60, D62, D65 (2_0_3_1) (tick)

D80 (1_9_0) (tick)

OpenVPN

OptionValuesDescriptionModels
network_default_enable_openvpnboolean

If 1, instructs the phone to perform the VPN connection on startup.

Defaults to 0.

D40, D45, D50, D70 (error)

D60, D62, D65 (2_2_1_0) (tick)

D80 (1_9_0) (tick)

openvpn_inline_config

http(s) URI as "url"

"1" as "value"

md5sum of url file as "md5" 

Sets the URL the phone will use to cURL in an inline OpenVPN configuration file. Value must be set to 1. md5 must be valid.

No default.

D40, D45, D50, D70 (error)
D60, D62, D65 (2_7_0) (tick)
D80 (1_9_0) (tick) 

Events Element

 Contacts Element Example
Events Element Example

Any number of event elements may be present directly under the events element.

Option

Values

Description

Models

id

digium.incomingCall.voicemail, digium.parkingLot.parked

Specifies the event that the phone should expect from server

No default.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
actionapp

Specifies that the phone should load an associated app / notification upon receiving the defined event

No default.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Keymap Elements

Keymap Elements control the functionality of softkeys during various phone states.

 Keymap Element Example
Keymap Element Example

Option

Values

Description

Models
state

id as one of:

  • calling
  • connected
  • connected/conference
  • connected/transfer
  • dial
  • dial/conference
  • dial/transfer
  • dialing
  • dialing/conference
  • dialing/transfer
  • failed
  • hold
  • hold/conference
  • hold/preconference
  • hold/transfer
  • idle
  • incoming
  • incoming/transfer

Sets the phone state to which this soft key mapping should apply.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Not applicable)

key

id as integer, beginning with 0

action as one of:

  • accept_call
  • backspace
  • cancel_call
  • clear_call
  • conference
  • end_call
  • forward_calls
    • label1 as:
      • _FORWARD
  • info
  • make_call
  • menu
  • missed_or_call_log
  • none
  • park_call
  • record_call
  • reject_call
  • resume
  • send_to_vmail
  • show_application
    • label1 as one of:
      • _CONTACTS
      • _PARKED_CALLS
      • _QUEUES
      • _STATUS
    • arg as one of:
      • contacts
      • voicemail
      • parking
      • status
      • queues
  • split_conference
  • status
  • toggle_url_number
  • transfer_call

Maps a soft key, represented by an id (index=0), left-to right, where index greater than the free keys on-screen will result in a "More..." soft key being automatically applied to the right-most key, to an action, optionally passed a label1, and optionally passed an arg. Note that not all actions are appropriate for all phone states and not all functionality, e.g. Call Recording, cannot be accomplished outside of a DPMA or Switchvox environment. There is currently no label1 for voicemail.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Not applicable)

Contacts Element

 Contacts Element Example
Contacts Element Example

Any number of contacts elements may be present directly under the config element.
These <contacts> elements have attributes, most importantly url which allow contacts xml sheets to be downloaded via the DPMA.

Option

Values

Description

Models

contacts

url as file link
id as unique identifier
md5 as the md5sum of the xml file

Specifies the contacts XML file to be retrieved by the phone and identifies that file; more than one contacts parameter may be used. Digium phones support basic authentication, so a username and password may be passed in the URL line, e.g. http://user:pass@server.example.com. Digest authentication is supported as of 2_3_0 (non-D80) and 1_5_0 (D80) .

No defaults.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Smart BLF Element

The Smart BLF element contains the BLF Items child element.  BLF Items points to an XML sheet that defines the function and positioning of BLF keys, Contacts and Applications on the phone.

BLF Items: Child Element of <smart_blf>

 BLF Items Element Example
BLF Items Element Example
OptionValuesDescriptionModels
blf_items

url as file link, network_id (optional) as network identifier for this element,

md5 (optional) as md5 sum of referenced XML sheet

Specifies the BLF Items XML file to be retrieved by the phone. Digium phones support basic authentication, so a username and password may be passed in the URL line, e.g. http://user:pass@server.example.com D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Accounts Element

 Accounts Element Example
Accounts Element Example

Option

Values

Description

Models
server_uuidNon-zero String

Specifies a unique identifier for the server.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

index

integer (0-5)

Defines the line key to which the account will be mapped.

There is no default index value.  This option is mandatory.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Supports 1 line only)

status

boolean

If 1, enables the account's line key. If 0, will not display the account's line on the phone or register with the primary host.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

register

boolean

If 1, then this account will attempt to register with the primary host. If 0, then registration will not be performed for this account.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

account_id

string

For Switchvox systems, the Switchvox account_id associated with the SIP account. For non-Switchvox systems, a unique identifier, not necessarily related to any SIP credentials.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

username

string

SIP username

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

authname

string

SIP authname

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

password

string

SIP password

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

passcode

string

SIP password

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

line_label

string

The text that shows up next to the line key for this account

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

caller_id

Name <Number>

Outgoing caller id displayed for this account

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

dial_plan

Digit mapping, see Dial Plans

The dial plan / digit mapping for this account

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

visual_voicemail

boolean

Only valid on account with index of 0. Only valid for phones provisioned by Switchvox or the DPMA. If 1, then the Msgs button action will open the voicemail app. If 0, then the Msgs button will be mapped to the extension defined for the voicemail option.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

voicemail

digits or SIP URI

A SIP URI or extension to be dialed for voicemail pertaining to this account.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

needMwiSubscription

boolean

If 1, the phone will subscribe for MWI for this account. If 0, the phone will not subscribe for MWI for this account.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

outbound_proxy

IP address / Hostname

Outbound proxy for this account

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

outbound_port

port

Port for the outbound proxy

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

plar_numberstringIf defined, the phone will dial the configured string as a URI when the account is taken off-hook.

D40, D45, D50, D70, D80 (error)

D60, D62, D65 (2_2_1_4) (tick)

ring_typenormal, answer, ring-answer, visualAllows control over the default ringing type for this account in the absence of any explicit Alert-Info header. Defaults to normal.

D40, D45, D50, D60, D62, D65, D70 (2_2_1_3) (tick)

D80 (error)

subscription_extensionstringFor DPMA-connected phones, defines the user-part to which the phone should subscribe for presence updatesD40, D45, D50, D60, D62, D65, D70, D80 (tick)

Host Primary: Child Element of <account>

Option

Values

Description

Models

server

Hostname or IPv4 Address

Sets the server to which calls for this account are directed

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

port

empty, or integer (1-65535)

Sets the server's SIP port. If empty, and if a hostname is used for the server, the port will be retrieved from DNS. The port option must be specified, even if it is set to empty, and is not optional.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

transport

udp, tcp, tls

Sets the transport type, UDP or TCP, TLS. TLS for D6x only.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
media_encryptionsdes

Sets the media_encryption method, none or SDES.

Defaults to empty string (none).

D40, D45, D50, D70, D80 (error)

D60, D62, D65 (2_1_0_5) (tick)

reregister

integer in seconds

Sets the re-registration interval which the phone will present in the Expires header of the REGISTER. At half the interval of the reregister value, plus or minus a few random seconds, the phone will perform its reregistration.

Defaults to 300.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

retry

integer

Specifies the period, plus or minutes 10 random seconds, at which the phone will perform a registration retry, given a registration failure.

Defaults to 25.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Host Alternate: Child Element of <account>

Option

Values

Description

Models

server

Hostname or IPv4 Address

Sets the server to which calls for this account are directed in the event that host_primary is unreachable

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

port

empty, or integer (1-65535)

Sets the server's SIP port. If empty, and if a hostname is used for the server, the port will be retrieved from DNS. The port option must be specified, even if it is set to empty, and is not optional.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

transport

udp, tcp, tls

Sets the transport type, UDP or TCP, TLS. TLS for D6x only.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

reregister

integer in seconds

Sets the re-registration interval which the phone will present in the Expires header of the REGISTER. At half the interval of the reregister value, plus or minus a few random seconds, the phone will perform its reregistration.

Defaults to 300.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

retry

integer

Specifies the period, plus or minutes 10 random seconds, at which the phone will perform a registration retry, given a registration failure.

Defaults to 25.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

authnameStringSpecifies an authentication name to be used when registering to the host_alternate server, if null, utilizes the auth name from the account object.

D40, D45, D50, D60, D62, D65, D70 (2_6_2) (tick)

D80 (error)

passwordStringSpecifies an authentication password to be used when registering to the host_alternate server, if null, utilizes the authentication password from the account object.

D40, D45, D50, D60, D62, D65, D70 (2_6_2) (tick)

D80 (error)

Permission: Child Element of <account>

Defines line/account based permissions for various phone functions with an id and value pair.

Option

Values

Description

Models

record_own_calls

boolean

If 1, allows the user to record their own calls using a soft-key. Note that this feature can only enabled when using the DPMA. Users manually provisioning Digium phones should set this to false in order to ensure that a non-functional (because the DPMA is not being used) call recording softkey does not appear.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
use_voicemailboolean

If 1, allows the user to have voicemail for this account.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
send_to_voicemailboolean

If 1, allows the user to send an incoming call to voicemail.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70 (error)
D80
(tick)
ignore_callsboolean

If 1, allows the user to ignore an incoming call.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Setting: Child Element of <account>

Defines line/account based settings for various phone functions with an id and value pair.

Option

Values

Description

Models

use_call_log_api

boolean

If 1, the phone will use the Switchvox Call Log API for this account.

Defaults to 0.

D40, D45, D50 (error)
D60, D62, D65, D70 (2_6_1) (tick)
D80 (1_9_0) (tick)
call_log_fetch_entriesinteger

Specifies the number of Call Log entries to fetch when making a request.

Defaults to 0.

D40, D45, D50 (error)
D60, D62, D65, D70 (2_6_1) (tick)  
D80 (1_9_0) (tick)
parking_lot_extensioninteger

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 phone-level parking_lot_extension setting.

No default.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
parking_lot_enable_blind_transferboolean

For Switchvox and DPMA environments, specifies the type of call parking transfer to perform. This option must be defined also, duplicating the phone-level parking_lot_enable_blind_transfer setting.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70 (tick)

Networks Element

 Networks Element Example
Networks Element Example

The networks element contains definitions for networks, each described by an individual <network> element and its attributes.

Each <network> element is described by the following attributes:

Option

Values

Description

Models

id

integer

Unique, numbered identifier for the network

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

display_name

string

A named identifier for the network

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

cidr

CIDR formatted address

A CIDR formatted network address, e.g. 10.0.0.0/8

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Codecs Element

 Codecs Element Example
Codecs Element Example

The codecs element contains all available codecs, each described by an individual <codec> element and its attributes.

Each <codec> element is described by the following attributes:

Option

Values

Description

Models

id

PCMU, PCMA, G722, G7221, G726-32, opus, G729, iLBC, L16, L16-256

A codec supported by the phone

See - Digium Phones Codecs

priority

integer (1-255)

Priority of the codec where higher numbers mean the codec is more favored

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

packetization

integer in 10ms increments per RFC codec guidelines

Packetization (ptime) rate for the specified codec, defaults to 20

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

jitter_min

integer in ms

Sets the minimum size of the codec jitter buffer

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

jitter_max

integer in ms

Sets the maximum size of the codec jitter buffer

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

jitter_target

integer in ms

Sets the target size of the codec jitter buffer

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

enabled

boolean

If 1, enables the codec. If 0, disables the codec.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
complexityinteger, 1-10Defines the encoding complexity for the Opus codec. Higher (10) numbers require more CPU time but produce better sounding audio. Defaults to 10.See - Digium Phones Codecs  
samplerateDepends on codec: nb, wb, uwbSets the sampling rate for a codec, applicable to G.722.1 & G.722.1C, licensed by Polycom ®, and Opus codecs. For G.722.1 set to wb (16000Hz), for G.722.1C set to uwb (32000Hz). Opus operates at either nb (8000Hz) or wb (16000Hz). Defaults to uwb for G.722.1C and wb for Opus.See - Digium Phones Codecs  
bitrateApplies to G.722.1 & G.722.1C, licensed by Polycom ®, codecs: 24000, 32000, 48000Sets the bitrate for a G.722.1 or G.722.1C codec. G.722.1 may be 24000bps or 32000bps. G.722.1C may be 24000, 32000 or 48000bps. Defaults to 48000 for G.722.1C and 32000 for G.722.1See - Digium Phones Codecs  
use_vbrboolean

Applies to the Opus codec. If 1, uses a variable bitrate encoder. If 0, uses a constant bitrate encoder.

Defaults to 0.

See - Digium Phones Codecs  

Ringtones Element

This section has two primary child elements:

  1. tones, which are the actual sounds heard when a call is made
  2. alerts, which map to a tone and represent a certain call condition

Tones: Child element of <ringtones>

 Tones Element Example
Tones Element Example

Element lists the <tone> elements, each described by the following attributes:

Option

Values

Description

Models

id

string

Internal Tone identifier

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

display

string

External Tone Description

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

url

URL string

Location from which to retrieve a 16-bit, 16kHz, mono raw signed linear sound file, less than 1MB in size

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

md5

md5sum

MD5 sum of the file to be retrieved

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

type

phone, user

Indicates the tone's origin; tones that are type phone are embedded into the phone's firmware, tones that are type user are retrieved by URL

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Alerts: Child element of <ringtones>

 Alerts Element Example
Alerts Element Example
  • Element lists the <alert> elements, each described by the following attributes.
  • Alert tones are played when the event designated by 'alert_info' occurs.

Option

Values

Description

Models

alert_info

string

The alert_info header that, as received, applies to this alert

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

ringtone_id

string

The id of the ring tone for this alert

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

ring_type

normal, answer, ring-answer, visual

The type of call-answer to affect for this alert.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Firmwares Element

 Firmwares Element Example
Firmwares Element Example
  • Element lists the <firmwares> elements, each described by the following attributes.
  • Network, if specified, allows the phone to load different firmware URLs depending on its own network address mask

Option

Values

Description

Models

model

D40, D45, D50, D60, D62, D65, D70, D80

Model number of the Digium phone

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

version

string

Version string for the firmware. On boot, the phone will check the version string against an internal copy of the string, as previously loaded. If the strings differ, the phone will load the new firmware

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

url

http URL string

URL location of the phone firmware. Digium phones support basic authentication, so a username and password may be passed in the URL line, e.g. http://user:pass@server.example.com. Firmware beginning with 2_3_0 (non-D80) and 1_5_0 (D80) also supports digest auth. 

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Public Firmwares Element

 Public Firmwares Element Example
Firmwares Element Example
  • Element lists the <public_firmwares> elements, each described by the following attributes.
  • Specifies a fallback firmare location - more than one public_firmware element may be specified for each model and the public_firmware servers will be tried in the order they are listed, in the event that an internal firmware server cannot be reached
  • A <public_firmwares> element does not take the place of a <firmwares> element; if a <firmwares> element is not present in the config, the phone will not apply any settings from any <public_firmwares> elements.

Option

Values

Description

Models

model

D40, D45, D50, D60, D62, D65, D70, D80

Model number of the Digium phone

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

version

string

Version string for the firmware. On boot, the phone will check the version string against an internal copy of the string, as previously loaded. If the strings differ, the phone will load the new firmware

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

url

http URL string

URL location of the phone firmware. Digium phones support basic authentication, so a username and password may be passed in the URL line, e.g. http://user:pass@server.example.com. Firmware beginning with 2_3_0 (non-D80) and 1_5_0 (D80) also supports digest auth. 

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Appconfig Element

 Appconfig Element Example
Appconfig Element Example
  • Element lists the <appconfig> elements.  Each element is identified by its identifier.  Native apps require use of an account parameter.
  • auto_start element applies to all appconfig definitions and specifies that an application should be loaded when the phone boots, not just on first use of the application.  This sill increase boot time but will decrease first load of the application.
  • Custom applications are defined with a name not matching a built-in app, are retrieved using a URL and can be loaded with custom settings, that are made accessible to the application. Custom applications do not apply to model D80 telephones.

Account: Child Element of <appconfig> for contacts, status, queues, parking, and voicemail applications

OptionValuesDescriptionModels
account_idStringSpecifies the account ID used when accessing the application server; typically the same as the SIP endpoint ID.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

usernameStringSpecifies the SIP endpoint ID used when accessing the application server.D40, D45, D50, D60, D62, D65, D70, D80 (tick)
passwordStringSpecifies the password used when accessing the application server as well as the password used when the require_password application setting is applied. Need not be the same as the SIP endpoint password.D40, D45, D50, D60, D62, D65, D70, D80 (tick)
appserverdash://YOUR SERVER/jsonSpecifies the location of application server, prefixed with "dasp" transport type.D40, D45, D50, D60, D62, D65, D70, D80 (tick)
apiformatjsonSpecifies the data format to use when exchanging information with the application serverD40, D45, D50, D60, D62, D65, D70, D80 (tick)

Appscreen: Application Child Element of <appconfig> for appscreen application

OptionValuesDescriptionModels
idbluetooth, voicemail, parking, status, contacts, queues, call_log, forward_calls, LogOutSpecifies the application to load into the phone's app screen, dependent on phone model.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
LogOut, D6x only

Phone Menu: Application Child Elements of <appconfig> for phone menu application

OptionValuesDescriptionModels
hide_options idabout, applications, preferences, admin, advancedSpecifies the menu item to hide

D40, D45, D50, D60, D62, D65, D70 (tick)
D80 (error)

option idadmin: network, qos, vlan, ethernetModes, systemTools, sipLines, changePassword, vpn
preferences: display, localization, sound, answering, network_select
advanced: reconfigure, factoryReset 
Specifies the sub-menu item to hideD40, D45, D50, D60, D62, D65, D70 (tick)
D80 (error)

Contacts: Settings Child Elements <appconfig> for contacts application

OptionValuesDescriptionModels
use_local_storageboolean

If 1, directs the contacts application to allow the use of local storage for contacts.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70 (tick)
D80 (error)

can_transfer_vmboolean

If 1, specifies that the phone is allowed to perform transfers to voicemail targets from within the contacts application.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
name_format

first_last, last_first

Specifies the formatting of name display, e.g. First Last or Last, First.

Defaults to first_last

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
in_switchvox_environmentboolean

If 1, alerts the Contacts application that it is operating inside a Switchvox system.

Defaults to 0. 

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

Display Rules: Child Element of <appconfig> for contacts application

OptionValuesDescriptionModels
idunique idA unique identifier for this display_rule, e.g. 0, 1, 2, etc.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Not applicable)

action_idA valid action as defined in the phone's Contacts fileSets the action_id for the display rule to act upon

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Not applicable)

phone_stateidle, hold, transfer, incoming/transfer, incoming, connected, dialing, calling, failedDefines the state of the local phone during which the rule will be acting. If not specified in a rule, all states are matched. Note that this list of states differs from the larger list of states available for BLF key action mappings.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Not applicable)

target_statusunknown, idle, on_hold, ringing, on_the_phoneOptional. Sets the status of the subscribed to contact that must be matched for this display rule to be in effect

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Not applicable)

showbooleanIf set to 1, shows a particular action. If set to 0, hides the action. To hide an action for all states and only show it for some states, first declare the action to have a false show, then declare it to have a true show for only a particular state or states.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (Not applicable)

Status: Settings Child Elements of <appconfig> for Status application

OptionValuesDescriptionModels
send_dndstatus set to one of:
available, unavailable, away, xa, chat, dnd 
Can be defined multiple times, one for each status. If set for a status, directs the phone to return 486 BUSY when in that status mode.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

full_applicationNoneIf defined, alerts the Status application to run in full mode. Full mode should only be run against DPMA or Switchvox. 

Voicemail: Application Child Elements of <appconfig> for Voicemail application

OptionValuesDescriptionModels
require_passwordboolean

If 1, causes the phone to require voicemail pin entry before the app can be foregrounded. Voicemail PIN is retrieved from the voicemail appconfig password.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

LogOut: Application Child Elements of <appconfig> for LogOut application

No child elements are available for the LogOut application.  The LogOut application applies only to the D60, D62, and D65 models, beginning with firmware 2_6_0, configured using DPMA.  The LogOut application is not displayed by default and must be configured to both display and auto_start.  Further, its use requires that the server-side allow PIN-based selection of phone configs.

Conferences: Application Child Elements of <appconfig> for Conferences application

The Conferences app applies only to the D80 for Switchvox 7.0 and greater systems.

OptionValuesDescriptionModels
default_bridgepin as integerSpecifies the default bridge number to be shown when the app is brought to the foreground

D80 (1_9_0) (tick)

  • Enabled element is mandatory

Custom Application: Application Child Elements of <appconfig> for custom application

OptionValuesDescriptionModels
urlurl as URL through which phone can retrieve the application's .zip fileCustom applications are cURL'd down by the phone from a remote URL as defined here.

D40, D45, D50, D60, D62, D65, D70 (tick)
D80 (error)

settingscustom settings in key-value pairSpecifies custom application values made available to the appD40, D45, D50, D60, D62, D65, D70 (tick)
D80 (error)

Multicastpage Element

 Multicastpage Element Example
Multicastpage Element Example
  • Element lists the <multicastpage> elements, each described by the following attributes.
  • Specifies listener addresses to which phone will subscribe for multicast audio playback in G.711 u-law, G.711 a-law, or G.722 formats

    Icon

    A blank multicast page element should be passed to the phone to ensure that listeners are turned off, e.g.:

    <multicastpage>
    <!-- need blank multicastpage to ensure listener removed if turned off -->
    </multicastpage>

Option

Values

Description

Models

id

string

A unique identifier for the listener, required

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

name

string

A name to be provided in the phone's announcement status bar when audio is received over this listener, required

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

extensionstringSets a local extension for this listener, that, if dialed by the phone, causes the phone to ignore RTP from this listener.

D40, D45, D50, D60, D62, D65, D70 (2_6_3) (tick)

D80 (error)

addr

IPv4 address

Multicast address to which phone should subscribe for audio, required

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

portValid integer for ports (1-65535)Port, combined with address above, to which phone should subscribe for audio, required

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

priorityinteger, 1-10Prioritization level, lower given more priority, for playing back streams when more than one subscribed address is providing audio, required

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

interrupt_callersboolean

If 1, places any in-progress calls on hold before playing back audio, and ignore the phone's local volume setting, playing back the audio at full volume. If 0, in-progress calls will have their audio played over the top of any in-progress calls.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70 (tick)

D80 (error)

Certs Element

 Certs Element Example
Certs Element Example
  • Element lists the <cert>, <clientcert>, and <clientkey> elements, each containing an in-line, raw certificate payload, not prefixed by an "----BEGIN CERTIFICATE----" header nor postfixed by an "----END CERTIFICATE----" footer.
  • cert will be loaded by phone and combined with built-in certificate bundle as a trusted certificate
  • <cert>, <clientcert>, and <clientkey> supported on D40, D45, D50, D60, D62, D65 and D70 as of 2_7_0.  D80 as of 1_5_2 supports <cert> only

Option

Values

Description

Models

id

string

A unique identifier for the cert, required

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

label

string

A name to be used to identify this cert, that can be utilized by other phone configuration elements.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

typeALL, RSA, DSA, ECFor clientkey types, specifies the type of encryption used for the client key, to be recognized by OpenSSL.

D40, D45, D50, D60, D62, D65, D70 (2_7_0) (tick)

D80 (error)

md5

string

Contains the md5sum of the certificate body. When this changes for any certificate, the phone will execute a restart in order to ensure the new certificates are used.

D40, D45, D50, D60, D62, D65, D70 (2_7_0) (tick)

D80 (error)

Activity Indicator Element

 Certs Element Example
Activity Indicator Element Example
  • Controls the behavior of the activity indicator lamp during various phone states.

Option

Values

Description

Models

id

idle, default, hold, ringing, activity, new_vm, listen_vm, leaving_vm, screen_vm, announcement

Specifies the state being configured

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

color

amber, green, red

Specifies the color to apply to the state being configured

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

stateoff, on, slow, fastSpecifies the lamp disposition to apply to the state being configured

D40, D45, D50, D60, D62, D65, D70 D80 (tick)

use_proxy_for Element

 Certs Element Example
use_proxy_for Element Example
  • Controls whether the phone should make direct API requests to Switchvox or indirect cURL requests.  Default to indirect.  This option should only be used inside Switchvox environments.

Option

Values

Description

Models

network

CIDR format netmask

Specifies the network to which the setting should be applied

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

network_id

id of a defined network

Specifies the network to which the setting should be applied

D40, D45, D50, D60, D62, D65, D70, D80 (tick)

hosthostnameSpecifies the proxy hostname

D40, D45, D50, D60, D62, D65, D70 D80 (tick)

useboolean

If 1, enables the use_proxy_for setting. If 0, disables the use_proxy_for setting.

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70 D80 (tick)

network_id attribute

The network_id attribute, in conjunction with the Networks element is used to provision multiple different options for a particular element, e.g. account address, so that when the Digium phone is located on different networks, the proper element for that network can be loaded by the phone. When the phone boots and discovers its IP address, it compares that against matching elements with network_id attributes and loads only those elements, rather than elements with non-matching network_ids.

Currently, the network_id attribute can be applied to the following elements:

  • ntp_server setting
  • network_vlan_discovery_mode setting
  • pc_vlan_id setting
  • host_primary element
  • host_alternate element
  • contacts element
  • firmwares element

Example

 network_id Attribute Example
network_id Attribute Example
  • No labels