Extension

Assigns an extension number to a line key or disables the extension function on a line key.

The number of line keys varies with phone models. When assigned with an extension number, you can configure the line key as a telephony extension. You can assign the line key with extended functions, for example, speed dial, Busy Lamp Field, and call pickup.

By default, you don't need to disable the extension to assign the line key with extended functions. However, if the Direct PLK Configuration feature is disabled, you must disable the extension to achieve the assignment. For more information about how to enable the feature, see Enable Direct PLK Configuration.

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Extension_1_ ua="na">1</Extension_1_>

  <Extension_2_ ua="na">2</Extension_2_>

  <Extension_3_ ua="na">3</Extension_3_>

  <Extension_4_ ua="na">Disabled</Extension_4_>

• On the phone web interface, select a number or Disabled from the options.

Allowed values: Disabled|1|2|3|4, the allowed values vary with phones.

Default: n, where n is the line key number.

Extended Function

Used to assign extended functions to a line key on the phone. The supported functions are:

• Busy Lamp Field (BLF)

  Example: fnc=blf;sub=BLF_List_URI@$PROXY;usr=user_ID@$PROXY

• BLF with Call Pickup

  Example: fnc=blf+cp;sub=BLF_List_URI@$PROXY;usr=user_ID@$PROXY

• Speed Dial

  Example: fnc=sd;usr=user_ID@$PROXY

• BLF with Speed Dial

  Example: fnc=blf+sd;sub=BLF_List_URI@$PROXY;usr=user_ID@$PROXY

• BLF with Speed Dial and Call Pickup

  Example: fnc=blf+sd+cp;sub=BLF_List_URI@$PROXY;usr=user_ID@$PROXY

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Extended_Function_1_>fnc=sd;ext=user_ID@$PROXY</Extended_Function_1_>

• On the phone web interface, specify the functions that apply to the line key.

Default: Empty

Conference Single Hardkey

You can use this field to specify whether to use only the Conferenc button on the key to initiate a conference call. When set to Yes, the user can use only the Conference button to initiate a conference call. The Conf softkey is deactivated. When set to No, the user can use both the Conference button and the Conf softkey.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Conference_Single_Hardkey_1_ ua="na">Yes</Conference_Single_Hardkey_1_>

• In the phone web interface, set this field to Yes or No to enable or disable this feature.

Allowed values: Yes|No

Default: No

Conference Bridge URL

URL used to join a conference call, generally in the form of a dialable number or a URI in this format user@IPaddress:port.

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Conference_Bridge_URL_1_ ua="na">*55</Conference_Bridge_URL_1_>

• in the phone web interface, specify the URI or a number as the conference bridge.

Default: Empty

Ring1 to Ring12

Ring tone scripts for various ringtones.

In the phone configuration XML file (cfg.xml), enter a string in this format:

<!-- Ringtone -->
<Ring1 ua="na">n=Sunrise;w=file://Sunrise.rwb;c=1</Ring1>
<Ring2 ua="na">n=Chirp 1;w=file://chirp1.raw;c=1</Ring2>
<Ring3 ua="na">n=Chirp 2;w=file://chirp2.raw;c=1</Ring3>
<Ring4 ua="na">n=Delight;w=file://Delight.rwb;c=1</Ring4>
<Ring5 ua="na">n=Evolve;w=file://Evolve.rwb;c=1</Ring5>
<Ring6 ua="na">n=Mellow;w=file://Mellow.rwb;c=1</Ring6>
<Ring7 ua="na">n=Mischief;w=file://Mischief.rwb;c=1</Ring7>
<Ring8 ua="na">n=Reflections;w=file://Reflections.rwb;c=1</Ring8>
<Ring9 ua="na">n=Ringer;w=file://Ringer.rwb;c=1</Ring9>
<Ring10 ua="na">n=Ascent;w=file://Ascent.rwb;c=1</Ring10>
<Ring11 ua="na">n=Are you there;w=file://AreYouThereF.raw;c=1</Ring11>
<Ring12 ua="na">n=Chime;w=file://Chime.raw;c=1</Ring12>
<Silent_Ring_Duration ua="na">60</Silent_Ring_Duration>

Silent Ring Duration

Controls the duration of the silent ring. For example, if the parameter is set to 20 seconds, the phone plays the silent ring for 20 seconds then sends 480 response to INVITE message.

In the phone configuration XML file (cfg.xml), enter a string in this format: <Ring1 ua="na">n=Sunrise;w=file://Sunrise.rwb;c=1</Ring1>

<Silent_Ring_Duration ua="na">60</Silent_Ring_Duration>

PRT Upload Rule

Specifies the path to the PRT upload script.

If the PRT Max Timer and PRT Upload Rule fields are empty, the phone doesn't generate the problem reports automatically unless user manually performs the generation.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <PRT_Upload_Rule ua="na">https://proxy.example.com/prt_upload.php</PRT_Upload_Rule>

• In the phone web page, enter the path in the format:

  https://proxy.example.com/prt_upload.php

  or

  http://proxy.example.com/prt_upload.php

Default: Empty

PRT Upload Method

Determines the method used to upload PRT logs to the remote server.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <PRT_Upload_Method ua="na">POST</PRT_Upload_Method>

• In the phone web page, select POST or PUT methods to upload the logs to the remote server.

Valid values: POST and PUT

Default: POST

PRT Max Timer

Determines at what interval (minutes) the phone starts generating problem report automatically.

If the PRT Max Timer and PRT Upload Rule fields are empty, the phone doesn't generate the problem reports automatically unless user manually performs the generation.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <PRT_Max_Timer ua="na">30</PRT_Max_Timer>

• In the phone web page, enter the interval duration in minutes.

Valid value range: 15 minutes to 1440 minutes

Default: Empty

PRT Name

Defines a name for the generated PRT file.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <PRT_Name ua="na">prt-string1-$MACRO</PRT_Name>

  Enter the name in the format:

  prt-string1-$MACRO

• In the phone web page, enter the name in the format:

  prt-string1-$MACRO

Default: Empty

PRT HTTP Header

Specifies the HTTP header for the URL in PRT Upload Rule.

The parameter value is associated with PRT HTTP Header Value.

Only when both parameters are configured, the HTTP header is included in the HTTP request.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <PRT_HTTP_Header ua="na">x-cisco-spark-canary-opts</PRT_HTTP_Header>

• In the phone web page, enter the HTTP header in the format:

  x-cisco-spark-canary-opts

Valid value range: a-z, A-Z, 0-9, underscore (_), and hyphen (-)

Default: Empty

PRT HTTP Header Value

Sets the value of the specified HTTP header.

The parameter value is associated with PRT HTTP Header.

Only when both parameters are configured, the HTTP header is included in the HTTP request.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <PRT_HTTP_Header_Value ua="na">always</PRT_HTTP_Header_Value>

• In the phone web page, enter the value in the format:

  always

Valid value range: a-z, A-Z, 0-9, underscore (_), comma (,), semicolon (;), equal (=), and hyphen (-)

Default: Empty

Group 1 Paging Script

–

Group 10 Paging Script

Enter a string to configure the phone to listen for and initiate multicast paging. You can add a phone to up to 10 paging groups. Enter the script in this format:

pggrp=<multicast-address>:<port>;<name=group_name>;<num=multicast_number>;
<listen=boolean_value>;<pri=priority_level>;<codec=codec_name>;

Example script:

pggrp=224.168.168.168:34560;name=GroupA;num=500;listen=yes;pri=1;codec=g711a;

• Multicast IP address (multicast-address) and port (port)—Enter the multicast IP address and the port specified on your paging server. The port number must be unique for each group and an even number within 1000 and 65534.

  Make sure that you set the same multicast IP address and port for all the phones within a paging group. Otherwise, the phones can't receive paging.

• Paging group name (name)—Optionally enter the name of the paging group. The name helps you identify the paging group the phone is in when you have multiple paging groups.

• Multicast number (num)—Specify the number for the phone to listen for multicast paging and initiate a multicast paging session. Assign the same multicast number to all the phones within the group. The number must comply to the dial plan specified for the line to initiate a multicast.

• Listen status (listen)—Specify whether the phone listens for paging from this group. Set this parameter to yes to make the phone listen for the paging. Otherwise, set it to no, or don't include this parameter in the script.

• Priority (pri)—Specify priority between paging and phone call. If you don't specify the priority or don't include this parameter in the script, the phone uses priority 1. The four priority levels are:

  • 0: Paging takes precedent over phone call. When the phone is on an active call, an incoming paging places the active call on hold. The call resumes when the paging ends.

  • 1: When the phone receives an incoming paging on an active call, the user hears the mix of the paging and the call.

  • 2: The user is alerted with the paging tone when receiving an incoming paging on an active line. The incoming paging isn't answered unless the active call is put on hold or ends.

  • 3: The phone ignores the incoming paging without any alert when the phone is on an active call.

• Audio codec (codec)—Optionally specify the audio codec for the multicast paging to use. The supported codecs are G711a, G711u, G722, and G729. If you don't specify the codec or don't include the codec parameter in the script, the phone uses G711u codec.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Group_1_Paging_Script ua="na">pggrp=224.168.168.168:34560;name=Group_1;
  num=800;listen=yes;pri=1;codec=g722</Group_1_Paging_Script>

• In the phone web interface, configure this field with a valid string.

Default: Empty

Enable TR-069

Settings that enables or disables the TR-069 function.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Enable_TR-069 ua="na">No</Enable_TR-069>

• In the phone web page, select Yes to enable this feature and select No to disable it.

Valid values: Yes|No

Default: No

ACS URL

URL of the ACS that uses the CPE WAN Management Protocol. This parameter must be in the form of a valid HTTP or HTTPS URL. The host portion of this URL is used by the CPE to validate the ACS certificate when it uses SSL or TLS.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <ACS_URL ua="na">https://acs.url.com</ACS_URL>

• In the phone web page, enter a valid HTTP or HTTPS URL of the ACS.

Default: Blank

ACS Username

Username that authenticates the CPE to the ACS when ACS uses the CPE WAN Management Protocol. This username is used only for HTTP-based authentication of the CPE.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <ACS_Username ua="na">acs username</ACS_Username>

• In the phone web page, enter a valid username for HTTPS-based authentication of the CPE.

Default: admin

ACS Password

Password to access to the ACS for a specific user. This password is used only for HTTP-based authentication of the CPE.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <ACS_Password ua="na"/>

• In the phone web page, enter a valid password for HTTPS-based authentication of the CPE.

Default: Blank

ACS URL In Use

URL of the ACS that is currently in use. This is a read-only field.

Connection Request URL

This is read-only field showing the URL of the ACS that makes the connection request to the CPE.

Connection Request Username

Username that authenticates the ACS that makes the connection request to the CPE.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Connection_Request_Password ua="na"/>

• In the phone web page, enter a valid username that authenticates the ACS.

Connection Request Password

Password used to authenticate the ACS that makes a connection request to the CPE.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Connection_Request_Password ua="na"/>

• In the phone web page, enter a valid password that authenticates the ACS.

Default: Blank

Periodic Inform Interval

Duration in seconds of the interval between CPE attempts to connect to the ACS when Periodic Inform Enable is set to yes.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Periodic_Inform_Interval ua="na">20</Periodic_Inform_Interval>

• In the phone web page, enter a valid duration in seconds.

Default: 20

Periodic Inform Enable

Settings that enables or disables the CPE connection requests.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Periodic_Inform_Enable ua="na">Yes</Periodic_Inform_Enable>

• In the phone web page, select Yes to enable this feature and select No to disable it.

Valid values: Yes|No

Default: Yes

TR-069 Traceability

Settings that enables or disables TR-069 transaction logs.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <TR-069_Traceability ua="na">Yes</TR-069_Traceability>

• In the phone web page, select Yes to enable this feature and select No to disable it.

Valid values: Yes|No

Default: No

CWMP V1.2 Support

Settings that enables or disables CPE WAN Management Protocol (CWMP) support. If set to disable, the phone does not send any Inform messages to the ACS nor accept any connection requests from the ACS.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <CWMP_V1.2_Support ua="na">Yes</CWMP_V1.2_Support>

• In the phone web page, select Yes to enable this feature and select No to disable it.

Valid values: Yes|No

Default: Yes

TR-069 VoiceObject Init

Settings to modify voice objects.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <TR-069_VoiceObject_Init ua="na">Yes</TR-069_VoiceObject_Init>

• In the phone web page, select Yes to initialize all voice objects to factory default values or select No to retain the current values.

Valid values: Yes|No

Default: Yes

TR-069 DHCPOption Init

Settings to modify DHCP settings.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <TR-069_DHCPOption_Init ua="na">Yes</TR-069_DHCPOption_Init>

• In the phone web page, select Yes to initialize the DHCP settings from the ACS or select No to retain the current DHCP settings.

Valid values: Yes|No

Default: Yes

BACKUP ACS URL

Backup URL of the ACS that uses the CPE WAN Management Protocol. This parameter must be in the form of a valid HTTP or HTTPS URL. The host portion of this URL is used by the CPE to validate the ACScertificate when it uses SSL or TLS.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <BACKUP_ACS_URL ua="na">https://acs.url.com</BACKUP_ACS_URL>

• In the phone web page, enter a valid URL that uses the CPE WAN Management Protocol.

Default: Blank

BACKUP ACS User

Backup username that authenticates the CPE to the ACS when ACS uses the CPE WAN Management Protocol. This username is used only for HTTP-based authentication of the CPE.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <BACKUP_ACS_User ua="na">backup username</BACKUP_ACS_User>

• In the phone web page, enter a valid username that authenticates the CPE to the ACS when ACS uses the CPE WAN Management Protocol.

Default: Blank

BACKUP ACS Password

Backup password to access to the ACS for a specific user. This password is used only for HTTP-based authentication of the CPE.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <BACKUP_ACS_Password ua="na"/>

• In the phone web page, enter a valid password that authenticates the CPE to the ACS when ACS uses the CPE WAN Management Protocol.

Default: Blank

Require Authentication for LCD Menu Access

Controls whether the user requires authentication to access phone menus.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Require_Authentication_for_LCD_Menu_Access ua="na">Default</Require_Authentication_for_LCD_Menu_Access>

• On the phone web interface, select the required value.

Allowed values: Default|Customized|No

• Default—When selected, user needs to provide password and then sign in to access the phone menus that requires authentication. Phone continues to support all the functionalities that are supported in the releases prior to 11.3(2). Phone displays lock screen icon.

  To access any phone menus that require authentication, user needs to provide the password and press Sign in. The lock icon remains locked. After the user signs in, the lock icon is unlocked.

• Customized—When selected, user requires authentication only to access Profile rule and Factory reset menus on the phone. Authenticaion control of these two menus also depends on the settings of the Factory Reset Menu menu and the Profile Rule Menu menu. User will not require any authentication to access other phone menus.

• No—When selected, the Sign in menu, the Sign out menu, the lock icon, and the Set password menus are not available on the phone. User can access phone menus without any authentication.

Default value: Default

Factory Reset Menu

Specifies if the user requires authentication to access Factory reset menu on the phone.

You can customize this parameter to Yes or No only when you set the Require Authentication for LCD Menu Access parameter to Customized.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Factory_Reset_Menu ua="na">Yes</Factory_Reset_Menu>

• On the phone web interface, set this parameter to Yes or No as needed.

Allowed values: Yes|No

Default value: Yes

Profile Rule Menu

Specifies if the user requires authentication to access Profile rule menu on the phone.

You can customize this parameter to Yes or No only when you set the Require Authentication for LCD Menu Access parameter to Customized.

Perform one of the following:

<Profile_Rule_Menu ua="na">Yes</Profile_Rule_Menu>

• On the phone web interface, set this parameter to Yes or No as needed.

Allowed values: Yes|No

Default value: Yes

XSI Host Server

Enter the name of the server. For example:

xsi.iop1.broadworks.net

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <XSI_Host_Server ua="na">https://xsi.iop1.broadworks.net</XSI_Host_Server>

• In the phone web page, enter the server.

For example:

https://xsi.iop1.broadworks.net

You can also specify a port for the server. For example:

https://xsi.iop1.broadworks.net:5061

If you don't specify a port. The default port for the specified protocol is used.

Default: Blank

XSI Authentication Type

Determines the XSI authentication type.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <XSI_Authentication_Type ua="na">SIP Credentials</XSI_Authentication_Type>

• In the phone web page, select an authentication type.

Options:

Login Credentials－authenticates access with Login User ID and Login Password.

SIP Credentials－authenticates access with the register Auth ID and Password of the SIP account registered on the phone.

If you select SIP Credentials for XSI Authentication Type, you need to enter subscriber Auth ID and Password in the Subscriber Information section.

Default: Login Credentials

Login User ID

BroadSoft User ID of the phone user.

For example:

johndoe@xdp.broadsoft.com.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Login_User_ID ua="na">4081005300@as1bsoft22.sipurash.com</Login_User_ID>

• In the phone web page, enter a valid user ID.

For any XSI Authentication Type, you must enter Login User ID. The BroadWorks Anywhere feature does not work without this parameter.

Default: admin

Login Password

Alphanumeric password associated with the Login User ID.

Enter Login Password, when you select Login Credentials for XSI authentication type.

After you enter the password, this parameter shows the following in the configuration file (cfg.xml): <ACS_Password ua="na">************</ACS_Password>

Default: Blank

Anywhere Enable

Enables BroadWorks Anywhere feature on an extension.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Anywhere_Enable_1_ ua="na">Yes</Anywhere_Enable_1_>

• In the phone web page, select Yes, Anywhere is enabled on this line, and the user can use the phone menu to add multiple locations to this specific line.

Valid values: Yes|No

Default: Yes

XSI Host Server

xsi.iop1.broadworks.net

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <XSI_Host_Server ua="na">https://xsi.iop1.broadworks.net</XSI_Host_Server>

• In the phone web interface, enter the XSI server to use.

Default: Empty

XSI Authentication Type

Determines the XSI authentication type. Select Login Credentials to authenticate access with XSI id and password. Select SIP Credentials to authenticate access with the register user ID and password of the SIP account registered on the phone.

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <XSI_Authentication_Type ua="na">SIP Credentials</XSI_Authentication_Type>

• In the phone web interface, specify the authentication type for XSI service.

Options: SIP Credentials and Login Credentials

Default: Login Credentials

Login User ID

BroadSoft User ID of the phone user; for example, johndoe@xdp.broadsoft.com.

Enter SIP Auth ID when you select Login Credentials or SIP Credentials for XSI authentication type.

When you choose SIP Auth ID as SIP Credentials, you must enter Login User ID. Without Login User ID, the BroadSoft directory will not appear under the phone Directory list.

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Login_User_ID ua="na">username</Login_User_ID>

• In the phone web interface, enter the username used to authenticate the access to the XSI server.

Default: Empty

Login Password

Alphanumeric password associated with the User ID.

Enter login password, when you select Login Credentials for XSI authentication type.

Default: Empty

Directory Enable

Enables BroadSoft directory for the phone user. Select Yes to enable the directory and select No to disable it.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Directory_Enable ua="na">Yes</Directory_Enable>

• In the phone web interface, set this field to Yes to enable the BroadSoft directory.

Option: Yes and No

Default: No

CallLog Associated Line

Allows you to select a phone line for which you want to display the recent call logs.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <CallLog_Associated_Line ua="na">1</CallLog_Associated_Line>

• In the phone web interface, Select a phone line.

Valid values: 1 to 10

Default: 1

Display Recents From

Allows you to set which type of recent call logs the phone will display.

Perform one of the following:

• In the phone configuration file with XML(cfg.xml), enter a string in this format:

  <Display_Recents_From ua="na">Phone</Display_Recents_From>

• In the phone web interface, Choose Server to display BroadSoft XSI recent call logs and select Phone to display local recent call logs.

Option: Phone and Server

Default: Phone