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.
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 |
---|---|---|
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 |
send_mac_with_useragent | boolean | If 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. |
use_secure_labels | boolean | If 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. |
General (Time)
Option | Values | Description |
---|---|---|
time_zone | Timezone String, e.g. America/Chicago | Sets the time zone for the phone |
time_source | "ntp" | Sets the time source for the phone. Currently, the only option is "ntp" |
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 |
ntp_resync | Seconds as integer, e.g. 86400 | Sets the interval between NTP synchronization |
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 | |
transport_udp_enabled | boolean | Sets whether to enable UDP transport, defaults to 1 | |
transport_udp_port | Valid integer for ports (1-65535) | Sets the local UDP SIP port, defaults to 5060 | |
transport_tcp_enabled | boolean | Sets whether to enable TCP transport, defaults to 1 | |
transport_tcp_port | Valid integer for ports (1-65535 ) | Sets the local TCP SIP port, defaults to 5060 | |
transport_tls_allowed | boolean | Sets whether to enable TLS transport, defaults to 1 | D6x only |
transport_tls_port | Valid integer for ports (1-65535) | Sets the local TLS SIP port, defaults to 5061 | D6x only |
udp_ka_interval | integer, in seconds | Sets the UDP keep alive interval, at which the phone will send CR-LF to the registered server. Defaults to 0, never. |
Preferences (Idle Screen)
Option | Values | Description |
---|---|---|
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 |
wallpaper_file | value 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-fetching | Sets the wallpaper, defaults to factory-wallpaper.png |
display_mc_notification | boolean | Disables / Enables display of missed calls on the phone, defaults to 1 |
hide_completed_elsewhere | boolean | When 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. |
small_clock | boolean | When 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. |
idle_company_text | string | When set, the phone will display this string in its status bar while idle and no other status notification icons are active. |
Preferences (Display)
Option | Values | Description |
---|---|---|
brightness | integer (0-10) | Sets the LCD screen brightness, defaults to 5 |
contrast | integer (0-10) | Sets the LCD screen contrast, defaults to 5 |
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. |
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 |
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 |
backlight_dim_level | integer (0-10) | Brightness level dims to when when dim_backlight is 1, defaults to 2 |
blf_page_return_timeout | integer (0-60) | Time, in seconds, that elapses before a D65 will return to its first page of rapid dial favorites. Defaults to 0 (never return). |
default_fontsize | integer (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. |
Preferences (Localization)
Option | Values | Description |
---|---|---|
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. |
time_short_format | an 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. |
date_short_format | an 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. |
date_time_format | string, 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 |
idle_screen_clock_format | an 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. |
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 |
---|---|---|
ringer_volume | integer (0-10) | Sets the ringer volume, defaults to 5 |
lock_ringing_volume | boolean | If true, prevents the phone's hard ringing key from manipulating the ringing-volume of the phone. Defaults to false. |
speaker_volume | integer (0-10) | Sets the speaker volume, defaults to 5 |
handset_volume | integer (0-10) | Sets the handset volume, defaults to 5 |
headset_volume | integer (0-10) | Sets the headset_volume, defaults to 5 |
handset_sidetone_db | Integer, e.g. -25 | Sets the gain, in negative dBs, for sidetone presented on the phone's handset. Defaults to -25. Digium cautions against changing this value. |
headset_sidetone_db | Integer, e.g. -15 | Sets the gain, in negative dBs, for sidetone presented on the phone's headset. Defaults to -15. Digium cautions against changing this value. |
reset_call_volume | boolean | If 1, volume changes made during a call do not persist to the next call, defaults to 0 |
active_ringtone | Tone ID from <tones> provided to phone | Sets the current user-selected ringtone, defaults to Digium |
Preferences (Answering Calls)
Option | Values | Description |
---|---|---|
headset_answer | boolean | Sets whether to use the headset, rather than the speaker, for answering all calls, defaults to 0 |
ring_headset_only | boolean | Sets whether or not to play ringing tone out the headset, defaults to 0 |
call_waiting_tone | boolean | Enabled by default, if disabled, the phone phone will not playback the call-waiting tone |
ehs | auto, jabra_iq, plantronics | Defines the Electronics Hookswitch type to support |
Contacts
Option | Values | Description |
---|---|---|
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. |
contacts_max_subscriptions | integer, e.g. 40 | Sets the maximum number of SUBSCRIBEs the phone will perform for contacts |
name_format | first_last, last_first | Formats the display of contact names, defaults to first_last |
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 |
Network (IP Settings)
Option | Values | Description |
---|---|---|
network_enable_dhcp | boolean | Disable or Enable DHCP network configuration, defaults to 1 |
network_static_ip_address | IPv4 address | Defines the network address for the phone |
network_subnet_mask | IPv4 netmask | Defines the netmask for the phone |
network_default_gateway | IPv4 address | Defines the network gateway for the phone |
network_primary_dns_server | IPv4 address | Defines the primary DNS server for the phone |
network_secondary_dns_server | IPv4 address | Defines the secondary DNS server for the phone |
Network (Virtual LAN)
Option | Values | Description |
---|---|---|
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 |
network_vlan_id | integer (0-4095) | Sets the VLAN ID |
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 |
Network (Interfaces)
Option | Values | Description |
---|---|---|
lan_port_mode | auto, 10hd, 10fd, 100hd, 100fd, 1000fd | Sets the port speed for the phone's LAN port. "auto" will perform auto-negotiation. |
pc_port_mode | auto, 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." |
Logging
Option | Values | Description |
---|---|---|
log_level | error, warning, debug, information | Sets the logging level, defaults to error |
log_server | IPv4 address of syslog server | Specifies remote syslog server |
log_port | port as integer | Specifies port of remote syslog server |
enable_logging | boolean | Disables or Enables remote syslog, defaults to 0 |
Miscellaneous
Option | Values | Description |
---|---|---|
web_ui_enabled | boolean | Disables, Enables the phone's web user interface, defaults to 1 (Enabled) |
sip_qos | integer (0-7) | Defaults to 3. Sets the SIP signaling QOS level |
rtp_qos | integer (0-7) | Defaults to 6. Sets the RTP media QOS level |
pc_qos | integer (0-7) | No default. Sets the QOS level for traffic from the PC port to the LAN port |
sip_dscp | integer (0-63) | Specifies the DSCP field of the DiffServ byte for SIP Signaling QoS, defaults to 24 |
rtp_dscp | integer (0-63) | Specifies the DSCP field of the DiffServ byte for RTP Media QoS, defaults to 46 |
802.1X
Option | Values | Description |
---|---|---|
8021x_passthrough | boolean | Enables or disables pass-through of EAPOL packets from the PC port to the LAN port, defaults to 0 |
8021x_eapol_on_disconnect | boolean | Enables or disables sending of EAPOL disconnect on behalf of PC-port attached device when disconnected, defaults to 0 |
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). |
8021x_identity | null, string | Sets the 802.1X authentication identifier (username), defaults to null (none). |
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 |
8021x_password | null, string | Sets the 802.1X authentication password, defaults to null (none) |
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) |
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) |
8021x_debug | null, -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. Defaults to null (none) |
OpenVPN
Option | Values | Description | Models |
---|---|---|---|
network_default_enable_openvpn | boolean | When enabled, instructs the phone to perform the VPN connection on startup. Defaults to disabled. | D60, D62, D65 |
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) | D60, D62, D65 |
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) | D60, D62, D65 |
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) | D60, D62, D65 |
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) | D60, D62, D65 |
Keymap Elements
Keymap Elements control the functionality of softkeys during various phone states.
Option | Values | Description |
---|---|---|
state | id as one of:
| Sets the phone state to which this soft key mapping should apply. |
key | id as integer, beginning with 0 action as one of:
| 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. |
Contacts Element
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 |
---|---|---|
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 |
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>
Option | Values | Description |
---|---|---|
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 |
Accounts Element
Option | Values | Description |
---|---|---|
server_uuid | String | Specifies a unique identifier for the server |
index | integer (0-5) | Defines the line key to which the account will be mapped |
status | boolean | Enables the line key; if false, will not display the line on the phone or register with the primary host |
register | boolean | If 1, then this account will attempt to register with the primary host |
account_id | string | SIP username |
username | string | SIP username |
authname | string | SIP authname |
password | string | SIP password |
passcode | string | SIP password |
line_label | string | The text that shows up next to the line key for this account |
caller_id | Name <Number> | Outgoing caller id displayed for this account |
dial_plan | Digit mapping, see Dial Plans | The dial plan / digit mapping for this account |
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. |
voicemail | digits or SIP URI | A SIP URI or extension to be dialed for voicemail pertaining to this account. |
needMwiSubscription | boolean | Defines whether or not a phone should subscribe for MWI on this account. |
outbound_proxy | IP address / Hostname | Outbound proxy for this account |
outbound_port | port | Port for the outbound proxy |
plar_number | string | If defined, the phone will dial the configured string as a URI when the account is taken off-hook. |
ring_type | normal, answer, ring-answer, visual | Allows control over the default ringing type for this account in the absence of any explicit Alert-Info header. Defaults to normal. |
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 | |
port | integer (1-65535) | Sets the server's SIP port | |
transport | udp, tcp, tls | Sets the transport type, UDP or TCP, TLS | TLS for D6x only |
media_encryption | null, sdes | Sets the media_encryption method, none or SDES, defaults to null (none). | SDES for D6x only |
reregister | integer in seconds | Sets the re-registration interval | |
retry | integer | Specifies the number of time to attempt re-registration if registration fails | |
num_retries | integer | Specifies the number of retries to attempt if registration fails |
Host Alternate: Child Element of <account>
Option | Values | Description |
---|---|---|
server | Hostname or IPv4 Address | Sets the server to which calls for this account are directed in the event that host_primary is unreachable |
port | integer (1-65535) | Sets the server's SIP port |
transport | udp, tcp | Sets the transport type, UDP or TCP |
reregister | integer in seconds | Sets the re-registration interval |
retry | integer | Specifies the number of time to attempt re-registration if registration fails |
num_retries | integer | Specifies the number of retries to attempt if registration fails |
Permission: Child Element of <account>
Defines line/account based permissions for various phone functions with an id and value pair.
Option | Values | Description |
---|---|---|
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. |
Networks Element
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 |
---|---|---|
id | integer | Unique, numbered identifier for the network |
display_name | string | A named identifier for the network |
cidr | CIDR formatted address | A CIDR formatted network address, e.g. 10.0.0.0/8 |
Codecs Element
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 |
---|---|---|
id | PCMU, PCMA, G722, G7221, G726-32, opus, G729, iLBC, L16, L16-256 | A codec supported by the phone |
priority | integer (1-255) | Priority of the codec where higher numbers mean the codec is more favored |
packetization | integer in 10ms increments per RFC codec guidelines | Packetization (ptime) rate for the specified codec, defaults to 20 |
jitter_min | integer in ms | Sets the minimum size of the codec jitter buffer |
jitter_max | integer in ms | Sets the maximum size of the codec jitter buffer |
jitter_target | integer in ms | Sets the target size of the codec jitter buffer |
enabled | boolean | Disables / Enables a codec |
complexity | integer, 1-10 | Defines the encoding complexity for the Opus codec. Higher (10) numbers require more CPU time but produce better sounding audio. Defaults to 10. |
samplerate | Depends on codec: nb, wb, uwb | Sets 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. |
bitrate | Applies to G.722.1 & G.722.1C, licensed by Polycom ®, codecs: 24000, 32000, 48000 | Sets 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.1 |
use_vbr | boolean | Applies to the Opus codec. Sets whether to use a constant or variable bitrate encoder. Defaults to disabled (constant bitrate). |
Ringtones Element
This section has two primary child elements:
- tones, which are the actual sounds heard when a call is made
- alerts, which map to a tone and represent a certain call condition
Tones: Child element of <ringtones>
Element lists the <tone> elements, each described by the following attributes:
Option | Values | Description |
---|---|---|
id | string | Internal Tone identifier |
display | string | External Tone Description |
url | URL string | Location from which to retrieve a 16-bit, 16kHz, mono raw signed linear sound file, less than 1MB in size |
md5 | md5sum | MD5 sum of the file to be retrieved |
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 |
Alerts: Child element of <ringtones>
- 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 |
---|---|---|
alert_info | string | The alert_info header that, as received, applies to this alert |
ringtone_id | string | The id of the ring tone for this alert |
ring_type | normal, answer, ring-answer, visual | The type of call-answer to affect for this alert. |
Firmwares Element
- 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 |
---|---|---|
model | D40, D50, D70 | Model number of the Digium phone |
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 |
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 |
Public Firmwares Element
- 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 |
---|---|---|
model | D40, D50, D70 | Model number of the Digium phone |
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 |
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 |
Appconfig Element
- Element lists the <appconfig> elements
Display Rules: Child Element of <appconfig> for contacts application
Option | Values | Description |
---|---|---|
id | unique id | A unique identifier for this display_rule, e.g. 0, 1, 2, etc. |
action_id | A valid action as defined in the phone's Contacts file | Sets the action_id for the display rule to act upon |
phone_state | idle, hold, transfer, incoming/transfer, incoming, connected, dialing, calling, failed | Defines 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. |
target_status | unknown, idle, on_hold, ringing, on_the_phone | Optional. Sets the status of the subscribed to contact that must be matched for this display rule to be in effect |
show | Boolean | If 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. |
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
- 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 |
---|---|---|
id | string | A unique identifier for the listener, required |
name | string | A name to be provided in the phone's announcement status bar when audio is received over this listener, required |
addr | IPv4 address | Multicast address to which phone should subscribe for audio, required |
port | Valid integer for ports (1-65535) | Port, combined with address above, to which phone should subscribe for audio, required |
priority | integer, 1-10 | Prioritization level, lower given more priority, for playing back streams when more than one subscribed address is providing audio, required |
interrupt_callers | boolean | When enabled, places any in-progress calls on hold before playing back audio. When disabled, in-progress calls will have their audio played over. Defaults to 0. |
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