Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »


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

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_useragentbooleanIf true, 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 false.

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

D80 (1_4_3) (tick)

use_secure_labelsbooleanIf true, 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 false.

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

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"

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

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

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

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

transport_udp_enabled

boolean

Sets whether to enable UDP 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

Sets whether to enable TCP transport, defaults to 1

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

D80 (error)

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 (tick)

D80 (error)

transport_tls_allowedbooleanSets whether to enable TLS 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 secondsSets 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 / user; path as location on disk of file - /factory_asterisk.png for default and /user_image.png for custom ; url as optional location to fetch a logo; md5 as optional when url is used to determine if logo has changed to avoid re-fetching

Sets the idle screen logo, defaults to factory-asterisk.png

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
wallpaper_filevalue as factory / user; path as location on disk of file - /factory_wallpaper.png for default and /user_wallpaper.png for custom ; url as optional location to fetch a logo; md5 as optional when url is used to determine if wallpaper has changed to avoid re-fetchingSets the wallpaper, defaults to factory-wallpaper.png

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

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

display_mc_notification

boolean

Disables / Enables display of missed calls on the phone, defaults to 1

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
display_pickup_notificationbooleanDisables / Enables display of pickup notification on the phone, defaults to 1.

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

D80 (1_8_0) (tick)

hide_completed_elsewherebooleanWhen enabled, will cause the phone to not register a call, missed or otherwise, when receiving RFC 3326 "Call completed elsewhere" SIP Reason. Disabled by default, so all calls that canceled from the remote side before answer will show as missed.D40, D45, D50, D60, D62, D65, D70, D80 (tick)
small_clockbooleanWhen set, the phone will display a small time and date setting rather than the large clock. Defaults to disabled. Applies only to D6x models of phones.

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

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

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

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

Controls whether the phone will perform a reconfigure when sent a check-sync SIP NOTIFY Event from the server to which it is registered. Defaults to 1. 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.

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

dim_backlight

boolean

enable backlight dimming where 1 dims the screen after backlight timeout has been reached and phone is otherwise idle, 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 1, 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, defaults to en_US. ru_RU applies only to D6x models of phones.

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

D80 (1_4_0) (tick)

time_short_formatan ICU date/time pattern, defaults to "h:mm a"Sets the time format used by the phone when displaying the small clock. This setting is normally controlled by the phone's configured locale.

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

D80 (Not applicable)

date_short_formatan ICU date/time pattern, defaults to "M/d/yy"Sets the date format used by the phone when displaying the short date. This setting is normally controlled by the phone's configured locale.

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

D80 (Not applicable)

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

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

D80 (Not applicable)

idle_screen_clock_formatan ICU date/time pattern, defaults to "{0} EEE, MMM d"Sets the clock format used by the phone on its idle screen. This setting is normally controlled by the phone's configured locale.

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_volumebooleanIf true, prevents the phone's hard ringing key from manipulating the ringing-volume of the phone. Defaults to false.

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. -25Sets the gain, in negative dBs, for sidetone presented on the phone's handset. Defaults to -25. Digium cautions against changing this value.

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

D80 (Not applicable)

headset_sidetone_dbInteger, e.g. -15Sets the gain, in negative dBs, for sidetone presented on the phone's headset. Defaults to -15. Digium cautions against changing this value.

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, 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

Sets whether to use the headset, rather than the speaker, for answering all calls, defaults to 0

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
ring_headset_onlybooleanSets whether or not to play ringing tone out the headset, defaults to 0D40, D45, D50, D60, D62, D65, D70, D80 (tick)
call_waiting_tonebooleanEnabled by default, if disabled, the phone phone will not playback the call-waiting toneD40, D45, D50, D60, D62, D65, D70, D80 (tick)

ehs

auto, jabra_iq, plantronics

Defines the Electronics Hookswitch type to support

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
call_control_checkxboolean, Defaults to 0If enabled, allows the confirmation key to answer a call and the x-key to reject a call. Defaults to 0.

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

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

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

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

D50, D70 (tick)

contacts_max_subscriptions

integer, e.g. 40Sets the maximum number of SUBSCRIBEs the phone will perform for contactsD40, 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 use for the rapid dial list

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

Network (IP Settings)

Option

Values

Description

Models

network_enable_dhcp

boolean

Disable or Enable DHCPv4/v6 network configuration, 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

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

network_subnet_mask

IPv4 netmask

Defines the netmask for the phone

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

network_default_gateway

IPv4 address

Defines the network gateway for the phone

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

network_primary_dns_server

IPv4 address

Defines the primary DNS server for the phone

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

network_secondary_dns_server

IPv4 address

Defines the secondary DNS server for the phone

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
network_disable_arping booleanIf true, causes the phone to not ARP for an in-use address as-provided by a DHCP server, before using it

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

D80 (error)

allow_insecure_sslbooleanBy 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, enable this option.

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

D80 (1_5_0) (tick)

network_ipv6_enabledbooleanIf true, the phone will attempt IPv6 networking, in addition to IPv4 networking

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Network (Virtual LAN)

Option

Values

Description

Models

network_vlan_discovery_mode

value of NONE, MANUAL, LLDP; network as IP mask

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

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

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

Network (Interfaces)

OptionValuesDescriptionModels
lan_port_modeauto, 10hd, 10fd, 100hd, 100fd, 1000fdSets the port speed for the phone's LAN port. "auto" will perform auto-negotiation.

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

D80 (error)

pc_port_modeauto, 10hd, 10fd, 100hd, 100fd, 1000fd, offSets the port speed for the phone's PC port. "auto" will perform auto-negotiation; "off" disables the port."

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 error

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

D80 (error)

log_server

IPv4 address of syslog server

Specifies remote syslog server

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

D80 (error)

log_port

port as integer

Specifies port of remote syslog server

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

D80 (error)

enable_logging

boolean

Disables or Enables remote syslog, defaults to 0

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

D80 (error)

Miscellaneous

Option

Values

Description

Models

web_ui_enabled

boolean

Disables, Enables the phone's web user interface, defaults to 1 (Enabled)

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

D80 (error)

sip_qos

integer (0-7)

Defaults to 3. Sets the SIP signaling QOS level

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

rtp_qos

integer (0-7)

Defaults to 6. Sets the RTP media QOS level

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

pc_qos

integer (0-7)

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

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)

802.1X

Option

Values

Description

Models

8021x_passthrough

boolean

Enables or disables pass-through of EAPOL packets 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 (error)

8021x_eapol_on_disconnect

boolean

Enables or disables sending of EAPOL disconnect on behalf of PC-port attached device when disconnected, defaults to 0

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

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

D80 (error)

8021x_method

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

Sets the method of 802.1X authentication for the phone, defaults to null (none).

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

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

D80 (error)

8021x_identity

null, string

Sets the 802.1X authentication identifier (username), defaults to null (none).

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

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

D80 (error)

8021x_anonymous_identity

null, string, PHONE_MAC

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

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

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

D80 (error)

8021x_password

null, string

Sets the 802.1X authentication password, defaults to null (none)

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

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

D80 (error)

8021x_client_cert

null, http(s) or ftp(s) URI as "url"

string as "value"

Sets the URL the phone will cURL its 802.1X client certificate from, and the local name the phone should use when storing the certificate. Phone will retrieve a new certificate when factory defaulted or when value changes. Defaults to null (none)

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

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

D80 (error)

8021X_root_cert

null, http(s) or ftp(s) URI as "url"

string as "value"

Sets the URL the phone will cURL its 802.1X root certificate from, and the local name the phone should use when storing the certificate. Phone will retrieve a new certificate when factory defaulted or when value changes. Defaults to null (none)

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

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

D80 (error)

8021x_debugnull, -d, -ddSets 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. Defaults to null (none)

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

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

D80 (error)

OpenVPN

OptionValuesDescriptionModels
network_default_enable_openvpnbooleanWhen enabled, instructs the phone to perform the VPN connection on startup. Defaults to disabled.

D40, D45, D50, D70 (error)

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

D80 (error)

openvpn_root_cert

null, http(s) or ftp(s) URI as "url"

string as "value"

Sets the URL the phone will cURL its VPN root certificate from, and the local name the phone should use when storing the certificate. The phone will retrieve a new certificate when factory defaulted or when value changes. Defaults to null (none)

D40, D45, D50, D70 (error)

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

D80 (error)

openvpn_client_cert

null, http(s) or ftp(s) URI as "url"

string as "value"

Sets the URL the phone will cURL its VPN client certificate from, and the local name the phone should use when storing the certificate. The phone will retrieve a new certificate when factory defaulted or when value changes. Defaults to null (none)

D40, D45, D50, D70 (error)

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

D80 (error)

openvpn_client_key

null, http(s) or ftp(s) URI as "url"

string as "value"

Sets the URL the phone will cURL its VPN client key from, and the local name the phone should use when storing the certificate. The phone will retrieve a new certificate when factory defaulted or when value changes. Defaults to null (none)

D40, D45, D50, D70 (error)

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

D80 (error)

openvpn_config_file

null, http(s) or ftp(s) URI as "url"

string as "value"

Sets the URL the phone will cURL its VPN configuration from, and the local name the phone should use when storing the certificate. The phone will retrieve a new certificate when factory defaulted or when value changes. Defaults to null (none)

D40, D45, D50, D70 (error)

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

D80 (error)

 

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) 

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_uuidStringSpecifies a unique identifier for the serverD40, D45, D50, D60, D62, D65, D70, D80 (tick)

index

integer (0-5)

Defines the line key to which the account will be mapped

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

D80 (Supports 1 line only)

status

boolean

Enables the line key; if false, will not display the line on the phone or register with the primary host

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

register

boolean

If 1, then this account will attempt to register with the primary host

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

account_id

string

SIP username

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 this is set to 1 then the Msgs button action will open the voicemail app. Otherwise it will dial the voicemail extension.

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

booleanDefines whether or not a phone should subscribe for MWI on this account.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)

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

integer (1-65535)

Sets the server's SIP port

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. TCP for all except D80.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
media_encryptionnull, sdesSets the media_encryption method, none or SDES, defaults to null (none).

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

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

reregister

integer in seconds

Sets the re-registration interval

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

retry

integer

Specifies the number of time to attempt re-registration if registration fails

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

num_retries

integer

Specifies the number of retries to attempt if registration fails

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

integer (1-65535)

Sets the server's SIP port

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

D80 (error)

transport

udp, tcp

Sets the transport type, UDP or TCP

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

D80 (error)

reregister

integer in seconds

Sets the re-registration interval

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

D80 (error)

retry

integer

Specifies the number of time to attempt re-registration if registration fails

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

D80 (error)

num_retries

integer

Specifies the number of retries to attempt if registration fails

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 0 in order to ensure that a non-functional (because the DPMA is not being used) call recording softkey does not appear.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
use_voicemailbooleanIf 1, allows the user to have voicemail for this accountD40, D45, D50, D60, D62, D65, D70, D80 (tick)
send_to_voicemailbooleanIf 1, allows the user to send an incoming call to voicemailD40, D45, D50, D60, D62, D65, D70, D80 (tick)
ignore_callsbooleanIf 1, allows the user to ignore an incoming callD40, 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, Defaults to 0

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

D40, D45, D50 (error)
D60, D62, D65, D70 (2_6_1) (tick)
D80 (error)
call_log_fetch_entriesinteger, Defaults to 50Specifies the number of Call Log entries to fetch when making a requestD40, D45, D50 (error)
D60, D62, D65, D70 (2_6_1) (tick)  
D80 (error)
parking_lot_extensioninteger, Defaults to 700For Switchvox and DPMA environments, specifies the lot in which a call is transferred using the Park soft keyD40, D45, D50, D60, D62, D65, D70, D80 (tick)
parking_lot_enable_blind_transferboolean, Defaults to 0For Switchvox and DPMA environments, specifies the type of call parking transfer to perform. Defaults to 1 (blind)D40, D45, D50, D60, D62, D65, D70, D80 (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

Disables / Enables a 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_vbrbooleanApplies to the Opus codec. Sets whether to use a constant or variable bitrate encoder. Defaults to disabled (constant bitrate).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

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 yes, shows a particular action; if set to no, 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)

The can_transfer_vm attribute controls the display of the "Transfer VM" softkey from within the Contacts application.
The name_format attribute controls the display order of names from within the Contacts application.

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

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_callersbooleanWhen enabled, 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. When disabled, in-progress calls will have their audio played over. 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> 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
  • Supported on D40, D45, D50, D60, D62, D65 and D70 as of 2_3_4 and D80 as of 1_5_2

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