The Akuvox SIP-Based Devices is a collection of end points include desktop phone, intercom and doorbell that use the Session Initiation Protocol (SIP) to ...
BroadSoft Partner Configuration Guide
Akuvox SIP Based Devices
October 2017 Document Version 2.1
9737 Washingtonian Boulevard, Suite 350 Gaithersburg, MD USA 20878 Tel +1 301.977.9440 WWW.BROADSOFT.COM
BroadWorks® Guide
Copyright Notice
Copyright© 2017 BroadSoft, Inc. All rights reserved. Any technical documentation that is made available by BroadSoft, Inc. is proprietary and confidential and is considered the copyrighted work of BroadSoft, Inc. This publication is for distribution under BroadSoft non-disclosure agreement only. No part of this publication may be duplicated without the express written permission of BroadSoft, Inc., 9737 Washingtonian Boulevard, Suite 350, Gaithersburg, MD 20878. BroadSoft reserves the right to make changes without prior notice. Trademarks Any product names mentioned in this document may be trademarks or registered trademarks of BroadSoft or their respective companies and are hereby acknowledged. This document is printed in the United States of America.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 2 OF 70
Document Revision History
Version 1.1
1.2 1.3 1.4 1.5 1.6 1.7 2.0
2.1
Reason for Change Introduced document for Akuvox SP-R5x version 53.0.1.0 validation with BroadWorks Release 19.sp1. Edited and published document. Minor appendix update to reflect the most current template file. Edited changes and published document. Made minor editorial changes and published document. Removed references to SCA. Edited changes and published document. Document renamed and updated with Akuvox SIP Based Devices version x.0.1.64 validation with BroadWorks Release 22.0. Edited changes and published document.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 3 OF 70
Table of Contents
Table of Figures ....................................................................................................................................6
1 Overview..........................................................................................................................................7
2 Interoperability Status ..................................................................................................................8
2.1 Verified Versions...........................................................................................................................8 2.2 Interface Capabilities Supported..................................................................................................8
2.2.1 SIP Interface Capabilities ....................................................................................................9 2.2.2 Other Interface Capabilities.............................................................................................. 14 2.3 Known Issues ............................................................................................................................ 16 3 BroadWorks Configuration....................................................................................................... 17
3.1 BroadWorks Device Profile Type Configuration ...................................................................... 17 3.2 BroadWorks Configuration Steps ............................................................................................. 18 4 SIP-Based Devices Configuration ........................................................................................... 19
4.1 Configuration Method ................................................................................................................ 19 4.2 System Level Configuration ...................................................................................................... 19
4.2.1 Configure Network Settings ............................................................................................. 19 4.2.3 Configure Service Settings............................................................................................... 21 4.3 Subscriber Level Configuration................................................................................................. 22 4.4 SIP Advanced Feature Configuration....................................................................................... 23 4.4.1 Shared Call Appearance Configuration........................................................................... 23 4.4.2 Busy Lamp Field Configuration........................................................................................ 23 4.4.3 Feature Key Synchronization Configuration ................................................................... 23 4.4.4 Call Center Feature Configuration ................................................................................... 23 4.4.5 Call Recording Feature Configuration ............................................................................. 24 4.4.6 Security Classification Feature Configuration ................................................................. 24 4.4.7 Emergency Call Configuration ......................................................................................... 24 4.4.8 Advice of Charge Configuration ....................................................................................... 24 4.4.9 Conference Event Configuration ..................................................................................... 25 4.5 Xtended Services Interface (Xsi) Feature Configuration ......................................................... 25 4.6 Instant Message and Presence Configuration......................................................................... 25 5 Device Management................................................................................................................... 26
5.1 Device Management Capabilities Supported .......................................................................... 26 5.2 Device Management Configuration .......................................................................................... 28
5.2.1 Configure BroadWorks Tags ........................................................................................... 28 5.2.2 Configure BroadWorks Device Profile Type ................................................................... 31 5.2.3 Create Device Profile Instance ........................................................................................ 38 5.2.4 Configure BroadWorks User............................................................................................ 39 5.2.5 Customize Tags................................................................................................................ 39 5.2.6 Configure Akuvox SIP-Based Devices............................................................................ 40 Appendix A: Reference Akuvox SIP-Based Devices Configuration Files.............................. 42
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES
20-BD5426-00
©2017 BROADSOFT INC.
PAGE 4 OF 70
References .......................................................................................................................................... 70
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 5 OF 70
Table of Figures
Figure 1 Device Identity/Profile Type....................................................................................................... 18 Figure 2 FKS Configuration ..................................................................................................................... 23 Figure 3 Config File Import....................................................................................................................... 24 Figure 4 Advice of Charge Config............................................................................................................ 25 Figure 5 System Default Tag Settings..................................................................................................... 29 Figure 6 Device Type-specific Tag Settings ........................................................................................... 31 Figure 7 Device Access FQDN................................................................................................................ 32 Figure 8 %BWMACADDRESS%.cfg File Settings................................................................................. 35 Figure 9 r0000000000<Part Number>.cfg File Settings......................................................................... 36 Figure 10 Ring.wav File Settings ............................................................................................................. 37 Figure 11 BroadWorks User Language Definition.................................................................................. 38 Figure 12 Device Profile Instance ............................................................................................................ 39 Figure 13 Example Login Screen ............................................................................................................ 41
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 6 OF 70
1 Overview
This guide describes the configuration procedures required for the Akuvox SIP-Based Devices for interoperability with BroadWorks. This includes the following device models: Akuvox E21 Akuvox R23 Akuvox R26 Akuvox R27 Akuvox R29 Akuvox VP-R47P Akuvox VP-R47G Akuvox VP-R48G Akuvox VP-R49P Akuvox SP-R50P Akuvox SP-R52P Akuvox SP-R53P Akuvox SP-R55P Akuvox SP-R55G Akuvox SP-R59P Akuvox SP-R59G Akuvox SP-R63G Akuvox SP-R67G Akuvox IT80 Akuvox IT81 Akuvox IT82 The Akuvox SIP-Based Devices is a collection of end points include desktop phone, intercom and doorbell that use the Session Initiation Protocol (SIP) to communicate with BroadWorks for call control. This guide describes the specific configuration items that are important for use with BroadWorks. It does not describe the purpose and use of all configuration items on the SIP-Based Devices. For those details, see the Akuvox SIP-based Devices Administrator Guide [1] supplied by Akuvox.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 7 OF 70
2 Interoperability Status
This section provides the known interoperability status of the Akuvox SIP-Based Devices with BroadWorks. This includes the version(s) tested, the 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 Akuvox.
2.1 Verified Versions
The following table identifies the verified Akuvox SIP-Based Devices and BroadWorks versions and the month/year the testing occurred. If the device has undergone more than one test cycle, versions for each test cycle are listed, with the most recent listed first.
Compatible Versions in the following table identify specific Akuvox versions that the partner has identified as compatible so should interface properly with BroadWorks. Generally, maintenance releases of the validated version are considered compatible and may not be specifically listed here. For any questions concerning maintenance and compatible releases, contact Akuvox.
NOTE: Interoperability testing is usually 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 themselves using the BroadWorks SIP Phone Interoperability Test Plan [5].
Verified Versions Date (mm/yyyy)
09/2017
BroadWorks Release Release 22.0
SIP-Based Devices Verified Version
x.0.1.64
SIP-Based Devices Compatible Versions
List any specific compatible versions.
2.2 Interface Capabilities Supported
This section identifies interface capabilities that have been verified through testing as supported by Akuvox SIP-Based Devices.
The Supported column in the tables in this section identifies the Akuvox SIP-Based Devices' support for each of the items covered in the test plan, with the following designations:
Yes Test item is supported
No Test item is not supported
NA Test item is not applicable to the device type
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 8 OF 70
NT Test item was not tested Caveats and clarifications are identified in the Comments column.
2.2.1
SIP Interface Capabilities
The Akuvox SIP-Based Devices have completed interoperability testing with BroadWorks using the BroadWorks SIP Phone Interoperability Test Plan [5]. The results 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 test items, which in turn are composed 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.
NOTE: DUT in the following table refers to the Device Under Test, which in this case are the Akuvox SIP-Based Devices.
BroadWorks SIP Phone Interoperability Test Plan Support Table
Test Plan Package
Test Plan Package Items
Supported
Basic
Call Origination
Yes
Call Termination
Yes
Session Audit
Yes
Session Timer
Yes
Ringback
Yes
Forked Dialog
Yes
181 Call Being Forwarded
Yes
Dial Plan
Yes
DTMF Inband
Yes
DTMF RFC 2833
Yes
DTMF DTMF Relay
Yes
Codec Negotiation
Yes
Codec Renegotiation
Yes
BroadWorks Services Third-Party Call Control Basic
NA
Third-Party Call Control Advanced
Yes
Voice Message Deposit/Retrieval
Yes
Message Waiting Indicator Unsolicited
Yes
Message Waiting Indicator Solicited Yes
Message Waiting Indicator Detail
Yes
Comments
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 9 OF 70
BroadWorks SIP Phone Interoperability Test Plan Support Table
Test Plan Package
Test Plan Package Items
Supported
Voice Portal Outcall
Yes
Advanced Alerting Ringing
Yes
Advanced Alerting Call Waiting
Yes
Advanced Alerting Ring Splash
Yes
Advanced Alerting Silent Alerting
Yes
Calling Line ID
Yes
Calling Line ID with Unicode Characters
Yes
Connected Line ID
Yes
Connected Line ID with Unicode Characters
Yes
Connected Line ID on UPDATE
Yes
Connected Line ID on Re-INVITE
Yes
Diversion Header
Yes
History-Info Header
Yes
Advice of Charge
Yes
Meet-Me Conferencing
Yes
Meet-Me Conferencing G722
Yes
Meet-Me Conferencing AMR-WB
No
Meet-Me Conferencing Opus
No
Collaborate Audio
Yes
Collaborate Audio G722
Yes
Collaborate Audio Opus
No
Call Decline Policy
Yes
DUT Services
Call Waiting
Yes
Call Control Services
Call Hold
Yes
Call Transfer
Yes
Three-Way Calling
Yes
Network-Based Conference
Yes
DUT Services
Register Authentication
Yes
Registration and
Authentication
Maximum Registration
Yes
Minimum Registration
Yes
Invite Authentication
Yes
Re-Invite/Update Authentication
Yes
Comments Before answer is not supported.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 10 OF 70
BroadWorks SIP Phone Interoperability Test Plan Support Table
Test Plan Package
Test Plan Package Items
Supported
Refer Authentication
Yes
Device Authenticating BroadWorks
No
DUT Services
Emergency Call
No
Emergency Call
Emergency Call with Ringback
No
DUT Services PAccess-Network-Info
REGISTER with P-Access-NetworkInfo Header
No
Header
INVITE with P-Access-Network-Info Header
No
DUT Services
Do Not Disturb
Yes
Miscellaneous
Call Forwarding Always
Yes
Call Forwarding Always Diversion Inhibitor
Yes
Anonymous Call
Yes
Anonymous Call Block
Yes
Remote Restart Via Notify
Yes
Advanced Phone
Busy Lamp Field
Yes
Services Busy
Lamp Field
Call Park Notification
Yes
Advanced Phone
Do Not Disturb
Yes
Services Feature
Key Synchronization, Do Not Disturb Ring Splash
Yes
Private Line
Call Forwarding
Yes
Call Forwarding Always Ring Splash Yes
Call Forwarding Always Diversion Inhibitor
Yes
Call Center Agent Logon/Logoff
Yes
Call Center Agent Unavailable Code No
Executive Call Filtering
No
Executive-Assistant Call Filtering
No
Executive-Assistant Diversion
No
Call Recording
No
Security Classification
No
Advanced Phone
Do Not Disturb
No
Services Feature
Key Synchronization, Do Not Disturb Ring Splash
No
Shared Line
Call Forwarding
No
Call Forwarding Always Ring Splash No
Comments
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 11 OF 70
BroadWorks SIP Phone Interoperability Test Plan Support Table
Test Plan Package
Test Plan Package Items
Supported
Call Forwarding Always Diversion Inhibitor
No
Security Classification
No
Advanced Phone
Services Missed Calls Display
Missed Calls Display Sync
No
Synchronization
Advanced Phone
Line-Seize
No
Services Shared
Call Appearance
Call-Info/Lamp Management
No
using Call Info
Public Hold
No
Private Hold
No
Hybrid Key System
No
Multiple Call Arrangement
No
Bridge Active Line
No
Bridge Active Line Silent Monitor
No
Call Park Notification
No
Advanced Phone
Services Call Park
Call Park Notification
No
Notification
Advanced Phone
Hold Reminder
Yes
Services Call Center
Call Information
No
Hoteling Event
Yes
Status Event
No
Disposition Code
No
Emergency Escalation
No
Customer Originated Trace
No
Advanced Phone
Pause/Resume
No
Services Call
Recording Controls
Start/Stop
No
Record Local Conference
No
Record Network Conference
No
Advanced Phone
Basic Call
No
Services Call
Recording Video
Record Local Conference
No
Record Network Conference
No
Advanced Phone
Services Security
Security Classification
No
Classification
Comments
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 12 OF 70
BroadWorks SIP Phone Interoperability Test Plan Support Table
Test Plan Package
Test Plan Package Items
Supported
Advanced Phone Services Conference Event
Network-Based Conference Creator
No
Network-Based Conference Participant
No
Meet-Me Conference Participant
No
Redundancy
DNS SRV Lookup
No
Register Failover/Failback
No
Invite Failover/Failback
No
Bye Failover
No
SBC/ALG - Basic
Register
Yes
Outgoing Invite
Yes
Incoming Invite
Yes
SBC/ALG
Register Failover/Failback
No
Failover/Failback
Invite Failover/Failback
No
Video Basic Video
Call Origination
Yes
Calls
Call Termination
Yes
Call Hold
Yes
Call Waiting
Yes
Call Transfer
Yes
Video BroadWorks
Auto Attendant
Yes
Video Services
Auto Attendant HD
Yes
Voice Messaging
Yes
Voice Messaging HD
Yes
Custom Ringback
Yes
Video BroadWorks
Network-based Conference
No
Video Conference
Network-based Conference HD
No
Collaborate Video
No
Collaborate Video HD
No
Video BroadWorks
Call from WebRTC Client
No
WebRTC Client
Call to WebRTC Client
No
TCP
Register
Yes
Outgoing Invite
Yes
Incoming Invite
Yes
IPV6
Call Origination
No
Comments
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 13 OF 70
BroadWorks SIP Phone Interoperability Test Plan Support Table
Test Plan Package
Test Plan Package Items
Supported
Call Termination
No
Session Audit
No
Ringback
No
Codec Negotiation/Renegotiation
No
Voice Message Deposit/Retrieval
No
Call Control
No
Registration with Authentication
No
Busy Lamp Field
No
Redundancy
No
SBC
No
Video
No
Dual Stack with Alternate Connectivity
No
Comments
2.2.2
Other Interface Capabilities
The Akuvox SIP-Based Devices may have implemented support for the following:
BroadWorks Xtended Services Interface (Xsi)
Extensible Messaging and Presence Protocol (XMPP) (BroadCloud/BroadWorks Collaborate Instant Messaging and Presence [IM&P])
Support for these interfaces is demonstrated by completing the BroadWorks SIP Phone XSI and XMPP Test Plan [6]. Support for these interfaces is summarized in the following table.
BroadWorks Xtended Services Interface (Xsi) and BroadCloud IM&P Support Table
Interface
Feature
Supported Comments
Xsi Features Authentication
Authenticate with SIP Credentials
No
Authenticate with BroadWorks User
No
Login Credentials
Xsi Features User Service Configuration
Authenticate with BroadWorks User
No
Directory Number
Remote Office
No
BroadWorks Anywhere
No
Simultaneous Ringing
No
Caller ID Blocking
No
Call Forwarding Always
No
Call Forwarding Busy
No
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 14 OF 70
BroadWorks Xtended Services Interface (Xsi) and BroadCloud IM&P Support Table
Interface
Feature
Supported Comments
Call Forwarding No Answer
No
Do Not Disturb
No
Xsi Features
Enterprise Directory
No
Directories
Enterprise Common Phone List
No
Group Directory
No
Group Common Phone List
No
Personal Phone List
No
Search All Directories
No
Xsi Features
Placed Calls
No
Call Logs
Received Calls
No
Missed Calls
No
All Calls
No
Sort by Name
No
Xsi Features
View Messages
No
Visual Voice Mail
Listen to Audio Message
No
Watch Video Message
No
Mark Message Read/Unread
No
Delete Message
No
Mark All Messages Read/Unread
No
XMPP Features
Contacts
No
Contact/Buddy List
Favorites
No
Groups
No
Non-XMPP Contacts
No
Conferences
No
XMPP Features
Login Invisible
No
Presence
Presence State
No
Presence Status
No
Contact's Presence State
No
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 15 OF 70
2.3 Known Issues
This section lists the known interoperability issues between BroadWorks and specific 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 issue and, where possible, identifies a workaround. The verified partner device versions are listed with an "X" indicating that the issue occurs in the specific release. The issues identified are device deficiencies or bugs, and are typically not BroadWorks release dependent.
The Issue Number is a tracking number for the issue. If it is an Akuvox issue, the issue number is from Akuvox's tracking system. If it is a BroadWorks issue, the issue number is from BroadSoft's tracking system.
For more information on any issues related to the particular partner device release, see the partner release notes.
Issue Number
Issue Description
Partner Version
x.0.1.64
-----
None
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 16 OF 70
3 BroadWorks Configuration
This section identifies the required BroadWorks device profile type for the Akuvox SIPBased Devices as well as any other unique BroadWorks configuration required for interoperability with the Akuvox.
3.1 BroadWorks Device Profile Type Configuration
This section identifies the device profile type settings to use when deploying the Akuvox SIP-Based Devices with BroadWorks.
Create a generic device profile type for supporting the Akuvox SIP-Based Devices with 2 lines is shown in the following example. Separate device profile types for supporting 3 or 6 lines can be created to support devices capable of more SIP lines. Alternatively, a device profile type can also be created for each Akuvox SIP-Based Devices model. The settings other than `Number of Ports' shown are recommended for use when deploying the Akuvox SIP-Based Devices with BroadWorks. For an explanation of the profile parameters, see the BroadWorks Device Management Configuration Guide [2].
The device profile type shown is generic and provides the Number of Ports (number of SIP lines) setting for Akuvox SIP-Based Devices which supports 2 SIP lines. The following table provides a reference on the available number of SIP line for each device model:
Model Name
Number of SIP Lines
E21
2
R23
2
R26
2
R27
2
R29
2
VP-R47P
6
VP-R47G
6
VP-R48G
6
VP-R49P
6
SP-R50P
2
SP-R52P
2
SP-R53P
3
SP-R55P
3
SP-R55G
3
SP-R59P
6
SP-R59G
6
SP-R63G
3
SP-R67G
6
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 17 OF 70
Model Name IT80 IT81 IT82
Number of SIP Lines 2 2 2
Figure 1 Device Identity/Profile Type
3.2 BroadWorks Configuration Steps
There are no additional BroadWorks configurations required.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 18 OF 70
4 SIP-Based Devices Configuration
This section describes the configuration settings required for the SIP-Based Devices integration with BroadWorks, primarily focusing on the SIP interface configuration. The SIP-Based Devices configuration settings identified in this section have been derived and verified through interoperability testing with BroadWorks. For configuration details not covered in this section, see the Akuvox SIP-based Devices Administrator Guide [1] for SIP-Based Devices.
4.1 Configuration Method
The SIP-Based Devices can be configured with a configuration file using Trivial File Transfer Protocol (TFTP) or through its embedded Web Server. The following examples describe how to set the parameters using a configuration file. This configuration description assumes the SIP-Based Devices uses the Dynamic Host Configuration Protocol (DHCP) to obtain an IP address, TFTP server, and other network settings. The Devices should be configured to load the configuration file each time it resets or resynchronizes.
Configuration Files
SIP-Based Devices Configuration Files
Level
Description
<software file name> Example: 48.0.1.64
System
Contains the device firmware load.
r0000000000<Part Number>.cfg Example:r000000000048.cfg
System
Contains configurable parameters that apply to all devices in a given deployment.
<MAC Address>.cfg
Subscriber
Contains configurable parameters that apply to an individual device in a deployment.
contact.xmlring.wav
Static or Subscriber
Any additional files that contain configurable parameters.
4.2 System Level Configuration
This section describes system-wide configuration items that are generally required for each SIP-Based device to work with BroadWorks. Subscriber-specific settings are described in the next section.
4.2.1
Configure Network Settings
Step
Command
Step 1
Config.Network.LAN.Enable = 1
Step 2
Config.Network.Lan.StaticIP =
Config.Network.Lan.SubnetMask =
Config.Network.Lan.DefaultGate way =
Step 3
Config.Network.LAN.UseStaticDN S= 1
Description 0:Disabled(Default); 1:Enabled
0:Disabled(Default); 1:Enabled
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 19 OF 70
Step Step 4
Step 5
Command
Config.Network.LAN.PrimaryDNS = 8.8.8.8 Config.Network.LAN.SecondaryDN S = 8.8.4.4
Config.Settings.SNTP.NTPServer 1 = Config.Settings.SNTP.NTPServer 2 =
Description
4.2.2
Configure SIP Interface Settings
Step
Command
Step 1
Set the SIP proxy/domain. Config.AccountX.Sip.Server = as.broadworks.net
Step 2 Step 3
Enable the outbound proxy. Config.AccountX.OutProxy.Enabl e = 1
Set the outbound proxy. Config.AccountX.OutProxy.Serve r = sbc.broadworks.net
Step 4 Step 5
Step 6 Step 7
Enable the account X. Config.AccountX.General.Enable = 1
Configure the registration information of account X. Config.Account1.General.Label = Config.Account1.General.Displa yName = Config.Account1.General.Userna me = Config.Account1.General.AuthNa me = Config.Account1.General.Pwd =
Enable or disable 100 reliable retransmission. Config.Account2.Call.Enable100 Rel = 1
Enable negotiated DTMF type. Config.AccountX.Dtmf.Type = 1
Description Set the SP-R5x 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. Enable the Outbound Proxy.
Set the outbound proxy to the SBC if one is deployed between the SP-R5x and BroadWorks. If there are redundant SBCs, set it to the FQDN for the SBC cluster. Enable the account X.
Configure the registration information of account X.
Enable or Disable 100 reliable retransmission; 0:Disabled (Default); 1:Enabled.
Set the SP-R5x to enable in-band or RFC 2833-negotiated DTMF.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 20 OF 70
4.2.3
Configure Service Settings
Step
Command
Step 1
#Configure the ring tone type, string.
Config.Settings.RingTone.Type =
Step 2
Enable or disable the call waiting feature.
Config.Features.Call_Waiting.E nable = 1
Description Ring1.wav by default
0:Disabled; 1:Enabled(default);
Step 3 Step 4 Step 5 Step 6 Step 7
Configure the phone to play warning tone when receiving an incoming call during an active call. Config.Features.Call_Waiting.P layTone = 1
Enable or Disable subscribe the MWI status. Config.Account1.SUBSCRIBE.Subs ribeMWI
Enable or Disable Always. Config.Account1.FEATURE_FORWAR D_ALWAYS.Enable = Configure target phonenumber that the phone will Always Forward to. Config.Account1.FEATURE_FORWAR D_ALWAYS.Target =
Enable or Disable Busy Forward Config.Account1.FEATURE_FORWAR D_BUSY.Enable = Configure target phonenumber that the phone will Busy Forward to. Config.Account1.FEATURE_FORWAR D_BUSY.Target =
Enable or Disable No Answer Forward. Config.Account1.FEATURE_FORWAR D_TIMEOUT.Enable = Configure target phonenumber that the phone will No Answer Forward to. Config.Account1.FEATURE_FORWAR D_TIMEOUT.Target =
Config.Account1.FEATURE_DND.En able =
0:Disabled(Default); 1:Enabled 0:Disabled(Default); 1:Enabled 0:Disabled(Default); 1:Enabled 0:Disabled(Default); 1:Enabled 0:Disabled(Default); 1:Enabled
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 21 OF 70
Step Step 8
Command
configure the conference type Config.Account1.CONFERENCE.Typ e = 0 configure the network conference URI. Config.Account1.CONFERENCE.Uri =
Description
0:Local Conference(default),1:Network Conference
4.3 Subscriber Level Configuration
This section identifies the device-specific parameters, including registration and authentication. These settings must be unique across devices in order to be matched with the settings for a BroadWorks SIP trunk or subscriber. SIP Registration requires that a unique address of record (AoR) be provisioned on BroadWorks and the device.
Step
Command
Description
Step 1
Enable each line to be used. Example:
Enable each SP-R5x in use.
Step 2 Step 3 Step 4
Config.Account1.General.Enable = 1 Config.Account2.General.Enable = 1
Set register user name for each line. Example: Config.Account1.General.Userna me = 2405551111 Config.Account2.General.Userna me = 2405552222
Enable SIP authentication for each line. Example: Config.Account1.General.AuthNa me = 1111@as.mycompany.com Config.Account1.General.Pwd = welcome Config.Account2.General.AuthNa me = 2222@as.mycompany.com Config.Account2.General.Pwd = welcome
Configure display name for each line. Example: Config.Account1.General.Displa yName = Claire Smith Config.Account2.General.Displa yName = Julie Wenkel
The register user name must correspond with the line/port setting on BroadWorks.
If the Authentication service is configured on BroadWorks, these parameters must be configured to match the BroadWorks settings.
For each line, configure the name to be displayed on the device.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 22 OF 70
4.4 SIP Advanced Feature Configuration
This section provides configuration instructions for advanced SIP features supported by the phone including but not limited to Shared Call Appearance, Busy Lamp Field, Feature Key Synchronization, Call Center, Emergency Call, Advice of Charge, Call Recording, and Security Classification.
4.4.1 Shared Call Appearance Configuration Akuvox SIP-Based Devices do not support Shared Call Appearance.
4.4.2 Busy Lamp Field Configuration Akuvox SIP-Based Devices do not support Busy Lamp Field.
4.4.3
Feature Key Synchronization Configuration
The Feature Key Synchronization provides synchronization of phone services, such as Call Forwarding and Do Not Disturb, with the settings on BroadWorks for the analogous services. Configuration of the phone to enable Feature Key Synchronization is described as follows.
1) Log in to the webpage user interface (UI) on the browser through the address;
2) Expand to Phone Call Feature, there is Feature Key Sync under Mode Phone;
Figure 2 FKS Configuration
4.4.4
Call Center Feature Configuration
This section provides configuration instructions to configure the phone to enable integration with BroadWorks Call Center features including but not limited to call information, hoteling, status, and disposition codes.
1) Enter following settings in a text, and save it as .cfg file.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 23 OF 70
#Enable or Disable Broadsoft Hoteling(or Flexible Seating) Config.Account1.HOTELING.Enable = 1 Config.Account1.HOTELING.User = 2404985381 Config.Account1.HOTELING.Password = 123456 Config.Account1.HOTELING.AutoLogin = 1
#Configure the hoteling mode; 0:otherwise, 1:hoteling host, 2:flexible seating host, 3:flexible seating guest Config.Account1.HOTELING.Mode = 1
2) Log in to the UI, expand to Upgrade Advanced; 3) Under Others, click Choose File to select the .cfg file and import it.
Figure 3 Config File Import
4.4.5 Call Recording Feature Configuration Akuvox SIP-Based Devices do not support Call Recording.
4.4.6 Security Classification Feature Configuration Akuvox SIP-Based Devices do not support Security Classification.
4.4.7 Emergency Call Configuration Akuvox SIP-Based Devices do not support Emergency Call.
4.4.8
Advice of Charge Configuration This section provides configuration instructions to configure the device to enable Advice of Charge.
1) Log in to the UI and expand to Account Advanced;
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 24 OF 70
2) There is AOC settings under BroadSoft;
Figure 4 Advice of Charge Config 4.4.9 Conference Event Configuration
Akuvox SIP-Based Devices do not support Conference Event.
4.5 Xtended Services Interface (Xsi) Feature Configuration
Akuvox SIP-Based Devices do not support Xsi Features.
4.6 Instant Message and Presence Configuration
Akuvox SIP-Based Devices do not support IM&P.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 25 OF 70
5 Device Management
The BroadWorks Device Management feature provides the capability to automate generation of device configuration files to support mass deployment of devices. This section identifies the Device Management capabilities supported by the Akuvox SIPBased Devices and the configuration steps required. For Device Management configuration details not covered here, see the BroadWorks Device Management Configuration Guide [2] and the BroadWorks CPE Kit Usage Guide [8].
5.1 Device Management Capabilities Supported
The Akuvox SIP-Based Devices have completed Device Management interoperability testing with BroadWorks using the BroadWorks Device Management Interoperability Test Plan [7]. The results are summarized in the following table.
The BroadWorks test plan is composed of packages, each covering distinct interoperability areas. Each package is composed of one or more test items, which in turn, are composed of one or more test cases. The test plan exercises the Device Management interface between the device and BroadWorks with the intent to ensure interoperability.
The Supported column in the following table identifies the Akuvox SIP-Based Devices' support for each of the items covered in the test plan packages, with the following designations:
Yes Test item is supported
No Test item is not supported
NA Test item is not applicable
NT Test item was not tested
Caveats and clarifications are identified in the Comments column.
NOTE: DUT in the following table refers to the Device Under Test, which in this case are the Akuvox SIP-Based Devices.
BroadWorks Device Management Interoperability Test Plan Support Table
Test Plan Package Test Plan Package Items
Supported
HTTP File Download
HTTP Download Using XSP IP Address
Yes
HTTP Download Using XSP FQDN
Yes
HTTP Download Using XSP Cluster
Yes
FQDN
HTTP Download With Double Slash
Yes
HTTPS File Download
HTTPS Download Using XSP IP Address
Yes
HTTPS Download Using XSP FQDN
Yes
HTTPS Download Using XSP Cluster
Yes
FQDN
Comments
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 26 OF 70
BroadWorks Device Management Interoperability Test Plan Support Table
Test Plan Package Test Plan Package Items
Supported
HTTPS File
HTTPS Download with Client
No
Download with
Authentication Using XSP FQDN
Client
Authentication
HTTPS Download with Client
No
Authentication Using XSP Cluster FQDN
Time Zone
Inspect Time Zone Setting
No
Mapping
Language
Inspect Language Setting
No
Mapping
File Inspection
Inspect System Config File
Yes
Inspect Device-Specific Config File
Yes
Inspect Other Config Files
Yes
Inspect Static Files
Yes
Device Inspection Inspect SIP Settings
Yes
Inspect Line Settings
Yes
Inspect Service Settings
Yes
HTTP File Upload HTTP Upload Using XSP IP Address
No
HTTP Upload Using XSP FQDN
No
HTTP Upload Using XSP Cluster FQDN
No
Call Processing
Register with Authentication
Yes
Sanity Tests
Call Origination
Yes
Call Termination
Yes
Remote Restart
Yes
Shared Line Origination
No
Shared Line Termination
No
Shared Line Status
No
Busy Lamp Field
Yes
Network-Based Conference
Yes
Flexible Seating
Association via Voice Portal
Yes
Association via Phone
Yes
No Touch
Provision via DHCP Options Field
Yes
Provisioning
No Touch Provision via DM redirect
No
No Touch Provision via Vendor redirect
No
Comments
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 27 OF 70
5.2 Device Management Configuration
This section identifies the steps required to enable the Akuvox SIP-Based Devices for device management. For Device Management configuration details not covered here, see the BroadWorks Device Management Configuration Guide [2] and the BroadWorks CPE Kit Usage Guide [8].
5.2.1
Configure BroadWorks Tags
The template files in Device Management use tags to represent the data stored on BroadWorks. When a configuration changes for a user, Device Management parses the template files and replaces the Device Management tags with the associated data stored on BroadWorks. There are default tags defined in the Device Management software and there are custom tags that the service provider can create and define via the web portal for use by Device Management. There are two types of custom tags that can be defined: system-default tags that are common to all devices on the system and device type-specific tags that are common to Akuvox device models only.
The Akuvox SIP-Based Devices make use of custom tags which can be configured by a BroadWorks administrator as either system default or device type-specific tags. This section identifies the required tags.
5.2.1.1
Create System Default Tags
Browse to System Resources Device Management Tag Sets and select the System Default tag set. The Akuvox configuration templates make use of the tags in the following table. Add the tags if they do not already exist.
Tag Name
Valid Settings
Description
%SNTP_SERVER_1%
IP address/FQDN
Network Time Protocol (NTP) server address.
%SNTP_SERVER_2%
IP address/FQDN
NTP server address alternate.
%DNS_SERVER_1%
IP address
DNS server address.
%DNS_SERVER_2%
IP address
DNS server address alternate.
%SBC_ADDRESS%
IP address/FQDN
SBC SIP address.
%SBC_PORT%
Port
SBC SIP port. The port should be set if the defined session border controller (SBC) address is an IP address. If the SBC address is an FQDN, then the SBC port should not be set.
%USE_SBC_BOOLEAN% 0/1
Use SBC: 1=yes, 0=no
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 28 OF 70
Example System Default Tag Settings
Figure 5 System Default Tag Settings
5.2.1.2
Create Device Type-specific Tags
Browse to System Resources Device Management Tag Sets and then click Add to add a new tag set. Configure the tag set name using the device name appended by Tags: Akuvox SIP-Based Devices Tags. Add the device type specific tags in the following table to the device tag set. If the tag set already exists, make sure the following tags are defined.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 29 OF 70
Tag Name
%AUTO_ANSWER_BINAR Y%
Valid Settings 0 OR 1
%E21_FIRMWARE% %R23_FIRMWARE% %R26_FIRMWARE% %R27_FIRMWARE% %R29_FIRMWARE% %R47_FIRMWARE% %R48_FIRMWARE% %R49_FIRMWARE% %R50_FIRMWARE% %R52_FIRMWARE% %R53_FIRMWARE% %R55_FIRMWARE% %R59_FIRMWARE% %R63_FIRMWARE% %R67_FIRMWARE% %IT80_FIRMWARE% %IT81_FIRMWARE% %IT82_FIRMWARE%
%TRANSPORT_TYPE%
<Firmware filename> 0, 1, 2 or 3
Description Enable or Disable auto answer when receiving an incoming call. 0: Disabled 1: Enabled The firmware filename to be used when constructing URL for requesting updates.
Sets the network transport protocol used for SIP communication. 0:UDP 1:TCP 2:TLS 3:DNS-NAPTR
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 30 OF 70
Example Device Type-specific Tag Settings
Figure 6 Device Type-specific Tag Settings
5.2.2
Configure BroadWorks Device Profile Type
The device profile type is a system-level structure that defines how the device interfaces with BroadWorks. It also identifies the default configuration files and other files, such as firmware, which are required for the device to operate correctly. The device profile type is created by the system administrator. Group administrators use the device profile type to create a device profile. The device profile is an instance of the device profile type that is associated with a physical device.
There are two BroadWorks device profile configuration methods described: import and manual. The import method takes a DTAF as input and builds the BroadWorks device profile type(s) automatically. The manual method takes the administrator through the steps to manually add and configure the device profile type(s).
The import method should be used if all of the following prerequisites are met:
The BroadWorks Release is 17.0 or later.
The device profile type(s) being imported do not already exist on the system. (If either a previous import or manual configuration was done, then the import fails.)
There is a DTAF file available for import with a BroadWorks release level that is the same as or prior to the release to which it is being imported. If the DTAF file is at a release level later than the release being imported to, then the import can fail.
Otherwise, use the manual method.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 31 OF 70
For more detailed instructions, refer to the BroadWorks CPE Kit Usage Guide [8] and the BroadWorks Device Management Configuration Guide [2].
5.2.2.1
Configuration Method 1: Import
This section identifies the steps necessary to make use of the Device Management import feature to configure BroadWorks to add the Akuvox SIP-Based Devices as a Device Management-enabled device type. Also, see the BroadWorks CPE Kit Usage Guide [8].
Download the Akuvox SIP-Based Devices CPE kit from BroadSoft Xchange at xchange.broadsoft.com. Extract the DTAF file(s) from the CPE kit. These are the import files. Repeat the following steps for each file you wish to import.
1) Log in to BroadWorks as an administrator.
2) Browse to System Resources Identity/Device Profile Types and then click Import.
3) Select Browse to find the extracted DTAF file for the model and then click OK to start the import.
After the import finishes, complete the following post-import configuration steps:
4) Browse to System Resources Identity/Device Profile Types.
5) Perform a search to find the imported Akuvox device profile type, Akuvox_SIPBased_Devices_2_Ports.
6) Browse to the Profile page and change the Device Management Device Access FQDN to your Xtended Services Platform (XSP) or XSP cluster address.
Figure 7 Device Access FQDN
7) Click the Files and Authentication link and then select the option to rebuild all the system files.
Firmware files must be obtained from Akuvox. These files are not included in the import. Complete the steps in section 5.2.2.2.2 Define Device Profile Type Files to define the static firmware files and to upload the firmware.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 32 OF 70
NOTE: The non-firmware static files in section 5.2.2.2.2 Define Device Profile Type Files are normally included in the import.
8) After importing the DTAFs, restart the Application Server to load the TimeZoneAlias files.
5.2.2.2
Configuration Method 2: Manual
This section identifies the basic steps necessary for an administrator to manually configure BroadWorks to add the Akuvox SIP-Based Devices as Device Management-enabled device types. This method should not be used except in special cases as described in the opening to section 5.2.2 Configure BroadWorks Device Profile Type.
For more detailed instruction on manual configuration, refer to the BroadWorks CPE Kit Usage Guide [8] and the BroadWorks Device Management Configuration Guide [2].
The steps in this section can also be followed to update previously imported or configured device profile type(s) with new configuration files and firmware.
If there are DTAFs for more than one device model, these steps must be completed for each model.
5.2.2.2.1 Create or Modify Device Profile Type
This section identifies the BroadWorks device profile type settings relevant to Device Management for the Akuvox SIP-Based Devices.
Browse to System Resources Identity/Device Profile Types and perform a search to find the Akuvox device profile type(s) created in section 3.1 BroadWorks Device Profile Type Configuration or add the device profile type for each model using the settings from section 3.1 BroadWorks Device Profile Type Configuration if they do not exist.
Configure the device profile type Signaling Address Type, Standard and Advanced options settings to match the settings in section 3.1 BroadWorks Device Profile Type Configuration.
Configure the device profile type Device Management options as shown in section 5.2.2.1 Configuration Method 1: Import.
The following subsections identify the required settings specific to Device Management.
5.2.2.2.2 Define Device Profile Type Files
This section describes the BroadWorks Device Management configuration necessary to identify the configuration files and other files that the Akuvox SIP-Based Devices download.
Configuration templates, firmware, and other files the SIP-Based Devices use must be uploaded to BroadWorks. Download the Akuvox SIP-Based Devices CPE kit from BroadSoft Xchange at xchange.broadsoft.com. Extract the configuration files from the Configuration Files folder of CPE kit. Obtain the firmware files directly from Akuvox.
The following table identifies the Akuvox configuration files distributed with the x.0.1.64 CPE kit.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 33 OF 70
File Name
Examples
%BWMACADDRE SS%.cfg
CPE Kit Template File Name File Type
%BWMACADDRESS%.cfg. template
Device-specific
r0000000000<Part Number>.cfg
r0000000000<Part Number>.cfg.template
System-level
TimeZoneAliasLab els_Akuvox<model>.properties
TimeZoneAliasLabels_ Akuvox-SIPBased_Devices.properties
Time Zone Alias
Ring.wav
Static
Static
Description
This file contains all the device specific configuration that the device needs to load.
The file contains all the BroadWorks system specific configuration that the device needs to load
The time zone alias file is a BroadWorks Device Management file used to map time zone identifiers between BroadWorks and Akuvox devices. A time zone alias file is required for each model.
This file is a sample used for customized ringing tone.
The following table identifies other files that the Akuvox SIP-Based Devices downloads from the server or uploads to the server. These files are not provided in the CPE kit and must be obtained from Akuvox.
File Name
File Type
Description
<Firmware File>
Static
The firmware file name is to be defined and matched with the %<Model>_FIRMWARE% tag.
Browse to System Resources Identity/Device Profile Types Files and Authentication to add the files as described in the following subsections.
5.2.2.2.2.1 %BWMACADDRESS%.cfg
Add the %BWMACADDRESS%.cfg file to the device profile type with the settings shown in Figure 5.
After creating the device profile type file, upload %BWMACADDRESS%.cfg. template, which is extracted from the CPE kit obtained from Akuvox. Use the Browse button on the file definition screen. Be sure to click Apply after uploading the file.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 34 OF 70
Figure 8 %BWMACADDRESS%.cfg File Settings
5.2.2.2.2.2 r0000000000<Part Number>.cfg
Add the r0000000000<Part Number>.cfg file to the device profile type with the settings shown in Figure 5.
After creating the device profile type file, upload r0000000000<Part Number>.cfg. template, which is extracted from the CPE kit obtained from Akuvox. Use the Browse button on the file definition screen. Be sure to click Apply after uploading the file.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 35 OF 70
Figure 9 r0000000000<Part Number>.cfg File Settings
Repeat to load the r0000000000<Part Number>.cfg file for each SIP-Based Devices model to be supported for the device profile type.
5.2.2.2.2.3 Ring.wav Add the Ring.wav file to the device profile type with the settings shown in Figure 6.
After creating the device profile type file, upload Ring.cfg template obtained from Akuvox. Use the Browse button on the file definition screen. Be sure to click Apply after uploading the file.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 36 OF 70
Figure 10 Ring.wav File Settings
5.2.2.2.3 Time Zone Mapping
The CPE kit contains a time zone properties file which can be used for each device model. This file maps the BroadWorks user's time zone settings to the device's time zone settings.
This time zone mapping file must be added to the /usr/local/broadworks/bw_base/conf/dms directory on the Application Server using the following file name format: TimeZoneAliasLabels_<Device_Type_Name>.properties.
For example, if the device type name is MyDevice T200, the time zone mapping file name must be TimeZoneAliasLabels_MyDevice+T200.properties. (A space in the device name must be converted to a "+" in the file name.) A separate TimeZoneAlias file must be provided for each device profile type, corresponding to each Akuvox model.
You must restart the Application Server for the TimeZoneAlias files to be picked up by the system.
5.2.2.2.4 Language Mapping
To enable Device Management control of the phone language for languages other than English, the languages defined on the BroadWorks Application Server must be mapped to the SIP-Based Devices definitions.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 37 OF 70
To perform the mapping, select the device profile type and from there select the Languages link. The defined BroadWorks languages will be listed in a table. If languages other than English do not appear, they have not yet been defined on the BroadWorks Application Server.
The supported languages and required mapping are:
BroadWorks Language Identifier
SIP-Based Devices Language Mapping
English (US)
0
English (BR)
0
French
9
German
10
Hungarian
0
Japanese
0
Russian
3
Spanish (CALA)
6
Spanish (Spain)
6
Swedish
0
The language applied to an individual phone is determined by the language defined for the user on the BroadWorks User's Profile page (see Figure 7).
Figure 11 BroadWorks User Language Definition
5.2.3
Create Device Profile Instance
The previous sections defined the device profile type such that the system is ready to mass deploy device profiles. A device profile is an instance of the device profile type and defines the BroadWorks interface to an individual Akuvox device.
Browse to the BroadWorks <group> Resources Identity/Device Profiles page and then select Add to add a new Akuvox SIP-Based Devices device profile. Configure the device profile as shown in the Figure 9 example.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES
20-BD5426-00
©2017 BROADSOFT INC.
PAGE 38 OF 70
Figure 12 Device Profile Instance
5.2.4
Configure BroadWorks User
Configure the user with the desired BroadWorks configuration and services. Any services that require a specific configuration on the device are managed via Device Management and are defined in the device configuration files, if the template files are created with the correct Device Management tags.
The device profile created in the previous section must be assigned to the BroadWorks user. Assigning the device profile to the user automatically causes the Device Management feature to generate the device configuration files for this user's device.
To assign the device profile to the user, browse to the BroadWorks <user> Addresses.
5.2.5
Customize Tags
This section identifies custom tags used by the SIP-Based Devices that may need to be customized at the group or device profile. Customizing a tag at the group level overrides the setting on the device profile type for the device profiles created within the group. Customizing a tag at the device profile level overrides the setting at the device profile type and/or group level for the individual device profile.
5.2.5.1
SBC Address Customization for Edge Device
In many deployments, an edge device, such as an enterprise SBC or application layer gateway, is deployed on the enterprise edge. The edge device's SIP server or outbound proxy setting is configured with the service provider's SBC IP address or FQDN. If there is no edge device, the following customization does not apply.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 39 OF 70
To integrate the edge device with Device Management, the SBC address tag (%SBC_ADDRESS%) defined in section 5.2.1.1 Create System Default Tags must be overridden at the group level with the LAN address of the edge device. To do so, perform that following steps.
1) At the Group Utilities Configure Device page, select the Akuvox device profile (for example, Akuvox_SIP-Based_Devices_2_Ports).
2) Click on the Custom Tags tab.
3) Click Add.
4) For the tag, enter "SBC_ADDRESS".
5) For the value, enter the edge device LAN IP address.
6) To save the tag data, click OK.
Repeat these steps for each Akuvox model provisioned in the group.
5.2.6
Configure Akuvox SIP-Based Devices
This section describes the steps necessary to configure the Akuvox SIP-Based Devices to integrate with BroadWorks Device Management.
5.2.6.1
Defining Device Management File Access URI
The SIP-Based Devices use the provisioning server parameters configured on the phone unless Option 43 has been defined on the DHCP server. If the DHCP server returns data set for the Option 43 parameter, then the SIP-Based Devices use the address defined in this field as the server address to retrieve its configuration data.
To utilize DHCP Options Field, the following value should be configured on the DHCP server for Option 43:
<Access Protocol>://<Device Access FQDN>:<Device Access Port>/ <Device Access Context Name>/<Device Access URI>
Example:
option myDevice code 43 = string;
subnet 10.2.0.0 netmask 255.255.255.0 { option subnet-mask 255.255.255.0; option domain-name-servers 10.2.0.29; option routers 10.2.0.1; option myDevice "http://xsp1.iop1.broadworks.net:80/dms/myDevice/" }
In case manual configuration is required, follow the instructions below to manually define the Device Management file access URL:
1) Log in to the web UI of the device. Expand to Upgrade Advanced, set the DHCP Option as 43 and fill in the Device Management server address URL, select the Automatic Autop Mode to "Power on".
2) Restart the device after settings.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 40 OF 70
Example Login Screen
Figure 13 Example Login Screen
5.2.6.2 No Touch Provisioning No Touch Provisioning is not supported by Akuvox.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 41 OF 70
Appendix A: Reference Akuvox SIP-Based Devices Configuration Files
The following is a reference configuration for the Akuvox SIP-Based Devices configured for use with BroadWorks. System Default File: r0000000000<Part Number>.cfg
NOTE: This is an example file and it should be used for reference only.
#############################################################################################
####
Firmware Update Configuation
####
#############################################################################################
#Configure the url of the firmware file server, support ftp/tftp/http/https protocol, the suffix of the file name must be .rom; Config.Firmware.Url = http://%BWDEVICEACCESSFQDN%/%BWDMSCONTEXT%/%BWDEVICEACCESSURI%%E21_FIRMWARE%
#############################################################################################
####
Custom Ringtone Update Configuation
####
#############################################################################################
#Configure the url of the custom ringtone file server, support ftp/tftp/http/https protocol, the suffix of the file name must be .wav; Config.Ringtone.Url = http://%BWDEVICEACCESSFQDN%/%BWDMSCONTEXT%/%BWDEVICEACCESSURI%Ring.wav
#############################################################################################
####
Contact Update Configuation
####
#############################################################################################
#Configure the url of the contact file server, support ftp/tftp/http/https protocol, the suffix of the file name must be .xml;
#############################################################################################
####
Auto-Provision Configuation
####
#############################################################################################
#Configure the url of the auto provisioning server; Config.Autoprovision.General.Url = http://%BWDEVICEACCESSFQDN%/%BWDMSCONTEXT%/%BWDEVICEACCESSURI%
#Configure the username and password for the phone to be authenticated by the auto provision server;
#Configure the auto provision mode; #0:disable(default); 1:Power On; 2:Repeatedly; 3:Power On + Repeatedly Config.Autoprovision.Mode.Mode =
#Configure the schedule time for auto provision when the auto provision mode is Repeatedly or Power On + Repeatedly; #DayOfWeek: 0~7, 0 is for everydayï¼OE1~7 is for monday~sunday; #HourOfDay: 0~23; Config.Autoprovision.SCHEDULE.DayOfWeek = 7 Config.Autoprovision.SCHEDULE.HourOfDay = 22 Config.Autoprovision.SCHEDULE.MinuteOfHour = 0 Config.Autoprovision.SCHEDULE.SecondOfMinute = 0
#Configure Aes key (16 bytes) for decrypting the common config file; Config.Autoprovision.AES.Key16 =
#Configure Aes key (16 bytes) for decrypting the Mac-Oriented config file; Config.Autoprovision.AES.Key16Mac =
#Enable or disable the PnP feature; 0:Disabled; 1:Enabled(default);
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 42 OF 70
Config.Autoprovision.Pnp.Enable = 1
#Configure the DHCP custom option; Config.Autoprovision.Dhcp_Option.CustomId =
#############################################################################################
####
Network Configuation
####
#############################################################################################
Config.Network.LAN.PrimaryDNS = %DNS_SERVER_1% Config.Network.LAN.SecondaryDNS = %DNS_SERVER_2% Config.Network.LAN.Enable = 1 Config.Network.LAN.UseStaticDNS = 1
#############################################################################################
####
TR069 Configuation
####
#############################################################################################
#Enable or disable the TR069 feature; 0:Disabled (default); 1:Enabled; Config.TR069.General.Enable = 0
#Configure the username and password for the phone to authenticate with the ACS; Config.TR069.ManagementServer.Username = Config.TR069.ManagementServer.Password =
#Configure the access URL of the ACS; Config.TR069.ManagementServer.Url =
#Configure the username and password for the phone to authenticate the connection requests; Config.TR069.ManagementServer.ConnectionRequestUsername = Config.TR069.ManagementServer.connectionRequestPassword =
#Enable or disable the phone to report its configuration information to the ACS; Config.TR069.ManagementServer.PeriodicInformEnable = 0
#Configure the interval(in seconds) for the phone to report its configuration information to the ACS; Config.TR069.ManagementServer.PeriodicInformInterval =
#############################################################################################
####
Call Forward Configuation
####
#############################################################################################
#Enable or Disable Always Forward; 0:Disabled(Default); 1:Enabled; Config.Forward.Always.Enable = 0
#Configure target phonenumber that the phone will Always Forward to: Config.Forward.Always.Target =
#Configure On or off Code for Always Forward; Config.Forward.Always.OnCode = Config.Forward.Always.OffCode =
#Enable or Disable Busy Forward; 0:Disabled(Default); 1:Enabled; Config.Forward.Busy.Enable = 0
#Configure target phonenumber that the phone will Busy Forward to: Config.Forward.Busy.Target =
#Configure On or off Code for Busy Forward; Config.Forward.Busy.OnCode = Config.Forward.Busy.OffCode =
#Enable or Disable No Answer Forward; 0:Disabled(Default); 1:Enabled; Config.Forward.Timeout.Enable = 0
#Configure target phonenumber that the phone will No Answer Forward to: Config.Forward.Timeout.Target =
#Configure No answer timeout the time after which the call will be forwarded when using No Answer Forward, the range is 0~45(in seconds) Config.Forward.Timeout.Timeout = 30
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 43 OF 70
#Configure On or off Code for No Answer Forward; Config.Forward.Timeout.OnCode = Config.Forward.Timeout.OffCode =
#############################################################################################
####
Call Park Configuation
####
#############################################################################################
#Enable or Disable Call Park; 0:Disabled(Default); 1:Enabled; Config.Forward.CallPark.Enable = 0
#Configure target phonenumber that the phone will Call Park to; Config.Forward.CallPark.Target =
#Configure line that the phone will Call Park to; the value is 0(Default), 1, 2; Config.Forward.CallPark.Line = 0
#############################################################################################
####
BroadSoft Phone Book Configuation
####
#############################################################################################
#Configuration of BroadSoft phonebook X ("X" ranges from 0-5);
#Config.BroadSoft.BroadSoftX.DisplayName =
#Config.BroadSoft.BroadSoftX.Server =
#Config.BroadSoft.BroadSoftX.Port =
#Config.BroadSoft.BroadSoftX.Username =
#Config.BroadSoft.BroadSoftX.Password =
Config.BroadSoft.BroadSoft0.DisplayName = Config.BroadSoft.BroadSoft0.Server = Config.BroadSoft.BroadSoft0.Port = Config.BroadSoft.BroadSoft0.Username = Config.BroadSoft.BroadSoft0.Password =
Config.BroadSoft.BroadSoft1.DisplayName = Config.BroadSoft.BroadSoft1.Server = Config.BroadSoft.BroadSoft1.Port = Config.BroadSoft.BroadSoft1.Username = Config.BroadSoft.BroadSoft1.Password =
Config.BroadSoft.BroadSoft2.DisplayName = Config.BroadSoft.BroadSoft2.Server = Config.BroadSoft.BroadSoft2.Port = Config.BroadSoft.BroadSoft2.Username = Config.BroadSoft.BroadSoft2.Password =
Config.BroadSoft.BroadSoft3.DisplayName = Config.BroadSoft.BroadSoft3.Server = Config.BroadSoft.BroadSoft3.Port = Config.BroadSoft.BroadSoft3.Username = Config.BroadSoft.BroadSoft3.Password =
Config.BroadSoft.BroadSoft4.DisplayName = Config.BroadSoft.BroadSoft4.Server = Config.BroadSoft.BroadSoft4.Port = Config.BroadSoft.BroadSoft4.Username = Config.BroadSoft.BroadSoft4.Password =
Config.BroadSoft.BroadSoft5.DisplayName = Config.BroadSoft.BroadSoft5.Server = Config.BroadSoft.BroadSoft5.Port = Config.BroadSoft.BroadSoft5.Username = Config.BroadSoft.BroadSoft5.Password = Config.BroadSoft.GENERAL.Enable = 1
Config.BroadSoft.UPDATECONTACT.Enable = 1 Config.BroadSoft.UPDATECONTACT.Interval = 3600
#######################################################################################
##
Broadsoft XSI
##
#######################################################################################
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 44 OF 70
# configures the access URL of the Xtended Services Platform server for account1; Config.BroadSoft.XSI.Server =
#configures the server port of the Xtended Services Platform server for account1; the range is 1~65535, default is 80; Config.BroadSoft.XSI.Port =
#configures the user name and password for XSI authentication for account1; Config.BroadSoft.XSI.User = Config.BroadSoft.XSI.Pwd =
#############################################################################################
####
LDAP Configuation
####
#############################################################################################
#Configure the search criteria for name and number lookups; Config.Ldap.Ldap.NameFilter = Config.Ldap.Ldap.NumberFilter =
#Configure the LDAP server and port; Config.Ldap.Ldap.Server = Config.Ldap.Ldap.Port =
#Configure the LDAP root path; Config.Ldap.Ldap.Root =
#Configure the LDAP username and password; Config.Ldap.Ldap.Username = Config.Ldap.Ldap.Password =
#Configure the maximum displayed search results, ranges from 1 to 32000(50 by default),the valid value is Integer; Config.Ldap.Ldap.MaxHits = 50
#Configure the search attribute for name and number lookups; Config.Ldap.Ldap.NameAttr = Config.Ldap.Ldap.NumberAttr = Config.Ldap.Ldap.DisplayName =
#Conifugre the search delay time,ranges from 0 to 2000, (in milliseconds, 0 by default); Config.Ldap.Ldap.SearchDelay = 0
#############################################################################################
####
Area Code Configuation
####
#############################################################################################
#Configure the area code; Config.AreaCode.General.Code = Config.AreaCode.General.MaxLen = Config.AreaCode.General.MinLen =
#Configure the line of area code; the valid value is: 0(default), 1, 2, 3; 0 is for auto; Config.AreaCode.General.Account = 0
#############################################################################################
####
Phone Features Configuation
####
#############################################################################################
#Enable or disable the call waiting feature; 0:Disabled; 1:Enabled(default); Config.Features.Call_Waiting.Enable = 1
#Configure the phone to play warning tone when receiving an incoming call during an active call; 0:Disabled; 1:Enabled(default); Config.Features.Call_Waiting.PlayTone = 1
#Enable or disable the intercom feature; 0-Disabled, 1-Enabled(default); Config.Features.Intercom.Enable = 1
#Enable or disable the phone to mute the speaker when automatically answer an intercom call, 0Disabled(default), 1-Enabled; Config.Features.Intercom.Mute = 0
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 45 OF 70
#Configure the delay time of the dialnow feature(in seconds); Config.Features.DialNow.Delay = 1
#Configure the delay time of the auto answer feature(in seconds); Config.Features.AutoAnswer.Delay = 0
#Enable or disable the ACD Auto Available feature; 0-Disabled(default), 1-Enabled; Config.Features.ACD.ACDAutoAvailable = 0
#Configure the time of the ACD Auto Available feature(in seconds); Config.Features.ACD.ACDAutoAvailableTime = 30
#############################################################################################
####
Speed Dial Configuation
####
#############################################################################################
Config.Features.SpeedDial.Label01 = Config.Features.SpeedDial.Num01 = Config.Features.SpeedDial.Line01 =
Config.Features.SpeedDial.Label02 = Config.Features.SpeedDial.Num02 = Config.Features.SpeedDial.Line02 =
Config.Features.SpeedDial.Label03 = Config.Features.SpeedDial.Num03 = Config.Features.SpeedDial.Line03 =
Config.Features.SpeedDial.Label04 = Config.Features.SpeedDial.Num04 = Config.Features.SpeedDial.Line04 =
Config.Features.SpeedDial.Label05 = Config.Features.SpeedDial.Num05 = Config.Features.SpeedDial.Line05 =
Config.Features.SpeedDial.Label06 = Config.Features.SpeedDial.Num06 = Config.Features.SpeedDial.Line06 =
Config.Features.SpeedDial.Label07 = Config.Features.SpeedDial.Num07 = Config.Features.SpeedDial.Line07 =
Config.Features.SpeedDial.Label08 = Config.Features.SpeedDial.Num08 = Config.Features.SpeedDial.Line08 =
Config.Features.SpeedDial.Label09 = Config.Features.SpeedDial.Num09 = Config.Features.SpeedDial.Line09 =
Config.Features.SpeedDial.Label10 = Config.Features.SpeedDial.Num10 = Config.Features.SpeedDial.Line10 =
Config.Features.SpeedDial.Label11 = Config.Features.SpeedDial.Num11 = Config.Features.SpeedDial.Line11 =
Config.Features.SpeedDial.Label12 = Config.Features.SpeedDial.Num12 = Config.Features.SpeedDial.Line12 =
#############################################################################################
####
Phone Action Url Configuation
####
#############################################################################################
Config.Features.ActionUrl.SetupCompleted =
Config.Features.ActionUrl.Registered =
Config.Features.ActionUrl.Unregistered =
Config.Features.ActionUrl.RegisterFailed =
Config.Features.ActionUrl.OffHook =
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 46 OF 70
Config.Features.ActionUrl.OnHook = Config.Features.ActionUrl.IncomingCall = Config.Features.ActionUrl.OutgoingCall = Config.Features.ActionUrl.Established = Config.Features.ActionUrl.Terminated = Config.Features.ActionUrl.OpenDND = Config.Features.ActionUrl.CloseDND = Config.Features.ActionUrl.OpenAlwaysForward = Config.Features.ActionUrl.CloseAlwaysForward = Config.Features.ActionUrl.OpenBusyForward = Config.Features.ActionUrl.CloseBusyForward = Config.Features.ActionUrl.OpenNoAnswerForward = Config.Features.ActionUrl.CloseNoAnswerForward = Config.Features.ActionUrl.TransferCall = Config.Features.ActionUrl.BlindTransfer = Config.Features.ActionUrl.AttendedTransfer = Config.Features.ActionUrl.Hold = Config.Features.ActionUrl.UnHold = Config.Features.ActionUrl.Mute = Config.Features.ActionUrl.UnMute = Config.Features.ActionUrl.MissedCall = Config.Features.ActionUrl.IPChanged = Config.Features.ActionUrl.ForwardInComingCall = Config.Features.ActionUrl.RejectInComingCall = Config.Features.ActionUrl.AnswerNewInCall = Config.Features.ActionUrl.TransferFinished = Config.Features.ActionUrl.TransferFailed = Config.Features.ActionUrl.IdleToBusy = Config.Features.ActionUrl.BusyToIdle = Config.Features.ActionUrl.Enable = Config.Features.RemoteControl.ActionURIAllowIPList =
#############################################################################################
####
Phone Settings Configuation
####
#############################################################################################
#Configure the language displays on the phone LCD screen, the available values are: 0English(default), 1-Chinese_s; Config.Settings.Language.Type = %BWLANGUAGE-1%
#Configure the language displays on the web page, the available values are: 0-English(default), 1-Chinese_s; Config.Settings.Language.WebLang = %BWLANGUAGE-1%
#Configure the offset time (in minutes), ranges from -300 to 300,(60 by default) the valid value is Integer; Config.Settings.DateTime.Offset = 60
#Configure the time format, 0-12 Hour, 1-24 Hour(default); Config.Settings.DateTime.TimeFormat = 1
#Enable or disable the NTP feature; 0:Disabled; 1:Enabled(default); Config.Settings.SNTP.Enable = 1
#Configure the time zone and time zone name for the phone; time zone ranges from -11 to +12 (0 by default); time zone name (GMT by default); Config.Settings.SNTP.TimeZone = %BWTIMEZONE-1% Config.Settings.SNTP.Name = %TIMEZONENAME%
#Configure the primary and secondary NTP servers. Default-0.pool.ntp.org. #The value can be the domain name or IP address of the NTP server. Config.Settings.SNTP.NTPServer1 = %SNTP_SERVER_1% Config.Settings.SNTP.NTPServer2 = %SNTP_SERVER_2%
#Configure the daylight saving time feature. 0-Disabled, 1-Enabled, 2-Automatic(default); Config.Settings.SNTP.DTS = 2
#Configure the update interval(in seconds) when using NTP Server(3600 by default); Config.Settings.SNTP.Interval = 3600
#Configure the start time of DST.(1/1/0 by default) #If the DST type is set to By Date,the value format is Month/Day/Hour;
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 47 OF 70
#If the DST type is set to By Week, the value format is Start Month/Start Day of Week/Start Day of Week Last in Month/Start Hour of Day. #For example,the value is 1/4/2/5, it means the start time is at 5 o'clock on Tuesday, the 4th week in January; Config.Settings.SNTP.StartTime = 1/1/0
#Configure the end time of DST, (12/31/23 by default), the value format is the same as the start time; Config.Settings.SNTP.EndTime = 12/31/23
#Configure the backlight level, Integer,0, 1, 2, 3, 4(default), 5; Config.Settings.Backlight.Level = 4
#Configure the backlight time, 0-Always off, 1-Always on, 10, 20default), 30, 40, 50, 60(, 90, 120(in seconds); Config.Settings.Backlight.Time = 20
#Configure the log level, Integer,0, 1, 2, 3(default), 4, 5, 6, 7; Config.Settings.LogLevel.Level = 3
#Configure the ring tone type, string(Ring1.wav by default); Config.Settings.RingTone.Type = Ring1.wav
#Configure the keyboard volume, the range is 1~15, default is 8; Config.Settings.Audio.KeyVol = 8
#Configure the ring volume, the range is 1~15, default is 8; Config.Settings.Audio.RingVol = 8
#Configure the hand free volume, the range is 1~15, default is 8; Config.Settings.HandFree.SpkVol = 8 Config.Settings.HandFree.MicVol = 8 Config.Settings.HandFree.SigToneVol = 8
#Configure the hand set volume, the range is 1~15, default is 8; Config.Settings.HandSet.SpkVol = 8 Config.Settings.HandSet.MicVol = 8 Config.Settings.HandSet.SigToneVol = 8
#Configure the head set volume, the range is 1~15, default is 8; Config.Settings.HeadSet.SpkVol = 8 Config.Settings.HeadSet.MicVol = 8 Config.Settings.HeadSet.SigToneVol = 8
#Configure the login password of the advanced settings on the phone UI(admin by default); Config.Settings.Login.Password = admin
#Configure the login password of the web(admin by default); Config.Settings.Web_Login.Password = admin
#Configure the timeout of the dial in or dial out(in seconds, 60 by default); Config.Settings.CallTimeOut.DialIn = 60 Config.Settings.CallTimeOut.DialOut = 60
#Configure the distinctive ring; Config.Settings.Ringer.Keyword01 = Config.Settings.Ringer.Ringtone01 =
Config.Settings.Ringer.Keyword02 = Config.Settings.Ringer.Ringtone02 =
Config.Settings.Ringer.Keyword03 = Config.Settings.Ringer.Ringtone03 =
Config.Settings.Ringer.Keyword04 = Config.Settings.Ringer.Ringtone04 =
Config.Settings.Ringer.Keyword05 = Config.Settings.Ringer.Ringtone05 =
Config.Settings.Ringer.Keyword06 = Config.Settings.Ringer.Ringtone06 =
Config.Settings.Ringer.Keyword07 =
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 48 OF 70
Config.Settings.Ringer.Ringtone07 =
Config.Settings.Ringer.Keyword08 = Config.Settings.Ringer.Ringtone08 =
Config.Settings.Ringer.Keyword09 = Config.Settings.Ringer.Ringtone09 =
Config.Settings.Ringer.Keyword10 = Config.Settings.Ringer.Ringtone10 =
#############################################################################################
####
Voice Configuation
####
#############################################################################################
#Enable or disable the phone to detect the silence, 0-Disbaled (default),1-Enabled; Config.Voice.General.VAD = 0
#Enable or disable the phone to generate comfortable noise, 0-Disabled, 1-Enabled; Config.Voice.General.CNG = 1
#Configure the side tone,the value ranges from-32768 to -3; the default value is -32768; Config.Voice.General.SideTone = -32768
#Enable or disable the phone to cancel echo, 0-Disabled, 1-Enabled (default); Config.Voice.General.EchoCanceller = 1
#Enable or disable jitter buffer, 0-Disabled, 1-Enabled (default); Config.Voice.Jitter.Enable = 1
#Configure the type of jitter buffer, 0-Fixed, 1-Adaptive (default); Config.Voice.Jitter.Adaptive = 1
#Configure the minimum delay(0 by default), maximum delay(300 by default) and normal delay (120 by default); Config.Voice.Jitter.Min = 0 Config.Voice.Jitter.Max = 300 Config.Voice.Jitter.Nominal = 120
#Configure the type of voice tone; 0:Custom; 1:Default; 2:China; 3:Spain; 4:Luxembourg; 5:Sweden; 6:Taiwan; 7:Belgium; 8:Denmark; 9:Finland; 10:Germany; 11:Netherlands; 12:Norways; 13:Protugal; Config.Voice.Tone.Country = 1
Config.Voice.RTCP.Enable = Config.Voice.RTCP.Interval = Config.Voice.G726.Coding =
#Configure the ringback tone,dial tone and call wait tone when the tone type is 0(Custom); Config.Tone.General.Ringback = Config.Tone.General.Dialtone = Config.Tone.General.Callwait =
Device-specific File: <MAC Address>.cfg NOTE: This is an example file and it should be used for reference only.
#############################################################################################
####
Network Configuation
####
#############################################################################################
#############################################################################################
####
Account1 Configuation
####
#############################################################################################
#Enable or disable the account1, 0:Disabled(default); 1:Enabled;
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 49 OF 70
Config.Account1.General.Enable = %BWLINE-BINARY-1%
#Configure the account1 label which will display on the LCD screen; Config.Account1.General.Label = %BWEXTENSION-1%
#Configure the display name of account1; Config.Account1.General.DisplayName = %BWCLID-1%
#Configure the register user name of account1; Config.Account1.General.Username = %BWLINEPORT-1%
#Configure the user and password for register authentication; Config.Account1.General.AuthName = %BWAUTHUSER-1% Config.Account1.General.Pwd = %BWAUTHPASSWORD-1%
#Configure the SIP server address and port of account1; Config.Account1.Sip.Server = %BWHOST-1% Config.Account1.Sip.Port = 5060
Config.Account1.Sip.Server2 = Config.Account1.Sip.Port2 = 5060
#Configure the transport type; 0:UDP(Default); 1:TCP; 2:TLS; 3:DNS-NAPTR; Config.Account1.Sip.TransType = %TRANSPORT_TYPE%
#Configure the the max and min Listen Port; Config.Account1.SIP.ListenPortMin = Config.Account1.SIP.ListenPortMax =
#Enable or Disable the outbound proxy server; Config.Account1.OutProxy.Enable = %USE_SBC_BOOLEAN%
#Configure the IP address/domain of the outbound proxy server and the server port; Config.Account1.OutProxy.Server = %SBC_ADDRESS% Config.Account1.OutProxy.Port = %SBC_PORT%
#Configure the backup outbound proxy server address and port; Config.Account1.OutProxy.BakServer = Config.Account1.OutProxy.BakPort = 5060
#Configure the Stun feature; Config.Account1.Stun.Enable = Config.Account1.Stun.Server = Config.Account1.Stun.Port =
#Configure the DTMF type; 0:Inband; 1:RFC2833(Default); 2:Info; 3:Inband + Info; 4:Info + RFC2833; Config.Account1.DTMF.Type = 1
#Configure the RFC2833 payload, ranges from 96 to 225 (101 by default); Config.Account1.DTMF.Payload = 101
#Configure DTMF info type when using Info; 0:Disabled(default); 1:DTMF-Relay; 2:DTMF; 3:Telephone-Event; Config.Account1.DTMF.InfoType = 0
Config.Account1.DTMF.Duration = 300 Config.Account1.DTMF.Power =
#Configure the NAT keep-alive and the keep-alive interval(in seconds); Config.Account1.NAT.UdpKeepEnable = Config.Account1.NAT.UdpKeepInterval = Config.Account1.NAT.Rport =
#Configure the blf subscribe period(1800 seconds by default); Config.Account1.Blf.SubscribePeriod = 1800
#Configure the blf list uri; Config.Account1.Blf.BlfListUri = %BWBLF-URI-1%
#Configure the feature access code for directed call pickup; Config.Account1.BLF.BlfListCode =
#Configure the feature access code for directed call pickup with barge-in;
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 50 OF 70
Config.Account1.BLF.BlfListBargeInCode =
#Configure the voice message number; Config.Account1.VoiceMsg.Number = %BWVOICE-PORTAL-NUMBER-1%
#Configure AnonymousCall Config.Account1.ANONYMOUS_CALL.Enable = 0 Config.Account1.ANONYMOUS_CALL.OnCode = Config.Account1.ANONYMOUS_CALL.OffCode = Config.Account1.ANONYMOUS_CALL.PrivacyHeaderValue = id
#Configure Reject AnonymousCall Config.Account1.REJECT_ANONYMOUSCALL.Enable = 0 Config.Account1.REJECT_ANONYMOUSCALL.OnCode = Config.Account1.REJECT_ANONYMOUSCALL.OffCode =
#Configure the register expire time(1800 seconds by default); Config.Account1.REG.Timeout = 1800 Config.Account1.REG.Timeout2 = 1800
#configure the conference type; 0:Local Conference(default),1:Network Conference; Config.Account1.CONFERENCE.Type = 1 #configure the network conference URI; The default value is blank; Config.Account1.CONFERENCE.Uri = %BWNETWORK-CONFERENCE-SIPURI-1%
#Enable or Disable auto answer when receiving a incoming call for accout1; 0:Disabled(Default); 1:Enabled; Config.Account1.Auto_Answer.Enable = %AUTO_ANSWER_BINARY%
#Configure Session Timer Config.Account1.SESSION.EnableTimer = 0 Config.Account1.SESSION.Interval = 1800 Config.Account1.SESSION.Refresher = 0
#Configure the subscribe period of the ACD(in seconds), the range is 1800~65535, default is 1800; Config.Account1.SUBSCRIBE.SubscribeACDExpire = 1800
#Enable or Disable subscribe the MWI status; 0:Disabled(Default); 1:Enabled; Config.Account1.SUBSCRIBE.SubsribeMWI = 0
#Configure the subscribe period of the MWI(in seconds), the range is 1800~65535, default is 1800; Config.Account1.Subscribe.SubscribeMWIExpire = 1800
#Enable or Disable 100 reliable retransmission; 0:Disabled(Default); 1:Enabled; Config.Account1.Call.Enable100Rel = 0
#Configure the RTP packet time; 0(Disabled), 10, 20, 30, 40, 50, 60; Config.Account1.Call.Ptime =
#Enable or disable the DND feature; 0:Disabled(default); 1:Enabled; Config.Account1.FEATURE_DND.Enable = %BWDND-BINARY-1%
#Configure On or off Code for DND; Config.Account1.FEATURE_DND.OnCode = %BWFAC-DND-ACTIVATE-1% Config.Account1.FEATURE_DND.OffCode = %BWFAC-DND-DEACTIVATE-1%
#Configure return code for DND; the valid value is: 404(Not Found); 480(Temporarily Unavailable); 486(Busy Here); Config.Account1.DND.ReturnCode = 486
#Enable or Disable Always Forward; 0:Disabled(Default); 1:Enabled; Config.Account1.FEATURE_FORWARD_ALWAYS.Enable = %BWCFA-BINARY-1%
#Configure target phonenumber that the phone will Always Forward to; Config.Account1.FEATURE_FORWARD_ALWAYS.Target =
#Configure On or off Code for Always Forward; Config.Account1.FEATURE_FORWARD_ALWAYS.OnCode = %BWFAC-CFA-ACTIVATE-1% Config.Account1.FEATURE_FORWARD_ALWAYS.OffCode = %BWFAC-CFA-DEACTIVATE-1%
#Enable or Disable Busy Forward; 0:Disabled(Default); 1:Enabled; Config.Account1.FEATURE_FORWARD_BUSY.Enable =
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 51 OF 70
#Configure target phonenumber that the phone will Busy Forward to; Config.Account1.FEATURE_FORWARD_BUSY.Target =
#Configure On or off Code for Busy Forward; Config.Account1.FEATURE_FORWARD_BUSY.OnCode = %BWFAC-CFB-ACTIVATE-1% Config.Account1.FEATURE_FORWARD_BUSY.OffCode = %BWFAC-CFB-DEACTIVATE-1%
#Enable or Disable No Answer Forward; 0:Disabled(Default); 1:Enabled; Config.Account1.FEATURE_FORWARD_TIMEOUT.Enable =
#Configure target phonenumber that the phone will No Answer Forward to; Config.Account1.FEATURE_FORWARD_TIMEOUT.Target =
#Configure On or off Code for No Answer Forward; Config.Account1.FEATURE_FORWARD_TIMEOUT.OnCode = %BWFAC-CFNA-ACTIVATE-1% Config.Account1.FEATURE_FORWARD_TIMEOUT.OffCode = %BWFAC-CFNA-DEACTIVATE-1%
#Configure No answer timeout the time after which the call will be forwarded when using No Answer Forward, the range is 0~45(in seconds); Config.Account1.FEATURE_FORWARD_TIMEOUT.TimeOut = 30
#Enable or Disable Audio codecs for account1 (X ranges from 0 to 12); Config.Account1.AudioX.Enable = Config.Account1.Audio0.Enable = 1 Config.Account1.Audio1.Enable = 1 Config.Account1.Audio2.Enable = 0 Config.Account1.Audio3.Enable = 0 Config.Account1.Audio4.Enable = 1 Config.Account1.Audio5.Enable = 1 Config.Account1.Audio6.Enable = 0 Config.Account1.Audio7.Enable = 0 Config.Account1.Audio8.Enable = 0 Config.Account1.Audio9.Enable = 0 Config.Account1.Audio10.Enable = 0 Config.Account1.Audio11.Enable = 0 Config.Account1.Audio12.Enable = 0
#Enable or Disable Video codecs for account1 (X ranges from 0 to 2); Config.Account1.VideoX.Enable = Config.Account1.Video00.Enable = 1 Config.Account1.Video01.Enable = 1 Config.Account1.Video02.Enable = 0
#Enable or Disable advice of charge Config.Account1.AOC.AocEnable =
#Enable or Disable Broadsoft Hoteling(or Flexible Seating) Config.Account1.HOTELING.Enable = 0
#Configure the hoteling mode; 0:otherwise, 1:hoteling host, 2:flexible seating host, 3:flexible seating guest Config.Account1.HOTELING.Mode = %BWHOTELINGMODE-1%
#Configure the PIN code to unlock screen Config.Account1.HOTELING.UnlockPIN = %BWFLEXIBLESEATINGUNLOCKPIN-1%
#############################################################################################
####
Account2 Configuation
####
#############################################################################################
#Enable or disable the account2, 0:Disabled(default); 1:Enabled; Config.Account2.General.Enable = %BWLINE-BINARY-2%
#Configure the account2 label which will display on the LCD screen; Config.Account2.General.Label = %BWEXTENSION-2%
#Configure the display name of account2; Config.Account2.General.DisplayName = %BWCLID-2%
#Configure the register user name of account2; Config.Account2.General.Username = %BWLINEPORT-2%
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 52 OF 70
#Configure the user and password for register authentication; Config.Account2.General.AuthName = %BWAUTHUSER-2% Config.Account2.General.Pwd = %BWAUTHPASSWORD-2%
#Configure the SIP server address and port of account2; Config.Account2.Sip.Server = %BWHOST-2% Config.Account2.Sip.Port = 5060
Config.Account2.Sip.Server2 = Config.Account2.Sip.Port2 = 5060
#Configure the transport type; 0:UDP(Default); 1:TCP; 2:TLS; 3:DNS-NAPTR; Config.Account2.Sip.TransType = 0
#Configure the the max and min Listen Port; Config.Account2.SIP.ListenPortMin = Config.Account2.SIP.ListenPortMax =
#Enable or Disable the outbound proxy server; Config.Account2.OutProxy.Enable = %USE_SBC_BOOLEAN%
#Configure the IP address/domain of the outbound proxy server and the server port; Config.Account2.OutProxy.Server = %SBC_ADDRESS% Config.Account2.OutProxy.Port = %SBC_PORT%
#Configure the backup outbound proxy server address and port; Config.Account2.OutProxy.BakServer = Config.Account2.OutProxy.BakPort =
#Configure the Stun feature; Config.Account2.Stun.Enable = Config.Account2.Stun.Server = Config.Account2.Stun.Port =
#Configure the DTMF type; 0:Inband; 1:RFC2833(Default); 2:Info; 3:Inband + Info; 4:Info + RFC2833; Config.Account2.DTMF.Type = 1
#Configure the RFC2833 payload, ranges from 96 to 225 (101 by default); Config.Account2.DTMF.Payload = 101
#Configure DTMF info type when using Info; 0:Disabled(default); 1:DTMF-Relay; 2:DTMF; 3:Telephone-Event; Config.Account2.DTMF.InfoType = 0
Config.Account2.DTMF.Duration = 300 Config.Account2.DTMF.Power =
#Configure the NAT keep-alive and the keep-alive interval(in seconds); Config.Account2.NAT.UdpKeepEnable = Config.Account2.NAT.UdpKeepInterval = Config.Account2.NAT.Rport =
#Configure the blf subscribe period(1800 seconds by default); Config.Account2.Blf.SubscribePeriod = 1800
#Configure the blf list uri; Config.Account2.Blf.BlfListUri = %BWBLF-URI-2%
#Configure the feature access code for directed call pickup; Config.Account2.BLF.BlfListCode =
#Configure the feature access code for directed call pickup with barge-in; Config.Account2.BLF.BlfListBargeInCode =
#Configure the voice message number; Config.Account2.VoiceMsg.Number = %BWVOICE-PORTAL-NUMBER-2%
#Configure AnonymousCall Config.Account2.ANONYMOUS_CALL.Enable = 0 Config.Account2.ANONYMOUS_CALL.OnCode = Config.Account2.ANONYMOUS_CALL.OffCode =
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES
©2017 BROADSOFT INC.
20-BD5426-00 PAGE 53 OF 70
Config.Account2.ANONYMOUS_CALL.PrivacyHeaderValue = id
#Configure Reject AnonymousCall Config.Account2.REJECT_ANONYMOUSCALL.Enable = 0 Config.Account2.REJECT_ANONYMOUSCALL.OnCode = Config.Account2.REJECT_ANONYMOUSCALL.OffCode =
#Configure the register expire time(1800 seconds by default); Config.Account2.REG.Timeout = 1800 Config.Account2.REG.Timeout2 = 1800
#configure the conference type; 0:Local Conference(default),1:Network Conference; Config.Account2.CONFERENCE.Type = 1 #configure the network conference URI; The default value is blank; Config.Account2.CONFERENCE.Uri = %BWNETWORK-CONFERENCE-SIPURI-2%
#Enable or Disable auto answer when receiving a incoming call for accout2; 0:Disabled(Default); 1:Enabled; Config.Account2.Auto_Answer.Enable =
#Configure Session Timer Config.Account2.SESSION.EnableTimer = 0 Config.Account2.SESSION.Interval = 1800 Config.Account2.SESSION.Refresher = 0
#Configure the subscribe period of the ACD(in seconds), the range is 1800~65535, default is 1800; Config.Account2.SUBSCRIBE.SubscribeACDExpire = 1800
#Enable or Disable subscribe the MWI status; 0:Disabled(Default); 1:Enabled; Config.Account2.SUBSCRIBE.SubsribeMWI = 0
#Configure the subscribe period of the MWI(in seconds), the range is 1800~65535, default is 1800; Config.Account2.Subscribe.SubscribeMWIExpire = 1800
#Enable or Disable 100 reliable retransmission; 0:Disabled(Default); 1:Enabled; Config.Account2.Call.Enable100Rel = 0
#Configure the RTP packet time; 0(Disabled), 10, 20, 30, 40, 50, 60; Config.Account2.Call.Ptime =
#Enable or disable the DND feature; 0:Disabled(default); 1:Enabled; Config.Account2.FEATURE_DND.Enable = %BWDND-BINARY-2%
#Configure On or off Code for DND; Config.Account2.FEATURE_DND.OnCode = %BWFAC-DND-ACTIVATE-2% Config.Account2.FEATURE_DND.OffCode = %BWFAC-DND-DEACTIVATE-2%
#Configure return code for DND; the valid value is: 404(Not Found); 480(Temporarily Unavailable); 486(Busy Here); Config.Account2.DND.ReturnCode = 486
#Enable or Disable Always Forward; 0:Disabled(Default); 1:Enabled; Config.Account2.FEATURE_FORWARD_ALWAYS.Enable = %BWCFA-BINARY-2%
#Configure target phonenumber that the phone will Always Forward to; Config.Account2.FEATURE_FORWARD_ALWAYS.Target =
#Configure On or off Code for Always Forward; Config.Account2.FEATURE_FORWARD_ALWAYS.OnCode = %BWFAC-CFA-ACTIVATE-2% Config.Account2.FEATURE_FORWARD_ALWAYS.OffCode = %BWFAC-CFA-DEACTIVATE-2%
#Enable or Disable Busy Forward; 0:Disabled(Default); 1:Enabled; Config.Account2.FEATURE_FORWARD_BUSY.Enable =
#Configure target phonenumber that the phone will Busy Forward to; Config.Account2.FEATURE_FORWARD_BUSY.Target =
#Configure On or off Code for Busy Forward; Config.Account2.FEATURE_FORWARD_BUSY.OnCode = %BWFAC-CFB-ACTIVATE-2% Config.Account2.FEATURE_FORWARD_BUSY.OffCode = %BWFAC-CFB-DEACTIVATE-2%
#Enable or Disable No Answer Forward; 0:Disabled(Default); 1:Enabled;
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 54 OF 70
Config.Account2.FEATURE_FORWARD_TIMEOUT.Enable =
#Configure target phonenumber that the phone will No Answer Forward to; Config.Account2.FEATURE_FORWARD_TIMEOUT.Target =
#Configure On or off Code for No Answer Forward; Config.Account2.FEATURE_FORWARD_TIMEOUT.OnCode = %BWFAC-CFNA-ACTIVATE-2% Config.Account2.FEATURE_FORWARD_TIMEOUT.OffCode = %BWFAC-CFNA-DEACTIVATE-2%
#Configure No answer timeout the time after which the call will be forwarded when using No Answer Forward, the range is 0~45(in seconds); Config.Account2.FEATURE_FORWARD_TIMEOUT.TimeOut = 30
#Enable or Disable Audio codecs for account2 (X ranges from 0 to 12); Config.Account2.AudioX.Enable = Config.Account2.Audio0.Enable = 1 Config.Account2.Audio1.Enable = 1 Config.Account2.Audio2.Enable = 0 Config.Account2.Audio3.Enable = 0 Config.Account2.Audio4.Enable = 1 Config.Account2.Audio5.Enable = 1 Config.Account2.Audio6.Enable = 0 Config.Account2.Audio7.Enable = 0 Config.Account2.Audio8.Enable = 0 Config.Account2.Audio9.Enable = 0 Config.Account2.Audio10.Enable = 0 Config.Account2.Audio11.Enable = 0 Config.Account2.Audio12.Enable = 0
#Enable or Disable Video codecs for account2 (X ranges from 0 to 2); Config.Account2.VideoX.Enable = Config.Account2.Video00.Enable = 1 Config.Account2.Video01.Enable = 1 Config.Account2.Video02.Enable = 0
#Enable or Disable advice of charge Config.Account2.AOC.AocEnable =
#Enable or Disable Broadsoft Hoteling(or Flexible Seating)
#Configure the hoteling mode; 0:otherwise, 1:hoteling host, 2:flexible seating host, 3:flexible seating guest Config.Account2.HOTELING.Mode = %BWHOTELINGMODE-2%
#Configure the PIN code to unlock screen Config.Account2.HOTELING.UnlockPIN = %BWFLEXIBLESEATINGUNLOCKPIN-2%
#############################################################################################
####
Account3 Configuation
####
#############################################################################################
#Enable or disable the account3, 0:Disabled(default); 1:Enabled; Config.Account3.General.Enable = %BWLINE-BINARY-3%
#Configure the account3 label which will display on the LCD screen; Config.Account3.General.Label = %BWEXTENSION-3%
#Configure the display name of account3; Config.Account3.General.DisplayName = %BWCLID-3%
#Configure the register user name of account3; Config.Account3.General.Username = %BWLINEPORT-3%
#Configure the user and password for register authentication; Config.Account3.General.AuthName = %BWAUTHUSER-3% Config.Account3.General.Pwd = %BWAUTHPASSWORD-3%
#Configure the SIP server address and port of account3; Config.Account3.Sip.Server = %BWHOST-3% Config.Account3.Sip.Port = 5060
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 55 OF 70
Config.Account3.Sip.Server2 = Config.Account3.Sip.Port2 = 5060
#Configure the transport type; 0:UDP(Default); 1:TCP; 2:TLS; 3:DNS-NAPTR; Config.Account3.Sip.TransType = 0
#Configure the the max and min Listen Port; Config.Account3.SIP.ListenPortMin = Config.Account3.SIP.ListenPortMax =
#Enable or Disable the outbound proxy server; Config.Account3.OutProxy.Enable =
#Configure the IP address/domain of the outbound proxy server and the server port; Config.Account3.OutProxy.Server = %USE_SBC_BOOLEAN% Config.Account3.OutProxy.Port = %SBC_PORT%
#Configure the backup outbound proxy server address and port; Config.Account3.OutProxy.BakServer = Config.Account3.OutProxy.BakPort =
#Configure the Stun feature; Config.Account3.Stun.Enable = Config.Account3.Stun.Server = Config.Account3.Stun.Port =
#Configure the DTMF type; 0:Inband; 1:RFC2833(Default); 2:Info; 3:Inband + Info; 4:Info + RFC2833; Config.Account3.DTMF.Type = 1
#Configure the RFC2833 payload, ranges from 96 to 225 (101 by default); Config.Account3.DTMF.Payload = 101
#Configure DTMF info type when using Info; 0:Disabled(default); 1:DTMF-Relay; 2:DTMF; 3:Telephone-Event; Config.Account3.DTMF.InfoType = 0
Config.Account3.DTMF.Duration = 300 Config.Account3.DTMF.Power =
#Configure the NAT keep-alive and the keep-alive interval(in seconds); Config.Account3.NAT.UdpKeepEnable = Config.Account3.NAT.UdpKeepInterval = Config.Account3.NAT.Rport =
#Configure the blf subscribe period(1800 seconds by default); Config.Account3.Blf.SubscribePeriod = 1800
#Configure the blf list uri; Config.Account3.Blf.BlfListUri = %BWBLF-URI-3%
#Configure the feature access code for directed call pickup; Config.Account3.BLF.BlfListCode =
#Configure the feature access code for directed call pickup with barge-in; Config.Account3.BLF.BlfListBargeInCode =
#Configure the voice message number; Config.Account3.VoiceMsg.Number = %BWVOICE-PORTAL-NUMBER-3%
#Configure AnonymousCall Config.Account3.ANONYMOUS_CALL.Enable = 0 Config.Account3.ANONYMOUS_CALL.OnCode = Config.Account3.ANONYMOUS_CALL.OffCode = Config.Account3.ANONYMOUS_CALL.PrivacyHeaderValue = id
#Configure Reject AnonymousCall Config.Account3.REJECT_ANONYMOUSCALL.Enable = 0 Config.Account3.REJECT_ANONYMOUSCALL.OnCode = Config.Account3.REJECT_ANONYMOUSCALL.OffCode =
#Configure the register expire time(1800 seconds by default); Config.Account3.REG.Timeout = 1800 Config.Account3.REG.Timeout2 = 1800
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 56 OF 70
#configure the conference type; 0:Local Conference(default),1:Network Conference; Config.Account3.CONFERENCE.Type = 1 #configure the network conference URI; The default value is blank; Config.Account3.CONFERENCE.Uri = %BWNETWORK-CONFERENCE-SIPURI-3%
#Enable or Disable auto answer when receiving a incoming call for accout1; 0:Disabled(Default); 1:Enabled; Config.Account3.Auto_Answer.Enable =
#Configure Session Timer Config.Account3.SESSION.EnableTimer = 0 Config.Account3.SESSION.Interval = 1800 Config.Account3.SESSION.Refresher = 0
#Configure the subscribe period of the ACD(in seconds), the range is 1800~65535, default is 1800; Config.Account3.SUBSCRIBE.SubscribeACDExpire = 1800
#Enable or Disable subscribe the MWI status; 0:Disabled(Default); 1:Enabled; Config.Account3.SUBSCRIBE.SubsribeMWI = 0
#Configure the subscribe period of the MWI(in seconds), the range is 1800~65535, default is 1800; Config.Account3.Subscribe.SubscribeMWIExpire = 1800
#Enable or Disable 100 reliable retransmission; 0:Disabled(Default); 1:Enabled; Config.Account3.Call.Enable100Rel = 0
#Configure the RTP packet time; 0(Disabled), 10, 20, 30, 40, 50, 60; Config.Account3.Call.Ptime =
#Enable or disable the DND feature; 0:Disabled(default); 1:Enabled; Config.Account3.FEATURE_DND.Enable = %BWDND-BINARY-3%
#Configure On or off Code for DND; Config.Account3.FEATURE_DND.OnCode = %BWFAC-DND-ACTIVATE-3% Config.Account3.FEATURE_DND.OffCode = %BWFAC-DND-DEACTIVATE-3%
#Configure return code for DND; the valid value is: 404(Not Found); 480(Temporarily Unavailable); 486(Busy Here); Config.Account3.DND.ReturnCode = 486
#Enable or Disable Always Forward; 0:Disabled(Default); 1:Enabled; Config.Account3.FEATURE_FORWARD_ALWAYS.Enable = %BWCFA-BINARY-3%
#Configure target phonenumber that the phone will Always Forward to; Config.Account3.FEATURE_FORWARD_ALWAYS.Target =
#Configure On or off Code for Always Forward; Config.Account3.FEATURE_FORWARD_ALWAYS.OnCode = %BWFAC-CFA-ACTIVATE-3% Config.Account3.FEATURE_FORWARD_ALWAYS.OffCode = %BWFAC-CFA-DEACTIVATE-3%
#Enable or Disable Busy Forward; 0:Disabled(Default); 1:Enabled; Config.Account3.FEATURE_FORWARD_BUSY.Enable =
#Configure target phonenumber that the phone will Busy Forward to; Config.Account3.FEATURE_FORWARD_BUSY.Target =
#Configure On or off Code for Busy Forward; Config.Account3.FEATURE_FORWARD_BUSY.OnCode = %BWFAC-CFB-ACTIVATE-3% Config.Account3.FEATURE_FORWARD_BUSY.OffCode = %BWFAC-CFB-DEACTIVATE-3%
#Enable or Disable No Answer Forward; 0:Disabled(Default); 1:Enabled; Config.Account3.FEATURE_FORWARD_TIMEOUT.Enable =
#Configure target phonenumber that the phone will No Answer Forward to; Config.Account3.FEATURE_FORWARD_TIMEOUT.Target =
#Configure On or off Code for No Answer Forward; Config.Account3.FEATURE_FORWARD_TIMEOUT.OnCode = %BWFAC-CFNA-ACTIVATE-3% Config.Account3.FEATURE_FORWARD_TIMEOUT.OffCode = %BWFAC-CFNA-DEACTIVATE-3%
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 57 OF 70
#Configure No answer timeout the time after which the call will be forwarded when using No Answer Forward, the range is 0~45(in seconds); Config.Account3.FEATURE_FORWARD_TIMEOUT.TimeOut = 30
#Enable or Disable Audio codecs for account3 (X ranges from 0 to 12); Config.Account3.AudioX.Enable = Config.Account3.Audio0.Enable = 1 Config.Account3.Audio1.Enable = 1 Config.Account3.Audio2.Enable = 0 Config.Account3.Audio3.Enable = 0 Config.Account3.Audio4.Enable = 1 Config.Account3.Audio5.Enable = 1 Config.Account3.Audio6.Enable = 0 Config.Account3.Audio7.Enable = 0 Config.Account3.Audio8.Enable = 0 Config.Account3.Audio9.Enable = 0 Config.Account3.Audio10.Enable = 0 Config.Account3.Audio11.Enable = 0 Config.Account3.Audio12.Enable = 0
#Enable or Disable Video codecs for account3 (X ranges from 0 to 2); Config.Account3.VideoX.Enable = Config.Account3.Video00.Enable = 1 Config.Account3.Video01.Enable = 1 Config.Account3.Video02.Enable = 0
#Enable or Disable advice of charge Config.Account3.AOC.AocEnable =
#Enable or Disable Broadsoft Hoteling(or Flexible Seating)
#Configure the hoteling mode; 0:otherwise, 1:hoteling host, 2:flexible seating host, 3:flexible seating guest Config.Account3.HOTELING.Mode = %BWHOTELINGMODE-3%
#Configure the PIN code to unlock screen Config.Account3.HOTELING.UnlockPIN = %BWFLEXIBLESEATINGUNLOCKPIN-3%
#############################################################################################
####
Account4 Configuation
####
#############################################################################################
#Enable or disable the account4, 0:Disabled(default); 1:Enabled; Config.Account4.General.Enable = %BWLINE-BINARY-4%
#Configure the account4 label which will display on the LCD screen; Config.Account4.General.Label = %BWEXTENSION-4%
#Configure the display name of account4; Config.Account4.GENERAL.DisplayName = %BWCLID-4%
#Configure the register user name of account4; Config.Account4.GENERAL.UserName = %BWLINEPORT-4%
#Configure the user and password for register authentication; Config.Account4.GENERAL.AuthName = %BWAUTHUSER-4% Config.Account4.General.Pwd = %BWAUTHPASSWORD-4%
#Configure the SIP server address and port of account4; Config.Account4.SIP.Server = %BWHOST-4% Config.Account4.Sip.Port = 5060
Config.Account4.Sip.Server2 = Config.Account4.Sip.Port2 = 5060
#Configure the transport type; 0:UDP(Default); 1:TCP; 2:TLS; 3:DNS-NAPTR; Config.Account4.Sip.TransType = 0
#Configure the the max and min Listen Port; Config.Account4.SIP.ListenPortMin = Config.Account4.SIP.ListenPortMax =
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 58 OF 70
#Enable or Disable the outbound proxy server; Config.Account4.OutProxy.Enable = %USE_SBC_BOOLEAN%
#Configure the IP address/domain of the outbound proxy server and the server port; Config.Account4.OUTPROXY.Server = %SBC_ADDRESS% Config.Account4.OUTPROXY.Port = %SBC_PORT%
#Configure the backup outbound proxy server address and port; Config.Account4.OutProxy.BakServer = Config.Account4.OutProxy.BakPort =
#Configure the Stun feature; Config.Account4.Stun.Enable = Config.Account4.Stun.Server = Config.Account4.Stun.Port =
#Configure the DTMF type; 0:Inband; 1:RFC2833(Default); 2:Info; 3:Inband + Info; 4:Info + RFC2833; Config.Account4.DTMF.Type = 1
#Configure the RFC2833 payload, ranges from 96 to 225 (101 by default); Config.Account4.DTMF.Payload = 101
#Configure DTMF info type when using Info; 0:Disabled(default); 1:DTMF-Relay; 2:DTMF; 3:Telephone-Event; Config.Account4.DTMF.InfoType = 0
Config.Account4.DTMF.Duration = 300 Config.Account4.DTMF.Power =
#Configure the NAT keep-alive and the keep-alive interval(in seconds); Config.Account4.NAT.UdpKeepEnable = Config.Account4.NAT.UdpKeepInterval = Config.Account4.NAT.Rport =
#Configure the blf subscribe period(1800 seconds by default); Config.Account4.Blf.SubscribePeriod = 1800
#Configure the blf list uri; Config.Account4.BLF.BlfListUri = %BWBLF-URI-4%
#Configure the feature access code for directed call pickup; Config.Account4.BLF.BlfListCode =
#Configure the feature access code for directed call pickup with barge-in; Config.Account4.BLF.BlfListBargeInCode =
#Configure the voice message number; Config.Account4.VoiceMsg.Number = %BWVOICE-PORTAL-NUMBER-4%
#Configure AnonymousCall Config.Account4.ANONYMOUS_CALL.Enable = 0 Config.Account4.ANONYMOUS_CALL.OnCode = Config.Account4.ANONYMOUS_CALL.OffCode = Config.Account4.ANONYMOUS_CALL.PrivacyHeaderValue = id
#Configure Reject AnonymousCall Config.Account4.REJECT_ANONYMOUSCALL.Enable = 0 Config.Account4.REJECT_ANONYMOUSCALL.OnCode = Config.Account4.REJECT_ANONYMOUSCALL.OffCode =
#Configure the register expire time(1800 seconds by default); Config.Account4.REG.Timeout = 1800 Config.Account4.REG.Timeout2 = 1800
#configure the conference type; 0:Local Conference(default),1:Network Conference; Config.Account4.CONFERENCE.Type = 0 #configure the network conference URI; The default value is blank; Config.Account4.CONFERENCE.Uri = %BWNETWORK-CONFERENCE-SIPURI-4%
#Enable or Disable auto answer when receiving a incoming call for accout1; 0:Disabled(Default); 1:Enabled; Config.Account4.Auto_Answer.Enable =
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 59 OF 70
#Configure Session Timer Config.Account4.SESSION.EnableTimer = 0 Config.Account4.SESSION.Interval = 1800 Config.Account4.SESSION.Refresher = 0
#Configure the subscribe period of the ACD(in seconds), the range is 1800~65535, default is 1800; Config.Account4.SUBSCRIBE.SubscribeACDExpire = 1800
#Enable or Disable subscribe the MWI status; 0:Disabled(Default); 1:Enabled; Config.Account4.SUBSCRIBE.SubsribeMWI = 0
#Configure the subscribe period of the MWI(in seconds), the range is 1800~65535, default is 1800; Config.Account4.Subscribe.SubscribeMWIExpire = 1800
#Enable or Disable 100 reliable retransmission; 0:Disabled(Default); 1:Enabled; Config.Account4.Call.Enable100Rel = 0
#Configure the RTP packet time; 0(Disabled), 10, 20, 30, 40, 50, 60; Config.Account4.Call.Ptime =
#Enable or disable the DND feature; 0:Disabled(default); 1:Enabled; Config.Account4.FEATURE_DND.Enable = %BWDND-BINARY-4%
#Configure On or off Code for DND; Config.Account4.FEATURE_DND.OnCode = %BWFAC-DND-ACTIVATE-4% Config.Account4.FEATURE_DND.OffCode = %BWFAC-DND-DEACTIVATE-4%
#Configure return code for DND; the valid value is: 404(Not Found); 480(Temporarily Unavailable); 486(Busy Here); Config.Account4.DND.ReturnCode = 486
#Enable or Disable Always Forward; 0:Disabled(Default); 1:Enabled; Config.Account4.FEATURE_FORWARD_ALWAYS.Enable = %BWCFA-BINARY-4%
#Configure target phonenumber that the phone will Always Forward to; Config.Account4.FEATURE_FORWARD_ALWAYS.Target =
#Configure On or off Code for Always Forward; Config.Account4.FEATURE_FORWARD_ALWAYS.OnCode = %BWFAC-CFA-ACTIVATE-4% Config.Account4.FEATURE_FORWARD_ALWAYS.OffCode = %BWFAC-CFA-DEACTIVATE-4%
#Enable or Disable Busy Forward; 0:Disabled(Default); 1:Enabled; Config.Account4.FEATURE_FORWARD_BUSY.Enable =
#Configure target phonenumber that the phone will Busy Forward to; Config.Account4.FEATURE_FORWARD_BUSY.Target =
#Configure On or off Code for Busy Forward; Config.Account4.FEATURE_FORWARD_BUSY.OnCode = %BWFAC-CFB-ACTIVATE-4% Config.Account4.FEATURE_FORWARD_BUSY.OffCode = %BWFAC-CFB-DEACTIVATE-4%
#Enable or Disable No Answer Forward; 0:Disabled(Default); 1:Enabled; Config.Account4.FEATURE_FORWARD_TIMEOUT.Enable =
#Configure target phonenumber that the phone will No Answer Forward to; Config.Account4.FEATURE_FORWARD_TIMEOUT.Target =
#Configure On or off Code for No Answer Forward; Config.Account4.FEATURE_FORWARD_TIMEOUT.OnCode = %BWFAC-CFNA-ACTIVATE-4% Config.Account4.FEATURE_FORWARD_TIMEOUT.OffCode = %BWFAC-CFNA-DEACTIVATE-4%
#Configure No answer timeout the time after which the call will be forwarded when using No Answer Forward, the range is 0~45(in seconds); Config.Account4.FEATURE_FORWARD_TIMEOUT.TimeOut = 30
#Enable or Disable Audio codecs for account4 (X ranges from 0 to 12); Config.Account4.AudioX.Enable = Config.Account4.Audio0.Enable = 1 Config.Account4.Audio1.Enable = 1 Config.Account4.Audio2.Enable = 0 Config.Account4.Audio3.Enable = 0 Config.Account4.Audio4.Enable = 1
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 60 OF 70
Config.Account4.Audio5.Enable = 1 Config.Account4.Audio6.Enable = 0 Config.Account4.Audio7.Enable = 0 Config.Account4.Audio8.Enable = 0 Config.Account4.Audio9.Enable = 0 Config.Account4.Audio10.Enable = 0 Config.Account4.Audio11.Enable = 0 Config.Account4.Audio12.Enable = 0
#Enable or Disable Video codecs for account4 (X ranges from 0 to 2); Config.Account4.VideoX.Enable = Config.Account4.Video00.Enable = 1 Config.Account4.Video01.Enable = 1 Config.Account4.Video02.Enable = 0
#Enable or Disable advice of charge Config.Account4.AOC.AocEnable =
#Enable or Disable Broadsoft Hoteling(or Flexible Seating)
#Configure the hoteling mode; 0:otherwise, 1:hoteling host, 2:flexible seating host, 3:flexible seating guest Config.Account4.HOTELING.Mode = %BWHOTELINGMODE-4%
#Configure the PIN code to unlock screen Config.Account4.HOTELING.UnlockPIN=%BWFLEXIBLESEATINGUNLOCKPIN-4%
#############################################################################################
####
Account5 Configuation
####
#############################################################################################
#Enable or disable the account5, 0:Disabled(default); 1:Enabled; Config.Account5.General.Enable = %BWLINE-BINARY-5%
#Configure the account5 label which will display on the LCD screen; Config.Account5.General.Label = %BWEXTENSION-5%
#Configure the display name of account5; Config.Account5.GENERAL.DisplayName = %BWCLID-5%
#Configure the register user name of account5; Config.Account5.GENERAL.UserName = %BWLINEPORT-5%
#Configure the user and password for register authentication; Config.Account5.GENERAL.AuthName = %BWAUTHUSER-5% Config.Account5.General.Pwd = %BWAUTHPASSWORD-5%
#Configure the SIP server address and port of account5; Config.Account5.SIP.Server = %BWHOST-5% Config.Account5.Sip.Port = 5060
Config.Account5.Sip.Server2 = Config.Account5.Sip.Port2 = 5060
#Configure the transport type; 0:UDP(Default); 1:TCP; 2:TLS; 3:DNS-NAPTR; Config.Account5.Sip.TransType = 0
#Configure the the max and min Listen Port; Config.Account5.SIP.ListenPortMin = Config.Account5.SIP.ListenPortMax =
#Enable or Disable the outbound proxy server; Config.Account5.OutProxy.Enable = %USE_SBC_BOOLEAN%
#Configure the IP address/domain of the outbound proxy server and the server port; Config.Account5.OUTPROXY.Server = %SBC_ADDRESS% Config.Account5.OUTPROXY.Port = %SBC_PORT%
#Configure the backup outbound proxy server address and port; Config.Account5.OutProxy.BakServer = Config.Account5.OutProxy.BakPort =
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 61 OF 70
#Configure the Stun feature; Config.Account5.Stun.Enable = Config.Account5.Stun.Server = Config.Account5.Stun.Port =
#Configure the DTMF type; 0:Inband; 1:RFC2833(Default); 2:Info; 3:Inband + Info; 4:Info + RFC2833; Config.Account5.DTMF.Type = 1
#Configure the RFC2833 payload, ranges from 96 to 225 (101 by default); Config.Account5.DTMF.Payload = 101
#Configure DTMF info type when using Info; 0:Disabled(default); 1:DTMF-Relay; 2:DTMF; 3:Telephone-Event; Config.Account5.DTMF.InfoType = 0
Config.Account5.DTMF.Duration = 300 Config.Account5.DTMF.Power =
#Configure the NAT keep-alive and the keep-alive interval(in seconds); Config.Account5.NAT.UdpKeepEnable = Config.Account5.NAT.UdpKeepInterval = Config.Account5.NAT.Rport =
#Configure the blf subscribe period(1800 seconds by default); Config.Account5.Blf.SubscribePeriod = 1800
#Configure the blf list uri; Config.Account5.BLF.BlfListUri = %BWBLF-URI-5%
#Configure the feature access code for directed call pickup; Config.Account5.BLF.BlfListCode =
#Configure the feature access code for directed call pickup with barge-in; Config.Account5.BLF.BlfListBargeInCode =
#Configure the voice message number; Config.Account5.VoiceMsg.Number = %BWVOICE-PORTAL-NUMBER-5%
#Configure AnonymousCall Config.Account5.ANONYMOUS_CALL.Enable = 0 Config.Account5.ANONYMOUS_CALL.OnCode = Config.Account5.ANONYMOUS_CALL.OffCode = Config.Account5.ANONYMOUS_CALL.PrivacyHeaderValue = id
#Configure Reject AnonymousCall Config.Account5.REJECT_ANONYMOUSCALL.Enable = 0 Config.Account5.REJECT_ANONYMOUSCALL.OnCode = Config.Account5.REJECT_ANONYMOUSCALL.OffCode =
#Configure the register expire time(1800 seconds by default); Config.Account5.REG.Timeout = 1800 Config.Account5.REG.Timeout2 = 1800
#configure the conference type; 0:Local Conference(default),1:Network Conference; Config.Account5.CONFERENCE.Type = 1 #configure the network conference URI; The default value is blank; Config.Account5.CONFERENCE.Uri = %BWNETWORK-CONFERENCE-SIPURI-5%
#Enable or Disable auto answer when receiving a incoming call for accout1; 0:Disabled(Default); 1:Enabled; Config.Account5.Auto_Answer.Enable =
#Configure Session Timer Config.Account5.SESSION.EnableTimer = 0 Config.Account5.SESSION.Interval = 1800 Config.Account5.SESSION.Refresher = 0
#Configure the subscribe period of the ACD(in seconds), the range is 1800~65535, default is 1800; Config.Account5.SUBSCRIBE.SubscribeACDExpire = 1800
#Enable or Disable subscribe the MWI status; 0:Disabled(Default); 1:Enabled;
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 62 OF 70
Config.Account5.SUBSCRIBE.SubsribeMWI = 0
#Configure the subscribe period of the MWI(in seconds), the range is 1800~65535, default is 1800; Config.Account5.Subscribe.SubscribeMWIExpire = 1800
#Enable or Disable 100 reliable retransmission; 0:Disabled(Default); 1:Enabled; Config.Account5.Call.Enable100Rel = 0
#Configure the RTP packet time; 0(Disabled), 10, 20, 30, 40, 50, 60; Config.Account5.Call.Ptime =
#Enable or disable the DND feature; 0:Disabled(default); 1:Enabled; Config.Account5.FEATURE_DND.Enable = %BWDND-BINARY-5%
#Configure On or off Code for DND; Config.Account5.FEATURE_DND.OnCode = %BWFAC-DND-ACTIVATE-5% Config.Account5.FEATURE_DND.OffCode = %BWFAC-DND-DEACTIVATE-5%
#Configure return code for DND; the valid value is: 404(Not Found); 480(Temporarily Unavailable); 486(Busy Here); Config.Account5.DND.ReturnCode = 486
#Enable or Disable Always Forward; 0:Disabled(Default); 1:Enabled; Config.Account5.FEATURE_FORWARD_ALWAYS.Enable = %BWCFA-BINARY-5%
#Configure target phonenumber that the phone will Always Forward to; Config.Account5.FEATURE_FORWARD_ALWAYS.Target =
#Configure On or off Code for Always Forward; Config.Account5.FEATURE_FORWARD_ALWAYS.OnCode = %BWFAC-CFA-ACTIVATE-5% Config.Account5.FEATURE_FORWARD_ALWAYS.OffCode = %BWFAC-CFA-DEACTIVATE-5%
#Enable or Disable Busy Forward; 0:Disabled(Default); 1:Enabled; Config.Account5.FEATURE_FORWARD_BUSY.Enable =
#Configure target phonenumber that the phone will Busy Forward to; Config.Account5.FEATURE_FORWARD_BUSY.Target =
#Configure On or off Code for Busy Forward; Config.Account5.FEATURE_FORWARD_BUSY.OnCode = %BWFAC-CFB-ACTIVATE-5% Config.Account5.FEATURE_FORWARD_BUSY.OffCode = %BWFAC-CFB-DEACTIVATE-5%
#Enable or Disable No Answer Forward; 0:Disabled(Default); 1:Enabled; Config.Account5.FEATURE_FORWARD_TIMEOUT.Enable =
#Configure target phonenumber that the phone will No Answer Forward to; Config.Account5.FEATURE_FORWARD_TIMEOUT.Target =
#Configure On or off Code for No Answer Forward; Config.Account5.FEATURE_FORWARD_TIMEOUT.OnCode = %BWFAC-CFNA-ACTIVATE-5% Config.Account5.FEATURE_FORWARD_TIMEOUT.OffCode = %BWFAC-CFNA-DEACTIVATE-5%
#Configure No answer timeout the time after which the call will be forwarded when using No Answer Forward, the range is 0~45(in seconds); Config.Account5.FEATURE_FORWARD_TIMEOUT.TimeOut = 30
#Enable or Disable Audio codecs for account5 (X ranges from 0 to 12); Config.Account5.AudioX.Enable = Config.Account5.Audio0.Enable = 1 Config.Account5.Audio1.Enable = 1 Config.Account5.Audio2.Enable = 0 Config.Account5.Audio3.Enable = 0 Config.Account5.Audio4.Enable = 1 Config.Account5.Audio5.Enable = 1 Config.Account5.Audio6.Enable = 0 Config.Account5.Audio7.Enable = 0 Config.Account5.Audio8.Enable = 0 Config.Account5.Audio9.Enable = 0 Config.Account5.Audio10.Enable = 0 Config.Account5.Audio11.Enable = 0 Config.Account5.Audio12.Enable = 0
#Enable or Disable Video codecs for account5 (X ranges from 0 to 2);
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 63 OF 70
Config.Account5.VideoX.Enable = Config.Account5.Video00.Enable = 1 Config.Account5.Video01.Enable = 1 Config.Account5.Video02.Enable = 0
#Enable or Disable advice of charge Config.Account5.AOC.AocEnable =
#Enable or Disable Broadsoft Hoteling(or Flexible Seating)
#Configure the hoteling mode; 0:otherwise, 1:hoteling host, 2:flexible seating host, 3:flexible seating guest Config.Account5.HOTELING.Mode = %BWHOTELINGMODE-5%
#Configure the PIN code to unlock screen Config.Account5.HOTELING.UnlockPIN=%BWFLEXIBLESEATINGUNLOCKPIN-5%
#############################################################################################
####
Account6 Configuation
####
#############################################################################################
#Enable or disable the account6, 0:Disabled(default); 1:Enabled; Config.Account6.General.Enable = %BWLINE-BINARY-6%
#Configure the account6 label which will display on the LCD screen; Config.Account6.General.Label = %BWEXTENSION-6%
#Configure the display name of account6; Config.Account6.GENERAL.DisplayName = %BWCLID-6%
#Configure the register user name of account6; Config.Account6.GENERAL.UserName = %BWLINEPORT-6%
#Configure the user and password for register authentication; Config.Account6.GENERAL.AuthName = %BWAUTHUSER-6% Config.Account6.General.Pwd = %BWAUTHPASSWORD-6%
#Configure the SIP server address and port of account6; Config.Account6.SIP.Server = %BWHOST-6% Config.Account6.Sip.Port = 5060
Config.Account6.Sip.Server2 = Config.Account6.Sip.Port2 = 5060
#Configure the transport type; 0:UDP(Default); 1:TCP; 2:TLS; 3:DNS-NAPTR; Config.Account6.Sip.TransType = 0
#Configure the the max and min Listen Port; Config.Account6.SIP.ListenPortMin = Config.Account6.SIP.ListenPortMax =
#Enable or Disable the outbound proxy server; Config.Account6.OutProxy.Enable = %USE_SBC_BOOLEAN%
#Configure the IP address/domain of the outbound proxy server and the server port; Config.Account6.OUTPROXY.Server = %SBC_ADDRESS% Config.Account6.OUTPROXY.Port = %SBC_PORT%
#Configure the backup outbound proxy server address and port; Config.Account6.OutProxy.BakServer = Config.Account6.OutProxy.BakPort =
#Configure the Stun feature; Config.Account6.Stun.Enable = Config.Account6.Stun.Server = Config.Account6.Stun.Port =
#Configure the DTMF type; 0:Inband; 1:RFC2833(Default); 2:Info; 3:Inband + Info; 4:Info + RFC2833; Config.Account6.DTMF.Type = 1
#Configure the RFC2833 payload, ranges from 96 to 225 (101 by default);
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 64 OF 70
Config.Account6.DTMF.Payload = 101
#Configure DTMF info type when using Info; 0:Disabled(default); 1:DTMF-Relay; 2:DTMF; 3:Telephone-Event; Config.Account6.DTMF.InfoType = 0
Config.Account6.DTMF.Duration = 300 Config.Account6.DTMF.Power =
#Configure the NAT keep-alive and the keep-alive interval(in seconds); Config.Account6.NAT.UdpKeepEnable = Config.Account6.NAT.UdpKeepInterval = Config.Account6.NAT.Rport =
#Configure the blf subscribe period(1800 seconds by default); Config.Account6.Blf.SubscribePeriod = 1800
#Configure the blf list uri; Config.Account6.BLF.BlfListUri = %BWBLF-URI-6%
#Configure the feature access code for directed call pickup; Config.Account6.BLF.BlfListCode =
#Configure the feature access code for directed call pickup with barge-in; Config.Account6.BLF.BlfListBargeInCode =
#Configure the voice message number; Config.Account6.VoiceMsg.Number = %BWVOICE-PORTAL-NUMBER-6%
#Configure AnonymousCall Config.Account6.ANONYMOUS_CALL.Enable = 0 Config.Account6.ANONYMOUS_CALL.OnCode = Config.Account6.ANONYMOUS_CALL.OffCode = Config.Account6.ANONYMOUS_CALL.PrivacyHeaderValue = id
#Configure Reject AnonymousCall Config.Account6.REJECT_ANONYMOUSCALL.Enable = 0 Config.Account6.REJECT_ANONYMOUSCALL.OnCode = Config.Account6.REJECT_ANONYMOUSCALL.OffCode =
#Configure the register expire time(1800 seconds by default); Config.Account6.REG.Timeout = 1800 Config.Account6.REG.Timeout2 = 1800
#configure the conference type; 0:Local Conference(default),1:Network Conference; Config.Account6.CONFERENCE.Type = 1 #configure the network conference URI; The default value is blank; Config.Account6.CONFERENCE.Uri = %BWNETWORK-CONFERENCE-SIPURI-6%
#Enable or Disable auto answer when receiving a incoming call for accout1; 0:Disabled(Default); 1:Enabled; Config.Account6.Auto_Answer.Enable =
#Configure Session Timer Config.Account6.SESSION.EnableTimer = 0 Config.Account6.SESSION.Interval = 1800 Config.Account6.SESSION.Refresher = 0
#Configure the subscribe period of the ACD(in seconds), the range is 1800~65535, default is 1800; Config.Account6.SUBSCRIBE.SubscribeACDExpire = 1800
#Enable or Disable subscribe the MWI status; 0:Disabled(Default); 1:Enabled; Config.Account6.SUBSCRIBE.SubsribeMWI = 0
#Configure the subscribe period of the MWI(in seconds), the range is 1800~65535, default is 1800; Config.Account6.Subscribe.SubscribeMWIExpire = 1800
#Enable or Disable 100 reliable retransmission; 0:Disabled(Default); 1:Enabled; Config.Account6.Call.Enable100Rel = 0
#Configure the RTP packet time; 0(Disabled), 10, 20, 30, 40, 50, 60; Config.Account6.Call.Ptime =
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 65 OF 70
#Enable or disable the DND feature; 0:Disabled(default); 1:Enabled; Config.Account6.FEATURE_DND.Enable = %BWDND-BINARY-6%
#Configure On or off Code for DND; Config.Account6.FEATURE_DND.OnCode = %BWFAC-DND-ACTIVATE-6% Config.Account6.FEATURE_DND.OffCode = %BWFAC-DND-DEACTIVATE-6%
#Configure return code for DND; the valid value is: 404(Not Found); 480(Temporarily Unavailable); 486(Busy Here); Config.Account6.DND.ReturnCode = 486
#Enable or Disable Always Forward; 0:Disabled(Default); 1:Enabled; Config.Account6.FEATURE_FORWARD_ALWAYS.Enable = %BWCFA-BINARY-6%
#Configure target phonenumber that the phone will Always Forward to; Config.Account6.FEATURE_FORWARD_ALWAYS.Target =
#Configure On or off Code for Always Forward; Config.Account6.FEATURE_FORWARD_ALWAYS.OnCode = %BWFAC-CFA-ACTIVATE-6% Config.Account6.FEATURE_FORWARD_ALWAYS.OffCode = %BWFAC-CFA-DEACTIVATE-6%
#Enable or Disable Busy Forward; 0:Disabled(Default); 1:Enabled; Config.Account6.FEATURE_FORWARD_BUSY.Enable =
#Configure target phonenumber that the phone will Busy Forward to; Config.Account6.FEATURE_FORWARD_BUSY.Target =
#Configure On or off Code for Busy Forward; Config.Account6.FEATURE_FORWARD_BUSY.OnCode = %BWFAC-CFB-ACTIVATE-6% Config.Account6.FEATURE_FORWARD_BUSY.OffCode = %BWFAC-CFB-DEACTIVATE-6%
#Enable or Disable No Answer Forward; 0:Disabled(Default); 1:Enabled; Config.Account6.FEATURE_FORWARD_TIMEOUT.Enable =
#Configure target phonenumber that the phone will No Answer Forward to; Config.Account6.FEATURE_FORWARD_TIMEOUT.Target =
#Configure On or off Code for No Answer Forward; Config.Account6.FEATURE_FORWARD_TIMEOUT.OnCode = %BWFAC-CFNA-ACTIVATE-6% Config.Account6.FEATURE_FORWARD_TIMEOUT.OffCode = %BWFAC-CFNA-DEACTIVATE-6%
#Configure No answer timeout the time after which the call will be forwarded when using No Answer Forward, the range is 0~45(in seconds); Config.Account6.FEATURE_FORWARD_TIMEOUT.TimeOut = 30
#Enable or Disable Audio codecs for account6 (X ranges from 0 to 12); Config.Account6.AudioX.Enable = Config.Account6.Audio0.Enable = 1 Config.Account6.Audio1.Enable = 1 Config.Account6.Audio2.Enable = 0 Config.Account6.Audio3.Enable = 0 Config.Account6.Audio4.Enable = 1 Config.Account6.Audio5.Enable = 1 Config.Account6.Audio6.Enable = 0 Config.Account6.Audio7.Enable = 0 Config.Account6.Audio8.Enable = 0 Config.Account6.Audio9.Enable = 0 Config.Account6.Audio10.Enable = 0 Config.Account6.Audio11.Enable = 0 Config.Account6.Audio12.Enable = 0
#Enable or Disable Video codecs for account6 (X ranges from 0 to 2); Config.Account6.VideoX.Enable = Config.Account6.Video00.Enable = 1 Config.Account6.Video01.Enable = 1 Config.Account6.Video02.Enable = 0
#Enable or Disable advice of charge Config.Account6.AOC.AocEnable =
#Enable or Disable Broadsoft Hoteling(or Flexible Seating)
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 66 OF 70
#Configure the hoteling mode; 0:otherwise, 1:hoteling host, 2:flexible seating host, 3:flexible seating guest Config.Account6.HOTELING.Mode = %BWHOTELINGMODE-6%
#Configure the PIN code to unlock screen Config.Account6.HOTELING.UnlockPIN=%BWFLEXIBLESEATINGUNLOCKPIN-6%
#############################################################################################
####
Phone Settings Configuation
####
#############################################################################################
#Configure the language displays on the phone LCD screen, the available values are: 0English(default), 1-Chinese_s; Config.Settings.Language.Type = %BWLANGUAGE-1%
#Configure the language displays on the web page, the available values are: 0-English(default), 1-Chinese_s; Config.Settings.Language.WebLang = %BWLANGUAGE-1%
#Configure the offset time (in minutes), ranges from -300 to 300,(60 by default) the valid value is Integer; Config.Settings.DateTime.Offset = 60
#Configure the time format, 0-12 Hour, 1-24 Hour(default); Config.Settings.DateTime.TimeFormat = 1
#Enable or disable the NTP feature; 0:Disabled; 1:Enabled(default); Config.Settings.SNTP.Enable = 1
#Configure the time zone and time zone name for the phone; time zone ranges from -11 to +12 (0 by default); time zone name (GMT by default); Config.Settings.SNTP.TimeZone = %BWTIMEZONE-1% Config.Settings.SNTP.Name = %TIMEZONENAME%
#Configure the primary and secondary NTP servers. Default-0.pool.ntp.org. #The value can be the domain name or IP address of the NTP server. Config.Settings.SNTP.NTPServer1 = %SNTP_SERVER_1% Config.Settings.SNTP.NTPServer2 = %SNTP_SERVER_2%
#Configure the daylight saving time feature. 0-Disabled, 1-Enabled, 2-Automatic(default); Config.Settings.SNTP.DTS = 2
#Configure the update interval(in seconds) when using NTP Server(3600 by default); Config.Settings.SNTP.Interval = 3600
#Configure the start time of DST.(1/1/0 by default) #If the DST type is set to By Date,the value format is Month/Day/Hour; #If the DST type is set to By Week, the value format is Start Month/Start Day of Week/Start Day of Week Last in Month/Start Hour of Day. #For example,the value is 1/4/2/5, it means the start time is at 5 o'clock on Tuesday, the 4th week in January; Config.Settings.SNTP.StartTime = 1/1/0
#Configure the end time of DST, (12/31/23 by default), the value format is the same as the start time; Config.Settings.SNTP.EndTime = 12/31/23
#Configure the backlight level, Integer,0, 1, 2, 3, 4(default), 5; Config.Settings.Backlight.Level = 4
#Configure the backlight time, 0-Always off, 1-Always on, 10, 20default), 30, 40, 50, 60(, 90, 120(in seconds); Config.Settings.Backlight.Time = 20
#Configure the log level, Integer,0, 1, 2, 3(default), 4, 5, 6, 7; Config.Settings.LogLevel.Level = 3
#Configure the ring tone type, string(Ring1.wav by default); Config.Settings.RingTone.Type = Ring1.wav
#Configure the keyboard volume, the range is 1~15, default is 8; Config.Settings.Audio.KeyVol = 8
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 67 OF 70
#Configure the ring volume, the range is 1~15, default is 8; Config.Settings.Audio.RingVol = 8
#Configure the hand free volume, the range is 1~15, default is 8; Config.Settings.HandFree.SpkVol = 8 Config.Settings.HandFree.MicVol = 8 Config.Settings.HandFree.SigToneVol = 8
#Configure the hand set volume, the range is 1~15, default is 8; Config.Settings.HandSet.SpkVol = 8 Config.Settings.HandSet.MicVol = 8 Config.Settings.HandSet.SigToneVol = 8
#Configure the head set volume, the range is 1~15, default is 8; Config.Settings.HeadSet.SpkVol = 8 Config.Settings.HeadSet.MicVol = 8 Config.Settings.HeadSet.SigToneVol = 8
#Configure the login password of the advanced settings on the phone UI(admin by default); Config.Settings.Login.Password = admin
#Configure the login password of the web(admin by default); Config.Settings.Web_Login.Password = admin
#Configure the timeout of the dial in or dial out(in seconds, 60 by default); Config.Settings.CallTimeOut.DialIn = 60 Config.Settings.CallTimeOut.DialOut = 60
#Configure the distinctive ring; Config.Settings.Ringer.Keyword01 = Config.Settings.Ringer.Ringtone01 =
Config.Settings.Ringer.Keyword02 = Config.Settings.Ringer.Ringtone02 =
Config.Settings.Ringer.Keyword03 = Config.Settings.Ringer.Ringtone03 =
Config.Settings.Ringer.Keyword04 = Config.Settings.Ringer.Ringtone04 =
Config.Settings.Ringer.Keyword05 = Config.Settings.Ringer.Ringtone05 =
Config.Settings.Ringer.Keyword06 = Config.Settings.Ringer.Ringtone06 =
Config.Settings.Ringer.Keyword07 = Config.Settings.Ringer.Ringtone07 =
Config.Settings.Ringer.Keyword08 = Config.Settings.Ringer.Ringtone08 =
Config.Settings.Ringer.Keyword09 = Config.Settings.Ringer.Ringtone09 =
Config.Settings.Ringer.Keyword10 = Config.Settings.Ringer.Ringtone10 =
#############################################################################################
####
Voice Configuation
####
#############################################################################################
#Enable or disable the phone to detect the silence, 0-Disbaled (default),1-Enabled; Config.Voice.General.VAD = 0
#Enable or disable the phone to generate comfortable noise, 0-Disabled, 1-Enabled; Config.Voice.General.CNG = 1
#Configure the side tone,the value ranges from-32768 to -3; the default value is -32768; Config.Voice.General.SideTone = -32768
#Enable or disable the phone to cancel echo, 0-Disabled, 1-Enabled (default);
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 68 OF 70
Config.Voice.General.EchoCanceller = 1
#Enable or disable jitter buffer, 0-Disabled, 1-Enabled (default); Config.Voice.Jitter.Enable = 1
#Configure the type of jitter buffer, 0-Fixed, 1-Adaptive (default); Config.Voice.Jitter.Adaptive = 1
#Configure the minimum delay(0 by default), maximum delay(300 by default) and normal delay (120 by default); Config.Voice.Jitter.Min = 0 Config.Voice.Jitter.Max = 300 Config.Voice.Jitter.Nominal = 120
#Configure the type of voice tone; 0:Custom; 1:Default; 2:China; 3:Spain; 4:Luxembourg; 5:Sweden; 6:Taiwan; 7:Belgium; 8:Denmark; 9:Finland; 10:Germany; 11:Netherlands; 12:Norways; 13:Protugal; Config.Voice.Tone.Country = 1
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 69 OF 70
References
[1] Akuvox, Inc. 2017. Akuvox SIP-based Devices Administrator Guide, Release V1.1. Available from Akuvox at www.akuvox.com.
[2] BroadSoft, Inc. 2017. BroadWorks Device Management Configuration Guide, Release 22.0. Available from BroadSoft at xchange.broadsoft.com.
[3] BroadSoft, Inc. 2017. BroadWorks Redundancy Guide, Release 22.0. Available from BroadSoft at xchange.broadsoft.com.
[4] BroadSoft, Inc. 2016. BroadWorks SIP Access Interface Interworking Guide, Release 22.0. Available from BroadSoft at xchange.broadsoft.com.
[5] BroadSoft, Inc. 2017. BroadWorks SIP Phone Interoperability Test Plan, Release 22.0. Available from BroadSoft at xchange.broadsoft.com.
[6] BroadSoft, Inc. 2017. BroadWorks SIP Phone XSI and XMPP Test Plan, Release 22.0. Available from BroadSoft at xchange.broadsoft.com.
[7] BroadSoft, Inc. 2017. BroadWorks Device Management Interoperability Test Plan, Release 22.0. Available from BroadSoft at xchange.broadsoft.com.
[8] BroadSoft, Inc. 2016. BroadWorks CPE Kit Usage Guide, Release 22.0. Available from BroadSoft at xchange.broadsoft.com.
BROADSOFT PARTNER CONFIGURATION GUIDE AKUVOX SIP-BASED DEVICES ©2017 BROADSOFT INC.
20-BD5426-00 PAGE 70 OF 70
BroadSoft, Inc. Adobe PDF Library 11.0