Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
A Complete XML Configuration Example
A Complete XML Configuration Example
Code Block
xml
xml
borderStylesolid
titleA Complete XML Configuration Example
<?xml version="1.0" ?>
<config>
    <setting id="config_server_url" value="sip:proxy@server.example.com:5060;transport=udp" />
    <setting id="pbx_credentials" value="1" account_id="1234" host="server.example.com" user="1234" pass="my password" />
    <setting id="login_password" value="789" />
    <setting id="use_secure_labels" value="0" />
    <setting id="send_mac_with_useragent" value="0" />
    <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="ntp_prefer_option42" value="1" />
    <setting id="accept_local_calls" value="any" />
    <setting id="compact_sip_headers" value="0" />
    <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="transport_tls_allowed" value="1" />
    <setting id="transport_tls_port" value="5061" />
    <setting id="enable_ice" value="0" />
    <setting id="stunaddr" value="" />
    <setting id="tls_allow_wildcard_certs" value="1" />
    <setting id="udp_ka_interval" value="60"/>
    <setting id="logo_file" value="user" path="/user_image.png" url="https://server.example.com/mylogo.png" md5="126cd744583eeea1ab7e44ed8af3d39c" />
    <setting id="wallpaper_file" value="user" path="/user_wallpaper.png" url="https://server.example.com/wallpaper.png" md5="126cd744583eeea1ab7e44ed8af3d39d" />
    <setting id="display_mc_notification" value="1" />
    <setting id="display_pickup_notification" value="1" />
    <setting id="prefer_dialpad_over_incoming" value="0" />
    <setting id="hide_completed_elsewhere" value="0" />
    <setting id="small_clock" value="0" />
    <setting id="idle_company_text" value="" />
    <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="blf_page_return_timeout" value="0" />
    <setting id="default_fontsize" value="10" />
    <setting id="locale" value="en_US" />
    <setting id="time_short_format" value="h:mm a" />
    <setting id="date_short_format" value="M/d/yy" />
    <setting id="date_time_format" value="{1}, {0}" />
    <setting id="idle_screen_clock_format" value="{0} EEE, MMM d" />
    <setting id="ringer_volume" value="5" />
    <setting id="lock_ringing_volume" value="0" />
    <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="active_ringtone" value="Digium" />
    <setting id="headset_answer" value="0" />
    <setting id="ring_headset_only" value="0" />
    <setting id="call_waiting_tone" value="1" />
    <setting id="ehs" value="auto" />
    <setting id="call_control_checkx" value="0" />
    <setting id="parking_lot_extension" value="700" />
    <setting id="parking_lot_enable_blind_transfer" value="0" />
    <setting id="enable_blf_on_unused_line_keys" value="0" />
    <setting id="contacts_max_subscriptions" value="40" />
    <setting id="name_format" value="first_last" />
    <setting id="blf_contact_group" value="Default" />
    <setting id="use_call_photos" value="0" url="https://user:password@server.example.com/photos?did=" />
    <setting id="expansion_enable" value="0" type="EXP100" page_indicators="0" />
    <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_disable_arping" value="0" />
    <setting id="allow_insecure_ssl" value="0" />
    <setting id="network_ipv6_enabled" value="0"/>
    <setting id="network_ipv6_preferred" value="0"/>
    <setting id="network6_static_ip_address" value=""/>
    <setting id="network6_mask" value=""/>
    <setting id="network6_default_gateway" value=""/>
    <setting id="enable_tcp_sack" value="0" />
    <setting id="network_vlan_discovery_mode" value="NONE" />
    <setting id="network_vlan_id" value="44" />
    <setting id="pc_vlan_id" value="10" />
    <setting id="lan_port_mode" value="auto" />
    <setting id="pc_port_mode" value="auto" />
    <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_qos" value="3" />
    <setting id="rtp_qos" value="6" />
    <setting id="pc_qos" value="1" />
    <setting id="sip_dscp" value="24" />
    <setting id="rtp_dscp" value="46" />
    <setting id="rtp_start_port" value="4000" />
    <setting id="in_switchvox_environment" value="0" />
    <setting id="server_environment" value="" />
    <setting id="allow_app_dev" value="0" />
    <setting id="handshake_timeout" value="86400" />
    <setting id="retransmit_until_response" value="0" />
    <setting id="8021x_passthrough" value="0"/>
    <setting id="8021x_eapol_on_disconnect" value="0"/>
    <setting id="8021x_method" value=""/>
    <setting id="8021x_identity" value=""/>
    <setting id="8021x_anonymous_identity" value=""/>
    <setting id="8021x_password" value=""/>
    <setting id="8021x_client_key" value="my-client-key"/>
    <setting id="8021x_client_cert" value="my-client-cert"/>
    <setting id="8021x_debug" value="" />
    <setting id="network_default_enable_openvpn" value="0" />
    <setting id="openvpn_root_cert" url="https://user:password@server.example.com/vpn/ca.crt" value="ca.crt" />
    <setting id="openvpn_inline_config" url="https://user:password@server.example.com/vpn/client.ovpn" value="1" md5="abc123" />
    <setting id="rtapi_server_url" value="wss://server.example.com:443/rtapi/socket.io" />
    <events>
        <event id="digium.incomingCall.voicemail" action="app" />
        <event id="digium.parkingLot.parked" action="app" />
    </events>
    <keymap>
        <state id="idle">
            <softkeys>
                <key id="0" action="missed_or_call_log"/>
                <key id="1" action="show_application" label1="_CONTACTS">
                    <arg>contacts</arg>
                </key>
                <key id="2" action="status"/>
                <key id="3" action="info"/>
                <key id="4" action="forward_calls" label1="_FORWARD"/>
                <key id="5" action="menu"/>
            </softkeys>
        </state>
        <state id="hold">
            <softkeys>
                <key id="0" action="resume"/>
                <key id="1" action="none"/>
                <key id="2" action="none"/>
                <key id="3" action="end_call"/>
            </softkeys>
        </state>
        <state id="hold/transfer">
            <softkeys>
                <key id="0" action="resume"/>
                <key id="1" action="show_application" label1="_CONTACTS">
                    <arg>contacts</arg>
                </key>
                <key id="2" action="none"/>
                <key id="3" action="cancel_call"/>
            </softkeys>
        </state>
        <state id="hold/conference">
            <softkeys>
                <key id="0" action="resume"/>
                <key id="1" action="split_conference"/>
                <key id="2" action="none"/>
                <key id="3" action="end_call"/>
            </softkeys>
        </state>
        <state id="hold/preconference">
            <softkeys>
                <key id="0" action="resume"/>
                <key id="1" action="show_application" label1="_CONTACTS">
                    <arg>contacts</arg>
                </key>
                <key id="2" action="none"/>
                <key id="3" action="end_call"/>
            </softkeys>
        </state>
        <state id="incoming">
            <softkeys>
                <key id="0" action="accept_call"/>
                <key id="1" action="reject_call"/>
                <key id="2" action="transfer_call"/>
            </softkeys>
        </state>
        <state id="incoming/transfer">
            <softkeys>
                <key id="0" action="show_application" label1="_CONTACTS">
                    <arg>contacts</arg>
                </key>
                <key id="1" action="none"/>
                <key id="2" action="none"/>
                <key id="3" action="cancel_call"/>
            </softkeys>
        </state>
        <state id="connected">
            <softkeys>
                <key id="0" action="conference"/>
                <key id="1" action="none"/>
                <key id="2" action="none"/>
                <key id="3" action="end_call"/>
            </softkeys>
        </state>
        <state id="connected/conference">
            <softkeys>
                <key id="0" action="none"/>
                <key id="1" action="split_conference"/>
                <key id="2" action="none"/>
                <key id="3" action="end_call"/>
            </softkeys>
        </state>
        <state id="connected/transfer">
            <softkeys>
                <key id="0" action="transfer_call"/>
                <key id="1" action="none"/>
                <key id="2" action="none"/>
                <key id="3" action="end_call"/>
            </softkeys>
        </state>
        <state id="dial">
            <softkeys>
                <key id="0" action="toggle_url_number"/>
                <key id="1" action="show_application" label1="_CONTACTS">
                    <arg>contacts</arg>
                </key>
                <key id="2" action="none"/>
                <key id="3" action="cancel_call"/>
            </softkeys>
        </state>
        <state id="dial/conference">
            <softkeys>
                <key id="0" action="none"/>
                <key id="1" action="show_application" label1="_CONTACTS">
                    <arg>contacts</arg>
                </key>
                <key id="2" action="none"/>
                <key id="3" action="cancel_call"/>
            </softkeys>
        </state>
        <state id="dial/transfer">
            <softkeys>
                <key id="0" action="none"/>
                <key id="1" action="show_application" label1="_CONTACTS">
                    <arg>contacts</arg>
                </key>
                <key id="2" action="none"/>
                <key id="3" action="cancel_call"/>
            </softkeys>
        </state>
        <state id="dialing">
            <softkeys>
                <key id="0" action="make_call"/>
                <key id="1" action="backspace"/>
                <key id="2" action="none"/>
                <key id="3" action="cancel_call"/>
            </softkeys>
        </state>
        <state id="dialing/conference">
            <softkeys>
                <key id="0" action="make_call"/>
                <key id="1" action="show_application" label1="_CONTACTS">
                    <arg>contacts</arg>
                </key>
                <key id="2" action="backspace"/>
                <key id="3" action="cancel_call"/>
            </softkeys>
        </state>
        <state id="dialing/transfer">
            <softkeys>
                <key id="0" action="transfer_call"/>
                <key id="1" action="make_call"/>
                <key id="2" action="backspace"/>
                <key id="3" action="cancel_call"/>
            </softkeys>
        </state>
        <state id="failed">
            <softkeys>
                <key id="0" action="none"/>
                <key id="1" action="none"/>
                <key id="2" action="none"/>
                <key id="3" action="clear_call"/>
            </softkeys>
        </state>
        <state id="calling">
            <softkeys>
                <key id="0" action="none"/>
                <key id="1" action="none"/>
                <key id="2" action="none"/>
                <key id="3" action="end_call"/>
            </softkeys>
        </state>
    </keymap>
    <contacts url="https://server.example.com/myfile.xml" id="internal" md5="abcd123" />
    <smart_blf>
        <blf_items url="http://server.example.com/myblfitems.xml" />
    </smart_blf>
    <accounts>
        <account server_uuid="0" 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" needMwiSubscription="1" plar_number="" ring_type="normal" subscription_extension="auto_hint_100" mwi_subscription_uri-"" conflict="replace">
            <host_primary server="10.10.2.108" port="" transport="udp" media_encryption="" reregister="300" retry="25">
                <outbound_proxy server="" port="" transport="" />
            </host_primary>
            <host_alternate server="10.1.2.3" port="" transport="udp" media_encryption="" reregister="300" retry="25" authname="" password="" />
                <outbound_proxy server="" port="" transport="" />
            </host_alternate>
            <permission id="record_own_calls" value="0" />
            <setting id="use_call_log_api" value="0" />
            <setting id="call_log_fetch_entries" value="50" />
            <setting id="parking_lot_extension" value="700" />
            <setting id="parking_lot_enable_blind_transfer" value="0" />
            <permission id="use_voicemail" value="1" />
            <permission id="send_to_voicemail" value="1" />
            <permission id="ignore_calls" value="1" />
        </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" enabled="1" />
        <codec id="PCMA" priority="13" packetization="20" enabled="1" />
        <codec id="G722" priority="11" packetization="20" enabled="1" />
        <codec id="G7221" priority="10" packetization="20" enabled="1" samplerate="uwb" bitrate="48000" /> 
        <codec id="G726-32" priority="7" packetization="20" enabled="1" />
        <codec id="opus" priority="6" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" complexity="10" samplerate="wb" use_vbr="0" />
        <codec id="G729" priority="5" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
        <codec id="iLBC" priority="4" packetization="30" 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="bluetooth" />
        <application id="voicemail" />
        <application id="parking" />
        <application id="status" />
        <application id="contacts" />
        <application id="queues" />
        <application id="call_log" />
        <application id="forward_calls" />
        <application id="hotdesking" />
        <application id="conferences" />
        <auto_start />
    </appconfig>
    <appconfig id="phonemenu">
      <auto_start />
    </appconfig>
    <appconfig id="contacts">
        <account account_id="101" username="101" password="1234" appserver="dasp://server.example.com/json" apiformat="json"/>
        <display_rules>
            <display_rule id="0" action_id="monitor" show="0"/>
            <display_rule id="1" action_id="monitor" target_status="on_the_phone" show="1"/>
            <display_rule id="2" action_id="intercom" show="0"/>
            <display_rule id="3" action_id="intercom" target_status="idle" show="1"/>
            <display_rule id="4" action_id="dial_vm" phone_state="idle" show="0"/>
            <display_rule id="5" action_id="transfer_vm" show="0"/>
            <display_rule id="6" action_id="transfer_vm" phone_state="transfer" show="1"/>
        </display_rules>
        <settings can_transfer_vm="1" name_format="last_first" use_local_storage="0" preferred_contact_group="" />
        <settings in_switchvox_environment="0" />
        <auto_start />
    </appconfig>
    <appconfig id="status">
        <account account_id="101" username="101" password="1234" appserver="dasp://server.example.com/json" apiformat="json"/>
        <send_dnd status="" />
        <auto_start />
        <full_application />
    </appconfig>
    <appconfig id="queues">
        <account account_id="101" username="101" password="1234" appserver="dasp://server.example.com/json" apiformat="json"/>
        <auto_start />
    </appconfig>
    <appconfig id="parking">
        <account account_id="101" username="101" password="1234" appserver="dasp://server.example.com/json" apiformat="json"/>
        <auto_start />
    </appconfig>
    <appconfig id="voicemail">
        <account account_id="101" username="101" password="1234" appserver="dasp://server.example.com/json" apiformat="json"/>
        <settings require_password="0" />
        <auto_start />
    </appconfig>
    <appconfig id="hotdesking" use_pbx_credentials="1" status="logged_in">
        <account account_id="000000000000" username="000000000000" appserver="https://server.example.com/json" apiformat="json"/>
    </appconfig>
    <appconfig id="conferences">
        <enabled />
        <default_bridge pin="1234"/>
    </appconfig>
    <appconfig id="call_log">
        <account account_id="101" username="101" password="1234" appserver="dasp://server.example.com/json" apiformat="json"/>
        <enabled />
    </appconfig>
    <appconfig id="mycustomapp">
        <url url="http://server.example.com/myapp.zip" />
        <settings mysettinga="1" mysettingb="2" mysettingc="telephone" />
    </appconfig>
    <firmwares>
        <firmware model="D40" version="2_8_0" url="http://10.10.4.11/firmware/2_8_0_D40_firmware.eff" />
        <firmware model="D45" version="2_8_0" url="http://10.10.4.11/firmware/2_8_0_D45_firmware.eff" />
        <firmware model="D50" version="2_8_0" url="http://10.10.4.11/firmware/2_8_0_D50_firmware.eff" />
        <firmware model="D60" version="2_8_0" url="http://10.10.4.11/firmware/2_8_0_D60_firmware.eff" />
        <firmware model="D62" version="2_8_0" url="http://10.10.4.11/firmware/2_8_0_D62_firmware.eff" />
        <firmware model="D65" version="2_8_0" url="http://10.10.4.11/firmware/2_8_0_D65_firmware.eff" />
        <firmware model="D70" version="2_8_0" url="http://10.10.4.11/firmware/2_8_0_D70_firmware.eff" />
        <firmware model="D80" version="2_8_0" url="http://10.10.4.11/firmware/2_8_0_D80_firmware.eff" />
        <firmware model="EXP100" version="2.0.5.1" url="http://10.10.4.11/firmware/EXP100-2051.rom" />
    </firmwares>
    <public_firmwares>
        <public_firmware model="D40" version="2_8_0" url="http://firmware.example.com/firmware/2_8_0_D40_firmware.eff" />
        <public_firmware model="D45" version="2_8_0" url="http://firmware.example.com/firmware/2_8_0_D45_firmware.eff" />
        <public_firmware model="D50" version="2_8_0" url="http://firmware.example.com/firmware/2_8_0_D50_firmware.eff" />
        <public_firmware model="D60" version="2_8_0" url="http://firmware.example.com/firmware/2_8_0_D60_firmware.eff" />
        <public_firmware model="D62" version="2_8_0" url="http://firmware.example.com/firmware/2_8_0_D62_firmware.eff" />
        <public_firmware model="D65" version="2_8_0" url="http://firmware.example.com/firmware/2_8_0_D65_firmware.eff" />
        <public_firmware model="D70" version="2_8_0" url="http://firmware.example.com/firmware/2_8_0_D70_firmware.eff" />
        <public_firmware model="D80" version="2_8_0" url="http://firmware.example.com/firmware/2_8_0_D80_firmware.eff" />
        <public_firmware model="EXP100" version="2.0.5.1" url="http://firmware.example.com/firmware/2.0.5.1/EXP100-2051.rom" />
    </public_firmwares>
    <multicastpage>
        <listener id="1" extension="" name="SomePage" addr="239.0.0.1" port="32000" priority="1" interrupt_calls="0"/>
        <listener id="2" extension="" name="All Page" addr="239.0.0.2" port="32000" priority="2" interrupt_calls="1"/>
    </multicastpage>
    <certs>
        <cert id="1" label="my-ca" md5="abc123">MIICXQIBAAKB...XYZ</cert>
        <clientcert id="1" label="my-client-cert" md5="abc123">MIICXQIBAAKB...XYZ</clientcert>
        <clientkey id="1" label="my-client-key" type="RSA" md5="abc123">MIICXQIBAAKB...XYZ</clientkey>
    </certs>
    <activity_indicator>
        <setting id="idle" color="amber" state="off" />
        <setting id="default" color="amber" state="off" />
        <setting id="hold" color="red" state="slow" />
        <setting id="ringing" color="green" state="fast" />  
        <setting id="active" color="green" state="on" />
        <setting id="new_vm" color="red" state="slow" />
        <setting id="listen_vm" color="red" state="on" />
        <setting id="leaving_vm" color="amber" state="slow" />
        <setting id="screen_vm" color="amber" state="on" />
        <setting id="announcement" color="amber" state="fast" />
    </activity_indicator>
    <use_proxy_for network="10.10.0.0/20" network_id="1" host="10.1.2.3" use="0" />
</config>

...

Expand
Accounts Element Example
Accounts Element Example
Code Block
xml
xml
borderStylesolid
titleAccounts Element Example
<?xml version="1.0" ?>
<config>
    <accounts>
        <account server_uuid="0" 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" needMwiSubscription="1" plar_number="" ring_type="normal" subscription_extension="100" mwi_subscription_uri="" conflict="replace">
            <host_primary server="10.10.2.108" port="5060" transport="udp" media_encryption="" reregister="300" retry="25">
                <outbound_proxy server="" port="" transport="" />
            </host_primary>
            <host_alternate server="10.1.2.3" port="5060" transport="udp" media_encryption="" reregister="300" retry="25" />
                <outbound_proxy server="" port="" transport="" />
            </host_alternate>
            <permission id="record_own_calls" value="0" />
            <setting id="use_call_log_api" value="0" />
            <setting id="call_log_fetch_entries" value="50" />
            <setting id="parking_lot_extension" value="700" />
            <setting id="parking_lot_enable_blind_transfer" value="1" />
            <permission id="use_voicemail" value="1" />
            <permission id="send_to_voicemail" value="1" />
            <permission id="ignore_calls" value="1" />
        </account>
    </accounts>
</config>

Option

Values

Description

Models
server_uuidNon-zero String

Specifies a unique identifier for the server.

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

index

integer (0-5)

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

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

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

status

boolean

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

Defaults to 0.

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

register

boolean

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

Defaults to 0.

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

account_id

string

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

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

username

string

SIP username

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

authname

string

SIP authname

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

password

string

SIP password

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

passcode

string

SIP password

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

line_label

string

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

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

caller_id

Name <Number>

Outgoing caller id displayed for this account

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

dial_plan

Digit mapping, see XML Configuration 2.9.15+

The dial plan / digit mapping for this account

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

visual_voicemail

boolean

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

Defaults to 0.

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

voicemail

digits or SIP URI

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

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

needMwiSubscription

boolean

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

Defaults to 0.

D40, D45, D50, D60, D62, D65, D70, D80 (tick)
plar_numberstringIf defined, the phone will dial the configured string as a URI when the account is taken off-hook.

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

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

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

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

D80 (error)

subscription_extensionstringFor DPMA-connected phones, defines the user-part to which the phone should subscribe for presence updatesD40, D45, D50, D60, D62, D65, D70, D80 (tick)
mwi_subscription_uriSIP URI e.g.: sip:mailbox@hostIf empty, subscribe to the primary_host using the ISP username. If non-empty, allows definition of the URI for MWI subscriptionD60, D62, D65 (2_9_15)

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 in the event that host_primary is unreachable

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

port

empty, or integer (1-65535)

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

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

transport

udp, tcp, tls

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

D40, D45, D50, D60, D62, D65, D70, D80 (1_10_0 TCP, 1_12_0 TLS) (tick)

reregister

integer in seconds

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

Defaults to 300.

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

retry

integer

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

Defaults to 25.

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

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), D80 (1_10_0) (tick)

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), D80 (1_10_0) (tick)

Outbound Proxy: Child Element of

...

<host_primary> and/or <host_alternate>

Option

Values

Description

Models

server

Hostname or IP Address

Outbound proxy for this account.

D40D60, D45, D50, D62, D65 (2_9_15)

port

empty, or integer (1-65535)

Port for the outbound proxy

D60, D62, D65 (2_9_15)

transportudp, tcp, tlsSIP Transport for the outbound proxyD60, D62, D65 (2_9_15)

Outbound Proxy: Child Element of <account>

Option

Values

Description

Models

server

Hostname or IP Address

Outbound proxy for this account.

D40, D45, D50, D70 (2_8_3), D80 (1_10_3) (tick)
D60, D62, D65 as of 2_8_3; however, as of 2_9_15 should use child element of <host_primary> and/or <host_alternate> 

port

empty, or integer (1-65535)

Port for the outbound proxy

D40, D45, D50, D60, D62, D65, D70 D50D70 (2_8_3), D80 (1_10_3) (tick)
D60, D62, D65 as of 2_8_3; however, as of 2_9_15 should use child element of <host_primary> and/or <host_alternate> 

Permission: Child Element of <account>

...