Versions Compared

Version Old Version 3 New Version 4
Changes made by

Malcolm Davenport (Deactivated)

Malcolm Davenport (Deactivated)

Saved on

Key

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

...

Option

Values

Description

Models

config_recheck

value as boolean

idle_time as time, in seconds

days as string format day of week (0-6, 0=Sunday, 6=Saturday)

start_time as integer (hhmm)

hours as integer (1-23)

If value is true, sets phones that are configured using cURL config method (non-DPMA) to perform a periodic configuration request and application to the defined config_server_url. The specific time of the check will be random within the window set by the other parameters of the setting.  Default to 0.

idle_time determines the amount of time in seconds that the phone must be idle before the phone can begin the config pull. If the phone is not idle for this period of time, then the other values will not be evaluated.  Default 600 (10 minutes).

days determines on what days of the week the phone will perform the check.  Default every day.

start_time sets the time at which the check window opens.  Default 2AM.

hours sets the amount of time for which the check window remains open, during which the specific time is randomly calculated.  Default 2 hours.

P310, P315, P320, P325, P330, P370

Events Element

 Events Element Example

Expand
titleEvents Element Example
Code Block
<?xml version="1.0" ?>
<config>
    <events>
        <event id="digium.incomingCall.voicemail" action="app" />
        <event id="digium.parkingLot.parked" action="app" />
    </events>
</config>

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

Option

Values

Description

Models

id

digium.incomingCall.voicemail, digium.parkingLot.parked

Specifies the event that the phone should expect from server. voicemail not supported on P310 or P315

No default.

P310, P315, P320, P325, P330, P370

action

app

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

No default.

P310, P315, P320, P325, P330, P370

Keymap Elements

...

 

Expand
titleKeymap Element Example
Code Block
<?xml version="1.0" ?>
<config>
    <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>
</config>

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

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.

P310, P315, P320, P325, P330

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

      • FindMeFollow

    • arg as one of:

      • contacts

      • voicemail

      • parking

      • status

      • queues

      • findmefollow

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

Queues and voicemail applications not valid for P310 and P315 models.
record_call not valid for P310 and P315 models.

P310, P315, P320, P325, P330

Contacts Element

...

Expand
titleContacts Element Example
Code Block
<?xml version="1.0" ?>
<config>
    <contacts url="https://server.example.com/myfile.xml" id="internal" md5="abcd123" />
</config>

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.

...

BLF Items: Child Element of <smart_blf>

 BLF Items Element Example 

Expand
titleBLF Items Element Example
Code Block
<?xml version="1.0">
<config>
    <smart_blf>
        <blf_items url="http://server.example.com/myblfitems.xml" network_id="mynetwork" md5="abcd123" />
    </smart_blf>
</config>

Option

Values

Description

Models

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. Sangoma phones support basic authentication, so a username and password may be passed in the URL line, e.g. http://user:pass@server.example.com

P310, P315, P320, P325, P330, P370

Accounts Element

...

 

Expand
titleAccounts Element Example
Code Block
<?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" conflict="replace" mwi_subscription_uri="" >
            <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" />
            <setting id="call_rejection_code_dnd" value="486" />
            <setting id="call_rejection_code_ignore" value="603" />
        </account>
    </accounts>
</config>

Option

Values

Description

Models

server_uuid

Non-zero String

Specifies a unique identifier for the server.

P310, P315, P320, P325, P330, P370

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.

P310, P315, P320, P325, P330, P370

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.

P310, P315, P320, P325, P330, P370

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.

P310, P315, P320, P325, P330, P370

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.

P310, P315, P320, P325, P330, P370

username

string

SIP username

P310, P315, P320, P325, P330, P370

authname

string

SIP authname

P310, P315, P320, P325, P330, P370

password

string

SIP password

P310, P315, P320, P325, P330, P370

passcode

string

SIP password

P310, P315, P320, P325, P330, P370

line_label

string

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

P310, P315, P320, P325, P330, P370

caller_id

Name <Number>

Outgoing caller id displayed for this account

P310, P315, P320, P325, P330, P370

dial_plan

Digit mapping, see Dial Plans

The dial plan / digit mapping for this account

P310, P315, P320, P325, P330, P370

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.

P320, P325, P330, P370

voicemail

digits or SIP URI

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

P310, P315, P320, P325, P330, P370

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.

P310, P315, P320, P325, P330, P370

plar_number

string

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

None

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.

None

subscription_extension

string

For DPMA-connected phones, defines the user-part to which the phone should subscribe for presence updates

P310, P315, P320, P325, P330, P370

mwi_subscription_uri

SIP URI e.g.:
sip:mailbox@host 

If empty, subscribe to the host_primary using the SIP username. If non-empty, allows definition of the URI for MWI subscription

P310, P315, P320, P325, P330, P370

...

Option

Values

Description

Models

use_call_log_api

boolean

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

Defaults to 0.

P310, P315, P320, P325, P330, P370

call_log_fetch_entries

integer

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

Defaults to 50.

P310, P315, P320, P325, P330, P370

parking_lot_extension

integer

For Switchvox and DPMA environments, specifies the lot in which a call is transferred using the Park soft key, This option must be defined also, duplicating the phone-level parking_lot_extension setting.

No default.

P310, P315, P320, P325, P330, P370

parking_lot_enable_blind_transfer

boolean

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

Defaults to 0.

P310, P315, P320, P325, P330, P370

call_rejection_code_dnd

integer

Specifies the SIP code to be returned when this account returns DND state on an incoming call.
Defaults to 486
Can also be set globally as a setting

P310, P315, P320, P325, P330, P370
(4_14_0) 

call_rejection_code_ignore

integer

Specifies the SIP code to be returned when the user Ignores an incoming call to this account.
Defaults to 603
Can also be set globally as a setting 

P310, P315, P320, P325, P330, P370
(4_14_0) 

Networks Element

 Networks Element Example 

Expand
titleNetworks Element Example
Code Block
<?xml version="1.0" ?>
<config>
    <networks>
        <network id="network1" display_name="Internal" cidr="192.168.8.0/24" />
        <network id="network2" display_name="External" cidr="10.0.0.0/8" />
        <network id="network3" display_name="All Networks" cidr="0.0.0.0/0" />
    </networks>
</config>

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

...

Option

Values

Description

Models

id

string

Unique identifier for the network

P310, P315, P320, P325, P330, P370

display_name

string

A named identifier for the network

P310, P315, P320, P325, P330, P370

cidr

CIDR formatted address

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

P310, P315, P320, P325, P330, P370

Codecs Element

Expand

...

titleCodecs Element Example
Code Block
languagexml
<?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="opus" priority="6" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" complexity="10" samplerate="wb" use_vbr="1" />
        <codec id="G729" priority="5" packetization="20" jitter_min="0" jitter_max="0" jitter_target="0" enabled="1" />
    </codecs>
</config>

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

...

Tones: Child element of <ringtones>

 Tones Element Example 

Expand
titleTones Element Example
Code Block
<?xml version="1.0" ?>
<config>
    <ringtones>
        <tones>
            <tone id="Alarm" display="Alarm" type="phone"/>
            <tone id="Chimes" display="Chimes" type="phone"/>
            <tone id="Sangoma" display="Sangoma" 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>

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

...

Alerts: Child element of <ringtones>

Expand

...

titleAlerts Element Example
Code Block
<?xml version="1.0" ?>
<config>
    <ringtones>
        <alerts>
            <alert alert_info="normal" ringtone_id="Sangoma" ring_type="normal" />
            <alert alert_info="ring-answer" ringtone_id="Sangoma" 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>

  • 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

P310, P315, P320, P325, P330, P370

ringtone_id

string

The id of the ring tone for this alert

P310, P315, P320, P325, P330, P370

ring_type

normal, answer, ring-answer, visual

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

P310, P315, P320, P325, P330, P370

Firmwares Element

Expand

...

titleFirmwares Element Example
Code Block
<?xml version="1.0" ?>
<config>
    <firmwares>
        <firmware model="P320" version="3_0_7" url="http://10.10.4.11/firmware/3_0_7_P320_firmware.eff" />
        <firmware model="P325" version="3_0_7" url="http://10.10.4.11/firmware/3_0_7_P325_firmware.eff" />
    </firmwares>
</config>

  • 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

P310, P315, P320, P325, P330, P370, PM200

Model number of the Sangoma phone or expansion module

P310, P315, P320, P325, P330, P370, PM200

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

P310, P315, P320, P325, P330, P370

url

URL string

URL location of the phone firmware. Sangoma phones support basic authentication, so a username and password may be passed in the URL line, e.g. https://user:pass@server.example.com.

P310, P315, P320, P325, P330, P370

Public Firmwares Element

 Public Firmwares Element Example

 

Expand
titlePublic Firmwares Element Example
Code Block
<?xml version="1.0" ?>
<config>
    <public_firmwares>
        <public_firmware model="P320" version="3_0_7" url="http://firmware.example.com/firmware/3_0_7_P320_firmware.eff" />
        <public_firmware model="P325" version="3_0_7" url="http://firmware.example.com/firmware/3_0_7_P325_firmware.eff" />
    </public_firmwares>
</config>

  • 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

P310, P315, P320, P325, P330, P370, PM200

Model number of the Sangoma phone or expansion module

P310, P315, P320, P325, P330, P370, PM200

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

P310, P315, P320, P325, P330, P370, PM200

url

URL string

URL location of the phone firmware. Sangoma phones support basic authentication, so a username and password may be passed in the URL line, e.g. https://user:pass@server.example.com.

P310, P315, P320, P325, P330, P370, PM200

Appconfig Element

...

 

Expand
titleAppconfig Element Example
Code Block
<?xml version="1.0" ?>
<config>
    <appconfig id="appscreen">
        <application id="parking" />
        <application id="status" />
        <application id="contacts" />
        <application id="call_log" />
        <application id="forward_calls" />
        <application id="hotdesking" />
        <application id="mcastpage" />
        <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="1" action_id="dial_vm" phone_state="idle" show="0"/>
            <display_rule id="2" action_id="transfer_vm" show="0"/>
            <display_rule id="3" action_id="transfer_vm" phone_state="transfer" show="1"/>
        </display_rules>
        <settings can_transfer_vm="1" name_format="last_first" 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="parking">
        <account account_id="101" username="101" password="1234" appserver="dasp://server.example.com/json" apiformat="json"/>
        <auto_start />
    </appconfig>
    <appconfig id="hotdesking">
        <account account_id="000000000000" username="000000000000" appserver="https://server.example.com/json" apiformat="json"/>
    </appconfig>
     <appconfig id="call_log">
        <account account_id="101" username="101" password="1234" appserver="dash://server.example.com/json" apiformat="json"/>
        <enabled />
    </appconfig>
</config>

  • Element lists the <appconfig> elements.  Each element is identified by its identifier.  Native apps require use of an account parameter.

  • auto_start element applies to all appconfig definitions and specifies that an application should be loaded when the phone boots, not just on first use of the application.  This sill increase boot time but will decrease first load of the application.

  • Custom applications do not apply to model P310 and P315 telephones.

...

Option

Values

Description

Models

use_pbx_credentials

boolean

If enabled, the phone will use the credentials loaded in from the pbx_credentials configuration element

P320, P325, P330, P370

status

logged_out, logged_in

Defines whether the phone is in a logged out or a logged in state

P320, P325, P330, P370

Multicastpage Element

...

 

Expand
titleMulticastpage Element Example
Code Block
<?xml version="1.0" ?>
<config>
    <multicastpage>
        <listener id="1" name="SomePage" extension="123" addr="239.0.0.1" port="32000" priority="1" interrupt_calls="0"/>
        <listener id="2" name="All Page" extension="456" addr="239.0.0.2" port="32000" priority="2" interrupt_calls="1"/>
        <broadcast id="1" name="My Paging Group" addr="239.0.0.3" port="32000" codec="PCMU" />
    </multicastpage>
</config>

  • 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

  • Specifies broadcast addresses on which phone can multicast audio in G.711 u-law, G.711 a-law, or G.722 formats

...

Option

Values

Description

Models

id

string

A unique identifier for the broadcast, required

P320, P325, P330 (4_13_0)

name

string

A name to be provided in the phone's Multicast Page application or on a Rapid Dial key when mapping this broadcast, required

P320, P325, P330 (4_13_0)

addr

IPv4 address

Multicast address to which phone will broadcast audio, required

P320, P325, P330 (4_13_0)

port

Valid integer for ports (1-65535)

Port, combined with address above, to which phone will broadcast audio, required

P320, P325, P330 (4_13_0)

codec

PCMU, PCMA, G722

Specifies the codec that will be used by the phone in its multicast audio broadcast

P320, P325, P330 (4_13_0)

Certs Element

...

 

Expand
titleCerts Element Example
Code Block
<?xml version="1.0" ?>
<config>
    <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-cert" type="RSA" md5="abc123">MIICXQIBAAKB...XYZ</clientkey>
    </certs>
</config>

  • Element lists the <cert>, <clientcert>, and <clientkey> elements, each containing an in-line, raw certificate payload, not prefixed by an "----BEGIN CERTIFICATE----" header nor postfixed by an "----END CERTIFICATE----" footer.

  • cert will be loaded by phone and combined with built-in certificate bundle as a trusted certificate

...

Activity Indicator Element

 Activity Indicator Element Example 

Expand
titleActivity Indicator Element Example
Code Block
<?xml version="1.0" ?>
<config>
    <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> 
</config>

  • Controls the behavior of the activity indicator lamp during various phone states.

Option

Values

Description

Models

id

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

Specifies the state being configured

P310, P315, P320, P325, P330, P370

color

amber, green, red

Specifies the color to apply to the state being configured

P310, P315, P320, P325, P330, P370

state

off, on, slow, fast

Specifies the lamp disposition to apply to the state being configured

P310, P315, P320, P325, P330, P370

use_proxy_for Element

...

Expand
titleuse_proxy_for Element Example
Code Block
<?xml version="1.0" ?>
<config>
    <use_proxy_for network="10.10.0.0/20" network_id="network1" host="10.1.2.3" use="0" />
</config>

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

...

  • 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

 

Expand
titlenetwork_id Attribute Example
Code Block
<?xml version="1.0" ?>
<config>
    <networks>
        <network id="network1" display_name="Home" cidr="192.168.8.0/24" />
        <network id="network2" display_name="Work" cidr="10.0.0.0/8" />
    </networks>
    <setting id="ntp_server" value="0.digium.pool.ntp.org" network_id="network1" />
    <setting id="ntp_server" value="ntp.example.com" network_id="network2" />
    <setting id="network_vlan_discovery_mode" value="NONE" network_id="network1" />
    <setting id="network_vlan_discovery_mode" value="LLDP" network_id="network2" />
    <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" network_id="network1" />
            <host_alternate server="10.1.2.3" port="5060" transport="udp" reregister="300" retry="25" network_id="network1" />
            <host_primary server="10.1.2.4" port="5060" transport="udp" reregister="300" retry="25" network_id="network2" />
            <host_alternate server="10.1.2.5" port="5060" transport="udp" reregister="300" retry="25" network_id="network2" />
            <permission id="record_own_calls" value="0" />
        </account>
    </accounts>
    <contacts url="https://server.example.com/myfile.xml" id="internal" md5="abcd123" network_id="network1" />
    <contacts url="https://10.1.2.3/myfile.xml" id="internal" md5="abcd123" network_id="network2" />
    <firmware network_id="network1">
        <firmware model="P320" version="3_0_7" url="http://server.example.com/firmware/P320.firmware.eff" />
        <firmware model="P325" version="3_0_7" url="http://server.example.com/firmware/P325.firmware.eff" />
    </firmwares>
    <firmwares network_id="network2">
        <firmware model="P320" version="3_0_7" url="http://10.1.2.3/firmware/P320.firmware.eff" />
        <firmware model="P325" version="3_0_7" url="http://10.1.2.3/firmware/P325.firmware.eff" />
    </firmwares>
</config>