Introduction

This guide explains each xml tag used in the config.xml file of Cisco IP Phone Multiplatform Phones. Each tag represents a parameter in the phone.

Each xml tag definition includes details such as command syntax, default value, and description.

Use this guide with the following Cisco IP Phone Multiplatform Phones.

6800 Series

7800 Series

8800 Series

Cisco IP Phone 6821 Multiplatform Phones

Cisco IP Phone 6841 Multiplatform Phones

Cisco IP Phone 6851 Multiplatform Phones

Cisco IP Phone 6861 Multiplatform Phones

Cisco IP Phone 6871 Multiplatform Phones

Cisco IP Phone 7811 Multiplatform Phones

Cisco IP Phone 7821 Multiplatform Phones

Cisco IP Phone 7841 Multiplatform Phones

Cisco IP Phone 7861 Multiplatform Phones

Cisco IP Conference Phone 7832 Multiplatform Phones

Cisco IP Phone 8811 Multiplatform Phones

Cisco IP Phone 8841 Multiplatform Phones

Cisco IP Phone 8851 Multiplatform Phones

Cisco IP Phone 8861 Multiplatform Phones

Cisco IP Phone 8845 Multiplatform Phones

Cisco IP Phone 8865 Multiplatform Phones

Cisco IP Conference Phone 8832 Multiplatform Phones


Note

This guide doesn't contain parameters of ATA and DECT phones.


Revision History

Release

What's New

Firmware Release 11.3(3)

Introduced document for Cisco IP Phone Multiplatform Phones XML parameters running SIP Firmware Release 11.3(3) with Cisco BroadWorks 24.0.

This version contains only Rel 11.3(3) parameters.

ACD_Logged-off_LED

Syntax Description

XML Tag Name

ACD_Logged-off_LED

Example:

<ACD_Logged-off_LED ua="na">c=o</ACD_Logged-off_LED>

Web Parameter

ACD Logged-off LED

Default Value

Empty

Allowed Values

COLOR (c)g = GREENr = REDa = AMBERo = OFFWhen you set COLOR to OFF, PATTERN is ignored even if you set it.

PATTERN (p)b = Blink with a ColorThis is equivalent to the system default of Slow Blink.n = No Blink, Solid Color

Examples:

LED =Solid Red

User Input = c=r; p=n

c=r

LED = Blinking Amber

User Input= c=a; p=b

LED = OFF

User Input= c=o

Refer to "Color-Pattern Key" and "Sample LED Configurations" in the Admin Guides.

Units

N/A

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Available on LCD UI.

Description

The LED color and cadence state when the ACD PLK selected line has logged off ACD. It will follow the LED Pattern which is defined by customers. The LED Pattern Format is c=<COLOR> [; p=<PATTERN>]. c is

Phone Model

All MPP phones except 7832 and 8832

Labels

Att console

ACD_Logged-on_LED

Syntax Description

XML Tag Name

ACD_Logged-on_LED

Example:

<ACD_Logged-on_LED ua="na">c=g;p=n</ACD_Logged-on_LED>

Web Parameter

ACD Logged-on LED

Default Value

Empty

Allowed Values

COLOR (c)g = GREENr = REDa = AMBERo = OFFWhen you set COLOR to OFF, PATTERN is ignored even if you set it.

PATTERN (p)b = Blink with a ColorThis is equivalent to the system default of Slow Blink.n = No Blink, Solid Color

Examples:

LED =Solid Red

User Input = c=r; p=n

c=r

LED = Blinking Amber

User Input= c=a; p=b

LED = OFF

User Input= c=o

Refer to "Color-Pattern Key" and "Sample LED Configurations" in the Admin Guides.

Units

N/A

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Available on LCD UI.

Description

The LED color and cadence state when the ACD PLK selected line has logged on ACD. It will follow the LED Pattern which is defined by customers. The LED Pattern Format is c=<COLOR> [; p=<PATTERN>]. c is mandatory and p is optional where default behavior is "no blink with solid color" if it is not specified.

Phone Model

All MPP phones except 7832 and 8832

Labels

Att Console

ACD_Status_n_

Syntax Description

XML Tag Name

ACD_Status_n_

Example:

<ACD_Status_1_ ua="na">Sync From Local</ACD_Status_1_>

where n is the extension from 1 to 16

Web Parameter

ACD Status

Default Value

Sync From Server

Allowed Values

Option list: Sync From Server|Sync From Local

Units

Options without units

Limits

Option

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Sync From Server: When phone boots up, it will get ACD initial status from server, which is the legacy behavior.

Sync From Local: When the phone boots up, status is changed to "Registered" from "Unregistered" or "Registration failed", or registration destination ip address is changed due to failover, fallback or DNS response is changed, , it will set ACD status to the most recent local value.

Phone Model

All MPP phones

Labels

ACD Settings

Add_Contacts_to_Directory_Personal

Syntax Description

XML Tag Name

Add_Contacts_to_Directory_Personal

Example:

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

Web Parameter

Add Contacts to Directory Personal

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = na. Not available on LCD UI.

Description

Controls whether to add contacts to the BroadSoft Personal directory instead of the local personal address book.

Phone Model

All MPP phones

Labels

Directory

Allowed_APIs

Syntax Description

XML Tag Name

Allowed_APIs

Example:

<Allowed_APIs ua="na">.*</Allowed_APIs>

Web Parameter

Allowed APIs

Default Value

.*

Allowed Values

String/regular expression

.*: All APIs are allowed

/api/Call/v1/.*: All v1 Call interface calls are allowed.

/api/Call/v1/(Dial|Hangup): Only the v1 Call interface calls Dial and Hangup are allowed.

Units

String without units

Limits

String

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

ua=na

Description

A regular expression that can be used to limit the API calls that are allowed from the controlling server.

The regular expression provided is matched with the Request-URI path provided in the API request from the controlling server. If the entire path is not matched by the given regular expression, the API call is rejected.

Phone Model

All MPP phones

Labels

API

Assistant_Call_Filter

Syntax Description

XML Tag Name

Assistant_Call_Filter

Example:

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

Web Parameter

Assistant Call Filter

Default Value

Yes

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = na. Not available on LCD UI.

Description

Controls whether to show the Call filter menu on the phone screen for the assistant role. Set this field to Yes to show the menu. Otherwise, set it to No.

Phone Model

Supported by 6871 and 8800 Series (not including 8832)

Labels

Phone Menu Visibility

Audio_Overload_Point_9dB

Syntax Description

XML Tag Name

Audio_Overload_Point_9dB

Example:

<Audio_Overload_Point_9dB ua="rw">No</Audio_Overload_Point_9dB>

Phone Web Parameter

N/A

Default Value

No

Allowed Values

Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = rw. Available on XML config file only. Not available on LCD UI.

Description

Customer can use 9dB as the acoustic overload point when they select ETSI standard. It is not found on the Web UI.

Phone Model

Supported by 6841, 6851, 6861, 6871, 8811, 8851, 8861

Labels

Audio

Auto_Available_After_Sign-In_n_

Syntax Description

XML Tag Name

Auto_Available_After_Sign-In_n_

n is the extensions number of the phone.

Example:

<Auto_Available_After_Sign-In_1_
ua="na">Yes</Auto_Available_After_Sign-In_1_>

Web Parameter

Auto Available After Sign-In

Default Value

No

Allowed Values

Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Sets the agent status to Available automatically when the user signs into the phone as a call center agent.

Phone Model

All MPP phones

Labels

ACD Settings

Auto_Register_When_Failover

Syntax Description

XML Tag Name

Auto_Register_When_Failover

Example:

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

Web Parameter

Auto Register When Failover

Default Value

Yes

Allowed Values

Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Controls the fallback duration.

If set to Yes, the fallback happens only when current registration expires, which means only a REGISTER message can trigger fallback.

For example, when the value for Register Expires is 3600 seconds and Proxy Fallback Intvl is 600 seconds, the fallback is triggered 3600 seconds later and not 600 seconds later. When the value for Register Expires is 600 seconds and Proxy Fallback Intvl is 1000 seconds, the fallback is triggered at 1200 seconds. After successfully registering back to primary server, all the SIP messages go to primary server.

Phone Model

All MPP phones

Labels

SIP

BLF_List_URI

Syntax Description

XML Tag Name

BLF_List_URI

Example:

<BLF_List_URI ua="na">uri_name@server</BLF_List_URI>

Web Parameter

BLF List URI

Default Value

N/A

Allowed Values

uri_name@server

Units

N/A

Limits

N/A

User or Admin

Admin

Description

The Uniform Resource Identifier (URI) of the Busy Lamp Field (BLF) list that you have set up for a user of the phone, on the BroadSoft server.This field is only applicable if the phone is registered to a BroadSoft server. The BLF list is the list of users whose lines the phone is allowed to monitor.

The BLF List URI must be specified in the format <URI_name>@<server>. The BLF List URI specified must be the same as the value configured for the List URI: sip parameter on the BroadSoft server. Perform one of the following:

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

<BLF_List_URI ua="na">MonitoredUsersList@sipurash22.com</BLF_List_URI>

On the phone web interface, specify the BLF list that is defined on the BroadSoft server.

Phone Model

All MPP phones

Labels

BLF

BLF_List_Feature_Options

Syntax Description

XML Tag Name

BLF_List_Feature_Options

Example:

<BLF_List_Feature_Options ua="na">prk</BLF_List_Feature_Options>

Phone Web Parameter

BLF List Feature Options

Default Value

blf+sd+cp

Allowed Values

blf+sd+cp|prk

Units

String without units

Limits

Options

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI

Description

This parameter decides which functions are enabled for those BLF List URI auto-assigned linekeys. Enables One-Button Call Park and there is no need to enter a combination of key strokes for parking and unparking a call.

  • blf+sd+cp —BLF List URI auto-assigned linekey will support "BLF", "Speed Dial" and "Call Pickup" functions.

  • prk—BLF List URI auto-assigned linekey will only support "Call Park/Unpark" function.

Phone Model

Supported by 78xx, 88xx, and 68xx except 7811, 7832 and 8832.

Labels

Att console

Block_Anonymous_Call_Enable_n_

Syntax Description

XML Tag Name

Block_Anonymous_Call_Enable_n_

n is the extension number of the phone.

Example:

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

Web Parameter

Block Anonymous Call Enable

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = na. Not available on LCD UI.

Description

Enables synchronization of Anonymous Call Rejection between a specific line and a BroadSoft server.

Phone Model

All MPP phones

Labels

XSI Line Service

Broadsoft_Call_History_Key_List

Syntax Description

XML Tag Name

Broadsoft_Call_History_Key_List

Example:

<Broadsoft_Call_History_Key_List ua="na">option|1;call|2;editcall|3</Broadsoft_Call_History_Key_List>

Web Parameter

Broadsoft Call History Key List

Default Value

option|1;call|2;editcall|3;back|4;

option|1;call|2;editcall|3;

Allowed Values

Supported strings: option, call, editcall, filter, and back.

Units

N/A

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = na. Not available on LCD UI.

Description

Defines the values for the softkeys Option, Call, Edit call, Filter, and Back for All, Placed, Received, and Missed calls history list.

Phone Model

All MPP phones

Labels

PSK

Browse_Mode_Enable

Syntax Description

XML Tag Name

Browse_Mode_Enable

Example:

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

Web Parameter

Browse Mode Enable

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Directory Display Mode. When enabled, the contact list will be shown when you enter a directory.

Phone Model

All MPP phones

Labels

Directory

Call_Statistics

Syntax Description

XML Tag Name

Call_Statistics

Example:

<Call_Statistics ua="na">No</Call_Statistics>

Web Parameter

Call Statistics

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Option

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

ua=na

Description

Specifies whether the phone sends end-of-call statistics within SIP messages when a call terminates or is put on hold.

Phone Model

All MPP phones

Labels

RTP

Call_Waiting_Enable_n_

Syntax Description

XML Tag Name

Call_Waiting_Enable_n_

n is the extension number of the phone.

Example:

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

Web Parameter

Call Waiting Enable

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = na. Not available on LCD UI.

Description

Enables synchronization of Call Waiting between a specific line and a BroadSoft server.

Phone Model

All MPP phones

Labels

XSI Line Service

Cfwd_All

Syntax Description

XML Tag Name

Cfwd_All

Example:

<Cfwd_All ua="rw">No</Cfwd_All>

Web Parameter

Cfwd All

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Option

User or Admin

Exposed in user level, honored with ua = rw. Available on LCD UI.

Description

Forwards all calls. The setting of this parameter takes precedence over Cfwd Busy and Cfwd No Answer.

Phone Model

All MPP phones

Labels

UI/CCTRL

Cfwd_Busy

Syntax Description

XML Tag Name

Cfwd_Busy

Example:

<Cfwd_Busy ua="rw">No</Cfwd_Busy>

Web Parameter

Cfwd Busy

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Option

User or Admin

Exposed in user level, honored with ua = rw. Available on LCD UI.

Description

Forwards calls only if the line is busy.

Phone Model

All MPP phones

Labels

UI/CCTRL

Cfwd_No_Answer

Syntax Description

XML Tag Name

Cfwd_No_Answer

Example:

<Cfwd_No_Answer ua="rw">No</Cfwd_No_Answer>

Web Parameter

Cfwd No Answer

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Option

User or Admin

Exposed in user level, honored with ua = rw. Available on LCD UI.

Description

Forwards the incoming call only if the call isn’t answered for a waiting interval.

Phone Model

All MPP phones

Labels

UI/CCTRL

Cfwd_Setting

Syntax Description

XML Tag Name

Cfwd_Setting

Example:

<Cfwd_Setting ua="rw">Yes</Cfwd_Setting>

Web Parameter

Cfwd Setting

Default Value

Yes

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Option

User or Admin

Exposed in user level, honored with ua = rw. Not available on LCD UI.

Description

Provides a user the ability to modify the call forward settings from the phone web page.

This parameter isnot available in Release 11.3(2). It is available in Release 11.3(1) and earlier.

Phone Model

All MPP phones

Labels

UI/CCTRL

Call_Forward_On_LED

Syntax Description

XML Tag Name

Call_Forward_On_LED

Example:

<Call_Forward_On_LED ua="na">c=r;p=n</Call_Forward_On_LED>

Web Parameter

Call Forward On LED

Default Value

Empty

Allowed Values

COLOR (c)g = GREENr = REDa = AMBERo = OFFWhen you set COLOR to OFF, PATTERN is ignored even if you set it.

PATTERN (p)b = Blink with a Color. This is equivalent to the system default of Slow Blink.n = No Blink, Solid Color

Examples:

LED =Solid Red

User Input = c=r; p=n

c=r

LED = Blinking Amber

User Input= c=a; p=b

LED = OFF

User Input= c=o

Refer to "Color-Pattern Key" and "Sample LED Configurations" in the Admin Guides.

Units

N/A

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Available on LCD UI.

Description

The LED color and cadence state when the call forward PLK indicates that the selected line's call forward state is On. It will follow the LED Pattern which is defined by customers. The LED Pattern Format is c=<COLOR> [; p=<PATTERN>]. c is mandatory and p is optional where default behavior is "no blink with solid color" if it is not specified

Phone Model

All MPP phones except 7832 and 8832

Labels

Att Console

Call_Forward_Off_LED

Syntax Description

XML Tag Name

Call_Forward_Off_LED

Example:

<Call_Forward_Off_LED ua="na">c=o</Call_Forward_Off_LED>

Web Parameter

Call Forward Off LED

Default Value

Empty

Allowed Values

COLOR (c)g = GREENr = REDa = AMBERo = OFFWhen you set COLOR to OFF, PATTERN is ignored even if you set it.

PATTERN (p)b = Blink with a ColorThis is equivalent to the system default of Slow Blink.n = No Blink, Solid Color

Examples:

LED =Solid Red

User Input = c=r; p=n

c=r

LED = Blinking Amber

User Input= c=a; p=b

LED = OFF

User Input= c=o

Refer to "Color-Pattern Key" and "Sample LED Configurations" in the Admin Guides.

Units

N/A

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Available on LCD UI.

Description

The LED color and cadence state when the call forward PLK indicates that the selected line's call forward state is Off. It will follow the LED Pattern which is defined by customers. The LED Pattern Format is c=<COLOR> [; p=<PATTERN>]. c is mandatory and p is optional where default behavior is "no blink with solid color" if it is not specified

Phone Model

All MPP phones except 7832 and 8832

Labels

Att Console

Control_Server_URL

Syntax Description

XML Tag Name

Control_Server_URL

Example:

<Control_Server_URL ua="na"/>

In the phone web page enter the URL of a WebSocket server.

<Control_Server_URL>wss://my-server.com
/ws-server-path</Control_Server_URL>

Web Parameter

Control Server URL

Default Value

Empty

Allowed Values

URL

Units

URL

Limits

URL

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

The URL of a WebSocket server to which the phone attempts to stay connected.

URL should be in one of the following formats:

For a nonsecure HTTP connection: ws://your-server-name/path

For a secure HTTPS connection: wss://your-server-name/some-path

We recommend a secure connection.

Phone Model

All MPP phones

Labels

Remote SDK

Customizable_PLK_Options

Syntax Description

XML Tag Name

Customizable_PLK_Options

Example:

<Customizable_PLK_Options ua="na">mwi;sd;blf;shortcut;dnd;</Customizable_PLK_Options>

Example: sd;blf;cp;dnd;acd;callinfo

Example: proxycall;callpush;callretrieve;divert;bridgein

Web Parameter

Customizable PLK Options

Default Value

sd

Allowed Values

dnd|acd|callinfo|calllist|cfwd|lcr|proxycall|callpush|callretrieve|divert|bridgein|shortcut

Units

String without units

Limits

String Length range is 0 to 511

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Enables users to configure features on the line keys.

Phone Model

All MPP phones

Labels

Att Console

Device_Administration

Syntax Description

XML Tag Name

Device_Administration

Example:

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

Web Parameter

Device Administration

Default Value

Yes

Allowed Values

Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Available as Device administrationon the LCD UI.

Description

Controls whether to show the Device administration menu on the phone screen. Set this field to Yes to show the menu. Otherwise, set it to No.

Phone Model

All MPP phones

Labels

Phone Menu Visibility

Device_Config_Version

Syntax Description

XML Tag Name

Device_Config_Version

Example:

<Device_Config_Version ua="na">2021-01-05-v1</Device_Config_Version>

Web Parameter

N/A

Default Value

Empty

Allowed Values

Any string

Units

String without units

Limits

0–64 characters

User or Admin

Exposed in admin level, honored with ua = na. Not available on LCD UI and the phone web page.

Description

Customizes the product configuration version that shows as the menu item Configuration version on the phone screen Product information.

If the tag doesn't exist in the cfg.xml file or the parameter value is empty, the menu item doesn't display on the phone screen.

Phone Model

All MPP phones

Labels

Phone Menu

Divert_Off_LED

Syntax Description

XML Tag Name

Divert_Off_LED

Example:

<Divert_Off_LED ua="na">c=r</Divert_Off_LED>

Web Parameter

Divert Off LED

Default Value

Empty

Allowed Values

COLOR (c)g = GREENr = REDa = AMBERo = OFFWhen you set COLOR to OFF, PATTERN is ignored even if you set it.

PATTERN (p)b = Blink with a ColorThis is equivalent to the system default of Slow Blink.n = No Blink, Solid Color

Examples:

LED =Solid Red

User Input = c=r; p=n

c=r

LED = Blinking Amber

User Input= c=a; p=b

LED = OFF

User Input= c=o

Refer to "Color-Pattern Key" and "Sample LED Configurations" in the Admin Guides.

Units

N/A

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Available on LCD UI.

Description

The LED color and cadence when the Divert PLK indicates that the selected line's divert state is Off. It will follow the LED Pattern which is defined by customers. The LED Pattern Format is c=<COLOR> [; p=<PATTERN>]. c is mandatory and p is optional where default behavior is "no blink with solid color" if it is not specified.

Phone Model

All MPP phones except 7832 and 8832

Labels

Att Console

DND_Off_LED

Syntax Description

XML Tag Name

DND_Off_LED

Web Parameter

DND Off LED

Default Value

Empty

Allowed Values

COLOR (c)g = GREENr = REDa = AMBERo = OFFWhen you set COLOR to OFF, PATTERN is ignored even if you set it.

PATTERN (p)b = Blink with a ColorThis is equivalent to the system default of Slow Blink.n = No Blink, Solid Color

Examples:

LED =Solid Red

User Input = c=r; p=n

c=r

LED = Blinking Amber

User Input= c=a; p=b

LED = OFF

User Input= c=o

Refer to "Color-Pattern Key" and "Sample LED Configurations" in the Admin Guides.

Units

N/A

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Available on LCD UI.

Description

Turns off the DND LED pattern on the phone screen.

Phone Model

All MPP phones except 7832 and 8832

Labels

Calls

DND_On_LED

Syntax Description

XML Tag Name

DND_On_LED

Example:

<DND_On_LED ua="na">c=r</DND_On_LED>

Web Parameter

DND On LED

Default Value

Empty

Allowed Values

COLOR (c)g = GREENr = REDa = AMBERo = OFFWhen you set COLOR to OFF, PATTERN is ignored even if you set it.

PATTERN (p)b = Blink with a ColorThis is equivalent to the system default of Slow Blink.n = No Blink, Solid Color

Examples:

LED =Solid Red

User Input = c=r; p=n

c=r

LED = Blinking Amber

User Input= c=a; p=b

LED = OFF

User Input= c=o

Refer to "Color-Pattern Key" and "Sample LED Configurations" in the Admin Guides.

Units

N/A

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Available on LCD UI.

Description

The LED color and cadence when the DND PLK indicates that the selected line's DND is On. It will follow the LED Pattern which is defined by customers. The LED Pattern Format is c=<COLOR> [; p=<PATTERN>]. c is mandatory and p is optional where default behavior is "no blink with solid color" if it is not specified.

Phone Model

All 68xx, 78xx, 88xx, phones except 7832 and 8832

Labels

Att Console

Executive_Assistant_Role

Syntax Description

XML Tag Name

Executive_Assistant_Role

Example:

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

Web Parameter

Executive Assistant Role

Default Value

Default

Allowed Values

Option list: Default|Executive|Assistant

Units

Options without units

Limits

Option

User or Admin

Exposed in admin level, honored with ua = na. Not available on LCD UI.

Description

Preassigns the executive-assistant role to a phone extension.

This preassignment doesn't directly determine the executive-assistant role of the phone. Both the preassignments on the extensions and the role settings by the BroadWorks server determine the executive-assistant role of the phone.

Phone Model

Supported by 6871 and 8800 Series (not including 8832)

Labels

Executive Assistant

Extended_Function_n_

Syntax Description

XML Tag Name

Extended_Function_n_

n is the extension number of the phone.

Call park to a line key

  • For a private line, enter

    nc=prk;sub=$USER@$PROXY;nme=CallPark-Slot1
  • For a shared line, enter

    fnc=prk;sub=$USER@$PROXY;nme=Call-Park1;orbit=<DN of primary line>

You can configure this feature on the line key on which Extension is disabled .

where:

fnc= prk means function=call park

sub= 999999 is the phone to which the call parks. Replace 999999 with a numbers.

nme= XXXX is the name displayed on the phone for the call park line key. Replace XXXX with a name.

Example:

<Extended_Function_2_
ua="na">fnc=prk;sub=$USER@$PROXY;nme=CallPark-Slot1</Extended_Function_2_>

A line key as a phone menu shortcut

Example:

<Extended_Function_1_ ua="na">fnc=shortcut;url=userpref;nme=User
Preferences</Extended_Function_1_>

Web Parameter

Extended Function

Default Value

Empty

Allowed Values

String, the well-formated one is "fnc=type(;name=value)*", where * means zero or more repeats

Units

String without units

Limits

String Length: 0 to 511

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Adds extended functions to a line key.

Phone Model

All MPP phones

Labels

Line key

Extension_n_

Syntax Description

XML Tag Name

Extension_n_

n is the extension number of the phone.

Example:

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

Web Parameter

Extension

Default Value

n

where n is the extension (1-10) assigned to a line key.

Allowed Values

Drop-down list: n|Disabled

where n is the extension (1to10) assigned to a line key.

Units

Options with integer and string.

Limits

Options

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on the LCD UI.

Description

Specifies the n extension to be assigned to Line Key n.

Phone Model

All MPP phones

Labels

Line Key

EXT_SIP_Port

Syntax Description

XML Tag Name

EXT_SIP_Port

Example:

<EXT_SIP_Port_1_ua="na">5060</EXT_SIP_Port_1_>

Web Parameter

EXT SIP Port

Default Value

5060

Allowed Values

Integer (0-9), String

Units

Integer

Limits

0 to 65535

User or Admin

Admin

Description

The external SIP port number.

Phone Model

All MPP phones

Labels

SIP

Factory_Reset_Menu

Syntax Description

XML Tag Name

Factory_Reset_Menu

Example:

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

Web Parameter

Factory Reset Menu

Default Value

Yes

Allowed Values

Yes|No

Units

Boolean

Limits

N/A

User or Admin

Admin

Description

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

This parameter can be customized to Yes or No only when the Require Authentication for LCD Menu Access parameter is set to Customized.

Phone Model

All MPP phones

Labels

User Authentication Control for Phone menus

Feature_Activation_Code_Sync

Syntax Description

XML Tag Name

Feature_Activation_Code_Sync

Example:

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

where n is the extension number.

Web Parameter

Feature Activation Code Sync

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Option

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Enable or disable sending FAC code to server when dial vertical activation code.

Phone Model

All MPP phones

Labels

Call Feature setting

Firewall

Syntax Description

XML Tag Name

Firewall

Example:

<Firewall ua="na">Enabled</Firewall>

Web Parameter

Firewall

Default Value

Enabled

Allowed Values

Option list: Disabled|Enabled

Units

Options without units

Limits

Option

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

ua=na

Description

Improves phone security by by hardening the operating system. Tracks the ports for incoming and outgoing data. It detects incoming traffic from unexpected sources and blocks the access. Your firewall allows all outgoing traffic.

Phone Model

All MPP phones

Labels

Security

Firewall_Config

Syntax Description

XML Tag Name

Firewall_Config

Example:

<Firewall_Config ua="na">NO_ICMP_PING</Firewall_Config>

Web Parameter

Firewall Options

Default Value

Empty

Allowed Values

String

NO_ICMP_PING, NO_ICMP_UNREACHABLE, NO_CISCO_TFTP

The following keywords and options apply when the phone runs custom apps that handle incoming requests.

UDP:<xxx>, UDP:<xxx:yyy>, TCP:<xxx>, TCP:<xxx:yyy>

Units

String without units

Limits

String

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

ua=na

Description

Configures additional options in the Firewall Options field. Type the keyword for each option in the field, and separate the keywords by commas (,). Some keywords have values. Separate the values by colons (:).

Phone Model

All MPP phones

Labels

Security

Group_n_Paging_Script

Syntax Description

XML Tag Name

Group_1_Paging_Script

n is the group ID (1-10)

Example:

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

Web Parameter

Group n Paging Script

Default Value

pggrp=224.168.168.168:34560;name=All;num=800;listen=yes;

Allowed Values

String

Units

String

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

A string to configure the phone to listen for and initiate multicast paging. You can add a phone to up to 10 paging groups.

Phone Model

All MPP phones

Labels

Multiple paging

ice_stun_enable

Syntax Description

XML Tag Name

ice_stun_enable

Example:

<ice_stun_enable>Yes</ice_stun_enable>

Web Parameter

N/A

Default Value

No

Allowed Values

Option list Yes|No

Units

Boolean without units

Limits

Boolean/Option

User or Admin

Exposed in admin level through xml configuration file (Webex Calling Server). Honored with ua = rw/ro/na. Not available on the LCD UI.

Description

Optimizes media path for calls.

Phone Model

All MPP phones

Labels

NAT

Idle_Key_List

Syntax Description

XML Tag Name

Idle_Key_List

Example:

<Idle_Key_List
ua="rw">psk2;em_login;acd_login;acd_logout;astate;redial;cfwd;dnd;lcr;</Idle_Key_List>

Web Parameter

Idle Key List

Default Value

N/A

Allowed Values

Units

N/A

Limits

N/A

User or Admin

Admin

Description

Programmable softkey fields. Enter a string in these fields to configure softkeys that display on the phone screen. You can create softkeys for speed dials to numbers or extensions, vertical service activation codes (* codes), or XML. Configure the PSKs in this format:

Speed Dial:

fnc=sd;ext=extension_number@$PROXY;vid=n;nme=display_name

Vertical Service Activation Code:

fnc=sd;ext=star_code@$PROXY;vid=n;nme=display_name

XML Service:

fnc=xml;url=http://server_IP/services.xml;vid=n;nme=display_name

Menu shortcut:

fnc=shortcut;url=userpref;nme=User preferences

When you add a programmable softkey to a softkey list, such as Idle Key List, Missed Call Key List, and so on, the programmable softkey displays on the phone screen.

Perform one of the following:

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

<PSK_1 ua="na">fnc=xml;url=http://server_IP/services.xml;vid=n;
nme=display_name</PSK_1 ua="na">

In the phone web interface, set the PSKs in the valid format or scripts.

Phone Model

All MPP phones

Labels

PSK

LDAP_StartTLS_Enable

Syntax Description

XML Tag Name

LDAP_StartTLS_Enable

Example:

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

Web Parameter

StartTLS Enable

Default Value

No

Allowed Values

Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

  • StartTLS Enable = Yes: If Ldap_server is ldap://server:port, then phone will start to send Start_TLS request. If Ldap_server is ldaps://server:port, then phone will keep LDAPs and will ignore this parameter.

  • StartTLS Enable = No: Phone will keep the existing behavior.

Phone Model

All MPP phones

Labels

LDAP

LDAP_Prompt_For_Empty_Credentials

Syntax Description

XML Tag Name

LDAP_Prompt_For_Empty_Credentials

Example:

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

where n is the extension number.

Web Parameter

N/A

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Option

User or Admin

Hidden. Not available on LCD UI.

ua=na

Description

Enable or disable the LDAP sign-in prompt when there’s no user credential on the phone. This function is used only for the simple authentication method that involves the anonymous simple bind operation.

Phone Model

All MPP phones

Labels

LDAP

Max_Display_Records

Syntax Description

XML Tag Name

Max_Display_Records

Example:

<Max_Display_Records ua="na">50</Max_Display_Records>

Web Parameter

Max Display Records

Default Value

50

Allowed Values

50 to 999

Units

Record number

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Maximum display records for a directory.

Phone Model

All MPP phones except 7811 and 7832

Labels

Directory

MediaSec_Request_n_

Syntax Description

XML Tag Name

MediaSec_Request_n_

where n is the extension number (1 to 16) of the phone

Example:

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

Phone Web Parameter

MediaSec Request

Default Value

No

Allowed Values

Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI

Description

Specifies whether the phone initiates media plane security negotiation with the server.

  • Yes—The phone initiates media plane security negotiations.

  • No—The phone doesn't initiate negotiations but can handle negotiation requests from the server.

Phone Model

All models

Labels

SIP

MediaSec_Over_TLS_Only_n_

Syntax Description

XML Tag Name

MediaSec_Over_TLS_Only_n_

n is the extension number of the phone.

Example:

<MediaSec_Over_TLS_Only_1_ ua="na">No</MediaSec_Over_TLS_Only_1_>

Web Parameter

MediaSec Over TLS Only

Default Value

No

Allowed Values

Options: Yes|No

Units

Boolean without units

Limits

Option

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Specifies the signaling transport protocol over which media plane security negotiation is applied.

Before setting this field to Yes, ensure that the signaling transport protocol is TLS.

Phone Model

All MPP phones

Labels

Security

Personal_Directory_Enable

Syntax Description

XML Tag Name

Personal_Directory_Enable

Example:

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

Web Parameter

Personal Directory Enable

Default Value

Yes

Allowed Values

Yes|No

Units

Boolean

Limits

N/A

User or Admin

Admin

ua=na

Description

Enables the personal address book directory for the phone user.

When you disable the directory,

  • users can't search contacts from their personal address book

  • users can't add a contact in their personal address book

Phone Model

All MPP phones

Labels

Directory Services

Precondition_Support_n_

XML Tag Name

Precondition_Support_n_

n is the extension number of the phone.

Example:

<Precondition_Support_1_ua="na">Enabled</Precondition_Support_1_>

Web Parameter

Precondition Support

Default Value

Disabled

Allowed Values

Option list: Disabled|Enabled

Units

Options without units

Limits

Option

User or Admin

Exposed in admin level, honored with ua = na. Not available on LCD UI.

Description

Determines whether the phone includes the precondition tag (defined in RFC 3312) in the Supported header field.

  • Disabled: The phone doesn't include the precondition tag in the Supported header filed. And the phone doesn't return the 183 response when it receives the INVITE request that contains the QoS precondition in the SDP description.

  • Enabled: The phone includes the precondition tag in the Supported header field.

Phone Model

All MPP phones

Labels

SIP Settings

Programmable_Softkey_Enable

Syntax Description

XML Tag Name

Programmable_Softkey_Enable

Example:

<Programmable_Softkey_Enable ua="rw">Yes</Programmable_Softkey_Enable>

Web Parameter

Programmable Softkey Enable

Default Value

No

Allowed Values

Yes|No

Units

Boolean

Limits

N/A

User or Admin

Admin

Description

Enables or disables the programmable softkeys. Set this field to Yes to enable the programmable softkeys.

Phone Model

All MPP phones

Labels

PSK

Profile_Rule_Menu

Syntax Description

XML Tag Name

Profile_Rule_Menu

Example:

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

Web Parameter

Profile Rule Menu

Default Value

Yes

Allowed Values

Yes|No

Units

Boolean

Limits

N/A

User or Admin

Admin

Description

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.

Phone Model

All MPP phones

Labels

User authentication to phone menus

Proxy_Fallback_Intvl

Syntax Description

XML Tag Name

Proxy_Fallback_Intvl

Example:

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

n is the extension number.

Web Parameter

Proxy Fallback Intvl

Default Value

N/A

Allowed Values

Units

Seconds

Limits

N/A

User or Admin

Admin

Description

The proxy failback requires a value other than zero specified in the Proxy Fallback Intvl field on the Ext (n) tab in the phone web interface. If you set this field to 0, the SIP proxy failback feature is disabled.

The time when the phone triggers a failback depends on the phone configuration and the SIP transport protocols in use.

To enable the phone to perform failback between different SIP transport protocols, set SIP Transport to Auto on the Ext (n) tab in the phone web interface. You can also configure this extension-specific parameter in the configuration file with the following XML string:

<SIP_Transport_n_ ua="na">Auto</SIP_Transport_n_>

where n is the extension number.

Phone Model

All MPP phones

Labels

PRT_HTTP_Header

Syntax Description

XML Tag Name

PRT_HTTP_Header

Example:

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

Web Parameter

PRT HTTP Header

Default Value

Empty

Allowed Values

a-z, A-Z, 0-9, underscore (_), and hyphen (-)

Units

N/A

Limits

Maximum of 127 characters

User or Admin

Admin

Description

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.

Phone Model

All MPP phones

Labels

Provisioning

PRT_HTTP_Header_Value

Syntax Description

XML Tag Name

PRT_HTTP_Header_Value

Example:

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

Web Parameter

PRT HTTP Header Value

Default Value

Empty

Allowed Values

a-z, A-Z, 0-9, underscore (_), comma (,), semicolon (;), equal (=), and hyphen (-)
Note 

Except for the underscore (_), the first character must not be a special character.

Units

N/A

Limits

0 or 2–127 characters

User or Admin

Admin

Description

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.

Phone Model

All MPP phones

Labels

Provisioning

PSK_n

Syntax Description

XML Tag Name

PSK_n

n is the PSK ID (1-16)

Example:

<PSK_1 ua="na">fnc=sd;ext=5014@$PROXY;nme=sktest1</PSK_1>

Web Parameter

PSK

Default Value

N/A

Allowed Values

Integers

Units

Integer

Limits

1 to 16

User or Admin

Admin

Description

Programmable softkey fields. Enter a string in these fields to configure softkeys that display on the phone screen. You can create softkeys for speed dials to numbers or extensions, vertical service activation codes (* codes), or XML scripts.

Phone Model

All MPP phones

Labels

PSK

Register_Expires_n_

Syntax Description

XML Tag Name

Register_Expires_n_

Example:

<Register_Expires_1_ ua="na">3600</Register_Expires_1_>

Web Parameter

Register Expires

Default Value

3600

Allowed Values

Integer (0-9) String

Units

Seconds

Limits

Integer ranges 0 to 86400

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Defines how often the phone renews registration with the proxy. If the proxy responds to a REGISTER with a lower expires value, the phone renews registration based on that lower value instead of the configured value. If registration fails with an “Expires too brief” error response, the phone retries with the value specified in the Min-Expires header of the error.

Phone Model

All MPP phones

Labels

SIP

Replace_Unresolved_Caller_Name_with_Number

Syntax Description

XML Tag Name

Replace_Unresolved_Caller_Name_with_Number

Example:

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

Web Parameter

Replace Unresolved Caller Name with Number

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Option

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Controls whether to replace the caller name with the phone number when installed font cannot resolve the full caller name.

Phone Model

All MPP phones

Labels

Locale

Report_Problem_Menu

Syntax Description

XML Tag Name

Report_Problem_Menu

Example:

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

Web Parameter

Report Problem

Default Value

Yes

Allowed Values

Yes|No

Units

Boolean

Limits

N/A

User or Admin

Admin

ua=na

Description

Controls whether to show the Report problem menu on the phone screen. Set this field to Yes to show the menu. Otherwise, set it to No.

When the Status menu is invisible on the phone, the Report problem menu is invisible as well.

Phone Model

All MPP phones

Labels

Phone Menu Visibility

Require_Authentication_for_LCD_Menu_Access

Syntax Description

XML Tag Name

Require_Authentication_for_LCD_Menu_Access

Example:

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

Web Parameter

Require Authentication for LCD Menu Access

Default Value

Default

Allowed Values

Default|Customized|No

Units

N/A

Limits

N/A

User or Admin

Admin

Description

Controls whether the user requires authentication to access phone menus.

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

Phone Model

All MPP phones

Labels

User Authentication Phone menus

Search_All_Enable

Syntax Description

XML Tag Name

Search_All_Enable

Example:

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

Web Parameter

Search All Enable

Default Value

Yes

Allowed Values

Yes|No

Units

Boolean

Limits

N/A

User or Admin

Admin

u=na

Description

Determines whether the phone user can search for contacts in the All directories.

All directories only contain the enabled directories with the priority from highest to lowest.

  • Personal address book

  • BroadSoft directory

  • LDAP directory

  • Bluetooth phone directory

Phone Model

All MPP phones

Labels

Directory Service

Secure_Call_Option_n_

Syntax Description

XML Tag Name

Secure_Call_Option_n_

n is the extension number of the phone.

Example:

<Secure_Call_Option_1_ ua="na">Optional</Secure_Call_Option_1_>

Web Parameter

Secure Call Option

Default Value

Optional

Allowed Values

Option list: Optional|Required|Strict

Units

N/A

Limits

N/A

User or Admin

Exposed in user level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Optional-Retains the current secure call option for the phone.

Required-Rejects nonsecure calls from other phones.

Strict-Allows SRTP only when SIP transport is set to TLS. Allows RTP only when SIP transport is UDP/TCP.

Phone Model

All MPP phones

Labels

Call Setting Features

SIP_100REL_Enable_n_

XML Tag Name

SIP_100REL_Enable_n_

n is the extension number of the phone.

Example:

<SIP_100REL_Enable_1_ ua="na">No</SIP_100REL_Enable_1_>

Web Parameter

SIP 100REL Enable

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Option

User or Admin

Exposed in admin level, honored with ua = na. Not available on LCD UI.

Description

Individually enables the SIP 100REL feature.

When enabled, the phone supports the 100REL SIP extension for reliable transmission of provisional responses (18x) and uses PRACK requests.

Phone Model

All MPP phones

Labels

SIP Settings

SIP_Timer_F

Syntax Description

XML Tag Name

SIP_Timer_F

Example:

Web Parameter

SIP Timer F

Default Value

N/A

Allowed Values

Integer

Units

Seconds

Limits

0 to 64 seconds

User or Admin

Admin

Description

Non-INVITE time-out value.

Phone Model

All MPP phones

Labels

SIP

SIP_Transport

Syntax Description

XML Tag Name

SIP_Transport

Example:

<SIP_Transport_n_ ua="na">UDP</SIP_Transport_n_>

where n is the extension number.

Web Parameter

SIP Transport

Default Value

N/AUDP

Allowed Values

UDP|TCP|TLS|Auto

Units

N/A

Limits

N/A

User or Admin

Admin

Description

Specifies the transport protocol for SIP messages. For SIP messages, you can configure each extension to use:

  • a specific protocol

  • the protocol automatically selected by the phone

When you set up automatic selection, the phone determines the transport protocol based on the Name Authority Pointer (NAPTR) records on the DNS server. The phone uses the protocol with the highest priority in the records.

Phone Model

All MPP phones

Labels

SIP Settings

Speed_Dials

Syntax Description

XML Tag Name

Speed_Dials

Example:

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

Web Parameter

Speed Dials

Default Value

Yes

Allowed Values

Yes|No

Units

Boolean

Limits

N/A

User or Admin

Admin

ua=na

Description

Controls whether to show the Speed dials menu on the phone screen. Set this field to Yes to show the menu. Otherwise, set it to No.

Phone Model

All MPP phones

Labels

Speed Dial

Status

Syntax Description

XML Tag Name

Status

Example:

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

Web Parameter

Status

Default Value

Yes

Allowed Values

Yes|No

Units

Boolean

Limits

N/A

User or Admin

Admin

ua=na

Description

Controls whether to show the Status menu on the phone screen. Set this field to Yes to show the menu. Otherwise, set it to No.

Phone Model

All MPP phones

Labels

Phone Menu Visibility

TLS_Cipher_List

Syntax Description

XML Tag Name

TLS_Cipher_List

Example:

<TLS_Cipher_List ua="na">RSA:!aNULL:!eNULL</TLS_Cipher_List>

Web Parameter

TLS Cipher List

Default Value

(Blank)

Allowed Values

Any string

Units

String without units

Limits

Min length: 0 Max length: 521

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Allows you to specify the cipher list that the phone TLS applications use.

For the cipher list formats, see https://www.openssl.org/docs/man1.0.2/man1/ciphers.html.

Phone Model

All MPP phones

Labels

Security

TLS_Name_Validate_n_

Syntax Description

XML Tag Name

TLS_Name_Validate_n_

n is the extension number of the phone.

Example:

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

Web Parameter

TLS Name Validate

Default Value

Yes

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Option

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Specifies whether hostname verification is required when the phone line uses SIP over TLS.

This parameter works only when SIP Transport is set to TLS for the phone line.

Phone Model

All MPP phones

Labels

Security

Unavailable_Reason_Code_Enable_n_

Syntax Description

XML Tag Name

Unavailable_Reason_Code_Enable_n_

n is the extension number of the phone.

Example:

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

Web Parameter

Unavailable Reason Code Enable

Default Value

Yes

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = na. Not available on LCD UI.

Description

Controls whether to show or hide the Unavailable menu text box of the Set agent status screen on the phone.

Phone Model

All MPP phones

Labels

ACD Settings

Unit_n_Key_m_

Syntax Description

XML Tag Name

Unit_n_Key_m_

n is unit number of the key expansion module, and m is the key number.

Web Parameter

Unit n Key m

Default Value

N/A

Allowed Values

N/a

Units

String without units

Limits

N/A

User or Admin

Admin

ua=na

Description

Adds a menu shortcut to a line key of the attached key expansion module. Then, the user can press the configured line key to access the menu.

Adds an extended feature to a line key of the attached key expansion module. Then, the user can press the line key to access the feature.

Example:

<Unit_1_Key_2_ ua="na">fnc=shortcut;url=userpref;nme=User preferences</Unit_1_Key_2_>

where

  • fnc= shortcut means function=phone menu shortcut.

  • url= userpref is the menu to open with this line key. It's the User preferences menu in this example.

  • nme= XXXX is the menu shortcut name displayed on the key expansion module screen. If you don't specify a display name, the line key displays the target menu item. In the example, the line key displays User preferences.

Phone Model

All MPP phones

Labels

Menu Shortcut key expansion module

User_Preferences

Syntax Description

XML Tag Name

User_Preferences

Example:

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

Web Parameter

User Preferences

Default Value

Yes

Allowed Values

Yes|No

Units

Boolean

Limits

N/A

User or Admin

Admin

ua=na

Description

Controls whether to show the User preferences menu on the phone screen.

Set this field to Yes to show the menu. Otherwise, set it to No.

Phone Model

All MPP phones

Labels

Phone Menu Visibility

XsiDir_EnterpriseCommon_Enable

Syntax Description

XML Tag Name

XsiDir_EnterpriseCommon_Enable

Example:

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

Web Parameter

Directory EnterpriseCommon Enable

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Enables BroadSoft EnterpriseCommon directory.

The parameter is valid only when both Directory Enable and Directory Individual Mode Enable are set to Yes.

Phone Model

All MPP phones

Labels

Directory

XsiDir_EnterpriseCommon_Name

Syntax Description

XML Tag Name

XsiDir_EnterpriseCommon_Name

Example:

<XsiDir_EnterpriseCommon_Name ua="na">DirEnterpriseCommon</XsiDir_EnterpriseCommon_Name>

Web Parameter

Directory EnterpriseCommon Name

Default Value

Empty

Allowed Values

String without units

Units

N/A

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Name of the BroadSoft personal directory. Displays on the phone as a directory choice.

If the value is empty, the phone displays default name Enterprise Common.

Phone Model

All MPP phones

Labels

Directory

XsiDir_Enterprise_Enable

Syntax Description

XML Tag Name

XsiDir_Enterprise_Enable

Example:

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

Web Parameter

Directory Enterprise Enable

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Enables BroadSoft enterprise directory.

The parameter is valid only when both Directory Enable and Directory Individual Mode Enable are set to Yes.

Phone Model

All MPP phones

Labels

Directory

XsiDir_Enterprise_Name

Syntax Description

XML Tag Name

XsiDir_Enterprise_Name

Example:

<XsiDir_Enterprise_Name ua="na">DirEnterpriseName</XsiDir_Enterprise_Name>

Web Parameter

Directory Enterprise Name

Default Value

Empty

Allowed Values

String without units

Units

N/A

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Name of the BroadSoft Enterprise directory. Displays on the phone as a directory choice.

If the value is empty, the phone displays default name Enterprise.

Phone Model

All MPP phones

Labels

Directory

XsiDir_Group_Enable

Syntax Description

XML Tag Name

XsiDir_Group_Enable

Example:

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

Web Parameter

Directory Group Enable

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Enables BroadSoft Group directory.

The parameter is valid only when both Directory Enable and Directory Individual Mode Enable are set to Yes.

Phone Model

All MPP phones

Labels

Directory

XsiDir_Group_Name

Syntax Description

XML Tag Name

XsiDir_Group_Name

Example:

<XsiDir_Group_Name ua="na">DirGroupName</XsiDir_Group_Name>

Web Parameter

Directory Group Name

Default Value

Empty

Allowed Values

String without units

Units

N/A

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Name of the BroadSoft Group directory. Displays on the phone as a directory choice.

If the value is empty, the phone displays default name Group.

Phone Model

All MPP phones

Labels

Directory

XsiDir_GroupCommon_Enable

Syntax Description

XML Tag Name

XsiDir_GroupCommon_Enable

Example:

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

Web Parameter

Directory GroupCommon Enable

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Enables BroadSoft GroupCommon directory.

The parameter is valid only when both Directory Enable and Directory Individual Mode Enable are set to Yes.

Phone Model

All MPP phones

Labels

Directory

XsiDir_GroupCommon_Name

Syntax Description

XML Tag Name

XsiDir_GroupCommon_Name

Example:

<XsiDir_GroupCommon_Name ua="na">DirGroupCommon</XsiDir_GroupCommon_Name>

Web Parameter

Directory GroupCommon Name

Default Value

Empty

Allowed Values

String without units

Units

N/A

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Name of the BroadSoft personal directory. Displays on the phone as a directory choice.

If the value is empty, the phone displays default name Group Common.

Phone Model

All MPP phones

Labels

Directory

XsiDir_Individual_Mode_Enable

Syntax Description

XML Tag Name

XsiDir_Individual_Mode_Enable

Example:

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

Web Parameter

Directory Individual Mode Enable

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Individually enable or disable broadsoft directories. Only valid when XSI Directory Enable parameter is set to Yes.

Phone Model

All MPP phones

Labels

Directory

XsiDir_Personal_Enable

Syntax Description

XML Tag Name

XsiDir_Personal_Enable

Example:

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

Web Parameter

Directory Personal Enable

Default Value

No

Allowed Values

Option list: Yes|No

Units

Boolean without units

Limits

Boolean

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Enables BroadSoft personal directory.

The parameter is valid only when both Directory Enable and Directory Individual Mode Enable are set to Yes.

Phone Model

All MPP phones

Labels

Directory

XsiDir_Personal_Name

Syntax Description

XML Tag Name

XsiDir_Personal_Name

Example:

<XsiDir_Personal_Name ua="na">DirPersonalName</XsiDir_Personal_Name>

Web Parameter

Directory Personal Name

Default Value

Empty

Allowed Values

String without units

Units

N/A

Limits

N/A

User or Admin

Exposed in admin level, honored with ua = rw/ro/na. Not available on LCD UI.

Description

Name of the BroadSoft personal directory. Displays on the phone as a directory choice.

If the value is empty, the phone displays default name Personal.

Phone Model

All MPP phones

Labels

Directory