Skip to end of metadata
Go to start of metadata


TXT Configuration

This section describes the formatting and options available when creating TXT-based configuration files for provisioning Asterisk A30 phones.

Icon

The configuration elements provided in this section are subject to change between Asterisk A-series phone firmware releases.

  A Complete TXT Configuration Example
A Complete TXT Configuration Example

Top Level Elements

 Elements Example
TXT Top Level Elements

Each element is populated with a value.

Top Level Elements

Option

Values

Description

Version

String

If the phone is configured for auto provisioning and it successfully loads this configuration, the version string will be displayed on-screen.

NET CONFIG MODULE Elements

 Elements Example
NET CONFIG MODULE Elements

Each element is populated with a value.

NET CONFIG MODULE Elements

Option

Values

Description

WAN TYPEInteger, 0-2, Defaults to 0Defines the type of networking, 0 (IPv4 Only), 1 (IPv6 Only), 2 (IPv4 & IPv6)

WAN IP

IPv4 address

Sets the IPv4 address of the phone.

WAN Subnet MaskIPv4 net maskSets the IPv4 net mask of the phone.
WAN GatewayIPv4 network gatewaySets the IPv4 default gateway / route of the phone.
Domain NameDomain name, as stringSets the default domain search name of the phone.
Primary DNSIPv4 addressSets the primary DNS server of the phone.
Secondary DNSIPv4 addressSets the secondary DNS server of the phone.
Enable DHCPBoolean, Defaults to 1Enables or disables DHCP network configuration request. Defaults to 1.
DHCP Auto DNSBoolean, Defaults to 1Configures the phone to accept DNS servers provided by DHCP. If disabled, the phone will use the DNS servers defined by the PrimaryDNS and SecondaryDNS net configuration elements. Defaults to 1.
DHCP Auto TimeBoolean, Defaults to 1Configures the phone to set its time and SNTP server based upon receipt of DHCP Option 42. If disabled, the phone will use the NTP server as defined by the SNTPServer date configuration element and time as defined in other date configuration elements. Defaults to 1.
Use Vendor Class IDBoolean, Defaults to 0Configures the phone to send DHCP Option 61, Vendor Class Identifier. Defaults to 0.
Enable PPPoEBoolean, Defaults to 0Configures the phone to perform PPPoE authentication in order to retrieve its network configuration. Defaults to 0
PPPoE UserStringIf the phone is to use PPPoE authentication, sets the PPPoE authentication username.
PPPoE PasswordStringIf the phone is to use PPPoE authentication, sets the PPPoE authentication password.
ARP Cache LifeTime, in minutes, Defaults to 2Specifies the time in minutes to cache ARP
WAN6 IPIPv6 IP AddressSpecifies the phone's IPv6 address
WAN6 IP PREFIXIPv6 IP Address PrefixSpecifies the phone's IPv6 address prefix
WAN6 GatewayIPv6 AddressSpecifies the phone's IPv6 gateway
Domain6 NameStringSpecifies the IPv6 domain name search
Primary DNS6IPv6 AddressSpecifies the IPv6 primary DNS server address
Secondary DNS6IPv6 AddressSpecifies the IPv6 secondary DNS server address
Enable DHCP6Boolean, Defaults to 1If enabled, directs the phone to use a DHCPv6 server for IPv6 address assignment
DHCP6 auto DNSBoolean Defaults to 1If enabled, directs the phone to retrieve DNS servers from the DHCPv6 server
DHCP6 Auto TimeBoolean Defaults to 0If enabled, directs the phone to retrieve its SNTP server from the DHCPv6 server
Use Vendor6 Class IDBoolean, Defaults to 0If enabeld, the phone will send vendor class ID to the DHCPv6 server
Vendor6 Class IDStringSpecifies the phone's DHCPv6 vendor class ID

WIFI Config Element (currently unused)

This section contains child elements controlling WIFI support

Child elements of WIFI Config
 Elements Example
WIFI CONFIG Element Examples

Option

Values

Description

WIFI Enable

Boolean, Defaults to 0

Enables or disables support for WiFi network connectivity. Currently unused.

MM CONFIG MODULE Elements

 Elements
MM CONFIG MODULE Elements

Each element is populated with a value.

MM CONFIG MODULE Elements

Option

Values

Description

G723 Bit Rate

Boolean, Defaults to 1

Sets the bitrate type to be used for G.723.1 voice codec encoding. 0 sets encoding to 5.3kbit/s. 1 sets encoding to 6.3kbit/s. Defaults to 1

ILBC Payload TypeInteger, Defaults to 97.Sets the RTP payload type to be used for iLBC voice codec encoding. Defaults to 97.
ILBC Payload Len20, 30Sets the iLBC voice codec block length duration in milliseconds. 20 sets 20ms. 30 sets 30ms. Defaults to 20.
AMR Payload TypeInteger, Defaults to 108Sets the RTP payload type to be used for AMR voice codec encoding. Defaults to 108.
AMRWB Payload TypeInteger, Defaults to 109Sets the RTP payload type to be used for AMR (G.722.2) voice codec encoding. Defaults to 109.
Dtmf Payload TypeInteger, Defaults to 101Sets the RTP payload type to be used for RFC2833 DTMF events. Defaults to 101.
Opus Payload TypeInteger, Defaults to 107Sets the RTP payload type to be used for Opus voice codec encoding. Defaults to 107
Opus Sample RateBoolean, Defaults to 0Sets the Opus voice codec encoding type. 0 sets Narrowband. 1 sets Wideband. Defaults to 0.
VADBoolean, Defaults to 0Enables or disables Voice Activity Detection (VAD) for certain (G.729) codecs. Defaults to 0.
H264 Payload TypeInteger, Defaults to 117Sets the RTP payload type to be used for H.264 video codec encoding. Defaults to 117
Resv Audio BandBoolean, Defaults to 0If enabled, the phone will reduce video bandwidth to prioritize audio. Defaults to 0.
RTP Initial PortInteger, Defaults to 10000Sets the starting RTP port used for calls. Defaults to 10000
RTP Port QuantityInteger, Defaults to 200Sets the number of RTP ports to span across before recycling. Defaults to 1000.
RTP Keep AliveBoolean, Defaults to 0Enables or disables the sending of a periodic RTP keep alive packet. Defaults to 0.
RTCP CNAME UserStringSets the RTCP CNAME User part for RTCP Sender reports generated by the phone.
RTCP CNAME HostStringSets the RTCP CNAME Host part for RTCP Sender reports generated by the phone.
Select Your ToneInteger, Defaults to 11

Sets the phone's default tones based upon country as follows:

Australia, 15
Austria, 22
Belgium, 0
Brazil, 16
Canada, 18
Chile, 20
China, 1
Croatia, 17
Czech Republic, 12
Denmark, 23
Finland, 24
France, 25
Germany, 2
Greece, 26
Hungary, 27
India, 29
Israel, 3
Italy, 21
Japan, 4
Lithuania, 28
Mexico, 30
New Zealand, 31
Netherlands, 5
Norway, 6
Portugal, 32
Russia, 19
South Africa, 14
South Korea, 7
Spain, 33
Sweden, 8
Switzerland, 9
Taiwan, 10
United Kingdom, 13
United States, 11

Sidetone GAINBoolean, Defaults to 1If enabled, the phone will provide sidetone
Play Egresss DTMFBoolean, Defaults to 0Currently unused
Dial ToneString

Sets the dialing tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones, e.g.

350+440/0

Ringback ToneString

Sets the ring back tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones, e.g.
440+480/2000,0/4000

Busy ToneString

Sets the ring back tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones, e.g.
480+620/500,0/500

Congestion ToneString

Sets the congestion tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones.

Call waiting ToneStringSets the call waiting tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones, e.g.
440/300,0/10000,440/300,0/10000,0/0
Holding ToneString

Sets the holding tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones.

Error ToneStringSets the error tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones.
Stutter ToneStringSets the stutter tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones.
Information ToneStringSets the information tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones.

Dial Recall Tone

String Sets the dial recall tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones, e.g.

350+440/100,0/100,350+440/100,0/100,350+440/100,0/100,350+440/0

Message Tone

StringSets the message tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones.
Howler ToneString Sets the howler tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones.

Number Unobtainable

String Sets the number unobtainable tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones, e.g.

400/500,0/6000

Warning Tone

StringSets the warning tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones, e.g.

1400/500,0/0

Record Tone

StringSets the record tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones, e.g.

440/500,0/5000

Auto Answer Tone

StringSets the auto answer tone pattern, as a tone or combination of tones with a defined duration, optionally followed by other tones.

PHONE CONFIG Element

This section contains child elements controlling audio and video codecs.

Child elements of PHONE CONFIG
 Elements Example
PHONE CONFIG Element Examples

Option

Values

Description

Audio Codec Sets

Comma-separated list of:

PCMU
PCMA
G726-32
G729
G723
iLBC
AMR
AMR-WB 
opus
G722

Sets the list of codecs the phone is allowed to transcode.

Video Codec Sets

H264

Sets the video codec the A30 is allowed to decode.

Video Frame Rate

Integer, Defaults to 25

Sets the frame rate the A30 should expect to decode.

Video Bit Rate

Integer, Defaults to 2000000

Sets the bitrate of the video the A30 should expect to decode.

Video Resolution

Integer, Defaults to 4

Sets the resolution of the video the A30 should expect to decode.

Video Negotiate DirInteger, Defaults to 2Currently Unused

SIP CONFIG MODULE Elements

 Elements
SIP CONFIG MODULE Elements

Each element is populated with a value.

SIP CONFIG MODULE Elements

Option

Values

Description

SIP Port

Integer, 1-65535

Sets the local SIP signaling port used by the phone. Defaults to 5060

STUN ServerIPv4 address or hostnameSets the IPv4 address or hostname of a remote STUN server to be used by the phone. Defaults to none.
STUN PortInteger, 1-65535Sets the port of the remote STUN server to be used by the phone. Defaults to none

STUN Refresh Time

Integer, in secondsSets the STUN server refresh period used by the phone. Defaults to 50.

SIP Wait Stun Time

Integer, in millisecondsSets the amount of the, in milliseconds, the phone should wait for the STUN server to respond before continuing.

Extern NAT Addrs

IPv4 addressIf the phone is configured to use STUN, the SIP Contact address will be set according to this option. IP address of the phone, as broadcast by an upstream NAT router.

Reg Fail Interval

Integer, in secondsSets the time, after a failed registration, after reaching the halfway point of this interval time, at which the phone will attempt registration again. Defaults to 32.
SIP Pswd EncryptionBoolean, Defaults to 0If enabled, passwords contained in exported phone configurations will be disguised. Defaults to 0.
Strict BranchPrefixBoolean, Defaults to 0If enabled, when the phone receives a SIP message with a branch field that does not begin with z9hG4bk, the phone will return a 4xx message. Defaults to 0
Video Mute AttrBoolean, Defaults to 0If enabled, causes the phone, when placing a video-enabled call on hold, to use the "inactive" SDP a-line parameter. If disabled, the phone will use the sendrecv parameter instead. Defaults to 0
Enable Group BackupBoolean, Defaults to 0If enabled, and the phone has both regular and backup registrars configured, the phone will, upon a failure to register with either of the registrars, unregister from both. If disabled, the phone will attempt to register with both, and the registration of one will not affect the registration with another. Defaults to 0.
Enable RFC4475Boolean, Defaults to 0If enabled, and the phone receives a SIP message with a From or To field containing a blank space, quotation marks, or both, the phone will reject the message. Defaults to 0.
Strict UA MatchBoolean, Defaults to 0If enabled, the phone will only respond to requests from servers to which it is registered, based on the user-agent string provided by the incoming request. Defaults to 0.

CSTA Enable

Boolean, Defaults to 0Enables or disables the phone's support of uaCSTA. Defaults to 0.
Notify RebootBoolean, Defaults to 0If enabled, the phone will reboot in response to a received check-sync Event.

SIP Line List Element

This section contains child elements controlling SIP Line configurations.  Each line is controlled by its index value, beginning with 1, up to 6.

Child elements of SIP Line List
 Elements Example
SIP Line List Element Examples

Option

Values

Description

Phone Number

String

Sets the identifier used for the user part of the From and To lines in the phone's SIP messaging.

Display Name

String

Sets the quoted string name identifier used in the From and To (REGISTER only) in the phone's SIP messaging.

Sip Name

String

Sets a name for the SIP line, visible within the web admin UI of the phone.

Register Addr

IPv4 address or hostname

Sets the IPv4 address or hostname of the SIP Registrar.

Register Port

Integer, 1-65535

Sets the port used to contact the SIP Registrar. Defaults to 5060

Register User

StringSets the SIP authentication user.

Register Pswd

StringSets the SIP authentication password.

Register TTL

Integer, in seconds, Defaults to 3600Sets the default Expires timer for SIP registration. Defaults to 3600.

Enable Reg

Boolean, Defaults to 0Enables or disables SIP registration for this line.

Proxy Addr

IPv4 address or hostnameSets the IPv4 address or hostname for the SIP Proxy. Defaults to none.

Proxy Port

Integer, 1-65535Sets the port used to contact the SIP Proxy. Defaults to 5060.

Proxy User

StringSets the SIP proxy authentication user.

Proxy Pswd

StringSets the SIP proxy authentication password.

BakProxy Addr

IPv4 address or hostnameSets the IPv4 address or hostname for the backup SIP Proxy. Defaults to none.

BakProxy Port

Integer, 1-65535Sets the port used to contact the backup SIP Proxy. Defaults to 5060.

Enable Failback

Boolean, Defaults to 0Sets whether the phone, whereby it is configured with both a primary and a backup proxy, should, whereupon detection that the primary proxy is operational again after having previously failed, resume sending calls to the primary server. If enabled, the phone will switch back to the primary proxy. If disabled, the phone will continue to send calls to the backup. Defaults to 0.
Signal CryptoBoolean, Defaults to 0If enabled, causes the phone to encrypt SIP signaling. Defaults to 0.

SigCrypto Key

StringSets the key used to encrypt SIP signaling.

Media Crypto

Boolean, Defaults to 0If enabled, causes the phone to encrypt RTP media. Defaults to 0.

MedCrypto Key

StringSets the key used to encrypt RTP media.

SRTP Auth-Tag

Intege, Defaults to 0If set to 0, the phone will utilizes 80 byte SRTP tags, encrypting RTP using AES_CM_128_HMAC_SHA_80. If set to 1, the phone will utilize 32 byte SRTP tags, encrypting RTP using AES_CM_128_HMAC_SHA_32. Defaults to 0.
Local DomainStringsSets the domain name used in SIP registration

Always FWD

Boolean, Defaults to 0If enabled, the phone will unconditionally forward calls. Defaults to 0.

Busy FWD

Boolean, Defaults to 0If enabled, the phone will forward calls whenever it is busy. Defaults to 0.

No Answer FWD

Boolean, Defaults to 0If enabled, the phone will forward calls that are not answered. Defaults to 0.

Always FWD Num

StringSets the forwarding number used in conjunction with the AlwaysFWD option.

Busy FWD Num

StringSets the forwarding number used in conjunction with the BusyFWD option.

NoAnswer FWD Num

StringSets the forwarding number used in conjunction with the NoAnswerFWD option.

FWD Timer

Integer, in seconds, Defaults to 5Sets the time, in seconds, applied to the NoAnswerFWD option. Defaults to 5.

Hotline Num

StringSets the number to be dialed when the off-hook time is greater than the WarmLineTime and EnableHotline is enabled.
Enable HotlineBoolean, Defaults to 0If enabled, and the phone has been off-hook longer than the WarmLineTime, the phone will automatically dial the number defined by HotlineNum.
WarmLine TimeInteger, in seconds, 0-9, Defaults to 0.Sets the amount of time the phone must remain off-hook before attempting to execute Hotline functionality.

Pickup Num

StringSets the dialing prefix applied to calls that are picked up using function keys configured for Pickup functionality.

Join Num

StringSets the dialing prefix applied to calls that are joined using function keys configured for Join functionality.

Ring Type

Integer, 1-9, Defaults to 1Sets the default ringing type to be used. Defaults to 1.
NAT UDPUpdateInteger, 0-2, Defaults to 1If set to 1, the phone will send SIP OPTION packets to the server after each UDPUpdate_TTL time.  If set to 2, the phone will send a CRLF to the server after each UDPUpdate_TTL time.  If set to 0, the phone will send nothing.  Defaults to 1.
UDPUpdate TTLInteger, in seconds, Defaults to 60Sets the timer used by the NATUDPUpdate option.
Server TypeInteger

Sets special compatibility settings required for specific server types. The following types are supported:

3CX - 31
BOTE - 6
BroadSoft - 28
Cellcom - 30
COMMON - 0
CONFIG - 23 
FUJITSU - 24
Karel UCAP - 29
MITEL - 17
MS_RP - 22
NET2PHONE - 1
NORTEL - 14
SOFTX3000 - 26

Defaults to 0. 

User AgentStringSets the SIP User-Agent passed by the phone when communicating. SHOULD THIS DEFAULT TO A30?
PRACKBoolean, Defaults to 0Enables or disables SIP PRACK functionality within the phone. Defaults to 0.
Keep AUTHBoolean, Defaults to 0If enabled, the phone will, on SIP re-registration, send authentication in the initial REGISTER rather than waiting to send it after receiving a 401 Unauthorized message. Defaults to 0.

Session Timer

Boolean, Defaults to 0If enabled, the phone will send SIP session timers throughout the call, ending the call when there is no reply. Defaults to 0.
S Timer ExpiresInteger, in secondsSets the SIP Session timer timeout value in seconds.
Enable GRUUBoolean, Defaults to 0If enabled, the phone will append GRUU information to the Contact header of INVITEs. Defaults to 0.

DTMF Mode

Integer, 0-3, Defaults to 3

Sets the DTMF method to be used by the phone, as follows:

Inband - 0
RFC2833 - 1
SIP INFO - 2
Auto - 3 

DTMF Inf oModeInteger, 0-1, Defaults to 0If set to 1, and the phone is configured for SIP INFO DTMF, the * and # keypresses will send "*" and "#" respectively. If set to 0, and the phone is configured for SIP INFO DTMF, the * and # keypresses will send as 10 and 11 respectively. Defaults to 0.

NAT Type

Boolean, Defaults to 0If enabled, STUN will be used. Defaults to 0.

Enable Rport

Boolean, Defaults to 0If enabled, the phone will send rport to assist with NAT traversal as per RFC3581. Defaults to 0.

Subscribe

Boolean, Defaults to 0If enabled, the phone will subscribe for Message Waiting Indicator (MWI). Defaults to 0.

Sub Expire

Integer, in seconds, Defaults to 3600The timer at half-of-which, the phone will re-subscribe. Defaults to 3600.

Single Codec

Boolean, Defaults to 0If enabled, the phone will respond to SIP messages with only one codec, rather than with all codec capabilities. Defaults to 0.

CLIR

Integer, Defaults to 0Specifies the method of anonymous calling to use. When set to 0, the phone calls normally. When set to 1, the phone calls anonymously according to RFC3323. When set to 2, the phone calls anonymously according to RFC3325.

Strict Proxy

Boolean, Defaults to 0When enabled, respond using the source address, not the Via address. Defaults to 0.

Direct Contact

Boolean, Defaults to 0When enabled, attempt to directly communicate with the called party, not using the intermediary proxy or UA. Defaults to 0.
History InfoBoolean, Defaults to 0When enabled, call history information for the line will be provided. Defaults to 0. This configuration item is currently unused.

DNS SRV

Boolean, Defaults to 0If enabled, the phone will perform DNS SRV resolution for outgoing requests. Defaults to 0.

DNS Mode

Integer, 0-2, Defaults to 0.Sets the type of host resolution to perform. When set to 0, the phone will use A records. When set to 1, the phone will use SRV records. When set to 2, the phone will use NAPTR records.

XFER Expire

Integer, Defaults to 0Specifies the time, in seconds, after which the phone will send a BYE following attended transfer hang up.

Ban Anonymous

Boolean, Defaults to 0When enabled, the phone will reject anonymous calls. Defaults to 0.

Dial Off Line

Boolean, Defaults to 0If enabled, the phone will attempt to place outgoing calls, even when it is unregistered. If disabled, the phone will not be able to place outgoing calls when it is unregistered. Defaults to 0.

Quota Name

Boolean, Defaults to 0If enabled, the phone will encapsulate the Display Name that it sends in SIP signaling inside of quotation marks. Defaults to 0.

Presence Mode

Boolean, Default to 0When enabled, the phone utilizes special presence handling for Wuchuan servers. Defaults to 0.

RFC Ver

Integer, Defaults to 1Specifies the SIP signaling RFC standard to utilize. When set to 0, the phone will communicate using RFC2543 compliant signaling. When set to 1, the phone will communicate using RFC3261 compliant signaling. Defaults to 1.

Phone Port

UnusedUnused

Signal Port

Integer, Defaults to 5060Sets the phone's local SIP signaling port. Defaults to 5060.

Transport

Integer, 0, 1, 3, Defaults to 0

Sets the transport type for SIP signaling.

UDP - 0
TCP - 1
TLS - 3 

Use SRV Mixer

Boolean, Defaults to 0When enabled, the phone utilizes server-side conferencing support. Defaults to 0.
SRV Mixer UriStringSets the URI to be used for server-side conferencing when the UseSRVMixer option is enabled.

Long Contact

Boolean, Defaults to 0If enabled, allows the phone to process long Contact fields. Defaults to 0.

Auto TCP

Boolean, Defaults to 0When enabled, if the packet size of a UDP signaling packet is to exceed 1300 bytes, automatically use TCP transport. Defaults to 0.

Uri Escaped

Boolean, Defaults to 1If disabled, the phone will not escape # characters into "%23" when creating URIs. While this option is enabled, the rule to send numbers when pressing the # key should be disabled.

Click to Talk

Boolean, Defaults to 0If enabled, the phone can make a call by itself receiving an incoming REFER message. Defaults to 0.

MWI Num

StringSets the number to dial for voicemail.

CallPark Num

StringSets the number to dial for call parking.

Retrieve Num

StringSets the number to dial for call retrieval for Broadsoft environments.

MSRPHelp Num

StringFor MS_RP_BU servers, sets a number to be called after a successful transfer.

User Is Phone

Boolean, Defaults to 1If disabled, the phone will not append the ";user=phone" parameter to SIP messages.

Auto Answer

Boolean, Defaults to 0If enabled, and if the NoAnswerTime has elapsed, the phone will automatically answer an incoming call. Defaults to 0.

NoAnswerTime

Integer, in seconds, defaults to 5Sets the amount of time, in seconds, the phone should wait on an incoming call before proceeding to AutoAnswer, if AutoAnswer is enabled. Defaults to 5.

MissedCallLog

Boolean, Defaults to 1If disabled, the phone will not record call logs for this SIP line. Defaults to 1.

SvcCode Mode

Boolean, Defaults to 0If enabled, the phone will allow the sending of service codes (numbers) to the SIP server, depending on the enabling/disabling of certain functions on the phone. Defaults to 0.

DNDOn SvcCode

StringSets the number to send to the server when DND is enabled on the phone.

DNDOff SvcCode

StringSets the number to send to the server when DND is disabled on the phone.

CFUOn SvcCode

StringSets the number to send to the server when Call Forward Unconditional is enabled on the phone.

CFUOff SvcCode

StringSets the number to send to the server when Call Forward Unconditional is disabled on the phone.

CFBOn SvcCode

StringSets the number to send to the server when Call Forward Busy is enabled on the phone.

CFBOff SvcCode

StringSets the number to send to the server when Call Forward Busy is disabled on the phone.

CFNOn SvcCode

StringSets the number to send to the server when Call Forward on No Answer is enabled on the phone.

CFNOff SvcCode

StringSets the number to send to the server when Call Forward on No Answer is disabled on the phone.

ANCOn SvcCode

StringSets the number to send to the server when Anonymous Call Banning is enabled on the phone.

ANCOff SvcCode

StringSets the number to send to the server when Anonymous Call Banning is disabled on the phone.

Send ANOn Code

StringSets the number to send to the server when Anonymous Calling is enabled on the phone.

Send ANOff Code

StringSets the number to send to the server when Anonymous Calling is disabled on the phone.

CW On Code

StringSets the number to send to the server when Call Waiting is enabled on the phone.

CW Off Code

StringSets the number to send to the server when Call Waiting is disabled on the phone.

VoiceCodecMap

Comma-separated list of:

PCMU
PCMA
G726-32
G729
G723
iLBC
AMR
AMR-WB 
opus
G722

Sets the voice codecs used for this line.

VideoCodecMap

H264Sets the video codecs used for this line.

BLFList Uri

StringSpecifies the BLF Resource List to which the phone should subscribe. Multiple lists are supported, separated by commas.

BLF Server

IPv4 address or HostnameIf the server to which the phone is registered does not support BLF Resource List subscription package, sets the address of the BLF Resource List server.

Respond 182

Boolean, Defaults to 0If enabled, the phone will, when it's already on call and an additional call comes in, send a 182 Queued SIP message to the SIP server. If disabled, the phone sends a 180. Defaults to 0.

Enable BLFList

Boolean, Defaults to 0If enabled, the phone will subscribe for BLF Resource List.

Caller Id Type

Integer, 1-5, Defaults to 1

Sets the priority of the incoming Caller ID:

FROM header - 1
P-Asserted-Identity header, followed by FROM header - 2
Remote-Party-ID header, followed by FROM header - 3
P-Asserted-Identity header, followed by Remote-Party-ID header, followed by FROM header - 4
Remote-Party-ID header, followed by P-Asserted-Identity-Header, followed by FROM header - 5

Syn Clock Time

Boolean, Defaults to 0If enabled, the phone will set its clock according to the Date field in the 200 OK following a successful REGISTER. Defaults to 0.

Use VPN

Boolean, Defaults to 1If disabled, and the phone is connected to a VPN, the phone will not initiate REGISTER using the VPN IP address. If enabled, the phone will, when connected to a VPN, use the VPN IP address to initiate the REGISTER. Defaults to 1.

Enable DND

Boolean, Defaults to 0If enabled, the phone will not accept incoming calls from this SIP line. Defaults to 0.

Inactive Hold

Boolean, Defaults to 0If enabled, the phone will send "a=inactive" in the INVITE sent after a call is placed on hold. If disabled, the phone will send "a=sendonly" in the INVITE sent after a call is placed on hold. Defaults to 0.

Req With Port

Boolean, Defaults to 0If disabled do not send port in SIP messages to the server.

Update Reg Expire

Boolean, Defaults to 1If disabled, the phone will not update its registration expiration with the Expires value from the 200 OK that the server sends in response to a successful registration. Defaults to 1.

Enable SCA

Boolean, Defaults to 0Enables support for the Broadsoft SCA feature. Defaults to 0.

Sub CallPark

StringSets the Call Parking subscribed number for Broadsoft servers.

Sub CC Status

Boolean, Defaults to 0If enabled, subscribes to the Broadsoft call center service. Defaults to 0.

Feature Sync

Boolean, Defaults to 0Enables support for Broadsoft Feature Sync. Defaults to 0.

Enable XferBack

Boolean, Defaults to 0If enabled, when a call is transferred from another, and XferBackTime has been reached, the call will be transferred back to the original transferer. Defaults to 0.

XferBack Time

Integer, in seconds, Defaults to 35Sets the amount of time, in seconds, that must elapse before EnableXferBack is processed.

Use Tel Call

Boolean, Defaults to 0If enabled, the phone will replace "sip" in its URIs with "tel"

Enable Preview

Boolean, Defaults to 0If enabled, video preview will be enabled for video received before answer.

Preview Mode

n/aCurrently unused.

TLS Version

Integer, 0-2, Defaults to 0

Sets the type of TLS protocol version to be used:

TLS 1.0 - 0
TLS 1.1 - 1
TLS 1.2 - 2 

CSTA Number

StringSets the number/URI for the uaCSTA server.

Enable ChgPort

Boolean, Defaults to 0If enabled, the phone will attempt to dynamically change its local SIP port in order to work around SIP Router ALG issues. Defaults to 0.

VQ Name

StringSets an identifier for the voice quality server.

VQ Server

IPv4 Address or HostnameSets the IPv4 Address or hostname of the voice quality server.

VQ Server Port

Integer, 1-65535, Defaults to 5060Sets the port used by the voice quality server.

VQ HTTP Server

URLSets the HTTP URL of the voice quality server.
Flash ModeInteger, 0-1, Defaults to 0If set to 0, flash is handled locally on the phone. If set to 1, the phone will send a SIP INFO message indicating the flash event to the server, with data defined by Content_Type and Content_Body
Content TypeStringSets the content type data used when the phone sends SIP INFO flash messages to the server.
Content BodyStringSets the body of the data used when the phone sends SIP INFO flash messages to the server.
Unregister On BootBoolean, Defaults to 0If enabled, the phone will send unregisters to any registered servers after it reboots, before it attempts to register.  Defaults to 0.
Enable MAC HeaderBoolean, Defaults to 0If enabled, the phone will include a MAC parameter, with MAC address as value, in SDP.
Enable Register MACBoolean, Defaults to 0If enabled, the phone will include a MAC parameter, with MAC address as value, in SIP REGISTER packets.
Record StartRecord:onSpecifies the SDP to be passed when recording is started. Currently unused.
Record StopRecord:offSpecifies the SDP to be passed when recording is stopped. Currently unused.

CALL FEATURE MODULE Elements

 Elements
CALL FEATURE MODULE Elements

Port Config Element

This section contains child elements controlling phone calling configurations.  Each Port configuration is controlled by its index value, beginning with 1, up to 1.

Child elements of <port>
 Elements Example
Port Config Element Examples

Option

Values

Description

Enable XferDPlan

Boolean, Defaults to 1

When enabled, the phone, while in the transfer state, will execute off-hook dialing plan rules. Defaults to 1.

Enable FwdDPlan

Boolean, Defaults to 0

When enabled, the phone, while in the forward state, will execute off-hook dialing plan rules. Defaults to 0.

Enable Pre DPlan

Boolean, Defaults to 0

When enabled, the phone, while in the on-hook state, will execute off-hook dialing plan rules. Defaults to 0.

IP Dial Prefix

String, Defaults to .

Sets a dialing prefix to be prepended before making IP dialed calls. Defaults to .

Enable DND

Integer, 0-2, Defaults to 0When set to 0, enabling DND from the phone will have not affect from any line. When set to 1, enabling DND from the phone will have affect from any line. When set to 2, DND enabling/disabling will follow line rules.

DND Mode

Boolean, Defaults to 0When enabled, the phone will use the DND settings as set for the line. When disabled, the phone will use the DND settings as set for the phone. Defaults to 0.

Enable Space DND

Boolean, Defaults to 0When enabled, the phone will following DND timer as set by DNDStartTime and DNDEndTime

DND Start Time

Time, in 24-hour format, no separatorSets the beginning time for DND to be auto-enabled.

DND End Time

Time, in 24-hour format, no separatorSets the ending time for DND to be auto-disabled.

Enable White List

Boolean, Defaults to 1When enabled, the phone will always allow calls from white listed Caller ID numbers. If disabled, the phone will ignore whitelisted numbers and allow other calls. Defaults to 1.

Enable Black List

Boolean, Defaults to 1When enabled, the phone will never allow calls from black listed Caller ID numbers. If disabled, the phone will allow calls from black listed numbers. Defaults to 1.

Enable CallBar

Boolean, Defaults to 1If disabled, the phone will ignore numbers/prefixes listed in its Restricted Outgoing Calls table. Defaults to 1.

Mute Ringing

Boolean, Defaults to 0If enabled, the phone will not play ringing tone for incoming calls, instead only showing visual indicators. Defaults to 0.

Ban Dial Out

Boolean, Defaults to 0If enabled, the phone will not allow any outgoing calls to be made. Defaults to 0.

Ban Empty CID

Boolean, Defaults to 0If enabled, the phone will not allow any incoming calls that are void of Caller ID information. Defaults to 0.

Accept Any Call

Boolean, Defaults to 1If disabled, the phone will not allow anonymous incoming calls. Defaults to 1.

Enable CLIP

Boolean, Defaults to 1If disabled, the phone will not display incoming Caller ID information. Defaults to 1.

CallWaiting

Boolean, Defaults to 1If disabled, the phone will not allow additional incoming calls if it is already on a call. Defaults to 1.

CallTransfer

Boolean, Defaults to 1If disabled, the phone will not allow the user to transfer calls. Defaults to 1.

CallSemiXfer

Boolean, Defaults to 1If disabled, the phone will not allow Semi / Blond transfers. Defaults to 1.

CallConference

Boolean, Defaults to 1If disabled, the phone will not allow local conference calls. Defaults to 1.

Auto PickupNext

Boolean, Defaults to 0If enabled, ending one call while another is ringing or in progress automatically picks up the ringing or other in-progress call. Defaults to 0.

Busy No Line

Boolean, Defaults to 0If enabled, the phone will play dialing tone when off-hook, only if off-hook on a registered SIP line. Defaults to 0.

Auto Onhook

Boolean, Defaults to 1If disabled, and the AutoOnhookTime has not been reached, the phone will remain off-hook after the conclusion of a handsfree call. Defaults to 1.

Auto Onhook Time

Integer, in seconds, Defaults to 3Sets the time at which the phone should remain off-hook before going on-hook if AutoOnHook is not disabled. Defaults to 3.

Enable Intercom

Boolean, Defaults to 1If disabled, the phone will not go into Intercom mode when receiving an INVITE that should cause it to auto-answer, e.g. Alert-Info: info=alert-autoanswer; or Call-Info: answer-after=2. Defaults to 1.

Intercom Mute

Boolean, Defaults to 0If enabled, the phone, when it goes into Intercom mode, will automatically mute the microphone. Defaults to 0.

Intercom Tone

Boolean, Defaults to 0If enabled, before the phone enters into an Intercom call, it will playback a tone. Defaults to 0.

Intercom Barge

Boolean, Defaults to 0If enabled, the phone will allow an Intercom call to barge over an already-in-progress call. Defaults to 0.

Use Auto Redial

Boolean, Defaults to 0If enabled, when the user calls a busy number, the phone will offer a pop-up to continue dialing the destination according to AutoRedialDelay and AutoRedialTimes. Defaults to 0.
Redial EnterCallLogInteger, 0-1, Defaults to 0If set to 0, the redial button will dial the last number dialed.  If set to 1, the phone will enter the call log and display recently dialed numbers.  Defaults to 1.
AutoRedial DelayInteger, in seconds, Defaults to 30Sets the delay, in seconds, the phone should make between AutoRedialTimes if UseAutoRedial is enabled and has been called by the user. Defaults to 30.
AutoRedial TimesInteger, Defaults to 5Sets the number of times the phone should attempt to automatically redial a busy number. Defaults to 5.

Call Complete

Boolean, Defaults to 0If enabled, the phone will, upon transitioning from having called a Busy party back to the idle state, provide a pop-up allowing the user to dial the busy party again, or cancel. Defaults to 0.

CHolding Tone

Boolean, Defaults to 1If disabled, the phone will not play a tone every 40 seconds a call is left on hold. Defaults to 1.

CWaiting Tone

Boolean, Defaults to 1If disabled, the phone will not play a tone when an incoming call arrives while another call is already in progress. Defaults to 1.

Hide DTMF Type

Integer, 0-3, Defaults to 0

Sets the type of DTMF hiding on the onscreen display:

Display all input - 0
Hide all input using a * character - 1
As digits are entered, change them to a * character after a small delay - 2
Display only the last digit properly, but other digits as a * character - 3

Talk DTMF Tone

Boolean, Defaults to 1If disabled, local DTMF playback of tones will not be heard while the phone is on a call. Defaults to 1.

Dial DTMF Tone

Boolean, Defaults to 1If disabled, local DTMF playback of tones will not be heard while the phone is dialing. Defaults to 1.

Psw Dial Mode

Boolean, Defaults to 0If enabled, the phone will disguise, on-screen, dialed DTMF using * characters. Defaults to 0.

Psw Dial Length

Integer, Defaults to 0Sets the number of digits that should be disguised if PswDialMode is enabled. Digits entered after PswDialLength is reached in length will not be disguised. Defaults to 0.

Psw Dial Prefix

StringSets a dialing prefix that, if dialed, and if PswDialMode is enabled, will disguise, on-screen, dialed DTMF using * characters.

Enable MultiLine

Boolean, Defaults to 1If enabled, the phone will allow up to 10 incoming calls. If disabled, the phone will only allow up to 2 incoming calls. Defaults to 1.

Allow IP Call

Boolean, Defaults to 1If disabled, the phone will not be able to perform direct IP dialing. Defaults to 1.

Caller Name Type

Integer, Defaults to 0

Sets the priority of the caller name presentation:

Local Contact name, followed by Network Contact name, followed by SIP Display name - 0
Local Contact name, followed by SIP Display name, followed by Network Contact name - 1
Network Contact name, followed by Local Contact name, followed by SIP Display name - 2
Network Contact name, followed by SIP Display name, followed by Local Contact name - 3
SIP Display name, followed by Local Contact name, followed by Network Contact name - 4
SIP Display name, followed by Network Contact name, followed by Local Contact name - 5 

Mute For Ring

Boolean, Defaults to 0If the phone is in Silent Mode, enabling this option will cause the phone to ring when calls are received. Defaults to 0

Auto Handle Video

Integer, 0-2, Defaults to 1If set to 0, video must manually be enabled for incoming calls. If set to 1, video will be enabled for incoming calls. If set to 2, video calls will be rejected. Defaults to 1.

Default Ans Mode

Integer, 1-2. Defaults to 2.If set to 1, answer only with audio. If set to 2, answer with audio and video. Defaults to 2.

Default Dial Mode

Integer, 1-2, Defaults to 1.If set to 1, initiate calls only with audio. If set to 2, initiate calls with audio and video. Defaults to 1.

Hold To Transfer

Boolean, Defaults to 0If enabled, the hold key can be used to accomplish a transfer. Defaults to 0.

Enable PreDial

Boolean, Defaults to 1If disabled, the phone will go off-hook as soon as DTMF is entered, and off-hook dialing rules will be active. Defaults to 1.

Default Ext Line

Integer, 1-6, Defaults to 1Sets the line which the phone will, by default, use for outbound calling. Defaults to 1.

Enable De fLine

Boolean, Defaults to 0If enabled, show, while the phone is idle, in the phone's greeting / status bar, the default line that will be used. Defaults to 0.

Enable SelLine

Boolean, Defaults to 1If disabled, do not automatically switch from an unregistered default line to a registered other line for outgoing calls. Defaults to 1.

Ring in Headset

Boolean, Defaults to 0If enabled, play ringing tone out the headset port instead of the loudspeaker. Defaults to 0.

Auto Headset

Boolean, Defaults to 0If enabled, answered calls will answer to the headset, not to the handset (unless lifted) or loudspeaker. Defaults to 0.

DND Return Code

String, Defaults to 480Sets the SIP response code sent when the phone receives calls while DND is enabled. Defaults to 480.

Busy Return Code

String, Defaults to 486Sets the SIP response code sent when the phone receives a call while Busy. Defaults to 486.

Reject Return Code

String, Defaults to 603Sets the SIP response code when the phone rejects an incoming call. Defaults to 603.

Contact Type

Integer, 0-3, Defaults to 0If set to 0, the contact is left alone. If set to 1, the contact may be used for DND, FWD, or white list. If set to 2, the contact is used for DND or white list. If set to 3, the contact is used for FWD or white list. Defaults to 0.

Enable Country Code

Boolean, Default to 0If enabled, the phone will automatically truncate incoming numbers using the country code as defined by CountryCode and CallAreaCode and CodePlanList. Defaults to 0.

Country Code

StringSets the country code to be truncated from incoming numbers.

Cal lArea Code

StringSets the area code to be truncated from incoming numbers.
Number PrivacyBoolean, Defaults to 0If enabled, followed the defined PrivacyRule in order to disguise digits. Defaults to 0.
Privacy RuleString

Sets the privacy rule to apply to Number_Privacy number disguising where:

X defines the first number disguised
* defines a number to be disguised
. defines the last number to be disguised 

Trans DTMF CodeDTMF stringIf defined, sets digits that are sent to the server when a transfer is executed, in order to affect server-side transfer logic.
Hold DTMF CodeDTMF stringIf defined, sets digits that are sent to the server when a hold is executed, in order to affect server-side hold logic.
Conf DTMF CodeDTMF stringIf defined, sets digits that are sent to the server when a conference is executed, in order to affect server-side conference logic.
Disable Dial SearchBoolean, Defaults to 0Currently Unused

Basic DialPlan Element

This section contains child elements controlling phone calling configurations.

Child elements of Basic DialPlan
 Elements Example
basic Element Examples

Option

Values

Description

Dial by Pound

Boolean, Defaults to 1

If disabled, the phone will not allow the use of the # key to send a call upon completion of dialing. The sent number does not include the # DTMF. Defaults to 1.

BTransfer by Pound

Boolean, Defaults to 0If enabled, the phone will allow the use of the # key to blind transfer a call. Defaults to 0.

Onhook to BXfer

Boolean, Defaults to 0If enabled, the phone will allow the completion of a blind transfer by a cradling of the handset. Defaults to 0.

Onhook to AXfer

Boolean, Defaults to 0If enabled, the phone will allow the completion of an attended transfer by a cradling of the handset. Defaults to 0.

Conf Onhook to Xfer

Boolean, Defaults to 0If enabled, the phone will allow the completion of a conference transfer by a cradling of the handset. Defaults to 0.

Dial Fixed Length

Boolean, Defaults to 0If enabled, the phone will immediately dial the number that has been input according to a match of FixedLengthNums. Defaults to 0.

Fixed Length Nums

IntegerSets a number of digits that once entered, if DialFixedLength is enabled, will be immediately dialed.

Dial by Timeout

Boolean, Defaults to 1If disabled, the phone will not initiate a dial once the timeout set by DialTimeoutvalue is reached. Defaults to 1.

Dial Timeout value

Integer, in seconds, Defaults to 10Sets the amount of time, in seconds, the phone will wait for additional digits before completing a dial.

Enable E OneSixFour

Boolean, Defaults to 0If enabled, the phone will allow E.164 compliant dialing. Defaults to 0.

Alert Info Ring Element

This section contains child elements controlling phone behavior for Alert-Info headers.  Each element is controlled by its index value, beginning with 1, up to 10.

Child elements of <alertInfo>
 Elements Example
alertInfo Element Examples

Option

Values

Description

Text

String

Sets the Alert-Info string to be matched for this alert.

Ring TypeType 1
Type 2
Type 3
Type 4
Type 5
Type 6
Type 7
Type 8
Type 9 
Sets the ringing tone type to apply to this alert.

PHONE FEATURE MODULE Elements

 Elements
PHONE FEATURE MODULE Elements

Each element is populated with a value.

PHONE FEATURE MODULE Elements

Option

Values

Description

Menu Password

Integer, Defaults to 789

Sets the password used to access the phone's password-protected advanced menu setting. Defaults to 789.

KeyLock Password

Integer, Defaults to 123Sets the password used to unlock the phone when key lock has been engaged

Fast Keylock Code

IntegerSets a key sequence that, when entered, immediately locks the phone.

Enable KeyLock

Boolean, Defaults to 0If enabled, allows locking of the phone. Defaults to 0.
KeyLock TimeoutInteger in secondsSpecifies the timeout in seconds for keylock.
KeyLock StatusBoolean, Defaults to 0Currently Unused

Emergency Call

StringSets a number the phone is allowed to call, even while locked.

Push XML IP

IPv4 Hostname or addressSets the IPv4 Hostname or address of an XML PUSH server that will transmit XML to the phone.

SIP Number Plan

Boolean, Defaults to 0If enabled, non-numeric characters may be used when dialing out. Defaults to 0.

LDAP Search

Integer, 0-3, Defaults to 0Sets the LDAP server against which to search. Defaults to 0. Obsolete.

Search Path

StringSets the LDAP search path against which to search. Obsolete.

Caller Display T

Integer, 0-4, Defaults to 0

Sets the type of Caller Display to present to the user from:

Display Name Priority - 0
Display Number Only - 1
Alternate Display - 2
Scrolling Display - 3
Display Blank - 4 

CallLog DisplayType

Integer, Defaults to 0If set to 1, display only numbers in the call log list. If set to 0, display names. Defaults to 0.

Enable Recv SMS

Boolean, Defaults to 1If disabled, the phone will not be able to receive incoming text messages. Defaults to 1.

Enable Call History

Boolean, Defaults to 1If disabled, the phone will not record call log entries.

Line Display Format

$protocol$instance
$name@$protocol$instance
$protocol$instance:$name 

Sets the default line label display format for SIP lines.

SIPn - $protocol$instance
xxx@SIPn - $name@$protocol$instance
SIPn:xxx - $protocol$instance:$name 

Enable MWI Tone

Boolean, Defaults to 0If disabled, the phone will not play back a tone when receiving a new message and activating MWI. Defaults to 0.

Display Input Element

This section contains child elements controlling phone display configuration.  

Child elements of <display>
 Elements Example
Display Input Element Examples

Option

Values

Description

LCD Title

Boolean, Defaults to Asterisk

Sets the text displayed in the idle screen status bar. Defaults to Asterisk

LCD Constrast

Integer, 1-10, Defaults to 5Sets the display's contrast level. Obsolete.

Enable Energysaving

Integer, 0-32, Defaults to 4Sets the display's brightness level when the BacklightOffTime is reached. If set to 0, display will never dim. Defaults to 4.

LCD Luminance Level

Integer, Defaults to 12Sets the display's luminance level. Defaults to 12.

Backlight Off Time

Integer, 0-3600 in seconds, Defaults to 45Sets the time, in seconds, at which the backlight will be dimmed to the level set by EnableEnergysaving. Defaults to 45.

Disable CHN IME

Boolean, Defaults to 0If enabled, prevents Chinese input method. Defaults to 0.

Phone Model

String, Defaults to A30Sets the phone model. Defaults to A30.

Host Name

StringSets the phone host name.

Default Language

en, cn, tc, ru, it, de, fr, he

Sets the phone's default language as:

Chinese - cn
English - en
Chinese, Traditional - tc
French - fr
German - de
Hebrew - he
Italian - it
Russian - ru 

Defaults to en.

Enable GreetingsBoolean, Defaults to 0If enabled, the phone will display greeting words. Defaults to 0.

Power LED Element

This section contains child elements controlling the MWI / power LED of the telephone.

Child elements of Power LED
 Elements Example
Power LED Element Examples

Option

Values

Description

Power

Boolean , Defaults to 0

If enabled, the LED will be set to on when the phone is powered on and idle.

MWI Or SMS

Integer, 0-3, Defaults to 3

Sets the behavior of the LED when MWI is received or a SIP Message is received as follows:

Off - 0
On - 1
Fast blink - 2
Slow blink - 3 

Defaults to 3

In Using

Boolean, Defaults to 0If enabled, the LED will be turned on when the phone is off-hook or otherwise in use.

Ring

Integer, 0-3, Defaults to 2

Sets the behavior of the LED when the phone is ringing as follows:

Off - 0
On - 1
Fast blink - 2
Slow blink - 3

Defaults to 2 

HoldInteger, 0-3, Defaults to 0

Sets the behavior of the LED when the phone has a call on hold as follows:

Off - 0
On - 1
Fast blink - 2
Slow blink - 3

Defaults to 0

MuteInteger, 0-3, Defaults to 0

Sets the behavior of the LED when the phone is on mute as follows:

Off - 0
On - 1
Fast blink - 2
Slow blink - 3

Defaults to 0

Missed Call

Integer, 0-3, Defaults to 3

Sets the behavior of the LED when the phone has a missed call as follows:

Off - 0
On - 1
Fast blink - 2
Slow blink - 3

Defaults to 3

Voice Volume Element

This section contains child elements controlling phone volume configurations.

Child elements of <volume>
 Elements Example
Voice Volume Element Examples

Option

Values

Description

Handset Vol

Integer, 1-9, Defaults to 5

Sets the volume of the handset, Defaults to 5.

Handset Mic Vol

Integer, 1-9, Defaults to 3Sets the gain of the handset microphone. Defaults to 3.

Headset Vol

Integer, 1-9, Defaults to 5Sets the volume of the headset. Defaults to 5.

Headset Mic Vol

Integer, 1-9, Defaults to 3Sets the gain of the headset microphone. Defaults to 3.

Headset Ring Vol

Integer, 1-9, Defaults to 5Sets the volume of the headset ringing tone. Defaults to 5.

HandFree Vol

Integer, 1-9, Defaults to 5Sets the volume of the handsfree loudspeaker. Defaults to 5.

HandFree Mic Vol

Integer, 1-9, Defaults to 3Sets the gain of the handsfree microphone. Defaults to 3.

HandFree Ring Vol

Integer, 1-9, Defaults to 5Sets the volume of the handsfree loudspeaker ringing tone. Defaults to 5.

Ring Type

Type 1
Type 2
Type 3
Type 4
Type 5
Type 6
Type 7
Type 8
Type 9

Sets the ringing type to apply to the phone by default.

DateTime Config Element

This section contains child elements controlling phone date and time configurations.

Child elements of DateTime Config
 Elements Example
DateTime Config Element Examples

Option

Values

Description

Enable SNTP

Boolean, Defaults to 1

If disabled, the phone will not attempt to synchronize its clock to the defined SNTPServer

SNTP ServerIPv4 Hostname, Address, Defaults to 0.digium.pool.ntp.orgSets the phone's primary SNTP server. Defaults to 0.digium.pool.ntp.org

Second SNTP Server

IPv4 Hostname, Address, Defaults to 1.digium.pool.ntp.orgSets the phone's secondary SNTP server. Defaults to 1.digium.pool.ntp.org

Time Zone

-44, -40, -38, -36, -32, -28, -24, -30, -18, -16, -14, -12, -10, -8, -4, 0, 4, 8, 12, 14, 16, 18, 20, 22, 23, 24, 26, 28, 32, 35, 36, 38, 40, 42, 44, 46, 48, 51, 52, 54, 56, Defaults to -32

Sets the time zone for the phone as follows:

(UTC-11) Samoa, -44
(UTC-10) Hawaii-Aleutian,Alaska-Aleutia, -40
(UTC-9:30) French Polynesia, -38
(UTC-9) Alaska Time, -36
(UTC-8) Vancouver,Whitehorse,Tijuana,Mexicali,Pacific Time, -32
(UTC-7) Edmonton,Calgary,Mazatlan,Chihuahua,Mountain Time,United States-MST, -28
(UTC-6) Manitoba,Easter Islands,Mexico City,Acapulco,Central Time, -24
(UTC-5) Nassau,Montreal,Ottawa,Quebec,Havana,Eastern Time, -20
(UTC-4:30) Caracas, -18
(UTC-4) Halifax,Saint John,Santiago,Asuncion,Bermuda,Falkland Islands,Trinidad Tobago, -16
(UTC-3:30) New Foundland, -14
(UTC-3) Nuuk,Buenos Aires,no DST,DST, -12
(UTC-2:30) Newfoundland and Labrador, -10
(UTC-2) no DST, -8
(UTC-1) Azores, -1
(UTC) GMT,Greenland,Torshavn,Dublin,Lisboa,Porto,Funchal,Las Palmas,London,Morocco, 0
(UTC+1) Tirane,Vienna,Brussels,Caicos,Chad,Madrid,Zagreb,Prague,Kopenhagen,Paris,Berlin,Budapest,Rome,Luxembourg,Skopje,Amsterdam,Windhoek, 4
(UTC+2) Tallinn,Helsinki,Gaza,Athens,Tel Aviv,Amman,Riga,Beirut,Kishinev,Kaliningrad,Bucharest,Damascus,Kyiv,Odessa, 8
(UTC+3) East Africa Time,Baghdad,Moscow,Ankara, 12
(UTC+3:30) Teheran, 14
(UTC+4) Yerevan,Baku,Tbilisi,Aktau,Samara, 16
(UTC+4:30) Kabul, 18
(UTC+5) Aqtobe,Bishkek,Islamabad,Chelyabinsk, 20
(UTC+5:30) Calcutta, 22
(UTC+5:45) Katmandu, 23
(UTC+6) Astana,Almaty,Novosibirsk,Omsk, 24
(UTC+6:30) Naypyitaw, 26
(UTC+7) Krasnoyarsk,Bangkok, 28
(UTC+8) Beijing,Singapore,Perth,Irkutsk, Ulan-Ude, 32
(UTC+8:45) Eucla, 35
(UTC+9) Seoul,Tokyo,Yakutsk, Chita, 36
(UTC+9:30) Adelaide,Darwin, 38
(UTC+10) Sydney,Melbourne,Canberra,Brisbane,Hobart,Vladivostok, 40
(UTC+10:30) Lord Howe Islands, 42
(UTC+11) Noumea,Srednekolymsk Time, 44
(UTC+11:30) Norfolk Island, 46
(UTC+12) Wellington,Auckland,Kamchatka Time, 48
(UTC+12:45) Chatham Islands, 51
(UTC+13) Nukualofa, 52
(UTC+13:30) Chatham Islands, 54
(UTC+14) Kiribati, 56

Defaults to -32.

Time Zone Name

String, Defaults to UTC-8Sets the name of the time zone in UTC format. Defaults to UTC-8

SNTP Timeout

Integer, in seconds, Defaults to 5000Sets the time period at which the phone should re-sync its clock to the configured SNTP server. Defaults to 5000

DST Type

Integer, 0-2, Defaults to 1If set to 0, the phone will not attempt to automatically set daylight savings times. If set to 1, the phone will attempt to automatically set daylight savings times. If set to 2, the phone utilizes manually configured logic to know when to set daylight savings time modes.

DST Location

Integer, 0-4, Defaults to 3

Sets the daylight savings time location for automatic setting as follows:

None - 0
China (Beijing) - 1
Singapore (Singapore) - 2
Australia (Perth) - 3
Russia (Irkutsk, Ulan-Ude) - 4 

Defaults to 3.

DST Rule Mode

Integer, 0-2, Defaults to 0

Sets the type of DST rule to employ as follows:

Disabled - 0
By Date - 1
By Week - 2 

Defaults to 0

DST Min Offset

Integer, in minutes, Defaults to 60Sets the number of minutes to offset when the DST rule is in effect. Defaults to 60.

DST Start Mon

Integer, 1-12, Defaults to 3Sets the month, by calendar, beginning in January, at which the DST rule should start. Defaults to 3

DST Start Week

-1, 1, 2, 3, 4, 5, 6, Defaults to 5Sets the week, where -1 is the last week, at which the DST rule should start. Defaults to 5.

DST Start Wday

Integer, 0-6, Defaults to 0Sets the week day, where Sunday is 0, at which the DST rule should start. Defaults to 0

DST Start Hour

Integer, 0-23, Defaults to 2Sets the hour at which the DST rule should start. Defaults to 2

DST End Mon

Integer, 1-12, Defaults to 10Sets the month, by calendar, beginning in January, at which the DST rule should end. Defaults to 10

DST End Week

-1, 1, 2, 3, 4, 5, 6, Defaults to 5Sets the week, where -1 is the last week, at which the DST rule should end. Defaults to 5.

DST End Wday

Integer, 0-6, Defaults to 0Sets the week day, where Sunday is 0, at which the DST rule should end. Defaults to 0.

DST End Hour

Integer, 0-23, Defaults to 2Sets the hour at which the DST rule should end. Defaults to 2.

DateTime Display Element

This section contains child element controlling phone display of time.

Child elements of DateTime Display
 Elements Example
DateTime Display Element Examples

Option

Values

Description

Enable TimeDisplay

n/a

Currently unused

Time Display Style

Integer, 0-1, Defaults to 1If set to 0, display time using 24-hour format. If set to 1, display time using 12-hour format. Defaults to 1.

Date Display Style

Integer, 0-13, Defaults to 0

Sets the date display formatting that should be used by the phone as follows:

1 JAN MON - 0
JAN 1 MON - 1
MON 1 JAN - 2
MON JAN 1 - 3
DD MM YY - 4
DD MM YYYY - 5
MM DD YY - 6
MM DD YYYY - 7
YY MM DD - 8
YYYY MM DD - 9
1 January Monday - 10
January 1 Monday - 11
Monday 1 January - 12
Monday January 1 - 13 

Date Separator

Integer, 0-3, Defaults to 0

Sets the date display separator that should be used by the phone as follows:

/, 0
-, 1
., 2
(space character), 3 

ScreenSaver Config Element

This section contains child element, ScreenSaver Config, currently unused.

Child elements of ScreenSaver Config
 Elements Example
ScreenSaver Config Element Examples

Option

Values

Description

Screen Saver Type

n/a

Currently unused

Screen Timeoutn/aCurrently unused
Enable ActivePeriodn/aCurrently unused

Period One Start

n/aCurrently unused

Period One End Time

n/aCurrently unused

Period Two Start

n/aCurrently unused

Period Two End Time

n/aCurrently unused

Screen Saver App

n/aCurrently unused

Sleep After Active

n/aCurrently unused

Sleep Timeout

n/aCurrently unused

Softkey Config Element

This section contains child elements that control the softkey functions available during various phone states.

Child elements of Softkey Config
 Elements Example
softkey Element Examples

Option

Values

Description

Desktop Softkey

Defaults to: history;contact;dnd;menu;

Sets the soft key mapping for the idle screen.

Talking Softkey 

Defaults to: hold;xfer;conf;end;

Sets the soft key mapping for the on-call screen.
Ringing SoftkeyDefaults to: accept;none;forward;reject;Sets the soft key mapping for the ringing (incoming call) screen.
Alerting SoftkeyDefaults to: end;none;none;none;Sets the soft key mapping for the alerting screen.
XAlerting SoftkeyDefaults to: end;none;none;none;Sets the soft key mapping for the transfer alerting screen.
Conference SoftkeyDefaults to: hold;none;split;end;Sets the soft key mapping for the conference screen.
Waiting SoftkeyDefaults to: hold;xfer;conf;end;Sets the soft key mapping for the waiting screen.
Ending SoftkeyDefaults to: repeat;none;none;end;Sets the soft key mapping for the ending (far-end has disconnected) screen.
DialerPre SoftkeyDefaults to: delete;none;send;exit;Sets the soft key mapping for the on-hook dialing screen.
DialerXfer SoftkeyDefaults to: delete;xfer;send;exit;Sets the soft key mapping for the transfer screen.
DialerCfwd SoftkeyDefaults to: delete;none;cfwd;exit;Sets the soft key mapping for the call forwarding screen.
Desktop ClickDefaults to: history;status;paccout;naccout;menu;Sets the key mapping for the directional and check keys (up key, down key, left key, right key, check key) for the Idle state.
Dailer ClickDefaults to: pline;nline;none;none;none;Sets the key mapping for the directional and check keys (up key, down key, left key, right key, check key) for the Dialing state.
Call ClickDefaults to: pcall;ncall;voldown;volup;none;Sets the key mapping for the directional and check keys (up key, down key, left key, right key, check key) for the on-call state.
Desktop Long PressDefaults to: status;none;none;mwi;none;Sets the key mapping for the directional and check keys (up key, down key, left key, right key, check key) when they are long-pressed.
Softkey ModeInteger, 0-2, Defaults to 1If set to 0, custom soft keys are disabled. If set to 1, the More softkey is enabled for keys exceeding four. If set etc 2, the Arrow soft key is used for keys exceeding four. Currently hard-coded to 1.
DialerConf SoftkeyDefaults to: contact;clogs;redial;video;cancel;Currently unused.

Agent Config Element

This section contains child elements that control the Broadsoft Agent functionality, currently unused.

Child elements of Agent Config
 Elements Example
Agent Config Element Examples

Option

Values

Description

Agent Username

String

Sets the agent username.

Agent PasswordStringSets the agent password.
Agent NumberStringSets the agent number.
Agent SiplineInteger, 0-6, Defaults to 0Sets the SIP line to use for Agent login.
Agent StatusInteger, 0-4, Defaults to 0

Sets the agent status as follows:

LOGON - 0
LOGOFF - 1
UNAVILABLE - 2
AVAILABLE - 3
WRAPUP - 4 

Agent Status ReasonStringSets the agent's status reason code.

BW Directory Element

This section contains child elements that controls the Broadsoft remote phonebook functionality.  Each phonebook is identified by a unique index value expressed as an integer from 1-6.  Currently unused.

Child elements of BW Directory
 Elements Example
BW Directory Element Examples

Option

Values

Description

Title

String

Sets the displayed title of the remote Broadsoft phonebook.

URLStringSets the URL of the remote Broadsoft phonebook.
UsernameStringSets the username used to retrieve the remote Broadsoft phonebook.
PasswordStringSets the password used to retrieve the remote Broadsoft phonebook.
SipLineInteger, 0-5, Defaults to 0

Sets the SIP line with which to associate the remote Broadsoft phonebook.

BW Calllogs Element

This section contains child elements that control the Broadsoft remote call log functionality.  Each call log is identified by a unique index value expressed as an integer from 1-3.  Currently Unused

Child elements of BW Calllogs
 Elements Example
BW Calllogs Element Examples

Option

Values

Description

Title

String

Sets the displayed title of the remote Broadsoft call log.

URLStringSets the URL of the remote Broadsoft call log.
UsernameStringSets the username used to retrieve the remote Broadsoft call log.
PasswordStringSets the password used to retrieve the remote Broadsoft call log.
SipLineInteger, 0-5, Defaults to 0

Sets the SIP line with which to associate the remote Broadsoft call log.

LDAP Config Element

This section contains child elements that control the LDAP phonebook directory server functionality.  Each ldap element is identified by a unique index value expressed as an integer from 1-4.

Child elements of LDAP Config
 Elements Example
LDAP Config Element Examples

Option

Values

Description

Title

String

Sets the displayed title of the LDAP phonebook.

ServerStringSets the IPv4 address or hostname of the LDAP server.
PortInteger, Defaults to 389Sets the port for contacting the LDAP server. Defaults to 389.
BaseString, limited to 39 charactersSets the LDAP search root / base for queries.
Use SSLBoolean, Defaults to 0

If enabled, the phone will attempt to use SSL to connect to the LDAP server. Defaults to 0.

VersionInteger, 2-3, Defaults to 3Sets the LDAP protocol version to use when communication to the server. Defaults to 3.
Calling LineInteger, -1-6, Defaults to -1If -1, creating calls through the LDAP phonebook will be done via the current line. If the value is 1-6, use the corresponding SIP line to place the calls. Defaults to -1.
Bind LineInteger, -1-6, Defaults to 01If -1, queries through the LDAP phonebook will be done via the current line. If the value is 16, use the corresponding SIP line to place the calls. Defaults to -1.
In Call SearchBoolean, Defaults to 0If enabled, the phone will attempt to search the LDAP phonebook for matches for incoming calls.
Out Call SearchBoolean, Defaults to 0If enabled, the phone will attempt to search the LDAP phonebook for matching for outgoing calls.
AnonymousBoolean, Defaults to 0Unused.
AuthenticateInteger, 0-3, Defaults to 3

Specifies the method of authentication to be used against the LDAP server as follows:

None - 0
Digest-MD5 - 1
CRAM-MD5 - 2
Simple - 3 

UsernameStringSets the LDAP server authentication username.
PasswordStringSets the LDAP server authentication password.
Tel AttrString, defaults to telephoneNumberSets the LDAP attribute name to search for telephone numbers.
Mobile AttrString, defaults to mobileSets the LDAP attribute name to search for mobile numbers.
Other AttrStringSets an additional LDAP attribute name that can be searched for other numbers.
Name AttrString, defaults to "cn sn ou"Sets the LDAP name attributes that should be searched for people's names.
Sort AttrAn attribute defined by NameAttrSets the attribute, as defined by NameAttr, that should be sorted.
DisplaynameAn attribute defined by NameAttrSets the attribute, as defined by NameAttr, that should be displayed on the phone.
Number FilterString, Defaults to (|(telephoneNumber=%)(mobile=%)(other=%))Sets the LDAP search results filter for number filtering. Defaults to (|(telephoneNumber=%)(mobile=%)(other=%))
Name FilterString, Defaults to (|(cn=%)(sn=%))Sets the LDAP search results filter for name filtering. Defaults to (|(cn=%)(sn=%))
Max HitsInteger, Defaults to 50Sets the maximum number of results that the LDAP server will return for a given search. Defaults to 50.

Xml PhoneBook Element

This section contains child element that control the remote XML phonebook functionality.  Each phonebook is identified by a unique index value expressed as an integer from 1-5

Child elements of Xml PhoneBook
 Elements Example
Xml PhoneBook Element Examples

Option

Values

Description

Name

String

Sets the displayed name of the remote phonebook.

AddrURL stringSets the address of the remote phonebook.
UserNameStringSets the username optionally used to retrieve the remote phonebook.
PassWdStringSets the password optionally used to retrieve the remote phonebook.
SipLineInteger, -1-6, Defaults to -1

Sets the SIP line with which to associate the remote phonebook. If set to -1, use the current line. Otherwise, use the specified SIP line, from 1-6.

BindLineInteger, -1-6, Defaults to -1Sets the SIP line with which to bind the remote phonebook. If set to -1, use the current line. Otherwise, use the specified SIP line, from 1-6.

DEVICE MANAGER MODULE Elements

 Elements
DEVICE MANAGER MODULE Elements

Each element is populated with a value.

DEVICE MANAGER MODULE Elements

Option

Values

Description

Onhook Time

Time in milliseconds, Defaults to 120

Sets the on-hook debounce timer. Defaults to 120.

CTI CONFIG MODULE Elements

 Elements
CTI CONFIG MODULE Elements

Each element is populated with a value.

CTI CONFIG MODULE Elements

Option

Values

Description

Enabled Active Uri

Boolean, Defaults to 1

If disabled, the phone will not accept remote phone control from the server defined by ActiveUriIP. Defaults to 1.

Enabled Action UrlBoolean, Defaults to 1If disabled, the phone will not process any of the Action URL Event settings. Defaults to 1.
Active Uri IPStringSpecifies the IP address of the remote server sending commands to the phone.
Start Reboot UrlStringSpecifies the URL the phone should contact when it beings the reboot process.
Boot Completed UrlStringSpecifies the URL the phone should contact when it completes the boot process.
IP Change UrlStringSpecifies the URL the phone should contact when it changes IP addresses.
Reg On UrlStringSpecifies the URL the phone should contact when it completes a SIP registration.
Reg Off UrlStringSpecifies the URL the phone should contact when SIP registration is disabled.
Reg Failed UrlStringSpecifies the URL the phone should contact when SIP registration fails.
PhoneState Idle UrlStringSpecifies the URL the phone should contact when the phone returns from in-use to idle state.
PhoneState TalkingStringSpecifies the URL the phone should contact when it transitions from idle to talking (in-use).
PhoneState RingingStringSpecifies the URL the phone should contact when it transitions to the ringing state.
DND On UrlStringSpecifies the URL the phone should contact when DND is enabled.
DND Off UrlStringSpecifies the URL the phone should contact when DND is disabled.
Always FWD On UrlStringSpecifies the URL the phone should contact when Call Forward Always is enabled.
Always FWD Off UrlStringSpecifies the URL the phone should contact when Call Forward Always is disabled.
Busy FWD On UrlStringSpecifies the URL the phone should contact when Call Forward Busy is enabled.
Busy FWD Off UrlStringSpecifies the URL the phone should contact when Call Forward Busy is disabled.
No Ans FWD On UrlStringSpecifies the URL the phone should contact when Call Forward No Answer is enabled.
No Ans FWD Of fUrlStringSpecifies the URL the phone should contact when Call Forward No Answer is disabled.
Mute On UrlStringSpecifies the URL the phone should contact when Mute is enabled.
Mute Off UrlStringSpecifies the URL the phone should contact when Mute is disabled.
Incmoing Call UrlStringSpecifies the URL the phone should contact when it receives an incoming call.
Outgoing Call UrlStringSpecifies the URL the phone should contact when it makes an outgoing call.
Call Active UrlStringSpecifies the URL the phone should contact when a call active.
Call Stop UrlStringSpecifies the URL the phone should contact when a call is stopped.
Transfer UrlStringSpecifies the URL the phone should contact when a call is transferred.
Hold On UrlStringSpecifies the URL the phone should contact when it places a call on hold.
Hold Off UrlStringSpecifies the URL the phone should contact when it takes a call off of hold.
Held On UrlStringSpecifies the URL the phone should contact when it is placed on hold.
Held Off UrlStringSpecifies the URL the phone should contact when it is taken off of hold.
Mute On Call UrlStringSpecifies the URL the phone should contact when muting a call.
Mute Off Call UrlStringSpecifies the URL the phone should contact when unmuting a call.
New Missed call UrlStringSpecifies the URL the phone should contact when it receives a new missed call.
New MWI UrlStringSpecifies the URL the phone should contact when it receives a new MWI event.

New SMS Url

StringSpecifies the URL the phone should contact when it receives a new MESSAGE event.

CTI AT Config Element

This section contains child elements that control manufacturing testing.

Child elements of <at>
 Elements Example
at Element Examples

Option

Values

Description

At Enabledn/aUsed during manufacturing testing. Not user controllable.
At Servern/a

Used during manufacture testing. Not user controllable.

MCAST CFG MODULE Elements

 Elements
MCAST CFG MODULE Elements

Each element is populated with a value.

MCAST CFG MODULE Elements

Option

Values

Description

Priority

Integer, 0-10, Defaults to 0

Sets the priority value at which normal calls should take precedence over multicasted audio calls. At 0, normal calls will take priority over any multicasted calls. At 1, normal calls are lower priority than multicast priority 1 calls, but higher priority than any other multicast priority levels. Additional values follow the same logic. Defaults to 0.

Enable PriorityBoolean, Defaults to 0If enabled, the phone will sort multicast audio by priority, allowing one multicast audio stream to take precedence over another multicast audio stream. Defaults to 0.

Mcast Addr Element

This section contains child elements that set up the multicast audio listeners.  Each addr is identified by an index, specified with a unique integer, 1-10.

Child elements of Mcast Addr
 Elements Example
Mcast Addr Element Examples

Option

Values

Description

NameStringSets the name to be displayed on the phone's screen when audio from this multicast listener is played back.
HostIPv4 Multicast address

Sets the IPv4 multicast address for this listener.

PortIntegerSets the port for this multicast listener.

MMI CONFIG MODULE Elements

 Elements
MMI CONFIG MODULE Elements

Each element is populated with a value.

MMI CONFIG MODULE Elements

Option

Values

Description

Web Server Type

Boolean, Defaults to 0

If enabled, the phone will permit access to its configuration web pages using HTTPs, instead of HTTP. Defaults to 0.

Web PortInteger, Defaults to 80Sets the port for HTTP access. Defaults to 80.
Https Web PortInteger, Defaults to 443Sets the port for HTTPs access. Defaults to 443.
Remote ControlBoolean, Defaults to 1If disabled, the phone will not permit web configuration across the WAN port.
Enable MMI FilterBoolean, Defaults to 0If enabled the phone will not permit web configuration from any device not in the filter list.
Web AuthenticationBoolean, Defaults to 0If enabled, the phone utilizes basic auth instead of digest auth. Defaults to 0.
Enable TelnetBoolean, Defaults to 0If enabled, the phone will allow telnet access. Defaults to 0.
Telnet PortInteger, Defaults to 23Sets the port for Telnet access. Defaults to 23.
Telnet PromptStringSets the prompt to be given after logging in via Telnet.
Logon TimeoutTime in minutes, Defaults to 15Specifies the time before web logins are timed out. Defaults to 15.

MMI Account Element

This section contains child elements that set up web access users.  Each account is identified by an index, specified with a unique integer, 1-10.

Child elements of <account>
 Elements Example
account Element Examples

Option

Values

Description

NameStringSets the username for this account.
PasswordString

Sets the password for this account.

LevelInteger: 5, 10Sets the access level for this account. 5 for users, 10 for administrators.

TR069 CONFIG MODULE Elements

 Elements
TR069 ConfIG MODULE Elements

Each element is populated with a value.

TR069 CONFIG MODULE Elements

Option

Values

Description

TR069 Tone

Boolean, Defaults to 1

If disabled, the phone will not play a prompt tone after a successful TR069 connection. Defaults to 1.

CP ESerialNumberStringDisplays the equipment serial number. Not user-configurable.
ACS Server TypeBoolean, Defaults to 1When enabled, the phone is compatible with Common ACS servers. When disabled, the phone is compatible with Telecom (CTC) ACS servers. Defaults to 1.
Enable TR069Boolean, Defaults to 0If enabled, the phone will, on boot, send an authentication message to the ACS server. Defaults to 0.
ACS URLStringSets the address of the ACS server.
ACS UserNameStringSets the username used to authenticate against the ACS server.
ACS PasswordStringSets the password used to authenticate against the ACS server.
ACS Backup URLStringSets the address of a backup ACS server used when the primary server is unavailable.
ACS BackupUserNameStringSets the username used to authenticate against the backup ACS server.
ACS BackupPasswordStringSets the password used to authenticate against the backup ACS server.
CPE UserNameStringSets the CPE username used to authenticate against the ACS server.
CPE PasswordStringSets the CPE password used to authenticate against the ACS server.
Periodix IntervalInteger in seconds, Defaults to 3600Sets the CPE packet interval time. Defaults to 3600.
TLS VersionInteger, 0-2, Defaults to 0

Sets the TLS protocol to use when communicating with the ACS server as follows:

TLS 1.0 - 0
TLS 1.1 - 1
TLS 1.2 - 2 

Area CodeIntegerSets the ACS server area code. Defaults to 020.
STUN EnableBoolean, Defaults to 0If enabled, the phone will use a STUN server as specified by STUNServerAddr when performing TR069 provisioning.
STUN Server AddrIPv4 address or hostnameSets the STUN server address to use when performing TR069 provisioning.
STUN Serv erPortInteger, Defaults to 3478Sets the STUN server port to use when performing TR069 provisioning. Defaults to 3478.
STUN Local PortInteger, Defaults to 30000Sets the local STUN port to use when performing TR069 provisioning. Defaults to 30000.

 

SIP Hotspot MODULE Elements

 Elements
SIP Hotspot MODULE Elements

Each element is populated with a value.

SIP Hotspot MODULE Elements

Option

Values

Description

Enable Hotspot

n/a

Currently unused
Moden/aCurrently unused
Listen Typen/aCurrently unused
Listen IPn/aCurrently unused
Listen Portn/aCurrently unused
Own Namen/aCurrently unused

Line Conf List Element

This section contains child elements that set up Hotspot lines.  Each line is identified by an index, specified with a unique integer, 1-10.  Currently unused.

Child elements of Line Conf List
 Elements Example
Line Conf List Element Examples

Option

Values

Description

Enablen/aCurrently unused.

VPN CONFIG MODULE Elements

 Elements
VPN CONFIG MODULE Elements

Each element is populated with a value.

VPN CONFIG MODULE Elements

Option

Values

Description

VPN mode

Integer, -1, 1, 2, Defaults to -1

When set to -1, VPN is disabled, When set to 1, L2TP mode is enabled. When set to 2, OpenVPN mode is enabled.
Enable VPNBoolean, Defaults to 0If enabled, the phone will start the VPN connection.
Enable NatBoolean, Defaults to 0If enabled, other devices may route through the phone and out the VPN.
Openvpn modeBoolean, Defaults to 0When enabled, the OpenVPN configuration will use tap mode. When disabled the OpenVPN configuration will use tun mode. Defaults to 0.
L2TP Server AddressIPv4 address or hostnameSpecifies the address of the L2TP server.
L2TP User NameStringSets the L2TP authentication user name.
L2TP PasswordStringSets the L2TP authentication password.
L2TP Negotiate DNSBoolean, Defaults to 1If enabled, the L2TP server must assign the DNS server. Defaults to 1.
PPTP Server AddressIPv4 address or hostnameSpecifies the address of the PPTP server.
PPTP User NameStringSets the PPTP authentication user name.
PPTP PasswordStringSets the PPTP authentication password.

MAINTENANCE CONFIG MODULE Elements

 Elements
MAINTENANCE CONFIG MODULE Elements

Each element is populated with a value.

MAINTENANCE CONFIG MODULE Elements

Option

Values

Description

Contact Update Mode

Integer, 0-1, Defaults to 0

Sets the method by which the phone updates contacts. If set to 0, compare and add new. If set to 1, flush and import new list. Defaults to 0.

Auto Server DigestBoolean, Defaults to 0If enabled, the phone will verify the server digest

AUTOUPDATE CONFIG MODULE Elements

 Elements
AUTOUPDATE CONFIG MODULE Elements

Each auto provisioning element is populated with a value.

ap Elements

Option

Values

Description

Default Username

String

Sets the optional password that will be passed in when performing retrievals of provisioning files.

Default PasswordStringSets the optional password that will be passed in when performing retrievals of provisioning files.
Input Cfg File Namenull, $mac.cfg, $input.cfgIf null, the phone will retrieve a file as <mac>.cfg. If set to $mac, the phone will also retrieve a file as <mac>.cfg. If set to $input.cfg, the phone will prompt the user on the screen to input the file name during boot.
Device Cfg File KeyStringSpecifies an AES key that must be used to decrypt the device configuration file.
Common Cfg File KeyStringSpecifies an AES key that must be used to decrypt the common configuration file.
Download CommonConfBoolean, Defaults to 1If disabled, the phone will only download its own configuration file, and not also attempt to download the common configuration file.
Save Provision InfoBoolean, Defaults to 0If enabled, the phone will save the auto provisioning information.
Check Fail TimesInteger, Defaults to 5Specifies the number of time the phone will attempt to retrieve the provisioning information after failure before attempting to continue.
Flash Server IPIPv4 address or hostnameSpecifies the IPv4 address or hostname from which to cURL down provisioning information.
Flash File NameStringSpecifies the filename of the file to cURL down when performing AP.
Flash ProtocolInteger, 1, 2, 4, 5, Defaults to 2

Sets the protocol used to contact the provisioning server as follows:
FTP - 1
TFTP - 2
HTTP - 4
HTTPs - 5
Defaults to 1

Flash ModeInteger, 0-2, Defaults to 0

Sets the provisioning upgrade type as follows:

Do not download the specified config file - 0
Download the specified config file after reboot - 1
Download the specified config file according to the Download_Interval - 2 

Defaults to 0

Flash IntervalInteger, in hours, Defaults to 1Sets the interval, in hours, at which the phone will download the configuration file if so-specified by Download_Mode. Defaults to 1.
update PB IntervalInteger, in seconds, Defaults to 720Specifies the interval at which to update phonebooks. Defaults to 720.
Auto Image UrlStringSpecifies the location of a firmware file that the phone should download.
Auto Pbook UrlStringSpecifies the location of an XML phonebook the phone should download.

SIP Pnp List Element

This section contains child element that set up uPNP provisioning configuration for the phone.

Child elements of SIP Pnp List
 Elements Example
Sip Pnp List Element Examples

Option

Values

Description

PNP EnableBoolean, Defaults to 1If disabled, the phone will not attempt SIP uPNP for provisioning.
PNP IPIPv4 AddressSpecifies the IPv4 address to which the phone should broadcast its SIP uPNP information.
PNP PortInteger, Defaults to 5060Specifies the port to which the phone should broadcast its SIP uPNP information.
PNP TransportInteger, Defaults to 0If 0, broadcast using UDP. If 1, broadcast using TCP.
PNP IntervalInteger, 1-99, in hours, Defaults to 1Specifies the interval at which the phone should broadcast its SIP uPNP information.

Net Option Element

This section contains child element that set up DHCP Option provisioning configuration for the phone.

Child elements of Net Option
 Elements Example
Net Option Element Examples

Option

Values

Description

DHCP OptionInteger, Defaults to 66

Sets the type of DHCP Option to respond to for provisioning URL as follows:

Disabled - 0
Option 43 - 43
Option 66 - 66
Custom - 128-254 

DHCPv6 OptionInteger, Defaults to 0Currently unused
Dhcp Option 120Boolean, Defaults to 0If enabled, the phone will retrieve the SIP server address using DHCP Option 120. Defaults to 0.

OTA CONFIG MODULE Elements

 Elements
OTA CONFIG MODULE Elements

Each element is populated with a value.  At present, there are no ota element options.

OTA CONFIG MODULE Elements

Option

Values

Description

nullnullnull

RPS CONFIG MODULE Elements

 Elements
RPS CONFIG MODULE Elements

Each element is populated with a value.

RPS CONFIG MODULE Elements

Option

Values

Description

Rps NameString, Defaults to digiumSpecifies the name of the phone when reporting. Defaults to digium.

DIGIUM CONFIG MODULE Elements

 Elements
DIGIUM CONFIG MODULE Elements

Each element is populated with a value.

DIGIUM CONFIG MODULE Elements

Option

Values

Description

Digium EnableBoolean, Set to 1Specifies that the phone will contact Digium on boot
Lockdown StatusBooleanSpecifies the lockdown status of the phone. Defaults to 0.
Digium UrlString as URLSpecifies the URL of the Digium service
Pbx User AgentStringReports the User Agent of the last thing the phone was registered to.

FIRMWARE CHECK MODULE Elements

 Elements
FIRMWARE CHECK MODULE Elements

Each element is populated with a value.

FIRMWARE CHECK MODULE Elements

Option

Values

Description

Enable Auto UpgradeBoolean, Defaults to 0If enabled, the phone will automatically upgrade to new firmware if provided
Upgrade Server 1StringSpecifies the location of the first firmware server.
Upgrade Server 2StringSpecifies the location of the second (backup) firmware server.
Auto Upgrad IntervalInteger, in hours, Defaults to 24Specifies the amount of time, in hours, at which the phone should check for an upgrade. Defaults to 24.

QOS CONFIG MODULE Elements

 Elements
QOS CONFIG MODULE Elements

Each element is populated with a value.

QOS CONFIG MODULE Elements

Option

Values

Description

Enable VLAN

Boolean, Defaults to 0

If enabled, the phone will perform VLAN assignment of itself.

VLAN IDInteger, 0-4095Sets the VLAN ID to which the phone should bind itself.
Enable PVIDBoolean, Defaults to 0If enabled, the phone will tag and untag traffic relayed from/to the PC port.
PVID ValueInteger, 0-4095Sets the VLAN ID that the phone should use for tagging traffic from the PC port.
Signaling PriorityInteger, 0-7Sets the 802.1p COS bit for SIP Signaling.
Voice PriorityInteger, 0-7Sets the 802.1p COS bit for RTP audio.
VIdeo PriorityInteger, 0-7Sets the 802.1P COS bit for RTP video.
LAN Port PriorityInteger, 0-7Sets the 802.1p COS bit for the LAN port

Enable diffServ

Boolean, Defaults to 1If disabled, the phone will not perform DSCP tagging. Defaults to 1.
Singalling DSCPInteger, Defaults to 46Sets the SIP signaling DSCP byte.
Voice DSCPInteger, Defaults to 46Sets the RTP audio DSCP byte.
Video DSCPInteger, Defaults to 46Sets the RTP video DSCP byte.
LLDP TransmitBoolean, Defaults to 1If disabled, the phone will not send LLDP packets. Defaults to 1.
LLDP Refresh TimeInteger, in seconds, Defaults to 60Sets the period at which LLDP packets will be sent from the phone.
LLDP Learn PolicyBoolean, Defaults to 1If disabled, the phone will not attempt to learn its VLAN assignment using LLDP-MED TLV. Defaults to 1.
LLDP Save Learn DataBoolean, Defaults to 0If enabled, the phone will save the learned LLDP-MED data.

CDP Enable

Boolean, Defaults to 0If enabled, the phone will send CDP packets.

CDP Refresh Time

Integer, in seconds, Defaults to 60Sets the period at which CDP packets will be sent from the phone.
DHCP Option VlanInteger, Defaults to 0If set to 0, the phone will not retrieve its VLAN from DHCP. If set to an option, 128-254, the phone will respond to the named DHCP Option.

LOG CONFIG MODULE Elements

 Elements
LOG CONFIG MODULE Elements

Each element is populated with a value.

LOG CONFIG MODULE Elements

Option

Values

Description

Level

INFO

Sets the logging level to be output to the remote syslog server.

Style"level, tag"Sets the type of logging output to be sent to the remote syslog server.
Output DevicestdoutSets the device to output to, for the remote syslog server.
File Nameplatform.logSets the phone output log file that will be sent to the remote syslog server.
File Size512KBSets the maximum size of the output log.
Syslog TagplatformSets the logging tag to send to the remote syslog server.
Syslog ServerIPv4 address or hostnameSets the IPv4 address or hostname of the remote syslog server.
Syslog Server PortInteger, Defaults to 514Sets the port of the remote syslog server.

APP CONFIG MODULE Elements

 Elements
APP CONFIG MODULE Elements

Each element is populated with a value.

APP CONFIG MODULE Elements

Option

Values

Description

Watch Dog Enabled

Boolean, Defaults to 1

If disabled, the phone will not run its watchdog, which will automatically restart it in the event of a crash. Defaults to 1.

Enable In AccessBoolean, Defaults to 0If enabled, remoter servers cannot access the phone, but the phone can contact them. Defaults to 0.
Enable Out AccessBoolean, Defaults to 0If enabled, the phone cannot access remote servers, but can be contacted by them. Defaults to 0.

VQM CONFIG MODULE Elements

 Elements
VQM CONFIG MODULE Elements

Each element is populated with a value.

VQM CONFIG MODULE Elements

Option

Values

Description

Session Report

Boolean, Defaults to 1

If disabled, the phone will not send RTCP-XR Session Reports.

Interval ReportBoolean, Defaults to 1If disabled, the phone will not send RTCP-XR Interval Reports.
Interval PeriodInteger, in seconds, 5-99, Defaults to 60Sets the interval period at which the phone sends RTCP-XR reports. Defaults to 60.
MOS-LQ WarningInteger, 15-40, Defaults to 40Sets the warning threshold for MOS-LQ
MOS-LQ CriticialInteger, 15-40, Defaults to 25Sets the critical threshold for MOS-LQ
Delay WarningInteger, in milliseconds, 10-2000, Defaults to 150Sets the warning threshold for Delay. Defaults to 150.
Delay CriticalInteger, in milliseconds, 10-2000, Defaults to 200Sets the critical threshold for Delay. Defaults to 200.
Phone ReportBoolean, Defaults to 1If disabled, does not display reports on the phone.
WEB ReportBoolean, Defaults to 1If disabled, does not display reports on the phone's web interface.

DOT1X CONFIG MODULE Elements

 Elements
DOT1X CONFIG MODULE Elements

Each element is populated with a value.

DOT1X CONFIG MODULE Elements

Option

Values

Description

Xsup Mode

Integer, 0-3, Defaults to 0

Sets the 802.1X authentication method to be used as follows:

None - 0
EAP-MD5 - 1
EAP-TLS - 2
PEAP-MSCHAPv2 - 3 

Xsup UserStringSets the 802.1X authentication user name.
Xsup PasswordStringSets the 802.1X authentication password.

SSL Mode Element

This section contains child elements that setup 802.1X SSL authentication.

Child elements of SSL Mode
 Elements Example
opt Element Examples

Option

Values

Description

Permission CTFBoolean, Defaults to 0

If enabled, validates the server certificate. Defaults to 0.

Common NameBoolean, Defaults to 0If enabled, validates the common name in the server certificate. Defaults to 0.
CTF modeInteger, 0-2, Defaults to 0If set to 0, try default and custom certificates. If set to 1, try default (embedded) certificates only. If set to 2, try custom (user uploaded) certificates only. Defaults to 0.
Device Cert ModeInteger, 0-1, Defaults to 1When set to 0, the phone uses only built-in certificates for validation. When set to 1, the phone will use customer-provided certificates for validation.

RECORD CONFIG MODULE Elements

 Elements
RECORD CONFIG MODULE Elements

Each element is populated with a value.

RECORD CONFIG Elements

Option

Values

Description

Enabled

n/a

Currently unused
Voice Codecn/aCurrently unused
Record Typen/aCurrently unused
File Size Limitn/aCurrently unused
Server Addrn/aCurrently unused
Server Portn/aCurrently unused

ATE CONFIG MODULE Elements

 Elements
ATE CONFIG MODULE Elements

Each element is populated with a value.

ATE CONFIG MODULE Elements

Option

Values

Description

ATEId

Unused

Unused

UI MAINTAIN CONFIG MODULE Elements

 Elements
UI MAINTAIN CONFIG MODULE Elements

Each element is populated with a value.

UI MAINTAIN CONFIG MODULE Elements

Option

Values

Description

Timeout To ScreenSaver

n/a

Currently Unused

User Change Backgroundn/aCurrently Unused
EHS Headset typeInteger, Defaults to 0If set to 0, no EHS is enabled. If set to 1, EHS type for Plantronics is enabled.

DSSKEY CONFIG MODULE Elements

 Elements
DSSKEY CONFIG MODULE Elements

Each element is populated with a value.

DSSKEY CONFIG MODULE Elements

Option

Values

Description

Select DsskeyAction

Integer, 0-2

Specifies the action to take on a current call when pressing a DSS key:

Do nothing - 0
Hold call - 1
End call - 2 

Memory Key to BXferBoolean, Defaults to 0If enabled, a blind transfer can be accomplished to a BLF key if proceeded by the transfer hard key.
FuncKey Page NumInteger, 1-5Sets the number of pages of BLF keys to display.
Expand Board EnableBoolean, Defaults to 0Currently unused.
Extern1PageBelongn/aCurrently unused.

Dsskey Config Element

This section contains child element that control DSS keys on the phone, each assigned a unique index value as an integer, from 1-9.

Child elements of Dsskey Config
 Elements Example
internal Element Examples
Dsskey Config Elements

Option

Values

Description

Type

Integer

Sets the function type of the key as follows:

None - 0
Memory Key - 1
Line - 2
Key Event - 3
DTMF - 4
URL - 7
Share Line - 8
BLF List - 13
Multicast - 14
Application - 16 

ValueString

Value is composed of a complex string assembled as follows:

For Memory Key type keys:
 [number]@[sip account index 1-6]/[subtype][pickup number]
where subtype is as follows:
BLF / New Call - bc
BLF / Blind Transfer - bb
BLF / Attended Transfer - ba
Presence - p
MWI - m
Speed Dial - f
Intercom - i
Call Park - c
Call Forward - a

For Line Key type keys:
SIP[n] where n indicates the SIP line, from 1-6

For Key Event types as follows:

MWI - F_MWI
DND - F_DND
Hold - F_HOLD
Transfer - F_B_TRANSFER
Phonebook - F_PBOOK
Redial - F_REDIAL
Pickup - F_PICKUP
Join - F_JOIN
Call Forward - F_CFWD
Call Logs - F_CALLERS
Memo - F_MEMO
Headset - F_HEADSET
Release - F_RELEASE
Lock Phone - F_LOCK
SMS - F_SMS
Call Back - F_LOR
Hide DTMF - F_SDTMF
Intercom - F_INTERCOM
Prefix - F_PREFIX
Hot Desking - F_HOTDESKING
Agent - F_AGENT
End - F_END
Disposition - F_DISPOSITION
Escalate - F_ESCALATE
Trace - F_TRACE
Handfree - F_HANDFREE
Answer Key - F_AUTOANSWER
Private Hold - F_PRIVATEHOLD
Local Contacts - F_LOCALCONTACTS
LDAP Group - F_LDAPCONTACTS:[LDAP GROUP ID 1-4]
XML Contacts - F_XMLCONTACTS:[XML GROUP 1-4]
Broadsoft Group - F_BWCONTACTS:[Broadsoft Group 1-6]

For DTMF types as the DTMF keys to be transmitted.

For URL types as the URL to be queried. 

For Multicast types as [IP:Port]/Codec where codec is one of: PCMU, PCMA,G726-32,G729,G723,iLBC,AMR, AMR-WB, G722

Where pickup number reflects the extension that will be dialed if the watched party is in the ringing state. Otherwise the number will be dialed

TitleStringSets the visible, on-screen name of the key.

SoftDss Config

This section contains child elements that control the Softkeys, each assigned a unique index value, 1-10.

Child elements of <dssSoft>
 Elements Example
dssSoft Element Examples

Option

Values

Description

Typen/a

Currently unused.

Valuen/aCurrently unused.
Titlen/aCurrently unused.

  • No labels