This guide describes how to administer, configure, and provision Polycom VVX business IP phones with OBi
Edition software.
Audience, Purpose, and Required Skills
This guide is for a technical audience. You must be familiar with the following concepts:
● Current telecommunications practices, protocols, and principles
● Telecommunication basics, video teleconferencing, and voice or data equipment
● OpenSIP networks and VoIP endpoint environments
Related Poly and Partner Resources
See the following sites for information related to this release.
● The Polycom Support Site
information including Licensing & Product Registration, Self-Service, Account Management,
Product-Related Legal Notices, and Documents & Software downloads.
● The Polycom Document Library
HTML5 format, so that you can easily access and view installation, configuration, or administration
content from any type of online device.
● The Polycom Community
forums. Participate in discussion forums to share ideas and solve problems with your colleagues.
When logged in, you can access Poly support personnel and participate in developer and support
forums to find the latest information on hardware, software, and partner solutions topics.
● The Polycom Partner Network
RealPresence Platform with its customers' current UC infrastructures making it easy for you to
communicate face to face with the applications and devices you use every day.
● The Polycom Collaboration Services
get the most out of your investment through the benefits of collaboration.
● You can find Request for Comments (RFC) documents by entering the RFC number at
http://www.ietf.org/rfc.html
● For information on IP PBX and softswitch vendors, see Polycom Desktop Phone Compatibility
you’re using the Poly Trio solution, see Poly Trio and SoundStation IP Platform Compatibility
is the entry point to online product, service, and solution support
includes active product, service, and solution content in responsive
provides access to the latest developer and support information and
are industry leaders who natively integrate the Poly standards-based
help your business succeed and be more collaborative—and
.
. If
.
11
Page 13
Before You Begin
Notational Conventions
This guide provides device configuration parameters and their values in the following formats:
● Canonical fashion
● Literal fashion
Both notational conventions point to the same parameters, but their appearances are different.
The canonical fashion simplifies locating parameters on the phone’s system web interface or on
OBiTALK.com
You must use the literal fashion when provisioning or writing OBiPhoneXML apps.
Canonical Fashion
The following example shows the format of the canonical fashion.
● Parameter Group Name::ParameterName = Parameter Value
The Parameter Group Name is the heading of the parameter group on the left side panel of the device local
interface or the OBiTALK configuration web page. This string may contain spaces. When a group heading
has more than one level, separate each level with a –, such as:
● Services Providers – ITSP Profile A – SIP:
The ParameterName is the name of the parameter as shown on the web page and MUST NOT CONTAIN
ANY SPACES. Separate the Parameter Group Name and ParameterName by two colons (::).
The Parameter Value is the literal value to assign to the named parameter and may contain spaces.
You can omit Parameter Group Name or its top-level headings when the context is clear. For example:
● SP1 Service::AuthUserName = 4082224312
● ITSP Profile A - SIP::ProxyServer = sip.myserviceprovider.com
● ProxyServerPort= 5082
.
Literal Fashion
The following examples show the format of the literal fashion. Use the literal fashion when provisioning or
writing OBIPhoneXML apps.
● ParameterGroupName.ParameterName.Parameter Value
● Parameter.Group.Name.ParameterGroupName.ParameterName.Parameter Value
The ParameterGroupName. is the name of the first parameter group in literal fashion. This string MUST
NOT CONTAIN ANY SPACES, and always ends with a period. You can use more than one
ParameterGroupName.. The ParameterGroupName. is case-sensitive.
The ParameterName. is the name of the parameter, and always ends with a period. This string MUST NOT
CONTAIN ANY SPACES. The ParameterName. is case-sensitive.
The Parameter Value is the literal value assigned to the named parameter and may contain spaces. The Parameter Value isn’t case-sensitive, but it MUST EXACTLY MATCH the value when one or more
choices are available.
12
Page 14
Before You Begin
When using the literal fashion in your XML, you must exactly match the text string for
ParameterGroupName.ParameterName.Parameter Value. However, the system removes any text
formatting (such as bold or italics) when it processes your script or app.
Boolean Values
Parameters that take a Boolean value have a check box next to the parameter name on the system web
interface. Throughout the document, we refer to a Boolean value as enable or disable or yes or no, but you
must use true/false or True/False (case-sensitive) values for Boolean parameters in a phone
configuration file. This is equivalent to selecting or clearing the check box in the system web interface.
Multiple Choice Values
If your device uses parameter values contained in a drop-down menu, you must provision those parameters
with string values that match exactly one of those choices. Otherwise, the device uses the default choice.
Matching the provisioned value against valid strings is case-sensitive and doesn’t allow extra spaces.
Parameter Values
When entering a parameter value from the system web interface or via provisioning, avoid adding extra
white spaces before or after the parameter value. If the value is a comma-separated list of strings or contains
attributes after a comma or semicolon, avoid adding extra white spaces before and after the delimiter.
For example: CertainParameter = 1,2,3,4;a;b;c
If a parameter value can include white spaces, such as X_DisplayLabel, use just a single space and no
extra space before and after the value.
For example: X_DisplayLabel = My New Service
XML Usage
When you write or edit XML for ypur VVX business IP phone, use an XML editor that automatically checks
your syntax.
13
Page 15
Getting Started
The VVX business IP phones, OBi Edition, support Polycom HD Voice technology. You can manage the
phone's local interface and the network interaction on VVX business IP phones, OBi Edition, directly from
your phone or through the system web interface.
Product Overview
VVX business IP phones, OBi Edition, implement the following features and functionalities:
● Six SIP accounts with universal inter- and intra-service two-way call bridging among the six accounts
and the OBiTALK service.
● High-quality voice encoding using G.711, G.729, G.722, iLBC, and Opus algorithms.
● Recursive digit maps and associated call routing (outbound and inbound).
● Fully programmable line keys and softkeys.
● Programmable feature keys with preassigned functions and labels.
● Support for all standard SIP-based IP PBX and ITSPs/VSPs.
● Support for 3CX PBX and uaCSTA interoperability.
● Suited for all service provider and enterprise deployment environments, regardless of size.
● Ideal for self-service installations—home users, small business owners, or corporate IT departments
● Integration with softswitch architectures.
● Cloud management enabled via
an optional REST API.
OBiTALK.com
with both a user portal and an ITSP partner portal with
Supported Phones and Accessories
The following table lists the product names and features for VVX business IP phones, OBi Edition.
VVX OBi Edition Products and Accessories
Product NameFeatures
VVX 150 business IP phoneCompact monochrome display
VVX 250 business IP phone
VVX 350 business IP phone
VVX 450 business IP phone
5 VDC power adapterPowers your phone when Power over Ethernet (PoE) isn’t available
High-resolution color active-matrix TFT LCD display with a customizable UI
14
Page 16
Getting Started
VVX OBi Edition Products and Accessories (continued)
Product NameFeatures
Polycom® WiFi wireless
network adapter
USB headset(VVX 250, VVX 350, and VVX 450 only)
Polycom VVX EM50 Expansion
Module
Connects your phone to a Wi-Fi network
(VVX 250, VVX 350, and VVX 450 only)
(VVX 450 only)
Working with VVX Business IP Phones, OBi
Edition
There are several ways to configure and manage VVX business IP phones, OBi Edition. Use the methods
that best suit your deployment scenario.
Input Methods
You can input information directly into your phone using different options in your phone’s keypad.
Phone Keypad
You can input digits or text directly from your phone’s keypad. There are three input modes:
● Numeric (123): Each key press inputs the corresponding digit 0 to 9, *, and #.
● Alphanumeric (abc): Each key press provides a set of ASCII characters to input.
● Capitalized Alphanumeric (Abc): Same as alphanumeric mode, except the ASCII character options
defaults to a capital letter.
● IPv4 Address (IPv4): Same as numeric, but * maps to a dot (.) and # maps to a colon (:) (to enter an
IPv4 address).
You can change between input modes by pressing the Mode softkey (by default, the label is Switch Mode).
Logging In to the Phone
You can access the OBi Edition VVX business IP phones and web portals using default account credentials:
● For user access, the default user name and password are
● For administrator access, the default user name and password are
If you don’t have access to the phone or web portals using the default credentials, contact your service
provider for the user name and password. Make sure that you have access to the correct administrator or
user password before you attempt to log in to the OBi Device Management web page.
Use the same administrator password you use for the system web interface to access the Voice Services and Device Administration options in the phone’s local interface.
15
user
and
user.
admin
and
admin.
Page 17
Getting Started
Phone Native Web Portal
Each phone has its own built-in portal site at
of the phone. The native web portal offers configurable options and status information organized into a
number of web pages. The default page is the System Status page.
Default user name and passwords are user and user for the user level, and admin and admin for the
administrator level.
Administrator level has full access to all configuration parameters. The administrator can decide which
parameters are hidden, read-only, or read-writable at the user level.
http://{ip-address}
where
{ip-address}
is the IP address
Find the Phone IP Address
Each phone must have a valid IPv4 address to connect to the network and communicate with other devices
or cloud-based services. A valid IP address is a value other than
To find your phone’s IP address:
» Do one of the following:
Launch the Product Info App from the Main menu.
Go to Settings > Network.
Dial
***
and then select option 1 to enter the Voice Adm in menu.
0.0.0.0
.
Local Device Configuration
OBi Edition VVX business IP phones have an integrated device management web portal that you can
access from any standard web browser. The device management web page is organized into sections to
allow for a manageable and compartmentalized approach to configuring parameters available on your
phone.
Access the Device Management Web Portal
You can access and sign into the device management web page as a user or administrator.
To access the Device Management web page:
1 Connect your phone to the LAN.
2 From the phone Main menu, select Settings.
3 Under Settings, the first item, Network, shows the IP address of the phone.
4 Enter the phone IP Address as the URL of the web site you want to visit in your web browser.
5 When prompted, enter your user name and password.
Navigating the Device Management Web Portal
There are many configurable parameters available on the phone, organized into a number of device
configuration web pages. By browsing through the web pages, you can view all the parameters that you can
configure and read or set their values.
16
Page 18
Getting Started
Each web page is divided into three frames:
● A customizable top frame
● A left frame that lists the links to available pages
● A main frame that shows the parameters of the currently selected page
Use the expandable or collapsible menu tree on the left side of the page to navigate the various configuration
parameter sections of your phone.
You must submit changes made on each configuration page before moving to another page.
Otherwise, you lose any changes you made when you navigate to another page.
Most changes require a restart of the phone to take effect. However, you can restart the phone just
once after you have made and submitted all the necessary changes on all the pages.
The following table lists the available device configuration web pages:
Device Configuration Web Pages
Configuration PageAvailable Settings
StatusSystem Status
Call Status
Call History
SP Services Stats
OBiWiFi ConfigurationWi-Fi Settings
Wi-Fi Access Points
System ManagementWAN Settings
Auto Provisioning
Device Admin
Device Update
Service ProvidersITSP Profile A (repeated for ITSP Profile B, C, D, E, and F)
•General
•SIP
•RTP
Voice ServicesSP1 Service
SP2 Service
SP3 Service
SP4 Service
SP5 Service
SP6 Service
OBiTALK Service
Auto Attendant
Gateways and Trunk Groups
17
Page 19
Getting Started
Device Configuration Web Pages (continued)
Configuration PageAvailable Settings
IP PhonePhone Settings
Left Line Keys
Right Line Keys — on right side of phone screen (available only on VVX 450, OBi
Edition)
Programmable Keys
Side Car 1
Side Car 2
LED Settings
Soft Keys
LDAP
Line Key Customization
Screen Item Customization
Codec ProfilesCodec Profile A
Codec Profile B
Tone SettingsTone Profile A
Tone Profile B
Ring SettingsRing Profile A
Ring Profile B
Star CodesStar Code Profile A
Star Code Profile B
User SettingsUser Preferences
Speed Dials
User Defined Digit Maps
OBiTALK Portals
OBiTALK.com is a device management portal website that serves Polycom customers and service providers
deploying OBi Edition devices. OBiTALK.com uses remote provisioning to manage OBi Edition devices. It
stores or dynamically generates on demand a configuration file for each managed device and periodically
checks in with the OBiTALK server for configuration updates.
There are two levels of management portals at OBiTALK.com: User and ITSP.
User Portal
Users can add and manage one or more OBi Edition devices from an OBiTALK account. The portal has
setup wizards that help users configure voice services on any of their devices. Users can also see the
detailed status and current parameter values of their devices and change settings on multiple devices from
within the portal. The user portal has an upper limit of 20 devices per portal instance.
The user portal also enables members to add people and associated VVX business IP phones, OBi Edition,
to circles of trust. These circles of trust enable authorized users to share additional functionality.
18
Page 20
Getting Started
Device Management Platform Portal – for ITSPs
Service providers, system integrators, and value-added resellers deploying OBi Universal Adapters and IP
Phones can use the Device Management Platform portal to manage all their OBi endpoints remotely,
enabling fast and easy device deployment and maintenance.
Service providers and system integrators can add OBi Edition devices to the OBiTALK portal for secure and
remote provisioning, real-time call status reporting and troubleshooting, device UI management, and more.
Record Version Information
Contact partner@obihai.com to learn more about the OBiTALK DMP and how to sign up to receive access.
In case you need to contact Polycom technical support, record the following information for future reference:
● Phone models
● Software version
● Partner Platform
19
Page 21
Supported Network Configurations
VVX business IP phones, OBi Edition offer two interfaces for networking: Ethernet (indicated as WAN in the
local and system web interfaces) and Wi-Fi. You can use both network options at the same time, but
Ethernet takes precedence over Wi-Fi.
Configuring the External Ethernet Ports
You can configure the two external Ethernet ports from the system web interface.
To configure the external Ethernet ports:
1 Access the system web interface and log in with admin credentials.
2 Go to System Management > WAN Settings.
3 Configure the following parameters:
External Ethernet Port Configuration
ParameterValues
WAN Settings – Switch Port::Speed
WAN Settings – PC Port::Speed
•Auto
•100 Full
•100 Half
•10 Full
•10 Half
•1000 Full
•Disabled
Poly recommends using only the Auto or Disabled settings.
Configure the WAN Interface
The WAN interface on the phone refers to the internal Ethernet switch port connected directly to the phone
processor. You can configure the following setting groups on the phone.
20
Page 22
Supported Network Configurations
WAN Interface Setting Groups
Setting GroupDescription
VLANThe phones support VLAN tagging in compliance with 802.1p/q. If you enable WAN
Settings – Internet Settings::VLANEnable, the phone tags outbound traffic
according to the VLANID and VLANPriority parameters. The phones ignore
inbound traffic that doesn’t belong to the same VLAN.
LLDPThe phones support LLDP-MED to automatically discover Network Policy (VLAN
and DSCP) settings and perform other related handshake functions. Enable this
feature using the WAN Settings – Internet Settings::LLDP-MED parameter.
IP Address AssignmentThe phones support different methods of acquiring an IP address assigned to its
WAN interface. Configure the method using the WAN Settings – Internet Settings::AddressingType parameter, which can have one of the following
values:
•
DHCP
: Request address assignment from a DHCP server.
•
Static
: Use the statically assigned IP address, subnet mask, and default
gateway from the WAN Settings – Internet Settings::IPAddress, SubnetMask and DefaultGateway parameters, respectively.
DNS ServersYou can specify as many as two DNS servers to use with the WAN interface using
WAN Settings – Internet Settings::DNSServer1 and DNSServer2. Note that if
the DHCP offer includes DNS Servers, the phone takes as many as 16 servers from
the list and uses them together with the explicitly configured servers.
Cisco Discovery Protocol
(CDP)
The phones support CDP for automated network setting discovery. Common values
included in CDP broadcast messages are: Device Type and Model, Duplex/Speed
Setting, VLAN Setting, and PoE Class (Power Draw).
Configure the Wi-Fi Interface
The VVX 250, VVX 350, and VVX 450 business IP phones support Wi-Fi via the Polycom Wi-Fi wireless
network adapter. Connect the adapter to one of the USB ports on the phone.
VLAN and LLDP features aren’t available on Wi-Fi.
21
Page 23
Supported Network Configurations
Wi-Fi Interface Setting Groups
Setting GroupDescription
IP Address AssignmentThe phones support different methods of acquiring an IP address assigned to its
Wi-Fi interface. Configure the method using the WiFi Settings – Basic Settings::AddressingType parameter, which can have one of the following
values:
DHCP
•
•
DNS ServersYou can specify up to two DNS servers to use with the Wi-Fi interface using WiFi
Settings – Internet Settings::DNSServer1 and DNSServer2. Note that if the
DHCP offer includes DNS Servers, the phone takes as many as 16 servers from the
list and uses them together with the explicitly configured servers.
: Request address assignment from a DHCP server.
Static
: Use the statically assigned IP address, subnet mask, and default
gateway from the WAN Settings – Internet Settings::IPAddress, SubnetMask and DefaultGateway parameters, respectively.
DHCP Options
The phones support the following DHCP network options for both networking interfaces:
● 42
● 66
● 150
● 159
● 160
● 161
The options that the phone tries to extract from the DHCP offer is a comma-separated list of option numbers
specified in the WAN Settings – DHCP Client Settings::ExtraOptions parameter. The phone doesn’t
recognize any other option numbers.
You can use the following macros to refer to the values of these options in any of the configuration
parameters:
● $DHCPOPT66
● $DHCPOPT150
● $DHCPOPT159
● $DHCPOPT160
● $DHCPOPT161
For example, the default value of Auto Provisioning – ITSP Provisioning::ConfigURL is
tftp://$DHCPOPT66/$DM.xml
.
DNS Lookup
The following DNS behavior applies to both the WAN and Wi-Fi network interfaces.
22
Page 24
Supported Network Configurations
Lookup Order
When there are multiple DNS servers available, the phone queries as many DNS servers as necessary to
resolve a domain name. Use the WAN Settings – DNS Control::DNSQueryDelay parameter to insert
a short delay between each query to stop once the phone receives a positive response. If you set the delay
to 0, the phone queries all the DNS servers at the same time.
When there are DNS servers obtained from both DHCP and statically configured values, the phone queries
all the servers of one type before moving to the other type. Use the WAN Settings – DNS
Control::DNSQueryOrderparameter to control the order the phone queries the server types.
Locally Configured DNS Lookup Table
You can define as many as 30 local DNS records in the phone configuration. Once you define the DNS
records, you can enable the phone to search through these records before hitting the external DNS services
when attempting to resolve a domain name. These records can be A or SRV records.
This feature is particularly useful when you want to enable proxy redundancy without using any DNS
servers. Note that the only way to provide a list of redundant servers to the phone is through the use DNS
A or DNS SRV records.
NTP Servers and Local Time
The phone keeps track of current time by querying NTP servers (using SNTP). You can configure as many
as two NTP servers using the NTPServer1 and NTPServer2 parameters.
By default, the phone discovers the SNTP server using DHCP option 42, and discovered servers take
precedence. To disable SNTP discovery in DHCP and use the configured SNTP servers, remove 42 from
the DHCP extra option list.
The phone determines the local time iby the local time zone set in the LocalTimeZone parameter. The
phone queries the NTP servers once per hour to update the current time, and the phone uses its own local
clock in between NTP refreshes.
You can enable Daylight Saving Time (DST) by enabling the DaylightSavingTimeEnable parameter.
The phone automatically adjusts DST based on the start and end rules specified in
DaylightSavingTimeStart and DaylightSavingTimeEnd parameters. You can configure the
amount of time to adjust when daylight saving time is in effect using the DaylightSavingTimeDiff
parameter.
You can also enable the phone to use SIP Signaling to tell time. When the phone renews registration with
a SIP proxy server, the server may include a Date header in the response to the phone that indicates the
current GMT time. The phone processes this time value the same way it does with the result from the NTP
servers, if you enable ITSP Profile X – SIP::X_ProcessDateHeader.
23
Page 25
Manually Configuring Phones
There are several ways to configure and manage your phone. Use the methods that best suit your
deployment scenario.
Telephone-IVR-Based Local Configuration
VVX business IP phones, OBi Edition, have a built-in interactive voice response (IVR) for checking and
setting a small but essential subset of configuration parameters. Configuration via the IVR is a legacy
configuration method inherited from older OBi products that don’t have a display.
The IVR is an instance of an automated attendant (AA). VVX business IP phones, OBi Edition, offer two
instances of AA, referred to as AA1 and AA2. The IVR for configuration purposes is AA2, which we’ll just
refer to as the IVR to avoid confusion with AA1, which is the AA used to handle phone calls.
To invoke the IVR, pick up the phone, dial * * *, and follow the announced instructions. In order for the * * *
number to work, make sure the digit map pattern *** is included in the Phone Settings::DigitMap
parameter, and the rule,
The standard (non-customized) default values of these parameters are, respectively:
([1-9]x?*(Mpli)|[1-9]S9|[1-9][0-9]S9|***|**0|**1(Msp1)|**2(Msp2)|**3(Msp3)|**4(Msp4)|*
*9(Mpp)|(Mpli))
and
{([1-9]x?*(Mpli)):pp},{**0:aa},{***:aa2},{(<**1:>(Msp1)):sp1},
{(<**2:>(Msp2)):sp2},{(<**3:>(Msp3)):sp3},{(<**4:>(Msp4)):sp4},
{(<**9:>(Mpp)):pp},{(Mpli):pli}
{***:aa2}
is included in the Phone Settings::OutboundCallRoute parameter.
For the meaning of these values, see User-Defined Digit Maps and Call Routing.
Some parameter changes require a reboot to take effect. Changes made from the OBiTALK Configuration
web page trigger the phone to reboot automatically (after any current calls end).
Key Ahead: By pressing the appropriate button sequence on the telephone, you can barge into the next
menu of the IVR or invoke a command without waiting for the previous announcement to end.
Main Menu
The Main menu after starting the IVR is a list of operations that users can select by entering the
corresponding 1-digit option number (as listed below):
24
Page 26
Manually Configuring Phones
Integrated Voice Response Operations
SelectionAnnouncementWhat Can You Do?
1Basic Network Status
Reads the IP address and DHCP status.
2Advanced Network Status
Reads the primary and back-up DNS server,
primary and back-up NTP server.
3DHCP Current Value
Reads the current value and you have the
option to change the value.
4IP Address Current Value
Reads the current value and you have the
option to change the value. If you elect to enter
a new value (static IP address), DHCP is
disabled.
5Password Current Value
Reads the current IVR password value and you
have the option to change the value.
6Please Wait (while OBi is checking for software
update)…
One of the following messages plays:
•Software Update Available. Press 1 to
update software
•Software Update Not Available.
Press 0 to repeat the information.
Press 0 to repeat the information.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
If an update is available, press 1 to proceed with
the update. The software update process starts
as soon as you hang up the phone.
Warning: Once the software upgrade process
starts, the device’s power LED blinks rapidly.
Please make sure the power and network cable
stay connected to the unit until the process is
complete.
8Restore Factory DefaultPress 1 to confirm device restore to factory
default settings.
Press # to return to device configuration menu.
Press # # to exit IVR.
9Reboot OBi DevicePress 1 to confirm device reboot.
Press # to return to device configuration menu.
Press # # or hang up to exit IVR.
There are many additional options beyond the top-level Integrated Voice Response Operations options 1 –
9. Unlike the top-level options, however, the list of available additional options in Menu 0 isn’t announced.
To access the additional IVR options, do the following:
1 Enter * * * 0 #
2 Enter your desired option number, followed by #
3 Follow any additional prompts, as desired.
You must enter the corresponding option number (followed by a # key) to select the particular option. The
following tables list the available additional options (grouped by function):
Syslog Operation Options
Selection
(Always
Press “#”
After
Entering
Selection)
AnnouncementWhat Can You Do?
1 Firmware Version
Reads the current value of the firmware
version.
2 IVR Password
Reads the current value of the IVR password.
3Debug Level
Reads the current value of the debug level.
4 Syslog Server IP Address
Reads the current IP address of the syslog
server.
5Syslog Server Port
Reads the current value of the syslog server
port.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 1 to enter a new value.
Press 2 to set the default value of 514.
Press 0 to repeat the information.
Press # to enter another configuration selection.
26
Page 28
Manually Configuring Phones
WAN Settings Options
Selection
(Always
Press “#”
After
Entering
Selection)
AnnouncementWhat Can You Do?
20 DHCP Configuration
Reads the current value of the DHCP
configuration.
21IP Address
Reads the current value of the IP address.
22Default Gateway
Reads the current value of the default Internet
gateway.
23Subnet Mask
Reads the current value of the subnet mask.
24DNS Server (Primary)
Reads the current value of the primary DNS
server.
26NTP Server (Primary)
Reads the current value of the primary NTP
server.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
27
Page 29
Manually Configuring Phones
SP1 Options
Selection
(Always
Press “#”
After
Entering
Selection)
AnnouncementWhat Can You Do?
100Enable Service Provider One (SP1)
Reads the current value.
101Registration State of SP1
Reads the current value.
102SP1 User ID
Reads the current value.
167SP1 Block Caller ID EnablePress 1 to enter a new value.
168SP1 Block Anonymous Call EnablePress 1 to enter a new value.
172SP1 Call Forward ALL – Enable / DisablePress 1 to enter a new value.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
173SP1 Call Forward ALL NumberPress 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
174SP1 Call Forward on Busy – Enable / DisablePress 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
175SP1 Call Forward on Busy NumberPress 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
28
Page 30
Manually Configuring Phones
SP1 Options (continued)
Selection
(Always
Press “#”
After
Entering
Selection)
AnnouncementWhat Can You Do?
176SP1 Call Forward on No Answer – Enable /
Disable
177SP1 Call Forward on No Answer NumberPress 1 to enter a new value.
SP2 Options
Selection
(Always
Press “#”
After
Entering
Selection)
200Enable Service Provider Two (SP2)
201Registration State of SP2
AnnouncementWhat Can You Do?
Reads the current value.
Reads the current value.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 0 to repeat the information.
Press # to enter another configuration selection.
202SP2 User ID
Reads the current value.
267SP2 Block Caller ID EnablePress 1 to enter a new value.
268SP2 Block Anonymous Call EnablePress 1 to enter a new value.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
29
Page 31
Manually Configuring Phones
SP2 Options (continued)
Selection
(Always
Press “#”
After
Entering
Selection)
272SP2 Call Forward ALL – Enable / DisablePress 1 to enter a new value.
273SP2 Call Forward ALL NumberPress 1 to enter a new value.
274SP2 Call Forward on Busy – Enable / DisablePress 1 to enter a new value.
AnnouncementWhat Can You Do?
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
275SP2 Call Forward on Busy NumberPress 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
276SP2 Call Forward on No Answer – Enable /
Disable
277SP2 Call Forward on No Answer NumberPress 1 to enter a new value.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
30
Page 32
Manually Configuring Phones
OBiTALK Service Options
Selection
(Always
Press “#”
After
Entering
Selection)
AnnouncementWhat Can You Do?
900Enable OBiTALK Service
Reads the current value.
901Registration State of OBiTALK
Reads the current value.
967OBiTALK Block Caller ID EnablePress 1 to enter a new value.
968OBiTALK Block Anonymous Call EnablePress 1 to enter a new value.
972OBiTALK Call Forward ALL – Enable / DisablePress 1 to enter a new value.
973OBiTALK Call Forward ALL NumberPress 1 to enter a new value.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
974OBiTALK Call Forward on Busy – Enable /
Disable
975OBiTALK Call Forward on Busy NumberPress 1 to enter a new value.
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
31
Page 33
Manually Configuring Phones
OBiTALK Service Options (continued)
Selection
(Always
Press “#”
After
Entering
Selection)
AnnouncementWhat Can You Do?
976OBiTALK Call Forward on No Answer – Enable
/ Disable
977OBiTALK Call Forward on No Answer NumberPress 1 to enter a new value.
Auto Attendant Options
Selection
(Always
Press “#”
After
Entering
Selection)
80 Enable / Disable Auto Attendant. Press 1 to enter a new value.
AnnouncementWhat Can You Do?
Press 1 to enter a new value.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
Press 2 to set the default value.
Press 0 to repeat the information.
Press # to enter another configuration selection.
32
Page 34
Provisioning Phones
The OBiTALK Device Management Platform portal provides access to the configurations of the multiple
endpoints in batch mode by defining XML base profiles that are applied to multiple units. When a base profile
changes, all units using this base profile are updated automatically with the changes.
Remote Provisioning
The phone can download a configuration file from a server located in the cloud or in the same enterprise.
The configuration file may contain all the necessary parameter values for the phone to function normally.
The file may also tell the device to download an additional configuration file from a different URL or to
download a different firmware to replace the current one. The configuration file format and parameter
naming conventions are proprietary to Poly but are common across all OBi Edition products.
There are currently two configuration file formats supported: full XML format and short XML format with the
XML tags substituted with single-letter abbreviations. The XML structure and parameter naming convention
closely follows TR-104. For a full description of the configuration file and parameter names, refer to the
Polycom VVX Business IP Phones, OBi Edition Deployment Guide.
Similar to parameter groupings in device configuration web portal, parameters in the configuration file are
grouped into a number of configuration objects for remote provisioning. In fact, you’ll find a near one-to-one
correspondence between these objects and their location within the configuration web pages.
To illustrate this, consider the web page SP1 Service, the SIP Credentials section:
SIP credentials
33
Page 35
Provisioning Phones
The corresponding configuration object in a phone configuration XML file is
VoiceService.1.VoiceProfile.1.Line.1.SIP. as shown below:
Note that the dot (.) at the end of the object name is part of the name that cannot be omitted in the XML file.
You must use the correct object name to create a valid configuration file for the phone.
34
Page 36
Provisioning Phones
3CX Plug-and-Play Provisioning
3CX plug-and-play provisioning lets the phone broadcast a SIP Subscribe to the Event: ua-profile on each
reboot. With 3CX enabled, the phone also listens to SIP Notify of the same Event to extract from it the
provisioning URL to request configuration, but only if the current System Management – Auto Provisioning – ITSP Provisioning::ConfigURL parameter is still set to the default value. To enable 3CX
plug-and-play provisioning, change the System Management – Auto Provisioning – System
Info::X_Enable3CXPNP parameter to true on the device web page.
Zero-Touch Provisioning
Zero-Touch or ZT provisioning is a system level approach to deploying and maintaining thousands or
millions of devices with high security and control at the device level down to the individual parameter
provisioned on each device.
To enable ZT provisioning, enable the System Management – Auto Provisioning – OBiTalk
Provisioning::ZeroTouch parameter. Then customize the System Management – Auto Provisioning –
OBiTalk Provisioning::ConfigURL parameter, which tells the phone where to download a configuration
file. With these parameters configured, the first time a new phone is powered on and connected to the
network, it can automatically contact the designated URL to get the initial configuration file.
For more information on using ZT provisioning, contact your Poly sales representative.
Zero-Touch devices must contact OBiTALK.com one time to get the customized values before they
can start normal operation. Make sure that the device can access the internet before first use.
35
Page 37
Configuring Security Options
You can download and add custom certificates to VVX business IP phones, OBi Edition.
All certificates must be in DER or PEM format. When using (EAP) TLS, the client certificate file must also
include the private key (PEM) file appended to the client certificate. For more information on supported
certificates, see the Polycom Certificate Updates for OBi Edition at Polycom Support.
802.1X Authentication
VVX business IP phones, OBi Edition, support the following 802.1X authentication modes:
● Disable
● MD5
● TLS
● TTLS/MSCHAPv2
● PEAP-MSCHAPv2 (optional for all parameters)
You can set the authentication mode using the WAN Settings – Internet Settings::802_1XMode
parameter. Depending on the selected mode, you have to configure the additional authentication
parameters listed in the following table.
802.1X Authentication
ParameterDescription(EAP) MD5
802_1XIdentityA user name. If the value isn’t
needed, set the value as an
empty string.
802_1XPasswordA password or passphrase. If a
password or passphrase isn’t
needed, set the value as an
empty string.
802_1XAnonymousIDWhen empty, anonymous identity
isn’t used in authentication.
802_1XTLSSecurityProfileSecurity profile for the 802.1X
authentication.
RequiredRequiredRequired
RequiredRequiredRequired
(EAP)
TLS (1.0)
RequiredRequired
Required
TTLS/
MSCHAPv2
36
Page 38
Configuring Security Options
HTTPS Support
VVX OBi Edition software 6.4.0 and later supports https in a web browser. Under System Management >
WAN Settings >Web Server, set the value for Port to 443.
Minimum Password Length Support
The service provider can now specify the minimum length of the password. You can mention the number
and select the check box under System Management> WAN Settings >Web Server.
If you use the default password, a warning message Default password is used appears at the top right
corner of the page. Change this password and record it in a safe place. If you lose this password, you may
need to return your phone for service.
37
Page 39
Phone Display and Appearances
The phone has built-in skins that dictate the look and feel of the local interface. You can download a custom
skin onto the target phone. You can request an additional document with local interface customization
details from Poly.
LED Pattern Customization
Feature Key LED patterns for each well-defined state can be customized using the LED Settings in the
configuration. Each customizable pattern is configured in its own parameter as a comma-separated list of
{Color}[{Duration}]
{Duration}
LED stays at the given color indefinitely. The entire pattern is played repeatedly from left to right indefinitely
until the state changes. Here are some examples:
X
– Steady off
R
– Steady red
R500,X500
G50,X50,G50,X1000
part is the number of milliseconds to show the given color. If
– 500 ms red followed by 500 ms off
pairs, where
– 50 ms green, 50 ms off, 50 ms green, 1s off
{Color}
= R (for red), G (for green), or X (for off). The optional
{Duration}
is not specified, the
LED Settings Parameters
VVX business IP phones, OBi Edition, provide these LED setting parameters.
LED Settings Parameters
Parameter GroupParameterDescription
Call State
For a bound or unbound call key, the LED pattern reflects the local call state.
IP Phone – LED Settings –
Call State
IP Phone – LED Settings –
Call State
IP Phone – LED Settings –
Call State
IP Phone – LED Settings –
Call State
IdleNo call is active on the phone.
DialingThe phone is dialing a number.
TryingThe phone is trying an outgoing call
before the called party rings.
PeerRingingThe called party is ringing.
38
Page 40
Phone Display and Appearances
LED Settings Parameters (continued)
Parameter GroupParameterDescription
IP Phone – LED Settings –
Call State
IP Phone – LED Settings –
Call State
IP Phone – LED Settings –
Call State
IP Phone – LED Settings –
Call State
IP Phone – LED Settings –
Call State
IP Phone – LED Settings –
Call State
SCA State
For a call key that is bound to a shared line, the LED pattern reflects the Shared Call Appearance (SCA) state when
the user of the SCA is on another phone.
IP Phone – LED Settings –
SCA State
IP Phone – LED Settings –
SCA State
ConnectedThe called party is connected.
RingingAn incoming call is ringing.
HoldingThe phone is holding the call.
ErrorThe call failed.
CallParkedA call is parked on the bounded
extension.
ServiceDownThe service is down.
IdleSCA is not used by anyone.
SeizedSCA has been seized by another user.
IP Phone – LED Settings –
SCA State
IP Phone – LED Settings –
SCA State
IP Phone – LED Settings –
SCA State
IP Phone – LED Settings –
SCA State
IP Phone – LED Settings –
SCA State
IP Phone – LED Settings –
SCA State
BLF State
For a feature key that is assigned the Busy Lamp Field function, the LED reflects the state of the monitored entity.
IP Phone – LED Settings –
BLF State
TryingAnother user is trying an outgoing call
on the SCA.
PeerRingingThe call peer is ringing.
ConnectedThe call is connected.
HeldThe call is on hold.
PrivateHeldAnother user is holding the call as
private.
ServiceDownThe SCA service is down.
IdleThe monitored extension is idle.
39
Page 41
Phone Display and Appearances
LED Settings Parameters (continued)
Parameter GroupParameterDescription
IP Phone – LED Settings –
BLF State
IP Phone – LED Settings –
BLF State
IP Phone – LED Settings –
BLF State
IP Phone – LED Settings –
BLF State
IP Phone – LED Settings –
BLF State
Service State
For a feature key that is assigned the Line Monitor function, the LED pattern reflects the state of the bounding
voice service.
IP Phone – LED Settings –
Service State
IP Phone – LED Settings –
Service State
IP Phone – LED Settings –
Service State
CallParkedA call is parked against the monitored
extension.
RingingThe monitored extension is ringing.
BusyThe monitored extension is on a call.
HoldingThe monitored extension is holding a
call.
ServiceDownBLF service is down.
IdleNo calls.
InUseOne or more calls is connected or
trying.
RingingOne or more incoming calls is ringing.
IP Phone – LED Settings –
Service State
IP Phone – LED Settings –
Service State
ACD Agent State
For a feature key that is assigned the ACD Sign On or Off function, the LED reflects the current ACD Agent state.
IP Phone – LED Settings –
ACD Agent State
IP Phone – LED Settings –
ACD Agent State
IP Phone – LED Settings –
ACD Agent State
IP Phone – LED Settings –
ACD Agent State
IP Phone – LED Settings –
ACD Agent State
HoldingThe monitored extension is holding a
call.
ServiceDownThe service is down.
LoggedOffThe agent has logged off.
AvailableThe agent is logged on and available.
UnavailableThe agent is logged on but not
available.
WrappingUpThe agent is logged on but is wrapping
up the last call.
ServiceDownThe service is down.
40
Page 42
Phone Display and Appearances
LED Settings Parameters (continued)
Parameter GroupParameterDescription
IP Phone – LED Settings –
ACD Agent State
Presence State
For a feature key that is assigned the Presence Monitor function, the LED reflects the presence of the monitored
entity.
IP Phone – LED Settings –
Presence State
IP Phone – LED Settings –
ACD Agent State
IP Phone – LED Settings –
ACD Agent State
IP Phone – LED Settings –
ACD Agent State
IP Phone – LED Settings –
ACD Agent State
IP Phone – LED Settings –
ACD Agent State
Feature Key State
Miscellaneous feature key functions not covered in the previous fields.
LoggedOnThe agent just logged on.
OfflineInvisible.
OnlineOnline or available.
BusyDo Not Disturb (DND).
AwayAway.
ExtendedAwayExtended Away (XA).
ServiceDownThe service is down.
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
AnonymousCallEnabledFor a feature key assigned to the Block
Caller ID function, this LED pattern is
displayed when the feature is enabled.
AnonymousCallDisabledFor a feature key assigned to the Block
Caller ID function, this LED pattern is
displayed when the feature is disabled.
AnonymousCallServiceDownFor a feature key assigned to the Block
Caller ID function, this LED pattern is
displayed when the service that
provides the feature is down, if the
feature is provided by the ITSP.
AnonymousCallBlockEnabledFor a feature key assigned to the Block
Anonymous Call function, this LED
pattern is displayed when the feature is
enabled.
AnonymousCallBlockDisabledFor a feature key assigned to the Block
Anonymous Call function, this LED
pattern is displayed when the feature is
disabled.
41
Page 43
Phone Display and Appearances
LED Settings Parameters (continued)
Parameter GroupParameterDescription
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
AutoAnswerIntercomEnabledFor a feature key assigned to the Auto
Answer Intercom function, this LED
pattern is displayed when the feature is
disabled.
AutoAnswerIntercomDisabledFor a feature key assigned to the Auto
Answer Intercom function, this LED
pattern is displayed when the feature is
disabled.
CallForwardEnabledFor a feature key assigned to the Call
Forward function, this LED pattern is
displayed when the feature is enabled.
CallForwardDisabledFor a feature key assigned to the Call
Forward function, this LED pattern is
displayed when the feature is disabled.
CallForwardServiceDownFor a feature key assigned to the Call
Forward function, this LED pattern is
displayed when the service providing
this feature is down.
CallParkYesFor a feature key assigned to the Call
Park Monitor function, this LED pattern
is displayed when there is a call parked
on that park orbit.
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
CallParkNoFor a feature key assigned to the Call
Park Monitor function, this LED pattern
is displayed when there is no call
parked on that park orbit.
CallParkMonitorServiceDownFor a feature key assigned to the Call
Park Monitor function, this LED pattern
is displayed when the underlying call
park monitoring service is down
CallWaitingEnabledFor a feature key assigned to the Call
Waiting function, this LED pattern is
displayed when the feature is enabled.
CallWaitingDisabledFor a feature key assigned to the Call
Waiting function, this LED pattern is
displayed when the feature is disabled.
DoNotDisturbEnabledFor a feature key assigned to the Do
Not Disturb function, this LED pattern
is displayed when the feature is
enabled.
42
Page 44
Phone Display and Appearances
LED Settings Parameters (continued)
Parameter GroupParameterDescription
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
DoNotDisturbDisabledFor a feature key assigned to the Do
Not Disturb function, this LED pattern
is displayed when the feature is
disabled.
DoNotRingEnabledFor a feature key assigned to the Do
Not Ring function, this LED pattern is
displayed when the feature is enabled.
DoNotRingDisabledFor a feature key assigned to the Do
Not Ring function, this LED pattern is
displayed when the feature is disabled.
ExecFilterEnabledFor a feature key assigned to the Exec
Filter on or Off function, this LED
pattern is displayed when the feature is
enabled.
ExecFilterDisabledFor a feature key assigned to the Exec
Filter on or Off function, this LED
pattern is displayed when the feature is
enabled.
ExecFilterServiceDownFor a feature key assigned to the Exec
Filter on or Off function, this LED
pattern is displayed when the service
providing this feature is down.
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
ExecAssistEnabledFor a feature key assigned to the Exec
Assistant function, this LED pattern is
displayed when the assistant is not
filtering calls for any executives (the
executive list for this assistant is empty).
ExecAssistDisabledFor a feature key assigned to the Exec
Assistant function, this LED pattern is
displayed when the assistant is filtering
calls for at least one executive.
ExecAssistDivertOnFor a feature key assigned to the Exec
Assistant function, this LED pattern is
displayed when the assistant has turned
on the Divert option
ExecAssistServiceDownFor a feature key assigned to the Exec
Assistant function, this LED pattern is
displayed when the service providing
the Exec Assistant feature is down.
HotelingGuestLoggedOnFor a feature key assigned to the
Hoteling function, this LED pattern is
displayed when a guest has logged on.
43
Page 45
Phone Display and Appearances
LED Settings Parameters (continued)
Parameter GroupParameterDescription
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
HotelingGuestLoggedOffFor a feature key assigned to the
Hoteling function, this LED pattern is
displayed when no guest has logged on.
HotelingServiceDownFor a feature key assigned to the
Hoteling function, this LED pattern is
displayed when the service providing
this feature is down.
NewMessagesWaitingYesFor a feature key assigned to the
Message Status function, this LED
pattern is displayed when there are new
messages in that mailbox.
NewMessagesWaitingNoFor a feature key assigned to the
Message Status function, this LED
pattern is displayed when there are no
new messages in that mailbox.
MWIServiceDownFor a feature key assigned to the
Message Status function, this LED
pattern is displayed when the MWI
service for that mailbox is down.
PageGroupJoinedFor a feature key assigned to the Page
Group 1 to Page Group 10 function,
this LED pattern is displayed when the
phone has joined the group.
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
IP Phone – LED Settings –
Feature Key State
VMWI Lamp
PageGroupLeftFor a feature key assigned to the Page
Group 1 to Page Group 10 function,
this LED pattern is displayed when the
phone has left the group.
PageGroupMeTalkingFor a feature key assigned to the Page
Group 1 to Page Group 10 function,
this LED pattern is displayed when you
are talking to the group.
PageGroupThemTalkingFor a feature key assigned to the Page
Group 1 to Page Group 10 function,
this LED pattern is displayed when you
are listening and someone else in the
group is talking.
SecurityClassServiceDownFor a feature key assigned to the
Security Class function, this LED
pattern when the service providing this
feature is down.
44
Page 46
Phone Display and Appearances
LED Settings Parameters (continued)
Parameter GroupParameterDescription
IP Phone – LED Settings –
VMWI Lamp
IP Phone – LED Settings –
VMWI Lamp
IP Phone – LED Settings –
VMWI Lamp
IP Phone – LED Settings –
VMWI Lamp
NewMessagesWaitingYesNew messages are available for this
phone from all mailboxes.
NewMessagesWaitingNoNo new messages are available for this
phone from all mailboxes.
DisabledVMWI is disabled.
RingingDescribes whether the LED should blink
with the given pattern when the phone is
ringing. Note that if the pattern is blank,
ringing won’t affect the VMWI Lamp.
Local Interface Menu Customization
The parameters for customizing some local interface menus are summarized in the following table. Each
menu parameter is a comma-separated list of menu items, where each menu item is specified with an item
id followed by an optional semicolon and an item display text separated by a semicolon. For example:
menu = item, item, …, item
item = item-id;item-display-text
When multiple instances of the same menu parameters are specified, the items are concatenated internally
into a single item list. Items are displayed in the order they are specified. If
for an item, the default displayed text is used.
CustomDictionaryThis parameter enables you to specify an XML
This parameter requires the user to enter the
Web Administrator password to issue a factory
reset from the phone. The default is True.
dictionary to replace built-in GUI messages
with custom messages.
Main Menu Item IDs
Main Menu items include the basic set of menu choices on the Home screen, as well as custom proprietary
items that service providers can provision on your phone.
Main Menu Items
Main Menu Item IDDefault CaptionDescription
phone-bookContactsLocal phone book.
callsCurrent CallsList all the currently ongoing calls.
call-historyCall HistoryLocally stored call logs (for all calls on all services).
settingsSettingsList all the system level settings.
prod-infoProduct InfoA list of data related to the product such as model
and serial numbers, software and hardware
versions.
netsrvNet ServicesAccess the settings of many network provided
features for each SPn service, n = 1 – 6.
netdirNet DirAccess the network directory associated with a
specific SPI service or the LDAP service.
buddyBuddy ListAccess to the buddy list associated with a specific
SPn service.
directoriesDirectoriesA container that lists the following options:
•Local phone-book (same as Contacts)
•Network directory for each SPn service, when
available, n = 1 – 6
•LDAP Search (if configured)
When only the local phone-book is available, this
item behaves the same as the phone-book item.
messagesMessagesThis option shows a list where each entry is the
message or mailbox status of a SPn service, for n =
1 – 6, if enabled.
47
Page 49
Phone Display and Appearances
Main Menu Items (continued)
Main Menu Item IDDefault CaptionDescription
all-preferencesPreferencesA container that lists the following options:
•Phone (same as preferences item)
•SPn service (or its label), for n = 1 – 6, if enabled
If none of SPn preferences are enabled, then the
item behaves exactly as the legacy preferences
item.
call-historiesCall HistoriesA container to access the locally stored call
histories and the call history associated with each
SPn service, n = 1 – 6.
Net Services Menu Item IDs
This table lists the menu items on the Net Services menu of the VVX business IP phones, OBi Edition. Item
presence depends on subscribed network service.
Net Services Menu Items
Net Services Menu
Item ID
acdACD Agent Sign On/Off
bciAnonymous CallTurn Anonymous Call feature on or off.
bwanwBroadWorks Anywhere
buddyBuddy List
ccsCall Center Status
cfaCall Forward Always
cfbCall Forward Busy
cfnaCall Forward No Answer
recCall Recording Mode
dndDo Not Disturb
dispcodeEnter Call Disposition Code
execExecutive Call Filter
xassExecutive Assistance
hotelHoteling
Default
CaptionDescription
clogNetwork Call History
dirNetwork Directory
rmoffRemote Office
48
Page 50
Phone Display and Appearances
Net Services Menu Items (continued)
Net Services Menu
Item ID
secClassSecurity Class
simringSimultaneous Ring
Default
CaptionDescription
Preferences Menu Item IDs
This table lists the menu items on the Preferences menu of the VVX business IP phones, OBi Edition. Menu
items may vary depending on your phone.
Preferences Menu Items
Preferences Menu
Item IDDefault CaptionDescription
sidecarSideCar Background PictureSelect a background picture for your side car (VVX
450 only)
languageLanguageSelect the Language of the displayed text on the
phone screen.
timeFormatTime FormatSelect the format of the time display on the phone
screen.
dateFormatDate FormatSelect the format of the date display on the phone
screen.
hpTimeAuto Home PageSelect the amount of idle time before automatically
returning the phone screen to the Home screen.
skinSkinSelect the built-in UI scheme (“skin”) to use.
bgpicBackground PictureSelect an available background picture to use as
wall paper.
dringDefault RingtoneSelect an available ring tone as the default ring
tone.
dfontFontSelect an available font as the default font for the
displayed text.
appColsHome App ColumnsSelect the number of columns to display in the UI
Main menu.
packcallsPack Calls On DisplayEnable or disable packing calls on different
services on the same screen of the display.
sdimDim ScreenEnable or disable dimming the screen (to the least
settable brightness level) after the set interval of
no-key-presses-and-no-calls.
sdimDelayDim Screen DelayInterval of no-key-presses-and-no-calls in seconds
before dimming the screen, if enabled.
49
Page 51
Phone Display and Appearances
Preferences Menu Items (continued)
Preferences Menu
Item IDDefault CaptionDescription
ssvrScreen SaverEnable or disable the screen saver feature.
ssvrDelayScreen Saver DelayAmount of idle time in seconds before starting the
screen saver, if enabled.
ssvrTypeScreen Saver TypeSelect a screen saver type.
ssvrLockRequire Passcode On Wake UpSelect whether a passcode is required to exit from
the screen saver.
ssvrPassWake Up PasscodePasscode to exit from screen saver.
Screen Saver Show Custom
Contents
brightnessScreen BrightnessSet the brightness of the LCD screen.
audioDevicePreferred Audio DeviceSelect whether to use speakerphone or a headset
as the talk device when a headset is connected.
headsetDevicePreferred Headset DeviceSelect the preferred headset device when more
than one is connected.
ehsElectronic Hook Switch
dndDo Not DisturbEnable or disable Do Not Disturb.
dnrDo Not RingEnable or disable Do Not Ring.
cfa.enableCall ForwardEnable or disable Call Forwarding (all calls,
unconditionally).
cwaCall WaitingEnable or disable Call Waiting.
bacBlock Anonymous CallEnable or disable Block Anonymous Caller.
bciAnonymous CallEnable or disable Block Caller ID (also known as
Anonymous Call).
aansAuto Answer PageEnable or disable Auto-Answering incoming page.
pg1Join Page Group 1Join Page Group 1.
pg2Join Page Group 2Join Page Group 2.
pg3Join Page Group 3Join Page Group 3.
pg4Join Page Group 4Join Page Group 4.
pg5Join Page Group 5Join Page Group 5.
pg6Join Page Group 6Join Page Group 6.
pg7Join Page Group 7Join Page Group 7.
pg8Join Page Group 8Join Page Group 8.
50
Page 52
Phone Display and Appearances
Preferences Menu Items (continued)
Preferences Menu
Item IDDefault CaptionDescription
loginUnlock Admin SettingsLog in or out of administrative mode.
Product Info Menu Item IDs
This table lists the menu items on the Product Info menu of the VVX business IP phones, OBi Edition. Some
items require admin login.
Product Info Menu Items
Product Info Menu
Item IDDefault CaptionDescription
ipaddressIP AddressCurrent IP address for this phone
modelModelModel Number
obinumberOBi NumberOBi Number
macMAC Address(Ethernet) MAC Address
wfmacWiFi MAC AddressWi-Fi MAC Address
serialSerial NumberSerial Number
swverSoftware VersionSoftware Version
hwverHardware VersionHardware Version
ztinfoCustomization StatusZT Customization Status
uptimeUp TimeUP time since last bootup
Cache Control of Downloaded (Temporary) Data
You can download the following data items that the phone caches at run time (in DRAM):
● Ring tone file downloaded from the URL specified in User Preferences::DefaultRingtone
● Picture file downloaded from the URL specified in User Preferences::BackgroundPicture
● Caller ID Picture files downloaded from URL extracted from Call-Info header of SIP Messages
● Picture files downloaded from URL in src attribute of <img> elements in rendered <ScreenItem>
● Var-Tree XML files downloaded from URL in value attribute of <setvar> elements in rendered
<ScreenItem>
● Icon, Wave or MP3 files downloaded when rendering OBiPhoneXML apps
52
Page 54
Phone Display and Appearances
The expiration time of each individually cached data file is taken from the HTTP/Cache-Control header in
the 200 response when the phone originally receives the file from the server. If the Cache-Control header
is present in the 200 response with the no-cache flag specified, the phone doesn’t cache the downloaded
data file. If the Cache-Control header is present with the max-age attribute specified, phone caches the data
file for the number of seconds as specified in the max-age attribute. Otherwise, the phone caches the data
file indefinitely until one of the following happens that clears ALL the cached data:
● Phone power cycles
● Phone fully reboots (for example, after a firmware update)
● User selects Settings > Clear Data Cache on the local interface
Phone Customization Data
You can customize some of the data that drives the local interface. These data are collectively called phone
customization data, which include the following data types:
Phone Customization Data Type
Customization Data
Type
DescriptionInternal Data Storage Path
Background Pictures
(Wall Paper)
DictionaryThe translation to be used for
Text FontsThe true-type font files for
Ring TonesRing tone wave files. It must be
The pictures that you can choose
to show as wall paper during
normal phone operation. The
data files can be JPEG, PNG,
BMP, or GIF.
various items shown on the
phone screen.
rendering text to display on the
screen.
in 16-bit mono linear PCM wave
format sampled at 16 kHz.
/backgnd/
/dict/
/fonts/
/ringtones/
Background Pictures
The phone stores custom background pictures in the internal folder
Your VVX business IP phone, OBi Edition, can accept JPEG, PNG, BMP, and GIF file formats. You can
choose any of the pictures stored in this folder as background pictures on the phone screen.
You can browse the Background Picture entries under the phone’s Preferences menu and select one of
the available background pictures. Each of the built-in “Skins” has its own default background pictures.
/backgnd/
.
53
Page 55
Phone Display and Appearances
Use a USB Flash Drive to Add a Personal Photo
Add personal photos to internal storage using a USB flash drive on VVX 250, VVX 350, and VVX 450
business IP phones, OBi edition.
For VVX 450 phones with connected VVX EM50 expansion modules, you can connect a USB flash drive to
the side USB port on the expansion module.
The maximum resolution for images is 1024 × 768 pixels.
To use a USB flash drive to add a personal photo
1 Attach a USB flash drive to the USB port on your phone.
2 Go to Settings > Storage.
3 Press the > softkey to select the USB flash drive.
4 Press the Explore softkey.
5 Do one of the following:
Highlight the file, and press the Select softkey.
Press the Select All softkey.
6 Press the Copy softkey.
The phone returns to the internal destination folder.
7 Go to the phone’s background folder.
8 Press the Select key.
9 Press the Paste softkey.
Fonts Customization
The phone stores fonts in the internal folder
using the data package upload method. Acceptable font file formats are TTF and OTF.
To choose an installed font, you must also add a font-name-to-font-file for each installed font in the
file that is also stored in the same folder.
font.map
presented to you as a list of selections under Preferences/Font in the phone UI. On the web page the
DefaultFont parameter is just a string and should match one of the font names (not file names) listed in
font.map
The
#
# font.map
#
# The left column is a font name that a user can select from
# the Preferences menu. The right column is the corresponding
# physical font file installed on the phone.
# A valid font file must either a ttf or otf file.
maps the font name to the actual font file. The set of font names listed in
.
font.map
file lists all the factory-installed fonts that come with the phone.
/fonts/
. You can install custom font files on the phone only
font.map
font.map
is also
54
Page 56
Phone Display and Appearances
#
# You can use any number of white spaces as delimiters between the 2 columns.
#
aleo Aleo-Light.otf
aleo-bold Aleo-Bold.otf
aleo-italic Aleo-LightItalic.otf
aleo-bold-italic Aleo-BoldItalic.otf
banksia Banksia-Regular.otf
banksia-bold Banksia-Bold.otf
droidsans DroidSans.ttf
droidsans-bold DroidSans-Bold.ttf
libre-caslon LibreCaslonText-Regular.ttf
libre-caslon-bold LibreCaslonText-Bold.ttf
libre-caslon-italic LibreCaslonText-Italic.ttf
opensans OpenSans-Regular.ttf
opensans-bold OpenSans-Bold.ttf
opensans-italic OpenSans-Italic.ttf
opensans-bold-italic OpenSans-BoldItalic.ttf
quattrocento Quattrocento-Regular.ttf
quattrocento-bold Quattrocento-Bold.ttf
terminal-dosis TerminalDosis-Regular.ttf
terminal-dosis-bold TerminalDosis-Bold.ttf
The DefaultFont parameter takes only the font family. The phone automatically applies the style suffix.
You can use the following built-in font families:
● ptsans
● aleo
● banksia
● droidsans
● libre-caslon
● opensans
● quattrocento
● terminal-dosis
•When using the Tomáš skin, the font is fixed. A configured DefaultFont value doesn’t take
effect.
•When using a language other than English, make sure to use a font family that includes all the
characters in the chosen language.
57
Page 59
Phone Display and Appearances
Language Customization with Dictionary Files
Language customization enables you to change the language of the local interface by installing a dictionary
file for each selectable language. Dictionary files are XML files stored in the internal folder
be UTF-8 encoded. You must install custom dictionary files using the data package upload method.
By default, the phone comes with three built-in dictionary files:
● English-US
● English-UK
● Spanish
You can set select the language under Preferences on the UI.
Below is the full Spanish dictionary file that is shipped with the phone. The name of the language is specified
in the
lang
attribute of the root element
Preferences language selection.
<obiphone>
<!-- Each dictionary item has a key/value pair, a mode attribute and a namespace.
When applying the dictionary, we match the key against the source phrase.
If mode=”i”, the comparison is case-insensitive; otherwise the comparison
is case-sensitive. The namespace ns must be matched also. -->
<!-- Input App Titles -->
<item key="New Status" value="Nuevo Estatus" mode="i"/>
<item key="Edit Status" value="Editar Estatus" mode="i"/>
<item key="New Group Name" value="Nuevo Nombre de Grupo" mode="i"/>
65
Page 67
Phone Display and Appearances
<item key="Enter" value="Entrar" mode="i"/>
<item key="Blind Transfer Target" value="Objetivo Transferencia ciega" mode="i"/>
<item key="Supervisor Extension" value="Supervisor de Extensión" mode="i"/>
<item key="Disposition Code" value="Disposicion de Codigo" mode="i"/>
<item key="Forward All Number" value="Remitir Todo Número" mode="i"/>
<item key="Unavailable Reason Code" value="No disponible Código de Motivo" mode="i"/>
<item key="Enter Query" value="Entrar Consulta" mode="i"/>
<item key="Hoteling Passcode" value="Codigo de Contraseña Hoteling" mode="i"/>
<item key="Hoteling Guest Extension" value="Extension Huesped Hoteling" mode="i"/>
<item key="Enter Admin Password" value="Ingrese Contraseña del Administrador"
mode="i"/>
<item key="Enter Folder Name" value="Ingrese Nombre del Archivo" mode="i"/>
<item key="Exec Assist Divert Number" value="Exec Asist Numero de Desvio" mode="i"/>
<!-- Call related alerts -->
<item key="No Active Calls" value="No hay Llamadas Activas" mode="i"/>
<item key="Call Error" value="Error de Llamada" mode="i"/>
<item key="No Call Key avaiable to make another call" value="No Tecla de llamada
Disponible para hacer otra llamada" mode="i"/>
<item key="The requested service is not available at the moment" value="En este
momento el Servicio requerido no esta disponible" mode="i"/>
<item key="Conference Error" value="Error de Conferencia" mode="i"/>
<item key="No conference port avaiable to add participant" value="No hay puerto de
conferencia para agregar participante" mode="i"/>
<!-- OBiWiFi -->
<item key="OBiWiFi" value="OBiWiFi" mode="i"/>
<item key="Use USB Port 1 for OBiWiFi." value="Use el puerto USB 1 para OBiWiFi."
mode="i"/>
<item key="Connected with: " value="Conectado con: " mode="i"/>
<item key="Connecting with: " value="Conectar con: " mode="i"/>
<item key="Failed to authenticate with " value="Fallado para autenticar con "
mode="i"/>
<item key="Authentication Failed" value="Falla la Autenticación" mode="i"/>
<item key="Failed to associate with " value="Error al asociar con " mode="i"/>
<item key="Association Failied" value="Asociación no" mode="i"/>
<!-- Reboot -->
<item key="Reboot" value="Reiniciar" mode="i"/>
<item key="Press OK to reboot the phone." value="Presione OK para Reiniciar el
Telefono." mode="i"/>
<!-- Factory reset -->
<item key="Press OK to reset all settings to factory default. Phone will reboot
automatically."
value="Presione OK para Resetear Todos los Ajustes de Fabrica por defecto. El
Telefono se Reiniciara Automaticamente." mode="i"/>
<!-- Admin login -->
<item key="Unlock Settings Failed" value="Desbloquear Configuración Error" mode="i"/>
<item key="Invalid Password" value="Contraseña Invalida" mode="i"/>
<!-- OBiTalk -->
<item key="Add Device to OBiTalk" value="Agregue un dispositivo a OBiTalk" mode="i"/>
<item key="Code sent to OBiTalk..." value="Codigo enviado a OBiTalk..." mode="i"/>
66
Page 68
Phone Display and Appearances
<item key="Device not allowed to join!" value="Dispositivo no se le permitió unirse!"
mode="i"/>
<!-- Conference bridge -->
<item key="Conf. Bridge Error" value="Error del Puente de Conferencia" mode="i"/>
<item key="Call to Conference Bridge failed" value="Llamada al Puente Conferencia
fallado" mode="i"/>
<item key="Conference Bridge ended unexpectedly" value="Puente Conferencia terminó
inesperadamente" mode="i"/>
<item key="Last Call Total Charges" value="Gasto Total de la ultima llamada"
mode="i"/>
<!-- Network directory -->
<item key="Network Directory" value="Directorio Red" mode="i"/>
<item key="refreshed" value="Actualizado" mode="i"/>
<item key="Nothing refreshed" value="Nada Actualizado" mode="i"/>
<item key="Network Directory Search" value="Busqueda de Directorio Red" mode="i"/>
<item key="No items found for your query" value="No se han encontrado en su búsqueda
artículos" mode="i"/>
<!-- Buddy list -->
<item key="Buddy List Error" value="Error de Lista de Amigos" mode="i"/>
<item key="Failed to load buddy list" value="Fracaso en Bajar Lista de Amigos"
mode="i"/>
<!-- Call history -->
<item key="Clear List" value="Limpiar Lista" mode="i"/>
<item key="Press OK to remove all entries in the selected call history"
value="Presione OK para remover todas las entradas en el historial de llamadas
seleccionadas" mode="i"/>
<item key="Duplicate Entry" value="Entrada Duplicada" mode="i"/>
<item key="Select 'Replace' or 'Add As New' to proceed." value="Seleccione
'Reemplazar' o 'Agregar como Nuevo' para proceder." mode="i"/>
<!-- Phone book -->
<item key="Remove Entry" value="Remover Entradas" mode="i"/>
<item key="Press OK to permanently remove this entry from the Phone Book."
value="Presione OK para remover permanentemente esta entrada de la Agenda."
mode="i"/>
<item key="Discard Changes?" value="Descartar Cambios?" mode="i"/>
<item key="Press OK to proceed. Changes to the Phone Book will be discarded."
value="Presione OK Proceder. Cambios a la Agenda sera descartado." mode="i"/>
<!-- Misc -->
<item key="Progress" value="Progreso" mode="i"/>
<item key="More" value="Mas" mode="i"/>
<item key="Disconnected" value="Desconectado" mode="i"/>
<item key="Secured with" value="Asegurado con" mode="i"/>
<item key="Not in range" value="Fuera de rango" mode="i"/>
<item key="Peer to peer" value="De igual a igual" mode="i"/>
<item key="Ad-hoc" value="Ad-hoc" mode="i"/>
<item key="Remembered" value="Recordado" mode="i"/>
<item key="Not Discoverable" value="No detectable" mode="i"/>
<item key="Available" value="Disponible" mode="i"/>
<item key="Seconds remaining" value="Segundos Restantes" mode="i"/>
</dictionary>
67
Page 69
Phone Display and Appearances
</obiphone>
On boot up, your phone up scans the dictionary directory for all installed dictionary files and prepares a list
of language names by extracting the lang attribute in each file. The list of languages is presented to you
under Preferences > Phone > Language in the phone UI. On the phone configuration web page the value
for the Language parameter (under User Settings – User Preferences) is just a string and must be set to
one of the available language names.
Phone Book Pictures
Yop can associate pictures with each phone book entry. The phone stores these pictures in the internal
/people/
is no larger than 100 ×100 pixels.
folder. You can use JPEG, PNG, GIF, and BMP file formats. The recommended pixel dimension
The pictures display on the phone screen as part of caller-ID when the caller’s number matches an
entry in the phone book.
Ring Tones
Ring tones are included in the phone customization data package. The phone stores ring tones in the
internal folder
/ringtones/
. Ring tone filenames must end with the
.wav
extension.
Phone Customization Data Package
You must consolidate customizable data into one single data package to upload it onto the phone. The final
uploadable data package is a
than 30 MB. Inside the tar file, organize the data with the same folder structure as the phone’s internal
storage:
/backgnd Wall paper (background pictures) and logo.raw (splash screen)
/dict Dictionary files
/fonts Text font files
/ringtones Ring tone files
/people Phone book contact pictures
For example, create a directory
appropriate folder structure. Copy all the data files you want to upload to the phone in the corresponding
folders in this directory and issue the following command lines to create the target tar file:
% cd /home/test/obiphone-data
% tar –zcvf ../obiphone-data.tar.gz *
You must issue the tar command inside of the working directory
can’t strip the first level in the
Additionally, you can use the following command line to generate the MD5 checksum of the target
after you create it:
% md5sum obiphone-data.tar.gz
.tar
file that you can optionally zip. The size of the tar file must be no larger
/home/test/obiphone-data
.tar
file.
on a Linux machine that contains an
obiphone-data
, as the phone
.tar
file
68
Page 70
Phone Display and Appearances
The MD5 checksum is used as the version of the target customization data package. You must configure it
on the phones to trigger the phones to download a different version of the package if the currently installed
package has a different MD5 checksum from the configured MD5 checksum.
Uploading Customization Data Package to the Phone
After the tar file of the customization data package is created, it must be placed on a server to be uploaded
to the phones when the file is requested from the server by the phones. On the phone side, the downloading
of the customization data package from a server is controlled by a number of configuration parameters as
described in the table below, not unlike the way phone firmware is updated. As you can tell quickly that these
parameters have the same meaning as those similarly named parameters for downloading of firmware.
Note that your phone attempts to download a customization data package from the server after firmware
update and configuration parameter provisioning are completed. If the MD5 checksum of the downloaded
data packages does not match the configured value, the package is dropped and no data update is
performed. Otherwise, the phone install the downloaded data files into the corresponding folders and then
restarts (warm reboot).
Customization Data Package Parameters
Parameter GroupParameterDescription
ProvisioningMethodThis parameter controls if and when the phone should execute
given DownloadURL to download the customization data
package (if the installed version is not current). Choice of:
•Disabled = Do not execute DownloadURL
•System Start = Execute DownloadURL just once on
system start
•Periodically = Execute DownloadURL on system start,
and then periodically at the interval specified in the Interval
parameter
Note: First download on system start occurs after firmware
update and configuration provisioning are complete.
IntervalWhen Method is set to
number of seconds between execution of DownloadURL. If
value is 0, the phone executes DownloadURL just once on
system start (that is, equivalent to setting Method to
Start
).
DownloadURLIn its simplest form, this is the URL to download the Phone
Customization Data Package, such as
http://abcd.com/phone/cfg/datapkg.tar
The full syntax is a script similar to what can be specified in the
FirmwareURL parameter for firmware update. Refer to the
Polycom OBi Edition Deployment Guide for a description of all
the syntaxes of this script.
Periodically
, this is the interval in
System
69
Page 71
Phone Display and Appearances
Customization Data Package Parameters (continued)
Parameter GroupParameterDescription
MD5ChecksumStandard MD5 checksum of the Customization Data Package (a
32-character string of hexadecimal digits). This value must be
provided to the phone and it serves as the version of the target
data package. The phone executes DownloadURL only if the
currently installed data package has a different MD5 checksum
from the value of this parameter.
IncrementalThis Boolean option, if enabled, causes the phone to install the
customization data files without erasing the old data files first.
Otherwise, the old data files are erased before saving the
downloaded data files.
DnsLookupTypeChoice of:
•A Record Only
•SRV Record Only
•Try Both
DnsSrvPrefixChoice of:
•No Prefix
•With Prefix
•Try Both
Username(Optional) Username for authentication if DownloadURL uses
the scheme http:// or https://
Password(Optional) Password for authentication if DownloadURL uses
the scheme http:// or https://
Internal Data Storage Paths for User Preferences
Settings
There are a number of configuration parameters to directly or indirectly select one of several internally
stored data files for the phone to perform certain tasks, such as background picture or ring tone. This section
describes how the built-in and customized data files that support these settings are organized internally so
you can provision these parameter values accordingly.
The data files are organized into three levels: OBi Built-in, ITSP (or Administrator) Customized, and User
Customized. Each level has its own dedicated internal storage areas . The following table summarizes the
user settings that use these data files and where the phone stores the data files for each level:
70
Page 72
Phone Display and Appearances
Internal Data Storage Paths for User Preferences
Internal Data Storage Folders
Configuration
ParameterDescription
User
Preferences::
Language
User
Preferences::
BackgroundPict
ure
The parameter value must match the lang
attribute of the root element of one of the
dictionary xml files found under the folders
on the right. When there is a conflict, the
user version has the highest priority, then
the ITSP version, then your phone’s
version.
On each bootup the folders are scanned to
create a list of available languages from the
lang attributes that users can select from
the Preferences menu as their Language.
The parameter value must be the full
internal path name of a picture file stored in
one of the folders on the right or a URL.
If a URL is specified in the value, it must
start with
phone downloads and caches the data
internally until it is power cycled.
All available pictures under these folders
are also listed under the Preferences menu
for users to select as their wall paper
picture. The filenames must have one of the
following extensions: PNG, JPG, JPEG,
GIF, or BMP.
http://
or
https://
and the
Phone
Built-in
/data/dict//scratch/it
/data/them
es/backgnd
/
ITSP
Customized
sp/dict/
/scratch/it
sp/backgnd/
User
Customized
/scratch/ph
one/dict/
/scratch/ph
one/backgnd
/
User
Preferences::
DefaultRingtone
The parameter value must be the full
internal path name of a wave file stored in
one of the folders on the right or a URL.
If a URL is specified in the value, it must
start with
phone downloads and caches the data
internally until it is power cycled.
All available wave files under these folders
are listed under a) the Default Ringtone
option of the Preferences menu for users to
select as their default ring tone, and b) the
Ringtone field of the built-in Phone Book
application for users to choose a ring tone
for individual contact in phone book.
http://
or
https://
and the
/data/ring
tones/
/scratch/it
sp/ringtone
s/
/scratch/ph
one/rington
es/
71
Page 73
Phone Display and Appearances
Internal Data Storage Paths for User Preferences (continued)
Internal Data Storage Folders
Configuration
Parameter
There is no
configuration
parameter that
refers to data files
in these folders.
User
Preferences::
DefaultFont
Description
All available pictures under these folders on
the right are listed under the Picture menu
of the built-in Phone Book application for
users to select to assign to a contact. The
data filenames must on of the following
extensions: PNG, JPG, JPEG, GIF, or BMP.
The parameter value must be one of the
available font family names found in the
font.map files in the folders on the right.
When there is a conflict, the user version
has the highest priority, then the ITSP
customized version, then your phone’s
version.
Phone
Built-in
/obi/people//scratch/it
/data/fonts//scratch/it
ITSP
Customized
sp/people/
sp/fonts/
User
Customized
/scratch/ph
one/people/
/scratch/ph
one/fonts/
If a parameter value is to specify the filename of an internally stored data file, the full internal path must be
specified. For example:
User Settings – User Preferences::BackgroundPicture =
User Settings – User Preferences::DefaultRingtone =
/scratch/phone/backgnd/CherryBlossom.png
/data/ringtones/Office A.wav
72
Page 74
Updating the Software
You can use different methods to upgrade the firmware and software on your VVX business IP phone, OBi
Edition.
Updating the Firmware
You may need to update the firmware on your phone to receive new features, enhancements, and bug fixes.
Update Firmware Using IVR
The easiest way to update the phone’s firmware is by dialing *** then pressing option 6. If a firmware update
is available, you’re prompted to press 1 to continue and then hang up.
After hanging up, the download and update process completes in a couple of minutes over a fast internet
connection. The update can take much longer over legacy connectivity such as DSL or T1.
The headset button starts to flash once the firmware download completes and the phone prepares to reboot.
Update Firmware from the Local Interface
Launch the Settings App from the Main menu and press the F/W Update softkey. A message pops up on
the screen to describe whether new firmware is available. If available, press the Update Now softkey. Do
not power off the phone until the update completes and the phone automatically reboots immediately
afterward.
Update Firmware from the System Web Interface
Download the firmware file from OBiTALK.COM and store it on your computer. Then visit the phone's native
web page from a web browser on the same computer and click the Firmware Update link on the left side
panel of the landing page. On the firmware update page, enter the path to the firmware file (or click Browse
to locate the firmware file on the computer).
Automated Firmware Update
You can configure rules to automatically check and download new phone firmware from a server.
73
Page 75
Updating the Software
Background Firmware Update
You can update the firmware in the background on VVX 250, VVX 350, and VVX 450 business IP phones,
OBi Edition. Once enabled, the phone handles the firmware update without going through the Polyupdater,
and the update process occurs in the background during normal operation. Users can still use the phone
normally.
After the new firmware copies to the flash memory (and the phone isn’t in a call), the phone auto-reboots to
use the new firmware version.
You also can install new firmware directly from the system web interface by selecting the firmware file stored
on a local disk drive.
If you purchase a phone with software version 6.3.1 or later, background firmware update
is enabled by default.
Two Firmware File Formats: sip.ld and .fw
The current VVX firmware file format is the sip.ld format, which is used by both UCS and OBi Edition. To
allow firmware update in the background, the new firmware to update to must use a different firmware format
which is referred to as the .fw format. The .fw format is supported only when the background firmware
update feature has been enabled. When this update feature has been enabled, the sip.ld format is no
longer supported.
Like the sip.ld format firmware, Poly generates the .fw format for each build, signed with a Poly Release
Key. For example, the following firmware file may be generated:
● Skyline-6-3-1-25001-release-2018-12-13.fw (signed with Release Key)
But unlike the sip.ld format firmware, which requires a separate build for each phone model, the same
.fw format firmware file can be applied to all three phone models: VVX250, VVX350, and VVX450. The
filename of a .fw image can be anything and must be explicitly specified in provisioning rules.
Enabling Background Firmware Update
Enabling background firmware update requires a one-time format transition process. This process takes
about 4 to 5 minutes to complete and the phone is not usable during this period. It is highly recommended
to not to disconnect the power during the process. You can refer to the BackgroundUpdate parameter
status on the Status/System Status web page (Product Information section) to check whether background
firmware update feature has been enabled on the phone.
You can start this transition process by appending the ,bgu-conv=enable keyword to the FirmwareURL
parameter, such as:
As soon as the device verifies that the firmware in the http://192.168.1.1/backgroundupdate/
path is current, it starts the process automatically with a notification message displayed on the phone screen
until the process is done.
Once the transition process is completed, the phone auto reboots and factory resets. All existing
configuration, call logs, and phone book are lost. The BackgroundUpdate parameter is also changed to
Enabled. In case the procedure is interrupted or failed, you will have to use the Polyupdater to recover the
device. it is sometimes necessary to reinstall a sip.ld formatted image into the device.
74
Page 76
Updating the Software
Using the Background Firmware Update Feature
After the feature is enabled, the device only takes a .fw formatted image. Also, when using auto firmware
update during provisioning, a complete URL including the firmware file name must be given in the
FirmwareURL parameter. The phone does NOT append partnumber.sip.ld to the path when
downloading the image. Failure to include the .fw firmware filename results in a 404 or File not found
error. The following is an example of a correct URL:
When installing a .fw firmware from the device web page, the phone will NOT take a Config XML file as
firmware file any more, as is the case of a sip.ld file. You must provide the path to the firmware file directly.
If the given file is not a valid .fw firmware file, the firmware update procedure fails.
Reverting Back to sip.ld
Reverting back to use sip.ld firmware is equivalent to disabling background firmware update (to a .fw
firmware). This requires a one-time format (inverse) transition process on the device that has background
firmware update enabled. To do this, specify a complete URL including the firmware filename of a
corresponding sip.ld formatted image corresponding to the phone model in use in the FirmwareURL
parameter with the special keyword bgu-conv=disable appended. For example:
When the phone finds the special keyword in FirmwareURL, it first downloads the firmware file header
according to the given URL and makes sure it is a valid sip.ld firmware image. Then it saves the firmware
update URL into the Polyupdater and marks a flag to let the Polyupdater restore the flash partition on the
next boot, and then it auto-reboots. On the next boot up, the Polyupdater proceeds with reverting to the
original (UCS style) flash partitioning and subsequently upgrades to the given sip.ld firmware. Due to
flash repartitioning, the phone configuration is factory reset and all existing configuration, call logs, phone
book, and so forth are lost as a result.
Customization Data Auto Update
You can automatically update the phone customization data at the ITSP level.
For more information, see Phone Customization Data.
Auto Update Operation
Similar to the Auto Firmware Update feature, the Customization Data Auto Update feature is configured by
a set of parameters. When it is enabled, your phone attempts to download the Customization Data package
according to the scripts specified in the DownloadURL parameter. Then the data in the package is validated
by the given MD5 checksum before it is installed to internal storage. As soon as data installation successfully
completes, your phone restarts itself (warm boot) and won’t try to download the package again until the MD5
checksum is changed, even if the feature is still enabled.
The Auto Update operation is always performed after firmware update and all configuration provisioning are
completed.
75
Page 77
Updating the Software
Auto Update Configuration Parameters
This feature is configured by the following parameters.
Auto Update Configuration Parameters
ParameterDescriptionDefault Setting
MethodCurrent operational method of Provisioning. Choice of:
•Disabled = Do not download from DownloadURL
•System Start = Download from DownloadURL just once
on system start
•Periodically = Download from DownloadURL on
system start, and then periodically at the interval specified in
the Interval parameter
Note: First download on system start is performed after
firmware update and configuration provisioning are complete.
IntervalWhen Method is set to Periodically, this is the number of
seconds between download from DowloadURL. If value is 0,
device downloads once only on system start (equivalent to
setting Method to System Start).
DownloadURLURL of Customization Data package.
MD5ChecksumStandard MD5 checksum (hexadecimal string) of the
Customization Data package.
IncrementalWhen enabled, the Customization Data package is installed
incrementally without erasing the old data.
DnsLookupTypeChoice of:
•A Record Only
•SRV Record Only
•Try Both
Disabled
0
false
A Record Only
DnsSrvPrefixChoice of:
•No Prefix
•With Prefix
•Try Both
UsernameOptional Username for authentication if URL scheme is
http:// or https://.
PasswordOptional Password for authentication if URL scheme is
http:// or https://.
No Prefix
76
Page 78
Hardware and Accessories
This section provides information on configuring power management options and available VVX business
IP phone, OBi Edition, accessories for your users.
Powering VVX business IP phones, OBi Edition,
with an Ethernet Switch Connection
VVX business IP phones, OBi Edition, have a three-port Ethernet switch. The switch consists of one
internally connected port to the phone processor for traffic to and from the phone and two Ethernet
ports,labeled SW and PC.
You can power your phone through an AC power adapter or through a Power over Ethernet (PoE) cable
connected to the phone's SW Ethernet switch port.
Use either the AC power adapter or the PoE cable as a power source, but not both.
Available Accessories
VVX business IP phones, OBi Edition, support the following accessories:
● 5 VDC power adapter: Powers the phone when Power over Ethernet (PoE) isn’t available.
● Polycom Wi-Fi wireless network adapter: Connects the phone to a wireless network (VVX 250, VVX
350, and VVX 450 only).
● USB flash drive: Use to copy ring tones, background images, and other media to the phone (VVX
250, VVX 350, and VVX 450 only).
● USB headsets (VVX 250, VVX 350, and VVX 450 only).
77
Page 79
Poly VVX EM50 Expansion Modules
Add additional lines to your VVX 450 business IP phone by connecting a PolyVVX EM50 expansion module.
The following features are available on the VVX EM50 expansion module:
● Assign a function to each line key
● Thirty line keys and three display pages
● Supports 90 lines on each expansion module and 48 phone lines
● Connect up to two expansion modules to a VVX 450 business IP phone to support a total of 228 lines
● The expansion module has a USB port to connect low-powered devices
VVX 150, 250, and 350 business IP phones don’t support expansion modules. You can use Poly
VVX EM50 expansion modules only on VVX 450 business IP phones, OBi Edition, with OBi
Software 6.4.0 or later.
Set Up a VVX EM50 Expansion Module
VVX EM50 expansion modules are powered and signaled by VVX business IP phones, OBi Edition, and
require minimal setup. Expansion modules automatically configure and update when you connect them to
the phone.
To set up a VVX EM50 expansion module
1 Connect a VVX EM50 expansion module to the USB port on the side of the VVX 450 business IP
phone, OBi Edition.
The LED lights on the expansion module line keys flash red and green as it initializes.
VVX EM50 Expansion Module Line Keys
The line keys on VVX 450 business IP phones, OBi Edition, and VVX EM50 expansion modules are
numbered sequentially. For example, the VVX 450 business IP phone, OBi Edition supports 48 lines,
numbered 1 to 48. The first line on the connected expansion module is line 49.
The line keys on the expansion module are divided into 15 left and 15 right keys on each page. Each
expansion module supports three pages, extending its line keys to 90.
See Feature Keys for more information.
78
Page 80
Poly VVX EM50 Expansion Modules
VVX EM50 Expansion Module Background
Picture
The default background image on the VVX EM50 expansion module (side car) is the same as the phone
background. When you set the background image on the phone, the expansion module background
automatically updates. If you attach more than one EM50 expansion module, both show the same
background picture.
You can load a different background image for the expansion module by specifying the image in the User Preferences::SideCarBackgroundPicture parameter. The optimum image resolution is 480pixels wide
by 800 pixels high.
79
Page 81
Audio Features
You can create customized tone patterns and ring tones for your VVX business IP phones, OBi Edition.
Tone Patterns
Tone and Ring Profile A default settings are set for North American telephone standards. Tone and
Ring Profile B default settings are set for Australian telephone standards. You can download tone
profiles for other countries from the OBiTALK forum.
Tone Profile Features of Your Phone
Tone profiles use the following format:
[field-1];[field-2];[field-3];...;[field - 6]
Use a semicolon to separate the configuration fields. You can’t use spaces in the tone profile patterns.
Field–1 Composition
Field-1 describes frequency components used for tone synthesis. It supports as many as three different
frequencies.
The frequency expression is a string of numeric values with the notation + or –. The numeric values are the
frequency's decimal values in Hz and amplitude in dBm (maximum 3 dBm).
Different frequencies are separated by a comma.
Example: 350-18,440-18,550+2
● The first frequency is at 350 Hz with strength at –18 dBm
● The second frequency is at 440 Hz with strength at –18 dBm.
● The third frequency is at 550 Hz with strength at +2 dBm
Field–2 Composition
Field-2 describes the overall tone playback duration in seconds.
The expression is a numeric value, and supports as many as three decimated digits. The numeric value can
be negative, zero, positive, or skipped:
● Negative value: Tone plays indefinitely
● Zero value: Tone playback is skipped
● Positive value: Normal playback duration
80
Page 82
Audio Features
● No value: Tone plays indefinitely
Example: 30.234
● Tone playback terminates after 30.234 seconds.
Field–3 to Field–6 Composition
Fields 3 through 6 share the same definition. Each field describes one single cadence segment. Together,
these four fields form a macro-segment, which repeats until tone playback expires.
The expression is a string of numeric values with the special notation '/', '(', ')', and ','.
Special information tone (SIT) is generated from a set of frequency components:
● First frequency: 985 Hz at
● Second frequency: 1428 Hz at
● Third frequency: 1777 Hz at
The expiration time is exactly 20 seconds. It has only one cadence segment, which includes four on-off
sections. The segment has infinite repeating time:
● The first on-off section: generated by the first frequency component, and it has 0.38 tone second
active time and 0 inactive time.
● The second on-off section: generated by the second frequency component, and it has 0.38 tone
second active time and 0 inactive time.
–16 dBm
–16 dBm
–16 dBm
82
Page 84
Audio Features
● The third on-off section: generated by the third frequency component, and it has 0.38 tone second
active time and 0 inactive time.
● The fourth on-off section: only generate silence since no frequency component is specified. It has
tone 0 second active time and 4 seconds inactive time.
Stutter Tone
STUTTER, "350-18,440-18;20;.2(.1+.1);()"
Stutter dial tone is generated from a mixture of two frequency components:
350 Hz at
has two cadence segments.
● The first segment includes only one on-off section, on 0.1 second and off 0.1 second, and on-off
● The second segment includes one on-off section, and has infinite repeating time and infinite tone
For more information on Tone Profile A & B parameters, see the Tone Profile X Web Page (X = A, B) table
in the Device Web Page and Configuration Parameter Reference section.
For more information on call waiting parameters, see the Tone Profile X Web Page (X = A, B) table in the
Device Web Page and Configuration Parameter Reference section.
–18 dBm and 440 Hz at –18 dBm. The expiration time for the entire tone is exactly 20 seconds. It
repeats for 2 seconds.
active time, and plays until the entire tone duration has elapsed.
Ring Tones and Ring Patterns
The general format of an OBi ring profile is [field-1];[field-2];...;[field - 5]
Use a semicolon to separate as many as five configuration fields. You can’t use spaces in the ring profile
patterns.
Field-1 Composition
Field-1 describes the overall ringing duration in seconds.
The expression is a numeric value and supports as many as three decimated digits.
The numeric value can negative, zero, and positive:
● Negative value: Ringing lasts indefinitely
● No value: Ringing lasts infinitely
● Zero value: Ringing is skipped
● Positive value: Normal ringing duration
Example: 30.5
● This example illustrates a ringing tone that ends after 30.5 seconds.
Field-2 to Field-5 Composition
Fields 2 through 5 share the same definition, and each field describes one single cadence segment.
Together, the four fields form a macro-segment, which repeats until ringing expires.
83
Page 85
Audio Features
The expression is a string of numeric values with the special notation '(' , ')', and ','.
t(on_0+off_0,on_1+off_1,on_2+off_2,on_3+off_3)
● t: The cadence segment duration in seconds.
Negative value: Ringing indefinitely
No value: Ringing indefinitely
Zero value: Ringing is skipped
Positive value: Normal ringing duration
● on_0/1/2/3: The ring active time in seconds.
Negative value: Not allowed
No value: Infinite ring active time
Others: Normal ring active time (as many as three decimated digits)
● off_0/1/2/3: The ring inactive time in seconds.
Negative value: Not allowed
No value: Infinite ring inactive time
Others: Normal ring inactive time (as many as three decimated digits)
Example: 4(.3+2.34,2+1.5)
● This example illustrates a ringing tone comprised of two segments.
● Ringing is active for 0.3 seconds, followed by 2.34 seconds of silence, then ringing for 2 seconds, and
followed by 1.5 seconds of silence.This cadence operates repeatedly for 4 seconds.
84
Page 86
Voice Services
A voice service, also known as a line or trunk, is an individual user account with an ITSP. You can configure
the following voice services on your phone’s IP port:
● SP1
● SP2
● SP3
● SP4
● SP5
● SP6
● OBiTALK
An SPn service can be a generic SIP voice service. SIP/SP services include an extension from a PBX or a
subscriber account with a service provider. Every SP service user account requires a user name and usually
a password for authentication. The service provider assigns an extension number or DID number to the user
account. The assigned number may be the same as the user name of the account.
OBiTALK is a built-in service that Poly provides and manages for customers to use for technical support and
device-to-device calling among OBi devices.
ITSP Profiles
The configuration of an SP service is divided into a service provider part and a service subscriber part.
Service Provider Part
The service provider part comprises parameters that are common to all service subscriber accounts from
that service provider.
Each service provider part is an ITSP profile that has its own parameter groups. You can configure as many
as six ITSP Profiles (A through F) in a phone configuration.
Service Subscriber Part
The service subscriber part comprises of parameters that may vary for each specific subscriber account
from the service provider.
The service subscriber, known as an SP service, includes the SPn::
binds the SP service with an ITSP Profile. By default, the SPn::X_ServProvProfile parameter for all SP
X_ServProvProfile
parameter that
85
Page 87
Voice Services
services points to ITSP Profile A. If you want to use two different service providers with your phone, configure
the settings for them in ITSP Profile A and ITSP Profile B respectively.
A common mistake is not setting the X_ServProvProfile parameter correctly to point to the
corresponding ITSP profile.
Audio Codec Profiles
Two codec profiles are available on your phone, and they’re selectable per trunk (OBiTALK, SPn, n = 1
through 6). To select a codec as the preferred codec in this profile, set the priority of that codec to be highest
among all the enabled codecs in the profile. You can assign each of the SP and OBiTALK services to a
codec profile in its corresponding configuration. The codec list to use when setting up a call on the
underlying service is formed from the list of enabled codecs in the chosen profile and ordered according to
the assigned priorities in the profile. For codecs with the same priority setting, the codec that appears first
on the codec profile web page has a higher priority.
Specifying Target Phone Numbers
There are places within the configuration that specify a target phone number, such as a speed dial number
or a call forward number.
Two formats specify a target phone number:
● Short number: The number itself is specified, such as 3231234.
● Full number: The number and the service to use the number are specified, such as
sp3(14089993312).
The case-insensitive service names to use for each service in the full number specifications the
following:
spn for SPn Service for n = 1 – 6
pp for OBiTALK Service
Overview of Common Trunk Configuration
Trunks of every kind share some common characteristics that you can configure.
Trunk Capacity
Trunk Capacity is the maximum number of simultaneous calls allowed on the trunk. You can set the value
for each service using the MaxSessions parameter. The default value is 2 for all services. For OBiTALK
service, the maximum value is 4. For other SIP/SP services, do not set the value higher than the maximum
number of simultaneous calls allowed by the service provider.
86
Page 88
Voice Services
Service Enable
Before you put a trunk into service, enable the trunk in the phone configuration. There’s an Enable
parameter for each service, and this parameter is checked by default.
Service Account Credentials
All SP services require credentials, but OBiTALK services don’t require credentials. At the minimum, you
must configure a user name for the SP service account using the following parameters:
● SPn Service- Service Credentials::AuthUserName
● SPn Service- Service Credentials::AuthPassword (Optional; use if you require a password for
server authentication)
In a less common situation where the user name used for SIP authentication is different from the account
user name, set the account user name in SPn Service- Service Credentials::URI and the different user
name for authentication only in AuthUserName (required). If URI isn’t specified, it’s used for both as the
account user name and for SIP authentication. Note also that if AuthUserName isn’t specified, your phone
considers the service as disabled.
Servers
OBi Edition phones support the following servers and voice services:
● SIP servers
● OBiTALK servers
No matter what technology the service provider side equipment uses, you must provision it into your phone
configuration as a domain name or an IP address along with a port number if the server isn’t listening at the
standard port (5060). Note that since OBiTALK servers are known by your phone, there’s no need to
configure the server domains for this service. For other SIP/SP services, configure the proxy server in the
ITSP Profile X – SIP::ProxyServer parameter. If the listening port is nonstandard, configure the correct
value in ITSP Profile X – SIP::ProxyServerPort. The OutboundProxyparameter in the same
parameter group is often needed when the device-facing server is a session border controller (SBC).
Similarly if the outbound proxy isn’t listening at the standard port, configure the correct port value in
OutboundProxyPort. The RegistrarServer and RegistrarServerPort parameters are rarely
needed; your phone assumes that the SIP Registrar is the same as the SIP Proxy Server if they aren’t
specified separately.
SIP Transport refers to the transport protocol to use to exchange SIP messages with the server: UDP, TCP,
and TLS, which are all supported by your phone. Use the ITSP Profile X – SIP::ProxyServerTransport
parameter to configure the transport protocol. For TCP/TLS, your phone must start a TCP/TLS connection
with the ProxyServer and use the same connection to exchange all subsequent SIP messages. If
OutboundProxy is specified, your phone starts the TCP/TLS connection with the OutboundProxy
instead. With the OutboundProxyTransport parameter, it’s possible to choose a different transport to
use with the OutboundProxy and with the
When you only specify a short number, your phone determines the service to use, where necessary, by
going through normal digit map and call routing processing. With a specified full number, your phone uses
the number and service as specified without any modification.
ProxyServer
.
87
Page 89
Voice Services
SIP/SP Services
You can configure as many as six SIP/SP service accounts on your phones.
Each ITSP configuration is grouped as an ITSP Profile. There are six ITSP profiles available, referred to as
ITSP Profile A, B, C, D, E, and F, respectively. SP service account specifics are grouped under the heading
SPn Service, where n = 1— 6. An ITSP Profile includes the ProxyServer, OutboundProxy, and
DigitMap parameters, but, it doesn’t include account-specific parameters. An SP Service includes
account-specific parameters such as AuthUserName (usually, but not necessarily, the same as the phone
number of the account), AuthPassword, CallerIDName, and X_ServProfile (which ITSP Profile to
apply the ITSP-specific parameters from). If both SP Services use the same ITSP, it’s usually possible to
configure just one ITSP Profile with both SP Services referring to the same profile. However, if abstraction
of an ITSP Profile isn’t sufficient to cover a particular ITSP, configure multiple ITSP profiles for the same
ITSP and have each individual SP service using that ITSP to point to a different ITSP profile.
The SPn Service using ITSP Profile X is enabled by your phone only when at least the following parameters
are set:
● ITSP Profile X – SIP::ProxyServer = Not Blank
● SPn Service::Enabled = true (or checked on the native phone web page)
● SPn Service::AuthUsername = Not Blank
where X = A – F and n = 1 – 6. Otherwise, your phone considers the service disabled.
OBiTALK Service
OBiTALK is a proprietary protocol for communications among OBi Edition phones and to OBiTALK device
management servers. The protocol is intended for two main purposes:
● Peer-to-peer calling between OBi devices
● Device management by OBiTALK servers
Every OBi Edition phone comes with one instance of the OBiTALK service with the (fixed) factory-assigned
9-digit device OBi number as the userid of the service. OBi devices can call each other by dialing the other
party’s OBi number.
The OBiTALK service also enables you to view and change the settings of your phones from the OBiTALK
portal. If you disable the OBiTALK service in your phone’s configuration, you can’t place OBiTALK voice calls
or manage device features through the OBiTALK portal.
The OBiTALK Service::Enable parameter enables the OBiTALK service by default, unless disabled
through ZT customization.
You may want to limit OBiTALK calls just to the OBihai echo server. To do this, the administrator can change
the value of OBiTALK Service::DigitMap to: (<ob>222222222|ob222222222). You can change or
add more OBi numbers to this digit map by following the same pattern. A simple way to disable OBiTALK
voice calls completely is by setting OBiTALK Service – Calling Features::MaxSessions to 0. You can’t
do echo test in that case.
88
Page 90
Directories and Contacts
Your phone supports a directory search function with an external server using the Lightweight Directory
Access Protocol (LDAP). To use this function, you must configure an LDAP service on the phone. Users
then invoke the LDAP directory search application by selecting the option from the phone main menu or by
pressing a softkey.
LDAP Service Setup
You can point the Network Directory option on the main menu of the phone to an LDAP service using the
following parameters.
LDAP Parameters
Parameter GroupParameterDescription
IP Phone – LDAP –
Server
IP Phone – LDAP –
Server
IP Phone – LDAP –
Server
IP Phone – LDAP –
Server
HostThe hostname can be an IP address or domain name,
with optional ldap:// or ldaps:// scheme prefix. For
example: 192.168.15.186, ldap.forums.com,
ldap://ldap.testathon.net are all acceptable
hostname formats.
If scheme is not specified,
PortLDAP Server listening (TCP) port. The standard port is
389 for ldap:// and 636 for ldaps://. If the port value
is 0 or blank, the phone uses the corresponding standard
port.
PasswordThe Bind password for Simple or SALSL authentication
Note that this parameter is case-sensitive.
TLSSecurityProfileThe security profile for 802.1X authentication.
ldap:// is implied.
89
Page 91
Directories and Contacts
LDAP Parameters (continued)
Parameter GroupParameterDescription
IP Phone – LDAP –
Search Parameters
IP Phone – LDAP –
Search Parameters
BindDNA Distinguished Name (DN) that is authorized to use the
LDAP service. If none is specified, the query is regarded
as an anonymous one which may or may not be
acceptable to the server.
The BindDN value is usually derived from a user name
that typically looks like an email address, such as
admin@ldap.example.com. In which case, the
corresponding BindDN would be:
CN=admin,OU=users,DC=example,DC=com
Note that in the last example, the DN includes only the last
two parts of the domain name for illustration purpose only.
The DN may as well include the DC=ldap field, for
example. But the key point is that this value must agree
exactly with how it is specified at the server side.
SearchBaseThis parameter specifies the starting point of the LDAP
search. It is a case-insensitive comma-separated list of
{object}={value} pairs, where {object} can be any
of the following:
•CN (Common Name)
•OU (Organization Unit)
•O (Organization)
•C (Country)
•DC (Domain)
If the value is not specified, the phone by default derives
the search starting point from the value of LDAP –
Server:: Host. For example, if Host is
ldap.example.com, the default SearchBase value is
DC=example,DC=com
Note that it is a common convention to use just the last
two parts of the service domain as a search base, but it is
not necessarily so. The phone assumes this convention
when SearchBase is not specified.
IP Phone – LDAP –
Search Parameters
IP Phone – LDAP –
Search Parameters
ProtocolVersionProtocol version. Either 3 or 2. 3 is the default.
TLS_ReqCertControls whether to verify the server’s certificate on a TLS
connection. Choice of:
•never
•demand
Default value is never, which means not to verify the
server’s certificate.
90
Page 92
Directories and Contacts
LDAP Parameters (continued)
Parameter GroupParameterDescription
IP Phone – LDAP –
Search Parameters
IP Phone – LDAP –
Search Parameters
IP Phone – LDAP –
Search Parameters
ResultsPerPageSpecifies how many results to display on screen per page.
Valid values are:
•20
•40
•60
•80
•100
Default value is 20.
DefaultSearchFilterDefault search filter to append to each search. This must
be specified as a complete and valid LDAP search filter.
For example:
(|(objectclass=contact)(objectclass=person
))
Default value is:
(objectclass=*).
QueryFieldsA comma-separated list of user input LDAP
attributes/Display-Name to form the query filter.
Each item has three attributes separated by two slashes
(/): {ldap-attr}/{display-name}/{type} where
•{ldap-attr} is the standard ldap-attribute-name,
such as sn, givenName, telephoneNumber, cn,
... . This is the only required attribute in each field.
•{caption} is optional. This is the caption to display
on the screen for the input box. If not specified, the
{ldap-attr} value is used in its place.
•{type} is either A or N, for alphanumeric or number
type respectively and is case insensitive. If not
specified, it is assumed to be A.
ResultFieldsComma-separated list of LDAP fields to display for each
entry of the search result. Each field has three attributes
separated by two slashes (/):
{ldap-attr}/{caption}/{type} where
•{ldap-attr} is the standard ldap-attribute-name,
such as sn, givenName, telephoneNumber, cn,
.... This is the only required attribute in each field.
•{caption} is optional. This is the caption to display
on the screen for the displayed value. If not specified,
the {ldap-attr} value is used in its place.
•{type} is either S, C, or N, for String, Callable Number,
or Picture, respectively. It is case insensitive. If not
specified, it is assumed to be S.
NameFieldPreferenceComma-separated list of LDAP attributes to be used as
the Caller ID Name to display on screen, ordered by
preference. The first non-empty value in the list is used.
Default value is cn,givenName sn.
NumberFieldPreferenceComma-separated list of LDAP attributes to be used as
the Number to display on screen and to call by default,
ordered by preference. The first non-empty value in the
list is used.
Default value is
telephoneNumber,mobile,homePhone.
IP Phone – LDAP –
Search Parameters
IP Phone – LDAP –
Search Parameters
IP Phone – LDAP –
Search Parameters
SASL Parameters (not applicable for LDAP version 2)
PhotoFieldPreferenceComma-separated list of LDAP attributes to be used as
SortByAttributeThe LDAP attribute to use for sorting the search results by
AttributeComma-separated list of attributes to request from server.
the photo to display on screen, ordered by preference.
The first non-empty value is used.
Default value is thumbnailPhoto.
the server. Default value is cn
92
Page 94
Directories and Contacts
LDAP Parameters (continued)
Parameter GroupParameterDescription
IP Phone – LDAP –
SASL Authentication
Parameters
IP Phone – LDAP –
Search Parameters
SASL_AuthMethodMethod to use for SASL authentication. If the value is
Disabled, the phone uses Simple authentication only.
Choice of:
•Disabled (the default)
•Plain
•MD5
SASL_AuthCIDThe authentication ID for SASL authentication. The format
of this ID depends on the actual SASL mechanism used.
Client Authentication
LDAP v2 supports ldap:// and ldaps:// with Simple Authentication only. LDAP v3 adds support for TLS
and SASL Authentication. Simple authentication involves sending the LDAP server the FQDN of the client
and the corresponding password in clear-text, which has security issues unless you use ldaps:// or TLS.
Simple Authentication and Security Layer (SASL) [RFC2222] is a framework for authentication. To use
SASL, you must set the LDAP – SASLAuthMethod parameter to either
For more informations on each of these SASL mechanisms, go to http://www.openldap.org.
Plain or MD5.
LDAP Directory Search Application
Users can start the LDAP application on the phone from the Main menu or with a softkey (with ID = ldap).
Invoke LDAP by Main Menu – Directories Option
Include the Main menu Item ID directories in the Phone Settings – GUI Menus::MainMenu1 parameter.
When the LDAP service is properly configured, the LDAP option appears under the Directories menu, as
shown:
93
Page 95
Directories and Contacts
LDAP display example
Invoke LDAP by Main Menu – Network Directory
Option
First you must include the Main menu item ID netdir in the Phone Settings – GUI Menus::MainMenu1
parameter. To make the Network Directory option on the Main menu invoke the LDAP service, use the
following settings:
IP Phone Settings – Network Directory::Enable = true (checked)
IP Phone Settings – Network Directory::VoiceService = LDAP
Invoke LDAP by Softkey – LDAP
To use a softkey to invoke the LDAP application, add the ldap softkey to any of the configurable softkey
sets. For example, configure the following value for the Home softkey set with the LDAP softkey in the fourth
position:
redial,cfwd,dnd,ldap
Search Fields
By default, your phone displays the following search fields:
● Last Name (sn)
● First Name (givenName)
● Tel Num (telephoneNumber)
● Mobile Num (mobile)
● Home Num (homePhone)
One of more of these search fields may be specified per query; all the search criteria are added together to
form the search filter, and the value is case-insensitive. To specify partial match of an attribute value, use a
* wildcard character. For example: set Last Name = s* to query all entries with the sn that starts with an s or
S.
94
Page 96
Directories and Contacts
You can customized the search fields presented to you by specifying the fields in the QueryFields
parameter. This is a comma-separated list of fields. Refer to the LDAP parameter table above for the syntax.
Result Fields
The search results are presented in a table where a Name, a Number, and a Picture are shown, when the
values are available. Which LDAP attributes in the result are to be used for the Name, Number, and Picture
display can be controlled by setting the NameFieldPreference, NumberFieldPreference, and
PhotoFieldPreference parameters. Each of these parameters is a comma-separated list of LDAP
attributes arranged in order of preference. The first attribute in the list that has a non-empty value is used
for the corresponding display field.
You can see more attribute values of an entry by highlighting the entry on the top-level search result table
and pressing the OK key on the phone. This brings up the LDAP Result Details screen of the selected entry.
You can customize the attributes to display on this screen with the ResultsFields parameter, which is a
comma-separated list of fields to present to you. Refer to the LDAP parameter table for the syntax of this
parameter.
Search result examples
95
Page 97
Directories and Contacts
Sorting of Results
The phone relies on the server to sort the results. Sorting is based on a single LDAP attribute which can be
customized with the SortByAttribute parameter. The default value is cn.
Replace the Built-In Phone Book with LDAP
You can replace the built-in phone book with LDAP, such that when you press the phbk softkey or select
Contacts from the Main menu, it launches the LDAP feature instead of the built-in (local) phone book. Below
To enable Phone Book import from a PolyPhoneBook XML, specify a URL in the ImportURL parameter
(under User Preferences page Phone Book Settings. When a valid ImportURL is configured into the phone,
the Import softkey is shown on the top level screen in the Contacts app, by which you can invoke the import
operation. For example:
Note that the comma-separated parameters after the URL are optional and are used to control the HTTP
connection only.
Phone Book Import/Export
Web PageSectionParameterDescription
User
Preferences
User
Preferences
To enable Phone Book export to a PolyPhoneBook XML, specify a URL in the ExportURL parameter (under
User Preferences page Phone Book Settings. If a valid ExportURL parameter is configured into the phone,
the Export softkey is shown on the top level screen of the Contacts app, by which you can trigger the export
operation. Note that the phone tries to save the file on the server with the filename
PolyPhoneBook-yearmonth-day-hh-mm-ss.xml, where year-month-day-hh-mm-ss is the current date-time
in GMT. For example:
ExportURL =
Note that server-type is an optional comma-separated parameter to control the format of the HTTP Post
message body. If server-type is not specified, the phone sends a message body like this:
Phone Book
Settings
Phone Book
Settings
http://192.168.15.100/hfs,server-type=1
ImportURLA URL for importing into the phone book from a
PolyPhoneBook XML
ExportURLA URL for uploading the internal phone book as a
PolyPhoneBook XML.
You can append an optional comma-separated parameter
servertype=type to the URL; type can be 0 or 1. See the
examples for the meaning of each type.
96
Page 98
Directories and Contacts
POST /hfs/ HTTP/1.1
Host: 192.168.15.100
User-Agent: VVX450
Cache-Control: max-age=0
Accept-Language: en-us, en
Accept-Charset: ISO-8859-1, utf-8
Content-Type: application/xml
Content-Length: 362
Connection: Close
You can configure call features as a phone-level feature or a line-level feature. A phone feature applies to
all calls on the phone regardless which line a call is on. Call waiting, for example, is a phone feature. A line
feature applies only to calls on a specific line. For example, busy lamp field (BLF) is a line feature.
Some features may haveboth a phone feature version and a line feature version. For example, you can
provision Do Not Disturb as a phone feature for all calls and as a line feature for each line for the SP services
(SP1–SP6) and OBiTALK services.
Call States
As a call progresses from beginning to end, it goes through a number of defined stages commonly known
as call states or states. The following table includes the call states for calls on your phone.