Polycom HDA50 Administrator's Manual
ADMINISTRATOR GUIDE
Polycom® HDA50
1.0.0 | July 2019 | 3725-86015-001A
Copyright© 2019, Polycom, Inc. All rights reserved. No part of this document may be reproduced, translated into another
language or format, or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the
express written permission of Polycom, Inc.
6001 America Center Drive
San Jose, CA 95002
USA
®
Trademarks Polycom
and/or service marks of Polycom, Inc. and are registered and/or common law marks in the United States and various
other countries.
All other trademarks are property of their respective owners. No portion hereof may be reproduced or transmitted in any
form or by any means, for any purpose other than the recipient's personal use, without the express written permission
of Polycom.
Disclaimer While Polycom uses reasonable efforts to include accurate and up-to-date information in this document,
Polycom makes no warranties or representations as to its accuracy. Polycom assumes no liability or responsibility for
any typographical or other errors or omissions in the content of this document.
, the Polycom logo and the names and marks associated with Polycom products are trademarks
Limitation of Liability Polycom and/or its respective suppliers make no representations about the suitability of the
information contained in this document for any purpose. Information is provided "as is" without warranty of any kind and
is subject to change without notice. The entire risk arising out of its use remains with the recipient. In no event shall
Polycom and/or its respective suppliers be liable for any direct, consequential, incidental, special, punitive or other
damages whatsoever (including without limitation, damages for loss of business profits, business interruption, or loss of
business information), even if Polycom has been advised of the possibility of such damages.
End User License Agreement BY USING THIS PRODUCT, YOU ARE AGREEING TO THE TERMS OF THE END
USER LICENSE AGREEMENT (EULA) AT: http://documents.polycom.com/indexes/licenses. IF YOU DO NOT AGREE
TO THE TERMS OF THE EULA, DO NOT USE THE PRODUCT, AND YOU MAY RETURN IT IN THE ORIGINAL
PACKAGING TO THE SELLER FROM WHOM YOU PURCHASED THE PRODUCT.
Patent Information The accompanying product may be protected by one or more U.S. and foreign patents and/or
pending patent applications held by Polycom, Inc.
Open Source Software Used in this Product This product may contain open source software. You may receive the
open source software from Polycom up to three (3) years after the distribution date of the applicable product or software
at a charge not greater than the cost to Polycom of shipping or distributing the software to you. To receive software
information, as well as the open source software code used in this product, contact Polycom by email at
OpenSourceVideo@polycom.com.
Customer Feedback We are striving to improve our documentation quality and we appreciate your feedback. Email
your opinions and comments to DocumentationFeedback@polycom.com.
Polycom Support Visit the Polycom Support for End User License Agreements, software downloads, product
documents, product licenses, troubleshooting tips, service requ
ests, and more.
2
Contents
Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Audience, Purpose, and Required Skills . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Polycom and Partner Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
The Polycom Community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Notational Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Canonical Fashion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Literal Fashion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Boolean Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Multiple Choice Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Port Setup and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Configuration and Management Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Web Server-Based Local Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Local Device Update and Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Firmware Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Customized AA Prompts Backup and Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Backup Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Restore Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Reset Configuration Locally . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Reset Configuration Remotely . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Device Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Headset Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Phone Port Setup and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Use the Device as a Paging System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Available Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Polycom, Inc. 1
Contents
IP Routing and LAN Switching Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
IP Routing Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
LAN Switching Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
802.1X Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Status Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
System Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
WAN Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Product Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
USB Headset Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
SPn Service Status (n = 1, 2, 3, 4) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
OBiTALK Service Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
LAN Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Call Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Call History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Services, Phone, and Line Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Device Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Codec Profile Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Tone and Ring Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Tone Profile Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Field-1 Composition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Field-2 Composition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Field-3 to Field-6 Composition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Tone Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Ring Profile A & B . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Ring Profile Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Field-1 Composition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Field-2 to Field-5 Composition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Call Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Inbound Call Route Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Outbound Call Route Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Trunks, Endpoints, and Terminals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Service Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
SIP Service Provider Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
SIP Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
ITSP Driven Distinctive Ringing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
RTP Statistics – the X-RTP-Stat Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Media Loopback Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Polycom, Inc. 2
Contents
Using SPn as a Proxy for a SIP IP Phone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Automated Attendant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Customizing AA Prompt Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Trunk Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Parameter Reference Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Phone Port Setup and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Possible Error Messages on Firmware Update Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Polycom, Inc. 3
Before You Begin
This guide describes how to administer, configure, and provision Polycom® HDA50 devices.
Audience, Purpose, and Required Skills
This guide is for a technical audience. You must be familiar with the following concepts before beginning:
● Current telecommunications practices, protocols, and principles
● Telecommunication basics, video teleconferencing, and voice or data equipment
● Open SIP networks and VoIP endpoint environment
Related Documentation
For more information on HDA50, refer to the following documents on Polycom Support. These documents
are written for service providers and system administrators.
● Polycom
front panel LEDs, and safety and regulatory information.
● Polycom
initial configuration setup, and a provisioning parameter reference guide.
®
HDA50 Setup Sheet: Includes information about cable connections, package contents,
®
HDA50 Deployment Guide: Includes information about configuration, device settings,
s
Getting Help
For more information about installing, configuring, and administering Polycom products, see Documents &
Software at Polycom Support.
Polycom and Partner Resources
In addition to this guide, the following documents and other resources provide details and resources:
● For Polycom Software releases and documentation, see Polycom Voice Support.
● For user guides for Polycom voice products, refer to the product support page for your phone at
Polycom Voice Support.
● You can find Request for Comments (RFC) documents by entering the RFC number at
https://www.ietf.org/rfc/.
● For information on IP PBX and softswitch vendors, see Polycom Desktop Phone Compatibility.
● For information on Polycom Device Management Service for Service Providers (PDMS-SP), refer t
the documentation on Polycom Support.
Polycom, Inc. 4
o
Before You Begin
To find all Polycom partner solutions, see Strategic Global Partner Solutions.
The Polycom Community
The Polycom Community gives you access to the latest developer and support information. Participate in
discussion forums to share ideas and solve problems with your colleagues. To register with the Polycom
Community, simply create a Polycom Online account. When logged in, you can access Polycom support
personnel and participate in developer and support forums to find the latest information on hardware,
software, and partner solutions topics.
Documentation Feedback
We welcome your feedback to improve the quality of Polycom documentation.
You can email Documentation Feedback for any important queries or suggestions related to this
documentation.
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 device’s native web portal or on OBiTALK at
https://www1.obitalk.com.
The literal fashion is required when provisioning or writing OBIPhoneXML apps.
Canonical Fashion
This example shows the format of the canonical fashion.
● Parameter Group Name::ParameterName = Parameter Value {replace with actual
value}
The Parameter Group Name is the heading of the parameter group on the left side panel of the device local
configuration or OBiTALK Configuration web page. This string may contain spaces. When a group heading
has more than one level, each level is separated 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. Parameter Group Name and ParameterName are separated by two colons (::),as shown
in the first example above.
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
Polycom, Inc. 5
Before You Begin
● ProxyServerPort = 5082
Literal Fashion
These examples show the format of the literal fashion. The literal fashion is used 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 is terminated with a period, as shown. More than one
ParameterGroupName. may be used. The ParameterGroupName. is case-sensitive.
The ParameterName. is the name of the parameter, and always is terminated with a period, as shown. This
string MUST NOT CONTAIN ANY SPACES. The ParameterName. is case-sensitive.
The Parameter Value is the literal value to assign to the named parameter and may contain spaces. The
Parameter Value is not case-sensitive, but it MUST EXACTLY MATCH the value when one or more
choices are available.
When using the literal fashion in your XML, you need to exactly match the text string for
ParameterGroupName.ParameterName.Parameter Value, but text formatting such as bold face is not
required and will be removed when your script or app is processed.
{replace-with-actual-value}
Boolean Values
You can identify parameters that take a Boolean value on your device’s configuration web pages by a check
box next to the parameter name. Throughout the document, we may loosely refer to a Boolean value as
“enable/disable” or “yes/no”, but the only valid Boolean parameter values to use in a device configuration
file is either true/false or True/False (case-sensitive). This is equivalent to selecting or clearing the
check box on the configuration web pages.
Multiple Choice Values
You must provision parameters that take one of several valid options from a drop-down list on the device
message 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.
When a choice must be selected, the device web page provides a drop-down menu for that parameter. Copy
that value into your provisioning script.
Parameter Values
When entering a parameter value from the web page 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 space before and after the delimiter.
For example: CertainParameter = 1,2,3,4;a;b;c
Polycom, Inc. 6
Before You Begin
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
Polycom, Inc. 7
Getting Started
The HDA50 is a VoIP adapter for USB headsets. It offers audio reliability in instances when you prefer to
use a soft client for call management and control. Similar to a desk phone, it ensures that audio traffic is
separated and prioritized.
You can manage the HDA50 configuration and network interaction directly through the device, the native
device web interface, or the PDMS-SP portal at https://www1.obitalk.com.
Product Overview
The Polycom HDA50 is an Open SIP USB headset adapter with the following features:
● SIP service provider or local system administrator support for up to four SIP accounts
● USB headset connectivity optimized for Plantronics headsets
● Aggregation and bridging of SIP services
● Automatic Attendant (AA) for simplified call routing
● High-quality voice encoding using G.711, G.7.22, G.726, G.729, Opus, and iLBC algorithms
● Recursive digit maps and associated call routing (outbound and inbound)
Port Setup and Configuration
Make the following connections to use your device. For details, see the HDA50 Setup Sheet.
● Power Connection - Connect the supplied 12-volt power adapter to the device and the wall outlet or
working power strip. Only use the power adapter supplied with the original packaging to power the
device. Use of any power adapter other than what was provided with the device voids the warran
and may cause the unit to not function at all or cause undesired operation.
● Internet Connection Setup and Configuration - Connect an Ethernet cable from an available switch
port to the Internet port. By default, the device requests IP, DNS, and Internet (WAN) Gateway IP
addressing via DHCP
Polycom, Inc. 8
.
ty
Configuration and Management Interfaces
The HDA50 provides these interfaces for local configuration and management:
● Device web pa
● Remote c
ge
onfiguration and management using PDMS-SP at https://www1.obitalk.com
Web Server-Based Local Configuration
You can access the HDA50 device configuration web page using the IP address and default account
credentials:
● For user access, the default user name and password are user and user.
● For administrator access, the default user name and password are admin and admin.
Access the Device Management Web Page
Each device has its own built-in portal site at http://{ip-address} where {ip-address} is the IP
address of the device. The native web portal offers configurable options and status information organized
into a number of web pages.
If the device is already bootstrapped into your assigned PDMS-SP account, follow the procedure below to
find the device’s IP address.
Procedure
1 Log in to PDMS-SP.
2 Go to the Manage Device page and select the device by OBi number, MAC Address, or Serial
Number.
3 Go to the Configuration tab and select Local Configuration.
4 You can find the IP address at System Status > WAN Status > IPAddress.
5 Enter the device IP address in the address field of your web browser.
6 When prompted, enter the user name and password.
Use the collapsible menu on the left side of the page to easily go to the various configuration parameter
sections of the device.
In the PDMS-SP interface, Polycom recommends that you claim your device before you connect it
to the internet. Use this method instead of adding the device. After you claim it, the device is
associated with your account.
Polycom, Inc. 9
Configuration and Management Interfaces
Submit every configuration page individually after changes are made on the page. Otherwise changes are
discarded once you go to another page. Most changes require a reboot of the unit (by clicking the Reboot
button) to take effect. However, you may reboot the unit just once after you have made and submitted all the
necessary changes on all the pages.
When the device is operating in router mode, access the built-in web server from the LAN side or
the WAN side. LAN side access is always allowed. For security reasons, the access from the WAN
side can be disabled by configuration. WAN side access to the web server is disabled by default.
You can enable this option on the device web page (from the LAN side).
For more information on using the PDMS-SP interface, refer to the Polycom Device Management Service
for Service Providers Administrator Guide at Polycom Support.
Local Device Update and Management
You can manually update and manage your device.
Firmware Update
You can upgrade the firmware for your device from the device management web page. Store the firmware
file locally on a computer that you can access a web browser.
Procedure
1 Select the System Management – Device Update menu on the side panel of the web page.
2 Click the Browse button in the Firmware Update section of the page. In a file browser window,
select the firmware file.
3 Click the Update button to start the upgrade process.
The process takes about 30 seconds to complete.
Don’t disconnect the power from the device during this procedure. If the new firmware is upgraded
successfully, the device reboots automatically to start running the new firmware. Otherwise, the
web page shows an error message explaining why the upgrade failed.
To perform a multiple device upgrade, refer to the PDMS-SP procedure at
https://documents.polycom.com/bundle/pdms-sp-ag-current/page/t2733076.html
For step 3, use the HDA50 firmware link http://fw.obihai.com/HDA50-x-x-x-xxxx.fw.
Customized AA Prompts Backup and Restore
To restore an Automated Attendant (AA) prompt file, proceed exactly like a firmware upgrade via the web
browser, but provide the device with the prompt file instead of a firmware file.
Polycom, Inc. 10
Configuration and Management Interfaces
Procedure
1 Select the System Management – Device Update menu on the side panel of the web page.
2 Click the Browse button in the Firmware Update section of the page. In a file browser window,
select the prompt file.
3 Click the Update button to start the upgrade process.
All the existing prompts in the device are removed first when applying the backup file. This process
cannot be undone.
Backup Configuration
You can backup and store the current configuration of the device as a file in XML format at a specified
location. The default name of the file is
represents the MAC address of unit.
Procedure
backupxxxxxxxxxxxx.xml
, where the xxxxxxxxxxxxxx
1 In the Web UI, go to System Management > Device Update.
2 Choose backup options. Refer to the table for more information on backup options.
3 Select Backup to start the process.
4 When prompted, save the.xml file.
Different web browsers might handle this differently. If the operation is blocked due to the security
setting of the web browser, you should change the security setting temporarily to allow this
operation to complete.
Backup Options
Option Description Default Setting
Incl. Running Status If checked, the values of all status parameters are included in backup
file. Otherwise, status parameters are excluded from the backup.
Incl. Default Value If checked, the default values of parameters are included in the backup
file. Otherwise, default values are excluded from the backup.
Use OBi Version If not checked, the backup file uses XML tags that are compliant with
TR-104 standard. Otherwise, the backup file is stored in an OBi
proprietary format where the XML tags aren’t compliant with TR-104,
but the file size is smaller and the file is more readable.
No
No
No
Restore Configuration
When restoring the configuration to a previous backup copy, you need to specify the backup file you want
to restore to.
Polycom, Inc. 11
Configuration and Management Interfaces
Procedure
1 Click the Browse button in the Restore Configuration section of the web page.
2 Select the Restore button to start the process.
The device automatically reboots after the restoration is complete.
All passwords and PINs are excluded from the backup file. Hence they aren’t available to restore.
Call history is excluded from the backup, but can be saved as an XML formatted file separately
from the Call History web page.
Reset Configuration Locally
The Reset Configuration function resets the device to its factory default condition. Call history and various
statistical information are removed at the same time. Use the device reset with extreme caution as the
operation cannot be undone.
Procedure
1 Click Reset on the Reset Configuration web page. A confirmation window displays.
2 Click OK to confirm. The phone resets its configuration to its factory default condition.
The device automatically reboots after the factory reset process completes.
By default, the hardware reset button located via an opening on the underside of the device resets all
settings. You can change reset behavior via configuration.
Reset Configuration Options
Option Description Default Setting
Router Configuration When checked, click Reset to restore all your router
configuration parameters to the factory defaults.
All Settings When checked, click Reset to restore all configuration
parameters to the factory defaults.
Yes
Reset Configuration Remotely
You can reset the device configuration to its factory default condition remotely.
Procedure
1 Enter the following parameter into an XML configuration file:
2 In the PDMS-SP interface, use base profiles to push the XML file to the device. You can also go to
Restore Configuration on the local web page.
<ParameterList X_Reset="All">
Polycom, Inc. 12
Device Interface
The HDA50 contains a number of configurable device interface ports. These provide connections for a
headset, LAN, and computer connections.
Headset Connection
Use the USB port on your HDA50 to connect a supported headset.
To configure headset settings, go to Physical Interfaces > USB Port > USB Headset Settings on the
device web portal.
Phone Port Setup and Configuration
A phone has a very basic interface for I/O of signaling or control messages.
The device Phone port supports input signaling and control messages comprising:
● On H
● Of
● Hook
● DTMF ton
e device Phone port supports output signaling and control messages comprising:
Th
● Caller ID/CWCID
● MWI
● DTMF/Ton
● Ring
● Po
● CPC
● Power Denial
Th
e device Phone port has a Maximum Sessions capacity of two. This isn’t configurable. The device Phone
port replies BUSY to a new incoming call when:
● The Phone port already has two calls in session.
● The Phone port is ringing the pho
● Th
● The device is already in a fax ca
Th
e device Phone port supports Call Waiting when a second call is an inbound call:
ook
f H
ook
Flash
es
e
larity Reversa
e phone is in a dialing or fast busy state.
l
ne.
ll.
Polycom, Inc. 13
Device Interface
● Hook-Flash or press the Flash button to switch between calls.
● When the device Phone port goes On-Hook, this ends the current call and invokes a ring for the
holding call. The device Phone port supports 3-way Calling when the second call is an outbound call.
On the first Hook-Flash during an active call, the device can make a second outbound call.
On the second Hook-Flash, the first call and the second outbound call are placed in a conference. To remove
the second conferenced party, invoke a third Hook-Flash.
When the device goes On-Hook during a 3-way Call, this becomes a transfer when the second (outbound)
call is ringing or connected. If the second call doesn’t succeed, then the Phone port goes to an On Hook
state and rings as the holding call is still on the line, or Hook-Flash to resume the first call.
The device Phone port can select from the following services to which it can complete a call:
● SP1 Service (SP1)
● SP2 Service (SP2)
● SP3 Service (SP3)
● SP4 Service (SP4)
Use the Device as a Paging System
The device may be used as a paging system to allow the device to automatically answer incoming calls, but
not accept calls waiting.
Procedure
» Connect the device Phone port to an external PA system using an RJ11-to-line-out-connector, and
enable the UseForPagingOnly parameter.
Available Features
The HDA50 supports many IP routing and LAN features.
IP Routing and LAN Switching Features
The HDA50 has two Ethernet ports labeled as the Internet port and the LAN port. The device works as a
router by default. All the native voice services and features use the WAN port only when the HDA50 is in
router mode. To use the device as a 3-port switch (in Bridge mode) change its OperationMode parameter
from Router to Bridge. One of the switch ports is for internal use only.
IP Routing Features
In router mode, the network connected to the Internet Port is the WAN side of the device, and the network
connected to the LAN Port is the LAN side. You can connect the WAN side to another Ethernet switch or
directory to an access device, such as a modem. The HDA50 routes traffic between the LAN side and the
WAN side, allowing devices (such as PCs) attached to the LAN side to share Internet access. The HDA50
supports subnet masks as large as 255.255.255.0 to accommodate as many as 253 IP addresses on its
LAN side subnet.
Polycom, Inc. 14
Device Interface
In a d d i t i o n to being a NAT (Netwo r k Address Translation) r o u t e r, the HDA50 includes a DHCP server, a DNS
forwarder, and a basic firewall. It supports port forwarding, DMZ, QoS, and VLAN (802.1Q). The maximum
routing throughput between the WAN and the LAN side is approximately 30 Mbps. This speed can be
achieved when there are no active calls in the system. Otherwise, speed is limited to accommodate the
voice processing load. If the WAN side is connected to an Internet access device, the speed could be further
limited by the Internet uplink and downlink.
The HDA50 acquires its WAN side IP address using one of the following methods:
● Static Address Assignment
● DHCP
● PPPoE
The HDA50 acquires its WAN side IP address using DHCP by default. Also by default, the HDA50’s own
DHCP server is enabled to support LAN side clients such as PCs. The default LAN side IP address of the
router is 192.168.10.1.
Incoming packets received from the WAN side are forwarded by the router according to the following flow:
● If the firewall is enabled, discard the packet if it’s rejected by any one of the active firewall
components.
● If the sending host address matches a valid entry in an internal host binding table, queue the packet
for local processing. The router updates the binding table.
● If the sending host address matches a valid entry in an internal NAT binding table, forward the packet
to the corresponding LAN IP address. The router updates the NAT binding table.
● If the receiving port and protocol match a reserved pair to support an internal process, queue the
packet for local processing.
● If the receiving port and protocol match a port forwarding rule, forward the packet to the LAN IP
address according to that rule.
● If a DMZ host is configured, forward the packet to that LAN IP address.
● Queue the packet for internal processing.
DHCP Server
By default, the built-in DHCP server is enabled on the HDA50. It assigns IP address, network mask, DNS
server, and default gateway address to the DHCP clients on the LAN side. The default gateway and DNS
server have the same IP address as the LAN side IP address of the router. In the DHCP server configuration,
you can select the range of client IP addresses to give out the Lease Time and the Local Domain Name.
Furthermore, by using the DHCP reservation feature, you can reserve specific IP addresses for some
devices with specific MAC addresses. See the LAN Settings Parameter Guide and DHCP Reservation
Parameter Guide sections for more details.
Firewall
The firewall protects local processes and LAN side clients against certain basic threats from the WAN side
(or the Internet), such as port scanning and a DOS (Denial of Service) attack. Use the firewall settings to
turn on or off the following features:
●NATRedirection – If enabled, supports NAT Redirection, also known as NAT Loopback or Hairpin.
The default is disabled.
● DRDOSAttackProtection – If enabled, protects against DOS attack. The default is disabled.
Polycom, Inc. 15
Device Interface
● VPNPassThrough – If disabled, blocks all VPN traffic. The default is enabled.
These features take effect if the firewall is enabled. Otherwise, they’ll take on their respective default values.
Port Forwarding
You can define as many as 20 port forwarding rules on the device. For each rule, specify a range of ports
and designate receiving LAN IP address. You can also specify a rule for each that specifies if it should only
apply to packets transported over UDP, TCP, or both.
DMZ
The DMZ host is the default LAN client address that a packet received from the WAN side is forwarded to
when the router fails to find a matching LAN IP address or matching local process. If the firewall is enabled,
the packet is still subject to firewall inspection before forwarding to the DMZ host.
QoS
QoS (Quality of Service) refers to the prioritization of network traffic based on traffic type. On the HDA50,
QoS policy applies to upstream traffic (LAN-to-WAN) only. Downstream QoS is up to the ISP / upstream
routers and switches. The upstream traffic is prioritized according to its type of service as indicated by the
DiffServ/TOS bits in the IP header of each packet. In the QoS settings, you can map the 64 possible types
of service to one of the three priority classes: High, Medium, or Low. You also can specify the guaranteed
minimum upstream bandwidth for each priority class. LAN side clients indicate the desired priority class of
their outbound packets to the router by marking the DiffServ/TOS bits of their packets. See the QoS
Parameter Guide section for more details.
In addition to the three priority classes, a fourth priority class known as the Restricted class is available. The
Restricted class has the highest priority among the four classes. The guaranteed bandwidth for the
Restricted class is set separately with its own parameter in the configuration.
The total guaranteed bandwidth allocated to all the four priority classes is equal to the total available
bandwidth, specified in UpStreamBandwidth parameter in the QoS settings.
VLAN Support in Router Mode
In router mode, the HDA50 can support VLAN (802.1Q) on the WAN side. If you enable VLAN, the incoming
packets on WAN that don’t belong to the same VLAN are dropped. All outgoing packets on WAN are tagged
with the VLAN ID. The VLAN support is transparent to the devices on the LAN side. The router removes the
VLAN tag when forwarding packets to the LAN side.
LAN Switching Features
You can set the HDA50 to act as a 3-port switch. One of the ports is internal, while the two external ports
(labeled as Internet and LAN) connect to other devices. This is the Bridge mode. In this mode, all the router
features, such DHCP server, firewall, and port forwarding, won’t take effect. In this case, the QoS policy
provides native voice traffic the highest priority (this behavior isn’t configurable).
Polycom, Inc. 16
Device Interface
VLAN Support in Bridge Mode
If you enable VLAN in Bridge mode, incoming packets that don’t belong to the same VLAN are dropped. All
outgoing packets are tagged with the configured VLAN ID. The packets switched directly between the
external ports are not modified by the device.
802.1X Authentication
The device supports 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 parameter WAN Settings - Internet
Settings::802_1XMode. Depending on the selected mode, you have to configure the additional
authentication parameters listed in the following table.
802_1X Authentication
Parameter Description
802_1XIdentity A user name. If the value isn’t needed,
set the value as an empty string.
802_1XPassword A password or passphrase. If a
password or passphrase isn’t needed,
set the value as an empty string.
802_1XAnonymousID When empty, anonymous identity is
used in authentication.
802_1XTLSSecurityProfile Security profile for the 802.1x
authentication.
(EAP)
MD5
Required Required Required
Required Required Required
(EAP)
TLS1.0
Required Required
Required
TTLS/
MSCHAPv2
Polycom, Inc. 17
Status Pages
The device web page displays top level device and system statuses for the major features of your device.
System Status
The System Status page is divided into several sections and provides information on the status of the device
and some connected devices.
WAN Status
This shows the status of the WAN (Ethernet) interface, includes assigned IP address, default gateway, and
subnet mask.
Product Information
This shows basic product information, and the system up-time with the last reboot reason code in
parentheses. The following table defines the reboot reason codes.
Reboot Reason Codes
Reason Code Description
0 Reboot on power cycle.
1 Operating system reboot.
2 Reboot after Firmware Update Via provisioning or phone (***6).
3 Reboot after new profile invoked.
4 Reboot after parameter value change or firmware has changed and invoked via device web page.
5 Reboot after factory reset using the device hardware PIN.
6 New profile invoked and profile URL changed.
7 Reboot from SIP Notify (Reserved).
8 Reboot from telephone port (IVR).
9 Reboot from web page — no change in parameter values or firmware.
10 Reboot during OBiTALK signup.
11 Reboot during OBiTALK signup.
Polycom, Inc. 18
Status Pages
Reboot Reason Codes
Reason Code Description
12 Reboot after DHCP server offers IP, GW-IP, and/or netmask different from what the device is
currently using.
13 Reboot on data networking link re-establishment.
15 Reboot from firmware update via provisioning.
16 Reboot for DHCP renewal.
18 Reboot on WAN IP address change.
19 Reboot on LAN IP address change.
23 Reboot via OBiPhone XML app.
29 Reboot from LLDP-MED change.
USB Headset Status
This shows the device name and device status of the connected USB headset.
SPn Service Status (n = 1, 2, 3, 4)
The SPn service status values indicate the current state of the service with regard to its configuration (or
not) and if configured its registration status. If there are problems with the registration or authentication of
the device with a prescribed service, the SIP 4xx error message displays here.
OBiTALK Service Status
The status of the OBiTALK Service includes the following values:
● Status can be one of the following values:
Normal (User Mode): The service is functioning normally.
Backing Off: The service is currently down, and the device is taking a short pause before retrying
the connection.
● CallState can be one of the following values:
N Active Calls, where N = 0, 1,..., as many as the maximum number of calls allowed in the
configuration.
LAN Status
This page is available when the HDA50 is in router mode, and shows the status of devices currently on the
LAN. There are two sections:
Polycom, Inc. 19
Status Pages
● Attached Devices: All the devices that the router has discovered on the LAN side. Each entry has a
MAC address and an IP address.
● DHCP Clients: All the DHCP clients that have an active lease with the DHCP server. Each entry has
a Client Name, a MAC address, an IP address, and the lease expiration time (in seconds).
Call Status
This shows the status of a number of running call statistics and state parameters for each active call. For
each entry on the call status page, the following buttons may be available:
●Remove: This button is available for all calls. Pressing this button ends that call.
●Record: This button is available for calls involving the Phone port only. Pressing this button allows
you to record the current conversation in an audio (.au) file.
Call History
The Call History page shows the last 400 calls made with the device. Detailed call information is available,
including terminals involved, the name (if available) of the Peer endpoints making the call, and the direction
/ path the call took.
The Call History page also captures what time various events took place.
Save the call history by clicking on the Save All button. The Call History can be saved as an XML formatted
file called callhistory.xml.
Services, Phone, and Line Status
Find statistics relevant to SPn on the SPn Stats page (where n = 1, 2, 3, 4).
See the Parameter Reference Guide for information on the parameters displayed on these pages.
Polycom, Inc. 20
Device Settings
Device settings enable you to configure and customize your device’s codec, ring profiles, and tones.
Codec Profile Features
There are two codec profiles available on the devices. They are selectable per trunk
(SP1/SP2/SP3/SP4/OBiTALK). 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 this profile. Each of the SP1, SP2, SP3, SP4, and
OBiTALK services can be assigned 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 more information on codec profile parameters, see the Codec Profile Parameter Guide table in the
Parameter Reference Guide section.
Tone and Ring Patterns
Your device enables you to create customized tone patterns and ringtones.
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.
T one Profile Features
The general format for tone profiles is: [field-1];[field-2];[field-3];...;[field - 6]
Use a semicolon to separate the configuration fields.
No spaces are allowed in the tone profile pattern.
Field-1 Composition
This field describes frequency components used for tone synthesis and it supports as many as three
different frequencies.
Polycom, Inc. 21
Device Settings
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
This example means:
● The first frequency at 350 Hz with strength at
● The second frequency at 440 Hz with strength at
● The third frequency at 550 Hz with strength at +2 dBm
–18,440–18,550+2
–18 dBm
–18 dBm
Field-2 Composition
This field describes the overall tone playback duration in seconds.
The expression is a numeric value, and supports as many as 3 decimated digits. The numeric value can
negative, zero, positive, or skipped:
● Negative value: tone plays indefinitely
● Zero value: tone playback is skipped
● Positive value: Normal playback duration
● No value: tone plays indefinitely
Example: 30.234
This example means:
● Tone playback terminates after 30.234 seconds
Field-3 to Field-6 Composition
Field - 3/4/5/6 share the same definition, and each field describes one single cadence segment. Together,
the four fields form a macro-segment, which is repeated until tone playback expires.
The expression is a string of numeric values with the special notation '/', '(', ')' and ','.
Its format is: t(f_0/on_0+off_0,f_1/on_1+off_1,f_2/on_2+off_2,f_3/on_3+off_3)
● t: the cadence segment duration in seconds
Negative value: tone plays indefinitely
No value: tone plays indefinitely
Zero value: the duration of this particular segment is zero
Positive value: Normal playback duration
● f_0/1/2/3: a digit to describe which frequency component(s) are used for the synthesis, and can
be one of following 8 options (0 through 7)
0: No frequency specified (silent tone)
1: The first frequency
2: The second frequency
3: The first and second frequencies
4: The third frequency
Polycom, Inc. 22
Device Settings
5: The first and third frequencies
6: The second and third frequencies
7: The first and second frequencies if two or more than two frequency components, or the first
frequency if only one frequency component is available.
If no value is provided for f_0/1/2/3, it automatically uses the combination of the first one or two
available frequency components.
● on_0/1/2/3: the tone active time in seconds
Negative value: Not allowed
No value: infinite tone active time
Others: normal tone active time (as many as 3 decimated digits)
● off_0/1/2/3: the tone inactive time in seconds
Negative value: Not allowed
No value: infinite tone inactive time
Others: normal tone inactive time (as many as 3 decimated digits)
Example: 4(1/.3+2.34,3/2+1.5)
This example means:
● Use the first frequency to generate a tone for 0.3 seconds
● Follow this tone with 2.34 seconds of silence
● Use a combination of the first and second frequencies to generate a tone for 2 seconds
● Follow this tone with 1.5 seconds of silence
● The cadence operates repeatedly for 4 seconds.
Tone Examples
These examples show the interpretation of a few common tone patterns:
Dial Tone
DIAL, "350-18,440-18"
Dial tone is generated as a mixture of two frequency components:
350 Hz at –18 dBm and 440 Hz at –18 dBm
The expiration time is infinite, and tone active time is infinite.
Busy Tone
BUSY, "480-18,620-18;10;(.5+.5)"
Busy tone is generated as a mixture of two frequency components:
480 Hz at –18 dBm and 620 Hz at –18 dBm
The expiration time is exactly 10 seconds. It has only one cadence segment, which has tone active 0.5
second and tone inactive 0.5 second.
Polycom, Inc. 23
Device Settings
Prompt Tone
PROMPT, "480-16;10"
Prompt tone is generated from a single frequency component:
480 Hz at
tone infinite active time.
–16 dBm. The expiration time is exactly 10 seconds. It has only one cadence segment, which has
SIT Tone
SIT_1, "985-16,1428-16,1777-16;20;(1/.380+0,2/.380+0,4/.380+0,0/0+4)"
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 4 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.
● 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.
–16 dBm
–16 dBm
–16 dBm
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 sections, 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 A & B Parameter Guide table
in the Parameter Reference Guide 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 Profile A & B
The HDA50 provides two ring profiles that control associated call tones. You can customize each profile
separately.
Polycom, Inc. 24
Device Settings
Ring Profile Features
The general format of a ring profile is: [field-1];[field-2];...;[field - 5]
Use a semicolon to separate as many as five configuration fields.
No spaces are allowed in the tone profile pattern.
Field-1 Composition
Field-1 describes the overall ringing duration in seconds.
The expression is a numeric value, and supports as many as 3 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 terminates after 30.5 seconds.
Field-2 to Field-5 Composition
Fields-2/3/4/5 share the same definition, and each field describes one single cadence segment. Together,
the four fields form a macro-segment, which is repeated until ringing expires.
The expression is a string of numeric values with the special notation '(' , ')' and ','
It has the format as per the following construct:
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
● 1No value: Infinite ring active time
● Others: Normal ring active time (as many as 3 decimated digits)
off_0/1/2/3: The ring inactive time in seconds
● Negative value: Not allowed
Polycom, Inc. 25
Device Settings
● No value: Infinite ring inactive time
● Others: Normal ring inactive time (as many as 3 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.
For more information on call waiting parameters, see the Call Waiting Parameter Guide table in the
Parameter Reference Guide section.
For more information on ring profile parameters, see the Ring Profile Parameter Guide table in the
Parameter Reference Guide section.
Polycom, Inc. 26
Call Routing
Call Routing is the process by which the device sets up a call bridge or an endpoint call based on such
information as the trunk on which the call originates, the caller’s number, the called number, etc. Call Routing
Rules are parameters used to instruct the device how to route calls. A call can transform into a call bridge
or an endpoint call after being routed by the device according to the given routing rules.
Every call has to be originated from somewhere. From the device’s perspective, calls originated from the
trunk side are considered Inbound Calls, while calls originated from an endpoint Outbound Calls. The call
routing rule syntaxes for inbound calls and outbound calls are slightly different, and are explained in the
following section.
Inbound Call Route Configuration
Every trunk has a corresponding InboundCallRoute in the device configuration. It is a comma-separated
list of rules where each rule is also surrounded by a pair of curly braces {}. No extra white spaces are
allowed. These rules tell the device how to handle an inbound call, such as sending it to the Phone port (and
ringing the attached phone(s)), sending it to the Auto Attendant for further routing (interactively with the
caller), or making another call on a specific trunk to bridge with this call.
The general format is:
InboundCallRoute := rule OR {rule},{rule},….
Curly braces can be omitted if there is only one rule in the route. The OR operator is not part of the parameter
syntax; it is used here to separate alternative values only.
A rule has the following format:
rule := peering-list : terminal-list
The following table shows the rule formats.
Rule Formats
Rule Format Notes
peering-list : peering,peering,… Comma-separated list of 0 or more peering
objects
terminal-list : terminal,terminal,…. Comma-separated list of 0 or more
terminal objects
peering : caller-list > callee-list
caller-list : caller|caller|caller|… Vertical bar-separated list of 0 or more
caller objects
Polycom, Inc. 27
Call Routing
Rule Formats
Rule Format Notes
callee-list : callee|callee|callee| … Vertical bar-separated list of 0 or more
callee objects
caller : number OR embedded-digit-map OR ?
OR @
callee : number OR embedded-digit-map OR @
terminal : PHx OR AAx OR LIx(arg) OR SPx(arg)
OR PPx(arg)
arg : cid > target
x : 1 OR 2 OR 3… Where applicable; can be omitted if x = 1
cid : spoofed-caller-number OR $1
target : number-to-call OR $2
embedded-digitmap :
(Mlabel) OR digit-map
? = anonymous, @ = any number but
anonymous
arg object is optional
Notes:
● Terminal-list can be empty, which means to block this call. The preceding ‘:’ can’t be omitted.
As many as four terminals can be specified in the list. The listed terminals are called/rung by the
device simultaneously. This operation is known as forking the call. A terminal can be a trunk or an
endpoint.
● Abbreviated terminal names are case-insensitive.
● Number and number-to-call are literal strings, such as 14089991234.
● Digit-map is just any proper digit map, such as (1xxx|xx.); make sure to include the enclosing
parentheses.
● Spoofed-caller-number is a literal string, such as 14081112233, to be used as the caller
number for making a new call on the specified trunk.
● (Mlabel) is a named digit map, where label is the abbreviated name of any terminal that has a digit
map defined: SP1, SP2, SP3, SP4, LI1, PP, PH, PH2, HS, or AA.
● $1 is an internal variable containing the value of the caller number of this inbound call, after any digit
map transformation in the matched caller object of the matched peering object in the peering-list.
● $2 is an internal variable containing the called number of this inbound call, after any digit map
transformation in the matched callee object of the matched peering object in the peering-list.
More notes on peering-list and peering objects:
● Peering-list is optional in InboundCallRoute. If the peering-list is empty, the succeeding ‘:’ can
be omitted also. An empty peering-list implies a single peering object whose caller object list matches
any caller number. That is, the following InboundCallRoutes are all equivalent:
ph
{ph}
{:ph}
Polycom, Inc. 28
Loading...