proprietary and confidential and is considered the copyrighted work of Grandstream
Networks, Inc.
Trademarks
BroadWorks® and BroadWorks Assistant–Enterp rise™, BroadWor ks Call Center™,
BroadWorks Communicator™, BroadWorks Receptionist™, and BroadWorks
Deployment Studio™ are trademarks of BroadSoft, Inc.
Microsoft, MSN, Windows, and the Windows logo are registered trademarks of Microsoft
Corporation. Other product names mentio ned in this docume nt may be trademarks o r
registered trademarks of their respective compa nies and are hereby a cknowledged.
This document is printed in the United States of Ame rica.
This document describes the configuration procedures requi red for the Grandst ream
GXV/GXP/BT phones to be interoperable with BroadWorks. This includes the following
Grandstream phone models:
The GXV/GXP/BT phones use the Session Initiation Protocol (SIP) to communicate with
BroadWorks for call control.
This guide describes the specifi c configur ation items tha t are import ant for use wit h
BroadWorks. It does not describe the pur pose and u se of all configura tion items on t he
GXV/GXP/BT. For those details, see the GXV/GXP/BT User Manual supplied by
Grandstream [1].
This section provides the known interoperability status of the Grandstream GXV/GXP/BT
with BroadWorks. This includes the version(s) tested, capabilities supported and known
issues.
Interoperability testing validates that the device interfaces properly with BroadWorks via
the SIP interface. Qualitative aspects of the device or device capabilities not affecting the
SIP interface such as display features, performance, and audio qualities are not covered
by interoperability testing. Requests for information and/or issues regarding these aspects
should be directed to Grandstream.
2.1 Verified Versions
The following table identifies the verified Grandstream GXV/GXP/BT and BroadWorks
versions and the month/year the testing occurre d. If the device has un dergone more than
one test cycle, versions for each test cy cle are listed, with the most recent list ed first.
Compatible Versions in the following table identify specific Grandstream versions which
the partner has identified as compatible and should interface properly with BroadWorks.
Generally, maintenance releases of the validated version are con sidered compatible and
may not be specifically listed here. Contact Grandstream for any questions concerning
maintenance and compatible releases.
NOTE: Interoperability testing is normally performed with the latest generally available (GA)
device firmware/software and the latest GA BroadWorks release and service pack at the time the
testing occurs. If there is a need to use a non-verified mix of BroadWorks and device software
versions, customers can mitigate their risk by self-testing the combination using the BroadWorks
The Grandstream GXV/GXP/BT has completed interoperability testing with BroadWorks
using the BroadWorks SIP Access Device Interoperability Test Plan [5]. The re sults are
summarized in the following table.
The BroadWorks test plan is composed of packages, each covering distinct
interoperability areas, such as “Basic” call scenarios and “Redundancy” scenarios. Each
package is composed of one or more t est items which i n turn are comp osed of one or
more test cases. The test plan exercises the SIP interface between the device and
BroadWorks with the intent to ensure interoperability sufficient to support the BroadWorks
feature set.
The Supported column in the following table identifies the Grandstream GXV/GXP/BT‘s
support for each of the items covered in the test pla n packages, with the followi ng
designations:
Yes Test item is supported.
No Test item is not supported.
NA Test item is not applicable to the device type.
NT Test item was not tested.
Caveats or clarifications are identified in the Com ments column.
Note that DUT in the following table refers to the Device Under T est which in this case is
the Grandstream phone.
BroadWorks SIP Access Device Interoperability Test Plan Support Table
Test Plan Package Test Plan Package Items Supported Comments
Basic Call Origination Yes
BroadWorks SIP Access Device Interoperability Test Plan Support Table
Test Plan Package Test Plan Package Items Supported Comments
SBC/ALG Register Yes
Outgoing Invite Yes
Incoming Invite Yes
Video – Basic Video
Call Origination No GXV models only.
Calls
Call Termination No GXV models only.
Call Hold No GXV models only.
Call Waiting No GXV models only.
Call Transfer No GXV models only.
This section lists the known interoperability issues between BroadWorks and specifi c
partner release(s). Issues identified during interoperability testing and known issues
identified in the field are listed.
The following table provides a description of each issu e and, where possib le, identifies a
workaround. The verified partner device version s are listed with an “X” in dicating that the
issue occurs in the specific release. The issues identifi ed are device de ficiencies or bugs,
so typically not BroadWorks release dependent.
The Issue Number is a BroadSoft ExtraView partner i ssue number if the testing was
performed by BroadSoft. If the testing was performed by the partner or a third party, the
partner may or may not supply a tracking numbe r.
For more information on any issues related to the p articular pa rtner device releas e, see
the partner release notes.
Issue Number Issue Title and Description Partner Releases
All BroadWorks Releases
GXV-3000 1.0.0.41,
GXP-2000 / BT-200 1.1.2.14,
GXP-2020 1.1.3.5
GXP 1.1.6.46,
BT 1.1.6.46
GXV-3140 v1.0.2.18
Click-to-Answer fails.
The Grandstream phone fails to auto answer
after receiving INVITE with alert-info:
answer-after = 0 for click-to-answer
scenarios.
Workaround: None. Issue is fixed in
releases after 1.1.6.46.
This section identifies the required BroadWorks d evice profile for the Gran dstream
GXV/GXP/BT as well as any other unique BroadWorks configuration required for
interoperability with the Grandstream models listed previously.
3.1 BroadWorks Device Profile Configuration
This section identifies the device profile to use whe n deploying the Gr andstream
GXV/GXP/BT with BroadWorks.
The following table identifies the required Bro adWorks device i dentity/profile setting s for
interoperability between the GXV/GXP/BT and BroadWorks. For an explanation of the
profile parameters, refer to the BroadWorks Device Management Confi guration Guide [3].
For most of the following parameters, an “X” indicates the parameter function is supported
and/or required. If the item is blank, it is not supported. For items where text is su pplied,
the text content maps directly to the web page for adding or m odifying a devi ce profile.
Grandstream Identity/Device Profile
Signaling Address Type Intelligent Proxy Addressing
Standard Options
Number of Ports GXV-3140/GXV-3000/GXV-3005/GXV-3006: 3 lines
GXP-2000/GXP-2010: 4 lines
GXP-2020: 6 lines
GXP-1200: 2 lines
GXP-280: 1 line
BT-200/BT-201: 1 line
Ringback Tone/Early Media
Support
Local Ringback – No Early Media
Authentication Enabled
Registration Capable X
Static Registration Capable
E.164 Capable
Trusted
Authenticate REFER X
RFC 3264 Hold X
Video Capable X (GXV models only.)
Use History-Info Header X
Grandstream GXV/GXP/BT can be configured via web GUI as well as via the
Configuration File through TFTP or HTTP.
The GXV/GXP/BT accepts configuration files in a proprietary binary format, which is
produced by the Grandstream configuration tool. The co nfiguration tool creat es a device
configuration file based on a configuration te mplate and the device’s MAC address. All
Grandstream products sample configuration templ ates are available o n the Grandstream
web site. A configuration template file contains all t he configuration pa rameters availabl e
for a product, with comments describing allowed v alues of the param eters. For a det ailed
parameter list, refer to the corre sponding firmware release confi guration template [2] .
When the Grandstream device boots up or reb oots, it issues a request for a bin ary
configuration file named “cfgxxxxxxxxxxxx”, where “xxxxxxxxxxxx” is the MAC address of
the device, for example “cfg000b820102ab”. The configuration file na me should be in
lower case.
Grandstream offers free Configuration File Generat or software for bot h Linux/Unix and
Windows platforms. These Configuratio n File Gene rators can be downloade d from the
Grandstream web site at http://www.grandstream.com/support/configurationtool.html
The following examples describe how to set the pa rameters using a configuration file. The
GXV/GXP/BT should be configured to load the configuration file each time it resets or resynchronizes. For detailed information on automated provisioning, see the GXV/GXP /BT User Manual [1] and the Grandstream Configuration Tool Use r Guide[2].
[2].
The capabilities of the GXV/GXP/BT have been verified for use with BroadWorks based
on the settings described in the following table. For mo re information on the meaning,
purpose, and applicability of the individual configuration items see the GXV/GXP/BT
This section describes system-wide configuration requirements for each GXV/GXP/BT to
work with BroadWorks. Subscriber-specific settings are described in the next section.
Step Command Purpose
System Configuration Items
Step 1
Step 2
Step 3
Set SIP Proxy/Domain.
SIP Server = as.broadworks.net
Set Outbound Proxy.
Outbound Proxy =
alg.broadworks.net
Enable DNS SRV lookup.
Use DNS SRV = “Yes”
Set the GXV-3140/GXV3000/GXV-3005/GXV3006/GXP-2000/GXP2010/GXP-2020/GXP1200/GXP-280/BT-200/BT-201
SIP server to the Fully Qualified
Domain Name (FQDN) for the
BroadWorks Application Server
cluster.
The domain must match the
domain configured for the
BroadWorks subscriber’s
line/port domain.
Set the Outbound Proxy to the
Session Border Controller (SBC)
if one is deployed between the
GXV-3140/GXV-3000/GXV3005/GXV-3006/GXP2000/GXP-2010/GXP2020/GXP-1200/GXP-280/BT200/BT-201 and BroadWorks.
If there are redundant SBCs, set
it to the FQDN for the SBC
cluster.
Specify the video codec order of
preference for the GXV-3140
video phone.
Set a payload type for the video
codec assigned to the GXV-3140
video phone.
H.264 – Set a value between 96
and 127. The default value is 99.
H.263 – Set a value between 96
and 127. The default value is
103.
4.1.1 Video Codec Support/Recommendation for the GXV-3140
The following table lists the video intero perability test result s between the GXV-3140 and
existing BroadWorks validated video endpoint s. In addition, the tabl e also inclu des results
from interoperability testing between the GXV-3140 a nd BroadWorks video services.
Each video interoperability test was either done using only video codec H.26 4 or H.263.
Video Device/Service H.264 H.263
Tandberg MXP vF7.2 OK OK
Tandberg E20 v2.0.1.193887 OK OK
CounterPath Bria for BroadWorks
This section identifies the device-spe cific parameters, including registration a nd
authentication. These settings must be unique across device s to be matched with th e
settings for a BroadWorks subscriber.
Provisioning a subscriber to register with B roadWorks all ows calls to termi nate to the
subscriber’s line. Registration requires that a unique a ddress of record (AoR) i s
provisioned on BroadWorks and the phone; provisioning an Ao R on BroadWorks consi sts
of setting the line/port parameter to a unique value withi n the Applicatio n Server clu ster.
Grandstream GXV/GXP/BT supports 3/3/3/4/4/6/2/1/1/1 SIP accounts respectively. The
following example shows how to configur e subscriber el ements for an accou nt.
Enhanced IP Phone Configuration is a BroadWorks feature that enables autom atic
generation of device configuration files, given administrat or-supplied te mplates.
For more information on the Enhanced IP Phone Configuration feat ure, see the Device
Management Configuration Guide [3].
NOTE: BroadSoft does not manage or distribute template files for use with the Enhanced IP
Phone Configuration feature. Obtain template files from Grandstream or use the configuration
files obtained from Grandstream for the specific GXV/GXP/BT firmware release to create
template files appropriate for your installation.
Since the GXV/GXP/BT SIP phones require the configuration files be converted into a binary
format, an extra step must be performed when using this feature. After the configuration files
have been sent to the TFTP server and before the phone is reset, the configuration files must be
converted to binary format using Grandstream’s configuration tool. For detailed information on
automated provisioning, check the Grandstream Configuration Tool and Templates [2].
The GXV/GXP/BT uses only a phone-specific file to configure the device. However, the
Enhanced IP Phone Configuration feature requires a sy stem and a pho ne-specific file for
each device. To satisfy the system file requirement, an e mpty file (gxpDefault.txt, gxvDefault.txt, btDesfult.txt) will need to be uploaded to BroadWorks as the system file.
This file will be sent to the FTP server but will not actually be used for the configuration file
generation. The group template file is used to build the config uration files for th e devices
of this device type assigned to the group. For a sample GXV/GXP/BT group template file
see Appendix A: Sample GXV/GXP/BT Configuration File.
NOTE: The following samples are examples and should be used as a reference only. DO NOT CUT
AND PASTE THESE EXAMPLES TO GENERATE YOUR CONFIGURATION FILES. Use the
configuration files obtained from Grandstream with the specific release to generate your configuration
files.
System Default Parameters:
NOTE: This is an example file and should be used for reference only.