XML Configuration 3.9.0+

config_server_url

The URL of the DPMA / Switchvox config server in the format:
sip:proxy@host:port;transport=xyz

or:

[protocol://][user:password@]server[:port][/path] 

For phones attached to DPMA or Switchvox, contains the URL path to the config server. Transport type is dependent upon model and firmware version. sip:proxy is a literal.

Specifies the URL string that the Sangoma phone's cURL application will call in order to retrieve the phone's configuration file.

No default. 

P310, P315

pbx_credentials

value as string
account_id per Switchvox
host as the Switchvox hostname
user as the Switchvox account username
pass as the Switchvox account API password 

For Switchvox-connected phones only, specifies the set of credentials used by an application when the use_pbx_credentials appconfig parameter is true. This should be omitted for phones connecting to something other than Switchvox.

No default.

P310, P315

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

P310, P315

send_mac_with_useragent

boolean

If 1, 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 0.

P310, P315

use_secure_labels

boolean

If 1, 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 0.

P310, P315

time_zone

Timezone String, e.g. America/Chicago

Sets the time zone for the phone.

Defaults to America/Los_Angeles

P310, P315

time_source

"ntp"

Sets the time source for the phone. Currently, the only option is "ntp"

Defaults to ntp.

P310, P315

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

P310, P315

ntp_resync

Seconds as integer, e.g. 86400

Sets the interval between NTP synchronization.

Defaults to 86400.

P310, P315

ntp_prefer_option42

boolean

If 1, the phone will prefer and use an IPv4 address, not host name, NTP server, first server only and not multiple servers, as provided by DHCP Option 42. If 0, the phone will ignore DHCP Option 42.

Defaults to 1.

P310, P315

accept_local_calls

any / host

Sets whether to accept calls from any source or only from hosts to which the phone is registered.

Defaults to any.

P310, P315

compact_sip_headers

boolean, Defaults to 0

If enabled, causes the phone to utilize the compact form of SIP headers, rather than the expanded form, as well as causing the phone not to enumerate the statically defined codec payload types

P310, P315

transport_udp_enabled

boolean

If 1, enables UDP SIP transport. If 0, disables UDP SIP transport.

Defaults to 1

P310, P315

transport_udp_port

Valid integer for ports (1-65535)

Sets the local UDP SIP port.

Defaults to 5060

P310, P315

transport_tcp_enabled

boolean

If 1, enables TCP SIP transport. If 0, disables TCP SIP transport.

Defaults to 1

P310, P315

transport_tcp_port

Valid integer for ports (1-65535 )

Sets the local TCP SIP port.

Defaults to 5060

P310, P315

transport_tls_allowed

boolean

If 1, enables TLS SIP transport. If 0, disables TLS SIP transport.

Defaults to 1

P310, P315

transport_tls_port

Valid integer for ports (1-65535)

Sets the local TLS SIP port.

Defaults to 5061

P310, P315

tls_allow_wildcard_certs

boolean, defaults to 0

If enabled, SIP TLS signaling will accept a wildcard certificate as valid, contrary to RFC 5922 section 7.2

P310, P315

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.

P310, P315

logo_file

value as "factory" or "user"
path as location on disk of file
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.

value defaults to factory.

path defaults to "/factory_asterisk.png" and should be "/user_image.png" for custom

P310, P315

wallpaper_file

value as "factory" or "user"
path as location on disk of file
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

value defaults to factory.

path defaults to "/factory_wallpaper.png" and should be "/user_wallpaper.png" for custom

320x240 pixels for P310 and P315 

P310, P315

display_mc_notification

boolean

If 1, enables display of missed calls. If 0, disables display of missed calls.

Defaults to 1

P310, P315

hide_completed_elsewhere

boolean

If 1, the phone to not register a call, missed or otherwise, when receiving RFC 3326 "Call completed elsewhere" SIP Reason. If 0, all calls that are canceled from the remote side before answer by the local phone will show as missed.

Defaults to 0.

P310, P315

small_clock

boolean

If 1, the phone will display a small time and date on the idle screen. If 0, the regular, large format clock will be displayed on the idle screen.

Defaults to 0. 

P310, P315

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.

No default.

P310, P315

brightness

integer (1-10)

Sets the LCD screen brightness

Defaults to 5

P310, P315

enable_check_sync

boolean

If 1, the phone will perform a reconfigure when sent a check-sync SIP NOTIFY Event from the server to which it is registered. 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. If 0, the phone will ignore check-sync events.

Defaults to 1.

P310, P315

dim_backlight

boolean

If 1, the screen will dim after the backlight timeout has been reached and phone is otherwise idle. If 0, the phone will not dim the screen.

Defaults to 1

P310, P315

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

P310, P315

backlight_dim_level

integer (0-10)

Brightness level dims to when when dim_backlight is true.

Defaults to 2

P310, P315

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.

P310, P315

time_short_format

an ICU date/time pattern

Sets the time format used by the phone when displaying the small clock. This setting is normally controlled by the phone's configured locale.

Defaults to h:mm a

P310, P315

date_short_format

an ICU date/time pattern

Sets the date format used by the phone when displaying the short date. This setting is normally controlled by the phone's configured locale.

Defaults to M/d/yy

P310, P315

date_time_format

string

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

Defaults to {1}, {0}

P310, P315

idle_screen_clock_format

an ICU date/time pattern

Sets the clock format used by the phone on its idle screen. This setting is normally controlled by the phone's configured locale.

Defaults to {0} EEE, MMM d

P310, P315

ringer_volume

integer (0-10)

Sets the ringer volume.

Defaults to 5

P310, P315

lock_ringing_volume

boolean

If 1, the phone's hard ringing key will not change the ringing-volume of the phone. If 0, the hard ringing key will be able to change the ringing-volume of the phone.

Defaults to 0.

P310, P315

speaker_volume

integer (1-10)

Sets the speaker volume.

Defaults to 5

P310, P315

handset_volume

integer (1-10)

Sets the handset volume.

Defaults to 5

P310, P315

headset_volume

integer (1-10)

Sets the headset_volume.

Defaults to 5

P310, P315

reset_call_volume

boolean

If 1, volume changes made during a call do not persist to the next call. If 0, volume changes made during a call persist for subsequent calls.

Defaults to 0

P310, P315

active_ringtone

Tone ID from <tones> provided to phone

Sets the current user-selected ringtone.

Defaults to Sangoma

P310, P315

headset_answer

boolean

If 1, the phone will use direct calls answered using the Answer soft key to the headset, rather than the handsfree speaker. If 0, the phone will direct calls answered using the Answer soft key to the handsfree speaker.

Defaults to 0

P310, P315

ring_headset_only

boolean

If 1, the phone will play ringing tones out the headset interface. If 0, the phone will play ringing tones out the handsfree speaker.

Defaults to 0

P310, P315

call_waiting_tone

boolean

If 1, the phone will play a call waiting tone when other calls are received. If 0, the phone phone will not playback a call waiting tone

Defaults to 1.

P310, P315

ehs

auto, jabra_iq, plantronics

Defines the Electronics Hookswitch type to support.

Defaults to auto.

P310, P315

call_control_checkx

boolean,

If 1, allows the confirmation key to answer a call and the x-key to reject a call. If 0, the confirmation key will not answer a call nor will the x-key reject a call.

Defaults to 0.

P310, P315

parking_lot_extension

string

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 account-level parking_lot_extension setting.

No default.

P310, P315

parking_lot_enable_blind_transfer

boolean

For Switchvox and DPMA environments, specifies the type of call parking transfer to perform. If 1, a blind transfer will be performed. If 0, an attended transfer will be performed. This option must be defined also, duplicating the account-level parking_lot_enable_blind_transfer setting.

Defaults to 0.

P310, P315

contacts_max_subscriptions

integer, e.g. 40

Sets the maximum number of SUBSCRIBEs the phone will perform for contacts.

Defaults to 40.

P310, P315

name_format

first_last, last_first

Formats the display of contact names.

Defaults to first_last

P310, P315

blf_contact_group

Any group_name from the loaded contacts

The group_name of the contact list group to which the phone will subscribe. If this setting is blank, the phone will not subscribe for any indicators and no device state LEDs will light nor presence update.

No default.

P310, P315

network_enable_dhcp

boolean

If 1, enables DHCPv4/v6 network configuration. If 0, DHCP configuration is not used.

Defaults to 1

P310, P315

network_static_ip_address

IPv4 address

Defines the network address for the phone.

No default.

P310, P315

network_subnet_mask

IPv4 netmask

Defines the netmask for the phone.

No default.

P310, P315

network_default_gateway

IPv4 address

Defines the network gateway for the phone.

No default.

P310, P315

network_primary_dns_server

IPv4 address

Defines the primary DNS server for the phone.

No default.

P310, P315

network_secondary_dns_server

IPv4 address

Defines the secondary DNS server for the phone.

No default.

P310, P315

network_disable_arping 

boolean

If 1, causes the phone to not ARP for an in-use address as-provided by a DHCP server, before using it. If 0, the phone will ARP for other devices responding to the same IP address before accepting the address from the DHCP server.

Defaults to 0.

P310, P315

allow_insecure_ssl

boolean

By default, phones will not, using SSL, connect to self-signed servers. Instead, they will only connect to publicly-signed server. To allow the phone to connect to a self-signed server, set this option to 1.

Defaults to false.

P310, P315

enable_tcp_sack

boolean, Defaults to 0

If enabled, causes phone to enable TCP SACK processing. Defaults too disabled.

P310, P315

network_vlan_discovery_mode

NONE, MANUAL, LLDP

Sets use of none, manual, or LLDP discovered VLAN and, if MANUAL, defines the network.

Defaults to LLDP

P310, P315

network_vlan_id

integer (0-4095)

Sets the VLAN ID. VLAN ID 3182 is reserved ifexpansion_enable is enabled for D65 model phones.

No default.

P310, P315

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.

No default.

P310, P315

log_level

error, warning, debug, information

Sets the logging level.

Defaults to information

P310, P315

log_server

IPv4 address of syslog server

Specifies remote syslog server.

No default.

P310, P315

log_port

port as integer

Specifies port of remote syslog server.

No default.

P310, P315

enable_logging

boolean

If 1, the phone will send log events to a remove syslog server. If 0, the phone will not send log events to a remote syslog server.

Defaults to 0

P310, P315

web_ui_enabled

boolean

If 1, enables the phone's built-in web interface. If 0, disables the phone's built-in web interface.

Defaults to 1 (Enabled)

P310, P315

sip_qos

integer (0-7)

Sets the SIP signaling QOS level

Defaults to 3.

P310, P315

rtp_qos

integer (0-7)

Sets the RTP media QOS level.

Defaults to 6.

P310, P315

pc_qos

integer (0-7)

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

No default.

P310, P315

sip_dscp

integer (0-63)

Specifies the DSCP field of the DiffServ byte for SIP Signaling QoS.

Defaults to 24

P310, P315

rtp_dscp

integer (0-63)

Specifies the DSCP field of the DiffServ byte for RTP Media QoS.

Defaults to 46

P310, P315

in_switchvox_environment

boolean, Defaults to 0

If 1, informs the phone that it should operate as though it is connected to Switchvox, as opposed to any other server type.

Defaults to 0

P310, P315

server_environment

empty string, DPMA, Switchvox.

Defines the server environment under which the phone should be operating. Phones not attached to DPMA or Switchvox need not define this. Phones attached to DPMA should define DPMA. Phones attached to Switchvox should define Switchvox.

Defaults to empty string

P310, P315

handshake_timeout

time in seconds

For phones connected to Switchvox and/or DPMA, specifies a default timeout at which the phone should reissue a handshake, regardless of any external commands to otherwise issue one.

Defaults to 86400

P310, P315

retransmit_until_response

boolean

If 1, causes the phone to continue sending requests to the proxy, should the proxy not respond. If 0, the phone will re-send the request only once. It is not recommended to enable this option.

Defaults to 0.

P310, P315

sip_notify_call_control

boolean

If 1, causes the phone to respond to in-dialog SIP NOTIFY talk and hold Events to answer, hold, and resume calls.

Defaults to 0.

P310, P315

8021x_method

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

Sets the method of 802.1X authentication for the phone,

Defaults to empty string (none).

P310, P315

8021x_identity

string

Sets the 802.1X authentication identifier (username),

Defaults to empty string (none).

P310, P315

8021x_anonymous_identity

string, PHONE_MAC

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

Defaults to empty string (none).

P310, P315

8021x_password

string

Sets the 802.1X authentication password

Defaults to empty string (none)

P310, P315

8021x_client_cert

"value" as label for a defined <clientcert>

Sets the client certificate to be used when performing the 802.1X authentication. Value should be populated with the label of the <clientcert> to be used.

No default.

P310, P315

8021X_client_key

"value" as label for a defined <clientkey>

Sets the client key to be used when performing the 802.1X authentication.  Value should be populated with the label of the <clientkey> to be used.

No default.

P310, P315

8021x_debug

-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 Sangoma Support. Phone should not be configured to operate in this mode on an ongoing basis as it will generate excessive messages.

No default.

P310, P315

network_default_enable_openvpn

boolean

If 1, instructs the phone to perform the VPN connection on startup.

Defaults to 0.

P310, P315

openvpn_inline_config

http(s) URI as "url"

"1" as "value"

md5sum of url file as "md5" 

Sets the URL the phone will use to cURL in an inline OpenVPN configuration file. Value must be set to 1. md5 must be valid.

No default.

P310, P315

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 (3_7_0)

id

digium.incomingCall.voicemail, digium.parkingLot.parked

Specifies the event that the phone should expect from server

No default.

P310, P315

action

app

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

No default.

P310, P315

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

key

id as integer, beginning with 0

action as one of:

• accept_call

• backspace

• cancel_call

• clear_call

• conference

• end_call

• forward_calls

  • label1 as:

    • _FORWARD

• info

• make_call

• menu

• missed_or_call_log

• none

• park_call

• record_call

• reject_call

• resume

• send_to_vmail

• show_application

  • label1 as one of:

    • _CONTACTS

    • _PARKED_CALLS

    • _QUEUES

    • _STATUS

  • arg as one of:

    • contacts

    • voicemail

    • parking

    • status

    • queues

• split_conference

• status

• toggle_url_number

• transfer_call

Maps a soft key, represented by an id (index=0), left-to right, where index greater than the free keys on-screen will result in a "More..." soft key being automatically applied to the right-most key, to an action, optionally passed a label1, and optionally passed an arg. Note that not all actions are appropriate for all phone states and not all functionality, e.g. Call Recording, cannot be accomplished outside of a DPMA or Switchvox environment. There is currently no label1 for voicemail.

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

P310, P315

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

No defaults.

P310, P315

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

server_uuid

Non-zero String

Specifies a unique identifier for the server.

P310, P315

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

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

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

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

username

string

SIP username

P310, P315

authname

string

SIP authname

P310, P315

password

string

SIP password

P310, P315

passcode

string

SIP password

P310, P315

line_label

string

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

P310, P315

caller_id

Name <Number>

Outgoing caller id displayed for this account

P310, P315

dial_plan

Digit mapping, see Dial Plans

The dial plan / digit mapping for this account

P310, P315

voicemail

digits or SIP URI

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

P310, P315

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

P310, P315

plar_number

string

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

P310, P315

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.

P310, P315

subscription_extension

string

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

P310, P315

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 (3_3_1)

server

Hostname or IPv4 Address

Sets the server to which calls for this account are directed

P310, P315

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.

P310, P315

transport

udp, tcp, tls

Sets the transport type, UDP or TCP, TLS.

P310, P315

media_encryption

sdes

Sets the media_encryption method, none or SDES.

Defaults to empty string (none).

The media_encryption setting for the host_primary must match the setting for the host_alternate.

P310, P315

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.

P310, P315

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.

P310, P315

needMwiSubscription

boolean

Per-host override of needMwiSubscription from account element

P310, P315 (3_7_0)

mwi_subscription_uri

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

Per-host override of mwi_subscription_uri from account element

P310, P315 (3_7_0)

server

Hostname or IPv4 Address

Sets the server to which calls for this account are directed in the event that host_primary is unreachable

P310, P315

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.

P310, P315

transport

udp, tcp, tls

Sets the transport type, UDP or TCP, TLS.

P310, P315

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.

P310, P315

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.

P310, P315

authname

String

Specifies an authentication name to be used when registering to the host_alternate server, if null, utilizes the auth name from the account object.

P310, P315 

password

String

Specifies an authentication password to be used when registering to the host_alternate server, if null, utilizes the authentication password from the account object.

P310, P315 

needMwiSubscription

boolean

Per-host override of needMwiSubscription from account element

P310, P315 (3_7_0)

mwi_subscription_uri

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

Per-host override of mwi_subscription_uri from account element

P310, P315 (3_7_0)

server

Hostname or IP Address

Outbound proxy for this host.

P310, P315 (3_3_1)

port

empty, or integer (1-65535)

Port for the outbound proxy

P310, P315 (3_3_1)

transport

udp, tcp, tls

SIP Transport for the outbound proxy

P310, P315 (3_3_1)

use_voicemail

boolean

If 1, allows the user to have voicemail for this account.

Defaults to 0.

P310, P315

ignore_calls

boolean

If 1, allows the user to ignore an incoming call.

Defaults to 0.

P310, P315

use_call_log_api

boolean

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

Defaults to 0.

P310, P315

call_log_fetch_entries

integer

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

Defaults to 50.

P310, P315

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

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

id

string

Unique identifier for the network

P310, P315

display_name

string

A named identifier for the network

P310, P315

cidr

CIDR formatted address

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

P310, P315

id

PCMU, PCMA, G722, G726-32, opus, G729

A codec supported by the phone

P310, P315

priority

integer (1-255)

Priority of the codec where higher numbers mean the codec is more favored

P310, P315

packetization

integer in 10ms increments per RFC codec guidelines

Packetization (ptime) rate for the specified codec, defaults to 20

P310, P315

jitter_min

integer in ms

Sets the minimum size of the codec jitter buffer

P310, P315

jitter_max

integer in ms

Sets the maximum size of the codec jitter buffer

P310, P315

jitter_target

integer in ms

Sets the target size of the codec jitter buffer

P310, P315

enabled

boolean

If 1, enables the codec. If 0, disables the codec.

P310, P315

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.

P310, P315

samplerate

Depends on codec: nb, wb, uwb

Sets the sampling rate for a codec, applicable to Opus codec. Opus operates at either nb (8000Hz) or wb (16000Hz). Defaults to wb for Opus.

P310, P315

use_vbr

boolean

Applies to the Opus codec. If 1, uses a variable bitrate encoder. If 0, uses a constant bitrate encoder. Only the variable bitrate encoder is supported. The constant bitrate encoder will deliver malformed audio.

Defaults to 1.

P310, P315

id

string

Internal Tone identifier

P310, P315

display

string

External Tone Description

P310, P315

url

URL string

Location from which to retrieve a 16-bit, 16kHz, mono raw signed linear sound file, less than 1MB in size

P310, P315

md5

md5sum

MD5 sum of the file to be retrieved

P310, P315

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

P310, P315

alert_info

string

The alert_info header that, as received, applies to this alert

P310, P315

ringtone_id

string

The id of the ring tone for this alert

P310, P315

ring_type

normal, answer, ring-answer, visual

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

P310, P315

model

P310, P315

Model number of the Sangoma phone

P310, P315

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

url

http 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. http://user:pass@server.example.com.

P310, P315

model

P310, P315

Model number of the Sangoma phone

P310, P315

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

url

http 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. http://user:pass@server.example.com.

P310, P315

account_id

String

Specifies the account ID used when accessing the application server; typically the same as the SIP endpoint ID.

P310, P315

username

String

Specifies the SIP endpoint ID used when accessing the application server.

P310, P315

password

String

Specifies the password used when accessing the application server as well as the password used when the require_password application setting is applied. Need not be the same as the SIP endpoint password.

P310, P315

appserver

dash://YOUR SERVER/json

Specifies the location of application server, prefixed with "dasp" transport type.

P310, P315

apiformat

json

Specifies the data format to use when exchanging information with the application server

P310, P315

account_id

string

Specifies the MAC address of the telephone when logged_out and the server's account_id of the device when logged_in

P310, P315 

username

string

Specifies the MAC address of the telephone when logged_out and the username for the server when logged_int

P310, P315 

auth_token

string

When logged_in, specifies the auth_token for the user of the server

P310, P315 

appserver

URL as string

Specifies the URL of the application server

P310, P315 

apiformat

json

Specifies the data format to use when exchanging information with the application server

P310, P315 

id

parking, status, contacts, call_log, forward_calls, hotdesking, mcastpage

Specifies the application to load into the phone's app screen, dependent on phone model.

P310, P315

hide_options id

about, applications, preferences, admin, advanced

Specifies the menu item to hide

P310, P315

option id

admin: network, qos, vlan, ethernetModes, systemTools, sipLines, changePassword, vpn
preferences: display, localization, sound, answering, network_select
advanced: reconfigure, factoryReset 

Specifies the sub-menu item to hide

P310, P315

use_local_storage

boolean

If 1, directs the contacts application to allow the use of local storage for contacts.

Defaults to 0.

P310, P315

can_transfer_vm

boolean

If 1, specifies that the phone is allowed to perform transfers to voicemail targets from within the contacts application.

Defaults to 0.

P310, P315

name_format

first_last, last_first

Specifies the formatting of name display, e.g. First Last or Last, First.

Defaults to first_last

P310, P315

in_switchvox_environment

boolean

If 1, alerts the Contacts application that it is operating inside a Switchvox system.

Defaults to 0. 

P310, P315

preferred_contact_group

string

Specifies the contacts group to display when the application is loaded into the foreground. Defaults to empty string; all contacts.

P310, P315

id

unique id

A unique identifier for this display_rule, e.g. 0, 1, 2, etc.

P310, P315

action_id

A valid action as defined in the phone's Contacts file

Sets the action_id for the display rule to act upon

P310, P315

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.

P310, P315

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

P310, P315

show

boolean

If set to 1, shows a particular action. If set to 0, 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.

P310, P315

send_dnd

status set to one of:
available, unavailable, away, xa, chat, dnd 

Can be defined multiple times, one for each status. If set for a status, directs the phone to return 486 BUSY when in that status mode.

P310, P315

full_application

None

If defined, alerts the Status application to run in full mode. Full mode should only be run against DPMA or Switchvox.

use_pbx_credentials

boolean

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

P310, P315 

status

logged_out, logged_in

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

P310, P315 

id

string

A non-empty unique alpha-numeric string identifier for the listener, required

P310, P315

name

string

A name to be provided in the phone's announcement status bar when audio is received over this listener, required

P310, P315

extension

string

Sets a local extension for this listener, that, if dialed by the phone, causes the phone to ignore RTP from this listener.

P310, P315

addr

IPv4 address

Multicast address to which phone should subscribe for audio, required

P310, P315

port

Valid integer for ports (1-65535)

Port, combined with address above, to which phone should subscribe for audio, required

P310, P315

priority

integer, 1-10

Prioritization level, lower given more priority, for playing back streams when more than one subscribed address is providing audio, required

P310, P315

interrupt_calls

integer, 0-2

If 1, places any in-progress calls on hold before playing back audio, and ignore the phone's local volume setting, playing back the audio at full volume. If 0, in-progress calls will have their audio played over the top of any in-progress calls. If 2, phone will ignore pages for this listener if it is involved in another call.

Defaults to 2.

P310, P315

id

string

A unique identifier for the broadcast, required

P310, P315 (3_8_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

P310, P315 (3_8_0)

addr

IPv4 address

Multicast address to which phone will broadcast audio, required

P310, P315 (3_8_0)

port

Valid integer for ports (1-65535)

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

P310, P315 (3_8_0)

codec

PCMU, PCMA, G722

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

P310, P315 (3_8_0)

id

string

A unique identifier for the cert, required

P310, P315

label

string