Page History

...

Expand

	A Complete XML Configuration Example
	A Complete XML Configuration Example

Code Block

	xml
borderStyle	xml	solid
title	A Complete XML Configuration Examplexml
borderStyle	solid

<?xml version="1.0" ?>
<config>
    <setting id="login_password" value="789" />
    <setting id="time_zone" value="America/Los_Angeles" />
    <setting id="time_source" value="ntp" />
    <setting id="ntp_server" value="0.digium.pool.ntp.org" />
    <setting id="ntp_resync" value="86400" />
    <setting id="accept_local_calls" value="any" />
    <setting id="transport_udp_enabled" value="1" />
    <setting id="transport_udp_port" value="5060" />
    <setting id="transport_tcp_enabled" value="1" />
    <setting id="transport_tcp_port" value="5060" />
    <setting id="logo_file" value="user" path="/user_image.png" url="https://server.example.com/mylogo.png" md5="126cd744583eeea1ab7e44ed8af3d39c" />
    <setting id="display_mc_notification" value="1" />
    <setting id="brightness" value="10" />
    <setting id="contrast" value="10" />
    <setting id="enable_check_sync" value="1"/>
    <setting id="dim_backlight" value="1" />
    <setting id="backlight_timeout" value="30" />
    <setting id="backlight_dim_level" value="2" />
    <setting id="ringer_volume" value="5" />
    <setting id="speaker_volume" value="5" />
    <setting id="handset_volume" value="5" />
    <setting id="headset_volume" value="5" />
    <setting id="reset_call_volume" value="0" />
    <setting id="default_ringtone" value="Digium" />
    <setting id="active_ringtone" value="Digium" />
    <setting id="headset_answer" value="0" />
    <setting id="ehs" value="Plantronics" />
    <setting id="desi_strip_enable" value="1" />
    <setting id="enable_blf_on_unused_line_keys" value="0" />
    <setting id="name_format" value="first_last" />
    <setting id="blf_contact_group" value="Default" />
    <setting id="network_enable_dhcp" value="1" />
    <setting id="network_static_ip_address" value="" />
    <setting id="network_subnet_mask" value="" />
    <setting id="network_default_gateway" value="" />
    <setting id="network_domain_name" value="" />
    <setting id="network_primary_dns_server" value="" />
    <setting id="network_secondary_dns_server" value="" />
    <setting id="network_vlan_discovery_mode" value="NONE" />
    <setting id="network_vlan_qos" value="0" />
    <setting id="network_vlan_id" value="44" />
    <setting id="log_level" value="debug" />
    <setting id="enable_logging" value="0" />
    <setting id="log_server" value="10.1.2.3" />
    <setting id="log_port" value="514" />
    <setting id="web_ui_enabled" value="1" />
    <setting id="sip_dscp" value="24" />
    <setting id="rtp_dscp" value="46" />
    <keymap>
        <state id="incoming">
            <softkeys>
                <key id="0" action="accept_call" />
                <key id="1" action="reject_call" />
                <key id="2" action="transfer_call" />
                <key id="3" action="send_to_vmail" />
            </softkeys>
        </state>
    </keymap>
    <contacts url="https://server.example.com/myfile.xml" id="internal" md5="abcd123" />
    <accounts>
        <account index="0" status="1" register="1" account_id="100" username="100" authname="100" password="100" passcode="100" line_label="100 Alligator" caller_id="100 Alligator" dial_plan="[0-8]xxxxx|911|9411|9611|9011xxx.T3|91xxxxxxxxxx|9[2-9]xxxxxx|*xx.T3|[0-8]xx.T3" visual_voicemail="0" voicemail="sip:800@10.1.2.3" outbound_proxy="" outbound_port="" conflict="replace">
            <host_primary server="10.10.2.108" port="5060" transport="udp" reregister="300" retry="25" num_retries="5" />
            <permission id="record_own_calls" value="0" />
        </account>
    </accounts>
    <networks>
        <network id="1" display_name="Internal" cidr="192.168.8.0/24" />
        <network id="2" display_name="External" cidr="10.0.0.0/8" />
        <network id="3" display_name="All Networks" cidr="0.0.0.0/0" />
    </networks>
    <codecs>
        <codec id="PCMU" priority="255" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
        <codec id="PCMA" priority="13" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
        <codec id="G722" priority="11" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
        <codec id="G726-32" priority="7" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
        <codec id="G729" priority="4" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
        <codec id="L16" priority="2" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
        <codec id="L16-256" priority="1" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1"/>
    </codecs>
    <ringtones>
        <tones>
            <tone id="Alarm" display="Alarm" type="phone"/>
            <tone id="Chimes" display="Chimes" type="phone"/>
            <tone id="Digium" display="Digium" type="phone"/>
            <tone id="GuitarStrum" display="Guitar Strum" type="phone"/>
            <tone id="Jingle" display="Jingle" type="phone"/>
            <tone id="Office" display="Office" type="phone"/>
            <tone id="Office2" display="Office 2" type="phone"/>
            <tone id="RotaryPhone" display="Rotary Phone" type="phone"/>
            <tone id="SteelDrum" display="Steel Drum" type="phone"/>
            <tone id="Techno" display="Techno" type="phone"/>
            <tone id="Theme" display="Theme" type="phone"/>
            <tone id="Tweedle" display="Tweedle" type="phone"/>
            <tone id="Twinkle" display="Twinkle" type="phone"/>
            <tone id="Vibe" display="Vibe" type="phone"/>
        </tones>
        <alerts>
            <alert alert_info="normal" ringtone_id="Digium" ring_type="normal" />
            <alert alert_info="ring-answer" ringtone_id="Digium" ring_type="ring-answer" />
            <alert alert_info="intercom" ringtone_id="" ring_type="answer" />
            <alert alert_info="visual" ringtone_id="" ring_type="visual" />
        </alerts>
    </ringtones>
    <appconfig id="appscreen">
        <application id="contacts" />
    </appconfig>
    <appconfig id="contacts">
        <settings can_transfer_vm="1" name_format="last_first" />
    </appconfig>
    <firmwares>
        <firmware model="D50" version="1_0_3_45441" url="http://10.10.4.11/firmware/1_0_3_45441_D50_firmware.eff" />
        <firmware model="D70" version="1_0_3_45441" url="http://10.10.4.11/firmware/1_0_3_45441_D70_firmware.eff" />
        <firmware model="D40" version="1_0_3_45441" url="http://10.10.4.11/firmware/1_0_3_45441_D40_firmware.eff" />
    </firmwares>
    <public_firmwares>
        <public_firmware model="D50" version="1_0_3_45441" url="http://firmware.example.com/1_0_3_45441_D50_firmware.eff" />
        <public_firmware model="D70" version="1_0_3_45441" url="http://firmware.example.com/1_0_3_45441_D70_firmware.eff" />
        <public_firmware model="D40" version="1_0_3_45441" url="http://firmware.example.com/1_0_3_45441_D40_firmware.eff" />
    </public_firmwares>
</config>

...

Expand

	XML Setting Elements
	XML Setting Elements

Code Block

	xml
borderStyle	xml	solid
title	XML Setting Elementsxml
borderStyle	solid

<?xml version="1.0" ?>
<config>
    <setting id="login_password" value="789" />
    <setting id="time_zone" value="America/Los_Angeles" />
    <setting id="time_source" value="ntp" />
    <setting id="ntp_server" value="pool.ntp.org" />
    <setting id="ntp_resync" value="86400" />
    <setting id="accept_local_calls" value="any" />
    <setting id="transport_udp_enabled" value="1" />
    <setting id="transport_udp_port" value="5060" />
    <setting id="transport_tcp_enabled" value="1" />
    <setting id="transport_tcp_port" value="5060" />
    <setting id="logo_file" value="user" path="/user_image.png" url="https://server.example.com/mylogo.png" md5="126cd744583eeea1ab7e44ed8af3d39c" />
    <setting id="display_mc_notification" value="1" />
    <setting id="brightness" value="10" />
    <setting id="contrast" value="10" />
    <setting id="enable_check_sync" value="1"/>
    <setting id="dim_backlight" value="1" />
    <setting id="backlight_timeout" value="30" />
    <setting id="backlight_dim_level" value="2" />
    <setting id="ringer_volume" value="5" />
    <setting id="speaker_volume" value="5" />
    <setting id="handset_volume" value="5" />
    <setting id="headset_volume" value="5" />
    <setting id="reset_call_volume" value="0" />
    <setting id="default_ringtone" value="Digium" />
    <setting id="active_ringtone" value="Digium" />
    <setting id="headset_answer" value="0" />
    <setting id="ehs" value="Plantronics" />
    <setting id="desi_strip_enable" value="1" />
    <setting id="enable_blf_on_unused_line_keys" value="0" />
    <setting id="name_format" value="first_last" />
    <setting id="blf_contact_group" value="Default" />
    <setting id="network_enable_dhcp" value="1" />
    <setting id="network_static_ip_address" value="" />
    <setting id="network_subnet_mask" value="" />
    <setting id="network_default_gateway" value="" />
    <setting id="network_domain_name" value="" />
    <setting id="network_primary_dns_server" value="" />
    <setting id="network_secondary_dns_server" value="" />
    <setting id="network_vlan_discovery_mode" value="NONE" network="10.10.0.0/16" />
    <setting id="network_vlan_qos" value="0" />
    <setting id="network_vlan_id" value="44" />
    <setting id="log_level" value="debug" />
    <setting id="enable_logging" value="0" />
    <setting id="log_server" value="10.1.2.3" />
    <setting id="log_port" value="514" />
    <setting id="web_ui_enabled" value="1" />
    <setting id="parking_lot_extension" value="700" />
    <setting id="parking_lot_enable_blind_transfer" value="0" />
    <setting id="sip_dscp" value="24" />
    <setting id="rtp_dscp" value="46" />
</config>

...

Expand

	Keymap Element Example
	Keymap Element Example

Code Block

	xml
borderStyle	xml	solid
title	Keymap Element Examplexml
borderStyle	solid

<?xml version="1.0" ?>
<config>
<keymap>
        <state id="incoming">
            <softkeys>
                <key id="0" action="accept_call" />
                <key id="1" action="reject_call" />
                <key id="2" action="transfer_call" />
                <key id="3" action="send_to_vmail" />
            </softkeys>
        </state>
    </keymap>
</config>

...

Expand

	Contacts Element Example
	Contacts Element Example

Code Block

	xml
borderStyle	xml	solid
title	Contacts Element Examplexml
borderStyle	solid

<?xml version="1.0" ?>
<config>
    <contacts url="https://server.example.com/myfile.xml" id="internal" md5="abcd123" />
</config>

...

Expand

	Accounts Element Example
	Accounts Element Example

Code Block

	xml
borderStyle	xml	solid
title	Accounts Element Examplexml
borderStyle	solid

<?xml version="1.0" ?>
<config>
    <accounts>
        <account index="0" status="1" register="1" account_id="100" username="100" authname="100" password="100" passcode="100" line_label="100 Alligator" caller_id="100 Alligator" dial_plan="[0-8]xxxxx|911|9411|9611|9011xxx.T3|91xxxxxxxxxx|9[2-9]xxxxxx|*xx.T3|[0-8]xx.T3"  visual_voicemail="0" voicemail="sip:800@10.1.2.3" outbound_proxy="" outbound_port="" conflict="replace">
            <host_primary server="10.10.2.108" port="5060" transport="udp" reregister="300" retry="25" num_retries="5" />
            <permission id="record_own_calls" value="0" />
        </account>
    </accounts>
</config>

Option	Values	Description
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 #dialplans	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.
outbound_proxy	IP address / Hostname	Outbound proxy for this account
outobund_port	port	Port for the outbound proxy
conflict	replace

...

Expand

	Networks Element Example
	Networks Element Example

Code Block

	xml
borderStyle	xml	solid
title	Networks Element Examplexml
borderStyle	solid

<?xml version="1.0" ?>
<config>
    <networks>
        <network id="1" display_name="Internal" cidr="192.168.8.0/24" />
        <network id="2" display_name="External" cidr="10.0.0.0/8" />
        <network id="3" display_name="All Networks" cidr="0.0.0.0/0" />
    </networks>
</config>

...

Expand

	Codecs Element Example
	Codecs Element Example

Code Block

	xml
borderStyle	xml	solid
title	Codecs Element Examplexml
borderStyle	solid

<?xml version="1.0" ?>
<config>
    <codecs>
        <codec id="PCMU" priority="255" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
        <codec id="PCMA" priority="13" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
        <codec id="G722" priority="11" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
        <codec id="G726-32" priority="7" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
        <codec id="G729" priority="4" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
        <codec id="L16" priority="2" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
        <codec id="L16-256" priority="1" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1"/>
    </codecs>
</config>

...

Expand

	Tones Element Example
	Tones Element Example

Code Block

	xml
borderStyle	xml	solid
title	Tones Element Examplexml
borderStyle	solid

<?xml version="1.0" ?>
<config>
    <ringtones>
        <tones>
            <tone id="Alarm" display="Alarm" type="phone"/>
            <tone id="Chimes" display="Chimes" type="phone"/>
            <tone id="Digium" display="Digium" type="phone"/>
            <tone id="GuitarStrum" display="Guitar Strum" type="phone"/>
            <tone id="Jingle" display="Jingle" type="phone"/>
            <tone id="Office" display="Office" type="phone"/>
            <tone id="Office2" display="Office 2" type="phone"/>
            <tone id="RotaryPhone" display="Rotary Phone" type="phone"/>
            <tone id="SteelDrum" display="Steel Drum" type="phone"/>
            <tone id="Techno" display="Techno" type="phone"/>
            <tone id="Theme" display="Theme" type="phone"/>
            <tone id="Tweedle" display="Tweedle" type="phone"/>
            <tone id="Twinkle" display="Twinkle" type="phone"/>
            <tone id="Vibe" display="Vibe" type="phone"/>
            <tone id="208" display="Fancy" url="http://10.1.2.3/mytone.sln" md5="abc123" type="user"/>
        </tones>
    </ringtones>
</config>

...

Expand

	Alerts Element Example
	Alerts Element Example

Code Block

	xml
borderStyle	xml	solid
title	Alerts Element Examplexml
borderStyle	solid

<?xml version="1.0" ?>
<config>
    <ringtones>
        <alerts>
            <alert alert_info="normal" ringtone_id="Digium" ring_type="normal" />
            <alert alert_info="ring-answer" ringtone_id="Digium" ring_type="ring-answer" />
            <alert alert_info="intercom" ringtone_id="" ring_type="answer" />
            <alert alert_info="visual" ringtone_id="" ring_type="visual" />
        </alerts>
    </ringtones>
</config>

...

Expand

	Firmwares Element Example
	Firmwares Element Example

Code Block

	xml
borderStyle	xml	solid
title	Firmwares Element Examplexml
borderStyle	solid

<?xml version="1.0" ?>
<config>
    <firmwares>
        <firmware model="D50" version="1_0_3_45441" url="http://10.10.4.11/firmware/1_0_3_45441_D50_firmware.eff" />
        <firmware model="D70" version="1_0_3_45441" url="http://10.10.4.11/firmware/1_0_3_45441_D70_firmware.eff" />
        <firmware model="D40" version="1_0_3_45441" url="http://10.10.4.11/firmware/1_0_3_45441_D40_firmware.eff" />
    </firmwares>
</config>

...

Expand

	Public Firmwares Element Example
	Public Firmwares Element Example

Code Block

	xml
borderStyle	xml	solid
title	Firmwares Element Examplexml
borderStyle	solid

<?xml version="1.0" ?>
<config>
    <public_firmwares>
        <public_firmware model="D50" version="1_0_3_45441" url="http://firmware.example.com/1_0_3_45441_D50_firmware.eff" />
        <public_firmware model="D70" version="1_0_3_45441" url="http://firmware.example.com/1_0_3_45441_D70_firmware.eff" />
        <public_firmware model="D40" version="1_0_3_45441" url="http://firmware.example.com/1_0_3_45441_D40_firmware.eff" />
    </public_firmwares>
</config>

...

Expand

	Appconfig Element Example
	Appconfig Element Example

Code Block

	xml
borderStyle	xml	solid
title	Appconfig Element Examplexml
borderStyle	solid

<?xml version="1.0" ?>
<config>
    <appconfig id="appscreen">
        <application id="contacts" />
    </appconfig>
    <appconfig id="contacts">
        <settings can_transfer_vm="1" name_format="last_first" />
    </appconfig>
</config>

...

Expand

	network_id Attribute Example
	network_id Attribute Example

Code Block

	xml
borderStyle	xml	solid
title	network_id Attribute Examplexml
borderStyle	solid

<?xml version="1.0" ?>
<config>
    <networks>
        <network id="1" display_name="Home" cidr="192.168.8.0/24" />
        <network id="2" display_name="Work" cidr="10.0.0.0/8" />
    </networks>
    <setting id="ntp_server" value="0.digium.pool.ntp.org" network_id="1" />
    <setting id="ntp_server" value="ntp.example.com" network_id="2" />
    <setting id="network_vlan_discovery_mode" value="NONE" network_id="1" />
    <setting id="network_vlan_discovery_mode" value="LLDP" network_id="2" />
    <accounts>
        <account index="0" status="1" register="1" account_id="100" username="100" authname="100" password="100" passcode="100" line_label="100 Alligator" caller_id="100 Alligator" dial_plan="[0-8]xxxxx|911|9411|9611|9011xxx.T3|91xxxxxxxxxx|9[2-9]xxxxxx|*xx.T3|[0-8]xx.T3"  visual_voicemail="0" voicemail="sip:800@10.1.2.3" outbound_proxy="" outbound_port="" conflict="replace">
            <host_primary server="pbx.example.com" port="5060" transport="udp" reregister="300" retry="25" num_retries="5" network_id="1" />
            <host_primary server="10.1.2.3" port="5060" transport="udp" reregister="300" retry="25" num_retries"5" network_id="2" />
            <permission id="record_own_calls" value="0" />
        </account>
    </accounts>
    <contacts url="https://server.example.com/myfile.xml" id="internal" md5="abcd123" network_id="1" />
    <contacts url="https://10.1.2.3/myfile.xml" id="internal" md5="abcd123" network_id="2" />
    <firmware network_id="1">
        <firmware model="D50" version="1_0_3_45441" url="http://server.example.com/firmware/D50.firmware.eff" />
        <firmware model="D70" version="1_0_3_45441" url="http://server.example.com/firmware/D70.firmware.eff" />
        <firmware model="D40" version="1_0_3_45441" url="http://server.example.com/firmware/D40.firmware.eff" />
    </firmwares>
    <firmwares network_id="2">
        <firmware model="D50" version="1_0_3_45441" url="http://10.1.2.3/firmware/D50.firmware.eff" />
        <firmware model="D70" version="1_0_3_45441" url="http://10.1.2.3/firmware/D70.firmware.eff" />
        <firmware model="D40" version="1_0_3_45441" url="http://10.1.2.3/firmware/D40.firmware.eff" />
    </firmwares>
</config>

Versions Compared

Old Version 16

New Version Current

Key