EM-IPX-330 2100 2200 2500 (v3) v3.0
EM-IPX-330 2100 2200 2500 (v3) v3.0
IPX-330/IPX-2100/IPX-2200/IPX-2500
IPX-330 / IPX2100
IPX-2200 / IPX-2500
Internet Telephony PBX System
IPX-330/IPX-2100/IPX-2200/IPX-2500
Copyright
Copyright (C) 2018 PLANET Technology Corp. All rights reserved.
The products and programs described in this User’s Manual are licensed products of PLANET
Technology. This User’s Manual contains proprietary information protected by copyright, and
this User’s Manual and all accompanying hardware, software, and documentation are
copyrighted.
No part of this User’s Manual may be copied, photocopied, reproduced, translated, or reduced
to any electronic medium or machine-readable form by any means by electronic or mechanical
including photocopying, recording, or information storage and retrieval systems, for any
purpose other than the purchaser's personal use, and without the prior written permission of
PLANET Technology.
Disclaimer
PLANET Technology does not warrant that the hardware will work properly in all environments
and applications, and makes no warranty and representation, either implied or expressed, with
respect to the quality, performance, merchantability, or fitness for a particular purpose.
PLANET has made every effort to ensure that this User’s Manual is accurate; PLANET
disclaims liability for any inaccuracies or omissions that may have occurred.
Information in this User’s Manual is subject to change without notice and does not represent a
commitment on the part of PLANET. PLANET assumes no responsibility for any inaccuracies
that may be contained in this User’s Manual. PLANET makes no commitment to update or
keep current the information in this User’s Manual, and reserves the right to make
improvements to this User’s Manual and/or to the products described in this User’s Manual, at
any time without notice.
If user finds information in this manual that is incorrect, misleading, or incomplete, we would
appreciate user comments and suggestions.
CE Mark Warning
This is a class B device. In a domestic environment, this product may cause radio interference,
in which case the user may be required to take adequate measures.
WEEE Warning
To avoid the potential effects on the environment and human health as a result of
the presence of hazardous substances in electrical and electronic equipment, end
users of electrical and electronic equipment should understand the meaning of the
crossed-out wheeled bin symbol. Do not dispose of WEEE as unsorted municipal
waste and have to collect such WEEE separately.
Trademarks
The PLANET logo is a trademark of PLANET Technology. This documentation may refer to
numerous hardware and software products by their trade names. In most, if not all cases, their
respective companies claim these designations as trademarks or registered trademarks.
Revision
User’s Manual of PLANET Internet Telephony PBX System
Model: IPX-330/IPX-2100/IPX-2200/IPX-2500
Rev: 3 (May, 2018)
Internet Telephony PBX System
IPX-330/IPX-2100/IPX-2200/IPX-2500
Table of Contents
Introduction ..................................................................................................................................- 1 -
Features.................................................................................................................................- 5 -
Package Contents ..................................................................................................................- 7 -
Physical Specifications of IPX-330 .........................................................................................- 8 -
Physical Specifications of IPX-2100 .......................................................................................- 9 -
Physical Specifications of IPX-2200 / IPX-2500................................................................... - 10 -
Plug-in modules for IPX-2100/IPX-2200/IPX-2500 ............................................................. - 12 -
Specifications ..................................................................................................................... - 15 -
Installation Procedure ........................................................................................................ - 27 -
New System Setup Wizard ................................................................................................. - 27 -
Extensions .................................................................................................................................. - 33 -
Departments ...................................................................................................................... - 33 -
IP Extensions ...................................................................................................................... - 34 -
Analog Extensions .............................................................................................................. - 38 -
Inbound Control ......................................................................................................................... - 39 -
Inbound Destinations ......................................................................................................... - 39 -
IVR ...................................................................................................................................... - 39 -
Time Conditions ................................................................................................................. - 41 -
Inbound Routes .................................................................................................................. - 42 -
Direct Routing .................................................................................................................... - 43 -
Inbound Fax ........................................................................................................................ - 45 -
Blacklist .............................................................................................................................. - 46 -
Outbound Control ...................................................................................................................... - 47 -
Trunks ................................................................................................................................. - 47 -
FXO/GSM/WCDMA Trunks (IPX-21FO/IPX-21GS/IPX-21MA) ..................................... - 47 -
E1 Trunks (IPX-21PR) .................................................................................................. - 48 -
BRI Trunks (IPX-21BRv2) ............................................................................................. - 49 -
VoIP Trunks ................................................................................................................. - 50 -
Dial Rules ............................................................................................................................ - 52 -
Dial Permissions ................................................................................................................. - 53 -
PIN Sets .............................................................................................................................. - 55 -
Audio Library .............................................................................................................................. - 56 -
Music On Hold .................................................................................................................... - 56 -
IVR Prompts........................................................................................................................ - 56 -
Custom Prompts................................................................................................................. - 57 -
Advanced Features ..................................................................................................................... - 58 -
Call Forward ....................................................................................................................... - 58 -
Follow Me........................................................................................................................... - 59 -
Wake Up Call ...................................................................................................................... - 60 -
Conference ......................................................................................................................... - 61 -
DISA .................................................................................................................................... - 62 -
Paging & Intercom .............................................................................................................. - 63 -
Call Queue .......................................................................................................................... - 64 -
Internet Telephony PBX System
IPX-330/IPX-2100/IPX-2200/IPX-2500
Model
-1-
Off-net Calling Capability, Call Restriction, Call Access Control
The IPX-330 comes with 2 FXO ports and the IPX-2000 series integrates up to 8 calls via the IPX-21FO (4
FXO), IPX-21SL (2 FXO + 2 FXS) and IPX-21GS (4 GSM) modules to form a feature-rich PBX system that
supports seamless communications between the existing PSTN calls, analog phones, IP phones and
SIP-based endpoints.
With the Internet Telephony PBX system, home users and companies are able to save the installation cost and
extend their past investments in telephones, conferences and speakerphones. The Internet Telephony PBX
-2-
system can be the bridge between the traditional analog system and IP network without having to invest
heavily.
Standard Compliance
Compliant with the Session Initiation Protocol 2.0 (RFC 3261), the Internet Telephony PBX system is able to
broadly interoperate with equipment provided by VoIP infrastructure providers, thus enabling them to provide
their customers with better multi-media exchange services.
Green IP Office
The Fax to Email/Email to Fax service provided by the Internet Telephony PBX system allows users to transfer
and receive faxes directly to or from your email inbox as file attachments. It is an easy and confidential way of
receiving, storing and forwarding important fax documents, thus creating a paperless green office.
-3-
-4-
Features
System Highlights
15 concurrent calls and up to 30 registers (For IPX-330)
30 concurrent calls and up to 100 registers (For IPX-2100)
60 concurrent calls and up to 200 registers (For IPX-2200)
100 concurrent calls and up to 500 registers (For IPX-2500)
HD voice codec G.722 to perfect voice quality
Fax to Email/Email to Fax for green office
Voicemail to Email for not missing any important message
Paging and intercom function strengthens work efficiency
Built-in SIP Proxy Server following RFC 3261
Multiple Language of GUI for international business
Web-based Control Panel for easy configuration and management of the system
Strong security features protect your system from hacking
Supports maximum 8 ports for FXO/GSM (on 2 slots)
Supports 2 FXO interfaces (For IPX-330)
Records voice and voicemail to external USB disk
Supports Lync server
-5-
PBX Features
Black List
BLF (Busy Lamp Field)
CDR (Call Detailed Record)
Conference Room (20 rooms)
DID (Direct Inward Dialing Number)
DISA (Direct Inward System Access)
DND/Feature Codes/Flash Operation Panel
Follow Me/Auto-Provision
IVR (Interactive Voice Responses)
Multi-language System Prompt
Multiple-language GUI
Phone Book/PIN Set
LDAP Server for phonebook
Record Files downloaded
Ring Group/SIP Trunk
Skype for SIP/Smart DID/System Log
T.38 Fax (pass-through)/time-based rule
Virtual Fax, Voicemail and Voice Mail to E-Mail
Call Features
Call Back, Call Forward, Call Group
Call Hold, Call Paging and Intercom
Call Park, Call Pickup, Call Queue
Call Record, Call Route, Blind Transfer
Attend Transfer, Call Waiting
Caller ID, Dial by Name
Customized IVR, On-hold Music, Transfer
Three-way Conferencing, Video Call
-6-
Package Contents
Thank you for purchasing PLANET Internet Telephony PBX system. Open the box of the Internet Telephony
PBX system and carefully unpack it. The box should contain the following items:
If any of the above items are damaged or missing, please contact your dealer immediately.
-7-
Physical Specifications of IPX-330
Front Panel
Rear Panel
LED definitions
Identification Indication Status Specification
On Power on
PWR Power Status
Off Power off
On Connected but no data transmitting
WAN WAN Status Blink Data transmitting
Off Disconnected
On Connected but no data transmitting
LAN LAN Status Blink Data transmitting
Off Disconnected
Red Channel available
FXO 1~ FXO 2 FXO Status
Off Channel failure
On System initiating
SYS System Status Blink System is functioning
Off System failure
-8-
Physical Specifications of IPX-2100
Front Panel
Rear Panel
LED definitions
-9-
Physical Specifications of IPX-2200 / IPX-2500
Front Panel
LED definitions
Identification Indication Status Specification
Green Power On
PWR Power States
Off Power Off
Wink System is Running
SYS System States
Off System Booting or Failed
WAN/LAN Interface Wink Data Transmitting
WAN/LAN
States Off No Data Transmitting
Green Channel Loading Succeeded
FXS
Off Channel Loading Failed
Red Channel Loading Succeeded
FXO
Off Channel Loading Failed
Red Channel Loading Succeeded
GSM/WCDMA
Off Channel Loading Failed
Red Module Loading Succeeded
Slot 1 and Slot 2 L1
1-4 (Slot 1/2) Off Module Loading Failed
States
Red/Off CPE Signaling
E1/T1 Green/Off NET Signaling
L2/L3
(PRI/R2) Off/Red SS7 Signaling
Off/Green R2 Signaling
Green Connected (No Alarm)
L4
Red Disconnected (Alarm)
Red TE Mode
BRI Green NT Mode
Off Module Loading Failed
- 10 -
Physical interface description
1 Power Switch Switch the power on or off
1. Supporting 2 slots, user can buy expansion module like IPX-21FO (4 x FXO) or IPX-21GS (4 x
GSM) for extending port service.
2. If IPX-21GS is used, please disable pin lock function. Otherwise, dial out or call in will not
be available.
- 11 -
Plug-in modules for IPX-2100/IPX-2200/IPX-2500
IPX-21FO Module
IPX-21FO module provides 4 FXO interfaces for connecting PSTN lines provided by the telecom. It can be installed
on both slots of IPX-2100, IPX-2200 and IPX-2500 and provides maximal 8 FXO interfaces.
IPX-21GS Module
IPX-21GS module provides 4 GSM channels; it can be installed on IPX-2100, IPX-2200 and IPX-2500 for making and
receiving phone calls from GSM network. It is designed with SIM900 for global market; SIM900 is a quad-band
GSM engine that works on frequencies GSM 850MHz, EGSM 900MHz, DCS 1800MHz and PCS 1900MHz.
The IPX-21FS module provides 4 FXS interfaces for connecting fax machines or analog phones. It can be installed
on both slots of IPX-2100, IPX-2200 and IPX-2500 and provides maximal 8 FXS interfaces.
- 12 -
IPX-21SL Module (by project order)
The IPX-21SL module provides 2 FXO and 2 FXS interfaces; it can be installed on both slots of the IPX-2100,
IPX-2200 and IPX-2500. With the IPX-21SL module installed, it enables the IPPBX system with FXO to FXS lifeline
feature. When there’s power failure, you may still use the analog phone to make and receive phone calls.
The IPX-21MA (WCDMA) module provides 4 GSM/3G voice channels; it can be installed on IPX-2100, IPX-2200 and
IPX-2500 for making and receiving phone calls from the GSM/3G network. It is designed with SIM5320 series
module for global market, the SIM5320 is a dual-band WCDMA and quad-band GSM engine that works on
frequencies like UMTS 850MHz, UMTS 900MHz, UMTS 1900MHz, UMTS 2100MHz, GSM 850MHz, EGSM 900MHz,
DCS 1800MHz and PCS 1900MHz.
WCDMA modules for PLANET IP PBX series IPPBXs are only used for voice phone calls; they
CANNOT be used for data transmission from 3G network.
- 13 -
IPX-21BR Module (by project order)
The IPX-21BR module provides 4 BRI interfaces which can be configured to work in NT or TE mode. It can be
installed on IPX-2200 and IPX-2500 but not IPX-2100. Regarding the IPX-2200 and IPX-2500, only one 4BRI module
can be installed. And if it’s going to be installed with other modules (IPX-21FO, IPX-21FS, IPX-21GS, IPX-21MA
modules), it should be installed in Slot 2. The IPX-21BR cannot be installed with E1 module like the IPX-2200 or
IPX-2500.
The E1/T1 module provided a RJ48 interface which could be configured to work in E1 (PRI-NET, PRI-CPE, R2, SS7
signaling) and T1 mode. You can install 2 E1/T1 modules on both IPX-2200 and IPX-2500. If it’s going to be installed
with other modules (IPX-21FO, IPX-21FS, IPX-21GS and IPX-21MA), it should be installed on Slot 2. And the E1/T1
module cannot be installed with BRI module like the IPX-2200 or IPX-2500.
- 14 -
Specifications
IPX-330
Product
Internet Telephony PBX system (30 SIP Users registrations)
Hardware
- 15 -
RFC 3261, RFC 3311, RFC 3515
RFC 3265, RFC 3892, RFC 3361
RFC 3842, RFC 3389, RFC 3489
RFC 3428, RFC 2327, RFC 2833
RFC 2976, RFC 3263
Voice Codec G.711-Ulaw, G.711-Alaw, G.722, G.726, G.729, GSM, Speex and Opus
SIP 2.0 (RFC 3261), TCP/IP, UDP/RTP/RTCP, HTTP, ICMP, ARP, DNS, DHCP,
Protocols
NTP/SNTP, PPP, PPPoE
Internet Sharing
Features
- 16 -
DND (Do Not Disturb)
FOP (Flash Operation Panel) Status Monitoring
IVR (Interactive Voice Responses)
Follow Me, Call Spy and PIN Set
Distinctive Ringtone
Multi-language System Prompt
Multiple Language of GUI
Phone Book, Speed Dial
LDAP Server for phonebook
Record Files Download
Ring Group, SIP Trunk
Skype for SIP, Smart DID, System Log
T.38 fax (pass-through), voicemail and voicemail to e-mail
Time-based Rule
PBX log, web access log and PBX debug log
System Capacity
SYS: 1, LNK/Off
WAN: 1, LNK/Off
LED Indications LAN: 1, LNK/Off
PWR: 1, LNK/Off
FXO: 1~2, Red
- 17 -
IPX-2100
Product
Internet Telephony PBX system (100 SIP Users registrations)
Hardware
- 18 -
RFC 3428, RFC 2327, RFC 2833
RFC 2976, RFC 3263
Voice Codec G.711-Ulaw, G.711-Alaw, G.722, G.726, G.729, GSM, Speex and Opus
SIP 2.0 (RFC 3261), TCP/IP, UDP/RTP/RTCP, HTTP, ICMP, ARP, DNS, DHCP,
Protocols
NTP/SNTP, PPP, PPPoE
Internet Sharing
Features
- 19 -
Follow Me, Call Spy and PIN Set
Distinctive Ringtone
Multi-language System Prompt
Multiple Language of GUI
Phone Book, Speed Dial
LDAP Server for phonebook
Record Files Download
Ring Group, SIP Trunk
Skype for SIP, Smart DID, System Log
T.38 fax (pass-through), voicemail and voicemail to e-mail
Time-based Rule
PBX log, web access log and PBX debug log
System Capacity
SYS: 1, LNK/Off
WAN: 1, LNK/Off
LED Indications LAN: 1, LNK/Off
PWR: 1, LNK/Off
SLOT: FXO/GSM (Red), FXS (Green)
- 20 -
IPX-2200
Product
Internet Telephony PBX system (200 SIP Users registrations)
Hardware
- 21 -
RFC 3265, RFC 3892, RFC 3361
RFC 3842, RFC 3389, RFC 3489
RFC 3428, RFC 2327, RFC 2833
RFC 2976, RFC 3263
TCP/IP, UDP/RTP/RTCP, HTTP, ICMP, ARP, DNS, DHCP, NTP/SNTP, PPP, PPPoE
Voice Codec G.711-Ulaw, G.711-Alaw, G.722, G.726, G.729, GSM, Speex and Opus
Internet Sharing
Features
- 22 -
IVR (Interactive Voice Responses)
Follow Me, Call Spy and PIN Set
Distinctive Ringtone
Multi-language System Prompt
Multiple Language of GUI
Phone Book, Speed Dial
LDAP Server for phonebook
Record Files Download
Ring Group, SIP Trunk
Skype for SIP, Smart DID, System Log
T.38 fax (pass-through), voicemail and voicemail to e-mail
Time-based Rule
PBX log, web access log and PBX debug log
System Capacity
SYS: 1, LNK/Off
WAN: 1, LNK/Off
LED Indications LAN: 1, LNK/Off
PWR: 1, LNK/Off
SLOT: FXO/GSM (Red), FXS (Green)
- 23 -
IPX-2500
Product
Internet Telephony PBX system (500 SIP Users registrations)
Hardware
Voice Codec G.711-Ulaw, G.711-Alaw, G.722, G.726, G.729, GSM, Speex and Opus
- 24 -
Video Codec H.261, H.263, H.263+, H.264 and VP8
Internet Sharing
Features
- 25 -
Record Files Download
Ring Group, SIP Trunk
Skype for SIP, Smart DID, System Log
T.38 fax (pass-through), voicemail and voicemail to e-mail
Time-based Rule
PBX log, web access log and PBX debug log
System Capacity
SYS: 1, LNK/Off
WAN: 1, LNK/Off
LED Indications LAN: 1, LNK/Off
PWR: 1, LNK/Off
SLOT: FXO/GSM (Red), FXS (Green)
- 26 -
Installation Procedure
You may skip the wizard here by clicking on button. Or choose your native language to begin with the
wizard, if it’s not in the list then choose one that you familiar with. Once done, please click on button to
continue.
- 27 -
Step 2: Network Settings
Change the network profiles per your local WAN environment. Once done, click on the button, it
will take several seconds and you will be directed to the new page with new IP address automatically. Once done,
please click on button to continue.
Step 3: Location
- 28 -
Select the country/region you live in, the location you selected will also tell the IPPBX system which time zone and
tone zone you want the IPPBX to use. And some other regional settings will be defined as well.
This step is only for IPX-2200 and IPX-2500. If you have installed FXS/FXO/GSM/WCDMA modules on both Slots
then just simply click on button to continue. If you have installed E1/T1/BRI modules, please select the
module type accordingly. For more configurations please refer to Module Settings.
- 29 -
According to your company organization structure you can add departments and extensions here per each
department.
Specify the department name and number of the members, and then click on button to add another
department the same way. Once done, specify a start extension number and click on button to continue.
The operator extension is usually the extension number of the company receptionist or secretary. Please specify
the extension number here, in certain circumstances calls will be sent directly to this extension for information.
- 30 -
Admin account can be customized that you can use any user name you prefer. For security reasons, please do not
use weak administrator credentials.
Operator account has limited permissions compare to Admin user. It can be used by the operator user to manage
extension numbers of the company, setup calling features, manage call logs and recordings.
“Enable AMI” option can be used to enable CTI (Computer Telephony Integration) connectivity using the operator
account. Please keep it disabled if there’s no such requirement.
- 31 -
Mail server will be used to send out email notifications from the IPPBX system. Please select a mail service
provider from the list. Supported mail service providers’ default settings will be filled in automatically. If the mail
service provider of yours is not in the list please choose “Other”.
Once done, please click on button, now system will reboot for new settings take effect. If IPX-330 or
IPX-2100, you’ll have to wait around 4 minutes then refresh the page. If IPX-2200 or IPX-2500, it will take around 2
minutes to reboot, after this please refresh the page. Now you should see the login page like the screenshot
shown below.
Please use the admin credentials you defined during the installation wizard to sign in.
The admin user name and password are defined by during the installation wizard process. If you have skipped the
wizard, you’ll need to log in with the default username and password which are both “admin”. Once you have
modified the network profile during the quick installation wizard or after admin login, then you can power off and
deploy the IPPBX system to your local LAN, and then power it on for further configurations.
(Default IP) For increased security, please use https to access IP PBX.
For security reason, please change and memorize the new password after this first setup.
- 32 -
Extensions
Path: Telephony -> Extensions
Extensions and departments should have been created during the Quick Setup Wizard process. You may manage
extensions and departments here on this screen. If you have skipped the Quick Setup Wizard, you may create
them here on this screen as well.
Departments
If you have created departments and extensions from Quick Setup Wizard, you should see all your departments
and extensions here.
If you wish to create a new department, please click on the Add button. Specify the department name and select
member extensions and then submit.
If you wish to modify department settings, please click on the button, or click on the button to remove
a department.
- 33 -
You may change the department name from the Department Name textbox.
In the Ring Strategy dropdown list select a desired ring strategy of how to ring the department (Ring Group)
extensions upon incoming calls.
Ring All: Ring all available member extensions until one answers (default).
Leastrecent: Ring the extension of the member who has least recently received a call.
Fewestcalls: Ring the extension of the member who has taken the fewest number of calls.
Random: Ring the extension of a random member.
RRMemory: The system remembers which member was last called and begins the round robin with the
next agent.
Linear: Starting with the first member, ring the extension of each member in turn until the call is
answered.
RROrdered: Same as RRMemory, except the department member order is preserved.
In Destination if no answer dropdown list select a call destination for the inbound calls when no one answers
the call.
You may add/remove members of your department from the Select Department Members field.
IP Extensions
The extensions are created through the quick setup wizard, to check or modify the extension properties please
click the button.
- 34 -
User Name: Alias of this extension which can be the name of the extension user.
Password: The password is used for the phones to register or by the extension user to sign in the extension
web portal. This can be set manually or can be generated by the IPPBX system. Auto generated password
consists of numbers, letters and special characters.
Email: Email address of this extension user.
Outbound CID: Choose a number to show the external called party. This feature only works with E1/T1, BRI
and SIP trunks if the telco/ITSP (Internet Telephony Service Provider) allows this number to be passed.
Music On Hold: When the user holds a call the caller will listen to music, and the music can be set up here.
Mobile Number: The mobile phone number of the extension user.
Dial Permission: Defines which type of numbers the extension can dial.
Language: If the extension user is not a native speaker of the system default language, you may set a
different language for this user.
- 35 -
Before doing this please ensure the extension uses a strong password.
Simultaneous Register Count: The extensions could be registered on up to 5 different SIP endpoints at the
same time, by default the value is 2. When there are already 2 registers the 3rd register will be responded
with a 403 error.
Video Call: You may enable/disable video call support of this extension.
Video Codecs: Supported video codecs are H.261, H.263, H.263+, H.264, VP8.
Web Portal: If enabled, users can use their extension number and password to login to the IPPBX system web
GUI.
Call Recording: This is an automated recording option, you may choose to automatically record the inbound,
outbound or both inbound and outbound calls from/to this extension.
Call Spy: Call Spy feature allows the phone calls of this extension to be monitored from other extensions,
please refer to Call Spy Feature Codes for how to monitor phone calls.
Register Expiration: Default register expiration time, default value 120 seconds.
Transport Protocol: The transport protocol to be used by SIP signaling. By default it uses UDP protocol, if you
choose to use TCP or TLS please make sure the SIP IP phone or softphone uses the same protocol. Otherwise
you’ll get “403” error on SIP register.
DTMF Mode: Defines how the system detects DTMF tones, the default setting is RFC4733, it can be changed
if necessary.
SRTP: Secure Real-time Transport Protocol (SRTP) encrypts the RTP traffic to secure your VoIP phone calls.
Before enabling this option you need to ensure the SIP endpoint can also support SRTP.
Qualify: The IPPBX system sends a SIP OPTIONS command regularly to check that the device is still online.
NAT: Enable this option if extension user or the phone is behind a router.
Audio Codecs: PLANET IPPBX system supported audio codecs such as G.711 (ulaw, alaw), G.722, G.726, G.729,
GSM, Opus and Speex. The sequence of the audio codecs listed here is the sequence of the audio codecs to
be used for negotiating the media of a phone call to be established.
- 36 -
If you want more extensions to be created or if you had skipped the quick setup wizard so no extension had been
created, you may click on button to add a new extension or click on button to create bulk
extensions.
The extensions’ properties could be set while you are creating them.
Define a Start Extension Number and the number of extensions to be created in the Count field.
If you want to associate outbound CID numbers to the extensions, you’ll need to specify the first CID number
in the Start Outbound CID field and in the CID Calculation field specify the calculating of the following CID
numbers. Otherwise leave these two blanks.
In the Password field you may leave it blank so the created extensions will use random passwords or you can
define a password so the created extensions will share the same password.
As for other options, you may configure accordingly per your demands. The features/options configured will be
applied to all newly created extensions.
- 37 -
Analog Extensions
The Channel column and Extension column list the FXS interfaces and the corresponding extension numbers. They
are generated by the IPPBX system which cannot be modified.
You may click on the button to change settings if necessary.
- 38 -
Inbound Control
Path: Telephony -> Inbound Control
The Inbound Control section is where you define how IPPBX system handles incoming calls. Typically, you
determine the phone number that outside callers have called (DID Number) and then indicate which extension,
Ring Group, Voicemail, or other destination to which the call should be directed.
Inbound Destinations
A call destination in IPPBX system might be an IVR menu that instructs the callers to press certain digits to route
their calls, a queue to wait for specific telephone services, a ring group to call a number of user extensions, or
virtually any other type of process to route the call in whatever way is desired. A call may have several
destinations throughout its lifespan.
Below is a list of call destinations available in IPPBX system:
IVR: Strictly speaking, IVR is not an actual call destination. The calls landed on IVR menu will finally be
directed to other call destinations even another IVR menu and this is how you create multi-layer IVRs.
Extension: to ring a specific extension.
Voicemail: direct the caller to the voicemail box of a specific extension.
Trunk: direct the inbound call to a selected trunk and dial a specified number, it’s mostly used when the
IPPBX system is applied as a gateway.
Department (Ring Group): to ring the extensions of a department at this same time, in other words,
department equals to a ring group. If you want to exclude some extensions from the ring group, please
disable “Ring Group Member” option from the department edit screen.
Conference: to send the caller to a specific conference room.
Queue: to send the caller to a specific call queue.
Paging Group: to send the caller to a paging group, so the caller could make a public address to the paging
group members externally.
Hangup: to hangup the call directly.
Fax: to handover the call to IPPBX system and handled by Inbound Fax settings.
IVR
- 39 -
In order to create an IVR menu, please click on the button, you’ll see a popup dialog as below:
- 40 -
Time Conditions
This example shows the company opens from Monday to Friday. On each weekday, it opens from 9 am to 12 pm,
after a 2-hour break then opens from 2 pm to 6 pm. Any other time durations unspecified will be considered as
non-business hours.
In order to exclude holidays from the weekdays, you’ll also have to set up holidays.
Please ensure you add all upcoming holidays to the holiday list.
- 41 -
Now you could apply this time rule to the Inbound Routes.
Inbound Routes
- 42 -
In the Time Conditions drop-down list, select a time rule for this trunk, so the inbound calls will be routed on time
basis.
In the Business Hours field you should select a calling destination for business hours, and in the Non-business
Hours field select a calling destination for non-business hours.
Distinctive Ringtone is optional, if needed, you may specify the ringtone name of the phone, so when the callers
call in from this trunk the phone will ring this specific ringtone. It requires the phone supporting distinctive
ringtone feature.
This is how you configure inbound routes for a trunk, you may configure the same inbound routes for other trunks
or use different inbound route settings per your requirements.
Direct Routing
In the popup window, specify one of your DID numbers, and assign a call destination for all inbound calls by calling
this DID number.
- 43 -
In the above example, 94088322 is one of your DID numbers, you may configure it with an extension number,
when someone calls this number the call will then directly go to the selected extension.
In the Distinctive Ringtone field you may specify the ringtone name of the phone, so when the callers call the DID
number and the call goes to this extension the phone will ring this specific ringtone. It requires the phone
supporting distinctive ringtone feature.
To add a Direct Routing rule base on the caller’s number, please click “Add” button as shown below.
In the popup window, specify the caller’s number, and assign a call destination for inbound calls from this external
phone number.
Once this Direct Routing is created, all phone calls coming from the number 69032354 will then all go to extension
106, no matter when and from which trunk the call is coming in.
- 44 -
Inbound Fax
Virtual Fax feature on IPPBX system has the ability to automatically detect incoming fax and send the fax to one of
the destinations as below:
Save to System
Send as Email
Fax Machine
If the Fax Destination is set to Save in System.
The received faxes will be saved in the IPPBX system internal storage. Admin user and operator user are able to
check faxes on Reports -> System Logging -> Fax Logs page.
You’ll have to give an Email address for the IPPBX to send the receive faxes to this Email address. Each fax will be
attached to the Email in .tif format.
If your IPPBX system has been equipped with FXS ports, you may set the Fax Destination to Fax Machine.
In the dropdown list, select the analog (FXS port) extension number which has the fax machine attached. When
inbound fax detected, it will be directed to the fax machine.
- 45 -
Blacklist
By specifying a number in the top right number blank, you may add a number to the system blacklist.
To add blacklist numbers by using a template file, please click on button to download the
template file and edit with MS Excel, once done upload it from this page, the numbers you added in the template
file will be added to the system blacklist.
If you want to share the blacklist numbers on other IPPBX systems, you may download it by clicking the
button to download all blacklist numbers in a file and upload on other IPPBX systems.
- 46 -
Outbound Control
By default if you’ve not configured any outbound control settings, the extension users are not able to make
outbound phone calls yet. Please follow the instructions of this chapter to configure the IPPBX system for
outbound phone calls.
Trunks
A trunk on an IPPBX system is essential for extensions to be able to make outbound phone calls. On IPPBX system,
the trunks will be detected and generated automatically at the first time of the system initialization.
If needed you may edit the trunk settings by click on the button, or you may select the same type of trunks
and click on button to edit settings of the trunks together.
Select the parameters you wish to configure before modifying them. Usually if the trunks are working fine please
do not change these settings.
Call recording: To enable or disable call recording on the trunk/trunks. To enable recording you have options
- 47 -
to record inbound calls only, outbound calls only or both inbound and outbound calls.
Output Volume: Sets the volume of the outgoing calls from the FXO channels.
Input Volume: Sets the volume of the incoming calls from the FXO channels.
Answer Polarity Detection: When enabled, FXO (FXS signaled) ports watch for a polarity reversal to mark
when an outgoing call is answered by the remote party.
Hangup Polarity Detection: In certain countries, a polarity reversal is used to signal the disconnection of a
phone line. If enabled, the calls will be considered “hang up” on a polarity reversal.
Prompts Language: You can choose a desired language of the system voice prompts to play to the incoming
calls from this trunk. For example, if the call is not answered or the user is busy, the IPPBX system will notify
the caller to leave a voice message in the language you set.
Busy Detection: Enable busy tone detection, it is also possible to specify how many busy tones to wait for
before hanging up.
Busy Count: Specify how many busy tones to wait for before hanging up, and it’s configurable only if Busy
Detection is enabled.
Busy Pattern: If busy detection is enabled, it is also possible to specify the cadence of your busy signal.
E1 Trunks (IPX-21PR)
- 48 -
Call recording: To enable or disable call recording on the trunk/trunks. To enable recording you have options
to record inbound calls only, outbound calls only or both inbound and outbound calls.
Overlap Dial: Overlap dialing mode (sending overlap digits).
Outbound CID: The number you want to display to the called party.
Reset Interval: To set the time in seconds between restart of unused B channels.
Pri Indication: To enable this to report Busy and Congestion on a PRI using out-of-band notification.
Switch Type: To set the type of PRI switch being used by the telephony provider.
Prompts Language: Custom a system voice prompts language for the callers calling in from this trunk.
Fax Detect: Enable/disable fax detection on this trunk.
Dial Permission: Custom dial permission for this trunk, by default it uses the “Extension” dial permission.
Configure only if this trunk is used for PBX integration, so calls coming from the other side can dial out from
this IPPBX trunk directly. DO NOT change unless you fully understand how this feature works.
Preferred outbound CID: To set preferred outbound CID of this trunk of the extensions.
- 49 -
Call recording: To enable or disable call recording on the trunk/trunks. To enable recording you have options
to record inbound calls only, outbound calls only or both inbound and outbound calls.
Overlap Dial: Overlap dialing mode (sending overlap digits).
Outbound CID: The number you want to display to the called party.
Reset Interval: To set the time in seconds between restart of unused B channels.
Pri Indication: To enable this to report Busy and Congestion on a BRI using out-of-band notification.
Switch Type: To set the type of PRI switch being used by the telephony provider.
Prompts Language: Custom a system voice prompts language for the callers calling in from this trunk.
Fax Detect: To enable/disable fax detection on this trunk.
Dial Permission: Custom dial permission for this trunk, by default it uses the “Extension” dial permission.
Configure only if this trunk is used for PBX integration, so calls coming from the other side can dial out from
this IPPBX trunk directly. DO NOT change unless you fully understand how this feature works.
Preferred outbound CID: To set preferred outbound CID of this trunk of the extensions.
VoIP Trunks
Most of the trunk settings will be given by the service provider, settings that are not mentioned by the provider
you may leave them blank or use default values.
Authentication: If the service provider doesn't require a username and password for this account to register
to their server then you can enable this option.
Host: The SIP server domain or IP address.
Username: Username provided by VoIP Provider.
- 50 -
Password: Password provided by VoIP Provider.
Contact: Contact user to use in an outbound call request through this trunk.
Retry Interval: Once registration expired, retry interval is the number of seconds system will wait before
attempting to send another register request to the server.
Trunk Type: In practical applications, client mode VoIP trunks are the most commonly used to connect to the
VoIP providers for low cost, long distance and international phone calls, while server mode is only used when
users want to do SIP trunking between IPPBXs.
Registration Expiration: Expiration time of registration in seconds.
Max Retry: Defines how many times the IPPBX system will attempt to register to the server before
permanently giving up.
More advanced settings.
- 51 -
providers use UDP as default transport protocol.
Prompts Language: You can choose a desired language of the system voice prompts to play for the incoming
calls from this trunk. For example, if the call is not answered or the user is busy, the IPPBX system will notify
the caller to leave a voice message in the language you set.
Simultaneous Calls: This option will limit the number of simultaneous outbound calls can be made through
this trunk, leave it blank as not limited.
Preferred Outbound CID: To set preferred outbound CID of this trunk of the extensions.
From Domain: Your service provider’s domain name.
Dial Permission: Custom dial permission for this trunk, by default it uses the “default” dial permission.
Configure only if this trunk is for branch office integration, so calls coming from the other side can dial out
from this IPPBX trunk directly. DO NOT change unless you fully understand how this feature works.
Dial Rules
First of all in the Dial Rule Name blank specify a name to identify this dial rule.
In the Time Conditions dropdown list, you may select a time condition for this dial rule, so this dial rule will
only be available to be used at business hours.
- 52 -
Prepend option is used to always add specific digit/digits in front of the actual dialed number after the Dial
Prefix is deleted. These extra digits will be sent along with the actual number to the service provider to
exchange. For example, if you want to always add an area code in front of the dialed number, you can spcify
the area code in front of the dialed number, you can specify the area code here, otherwise leave this field
blank.
Dial Prefix is the first digit users have to dial while they want to make calls through the trunk/trunks selected
in this dial rule. The system will strip the prefix from the number that is sent to the trunk.
Dial Patterns act like a filter for matching numbers dialed with trunks. The various patterns you can enter are
similar to Asterisk's definition of them:
X — Refers to any digit between 0 and 9
N — Refers to any digit between 2 and 9
Z — Any digit that is not zero. (E.g. 1 to 9)
. — Wildcard. Match any number of anything. Must match *something*.
Pin Set is a collection of PIN codes for granting outbound phone calls.
Call Method sets how to use the selected trunks for outbound phone calls.
Linear: Always take the first available trunk, if the first trunk is busy it will try the second trunk, if the
second trunk is busy it will try the third, and so on.
Linear Cycle: Always take the next trunk, the trunk which the last had taken will not be used, it will call
out through the next one directly.
Double click one of the trunks or drag-and-drop to move the trunks from Available Trunks field to Selected
Trunks field. The selected trunks will be used by this dial rule for outbound phone calls.
If you want all users to use the same dial rule for outbound phone calls, a dial prefix may not be
necessary. But please make sure all available trunks should be included in the Selected Trunks field,
otherwise unselected trunks will never be used.
If you want to set different dial rules please make sure the dial rules use different dial prefixes.
Dial Permissions
- 53 -
In the Dial Rules section by moving the dial rules from the Available Rules field to the Selected Rules field to
enable the dial rules in this dial permission. In the above given example, 2 dial rules had been enabled. The
“Dial-FXO” rule is used to make phone calls through CO lines (land lines). The “dial-sip-trunk” rule is used to
make phone call through the SIP trunk. So if you assign this dial permission to the extension users, they will
be able to make outbound phone call both through CO lines and the SIP trunk.
In the Internal Permissions section by switching the internal call features on/off to enable/disable the call
features.
Extension: Allow/Disallow dialing other extension numbers.
Paging & Intercom: Allow/Disallow dialing paging & intercom group numbers.
Conference: Allow/Disallow using conference feature.
Parked Call: Allow/Disallow answering the parked calls.
DISA: Allow/Disallow using DISA feature.
Pickup Exten: Allow/Disallow pickup phone calls on other extensions.
Feature Codes: Allow/Disallow using feature codes.
Queue: Allow/Disallow dialing the call queue numbers.
IVR: Allow/Disallow dialing IVR extensions.
Spy: Allow/Disallow spying on other extensions’ phone calls.
Audio Console: Allow/Disallow using feature code to broadcast through audio out interface (IPX-2200
and IPX-2500 only).
By default all extensions use the default dial permission “DialPlan1”, if you have created new dial permissions,
please don’t forget to assign them to the extensions from Telephony -> Extensions -> IP Extensions and Telephony
-> Extensions -> Analog Extensions (if there are analog extensions) page.
- 54 -
PIN Sets
The PIN codes could be any digits that you want, but usually recommended it to be 3 to 5 digits meaningless
numbers.
You could distribute these PIN codes out to each of the extension users or several of them to share a same PIN per
your demand. If the PIN set is implemented on a dial rule or DISA, the IPPBX system will ask them to enter one of
those PIN codes before they can call out.
The PIN codes also can be used to query call logs and recordings, so even if the extension user dialed a number
from another extension if PIN code is used you’ll know who actually made that call.
- 55 -
Audio Library
Music On Hold
Give this folder a name and set the playback mode as shuffle (random playback) or in turn (playback in order).
Once done click on “Submit”.
Now click on button to upload audio files to the newly created folder one by one.
Supported File Format: MP3, WAV(8KHz, 16bit, Mono)
IVR Prompts
- 56 -
The recorded audio could be MP3 or WAV (16bit, 8KHz, Mono) format.
After uploading, you may playback on the web by clicking button or playback on a phone by clicking on the
button.
Custom Prompts
- 57 -
Advanced Features
Call Forward
By enabling Passthrough Caller ID option to cause the IPPBX system passing the actual caller ID to the target
number while forwarding.
Notify Caller before Forwarding option allows you to choose a voice prompts to be played to the caller to
notify caller that the call will be forwarded. The voice prompts is uploaded from Telephony -> Audio Library ->
Other Custom Prompts page. If this option is not enabled, the call will be forwarded without notifying the
caller.
To configure call forward please click on the button. And follow the explanations to complete the
configurations as below.
In the Forward Extension dropdown list select the extension to be configured with call forward.
In Forward Type dropdown list select the condition of when to forward the incoming calls.
In the Number field specify the number to receive the forwarded phone calls. If it’s another internal
extension number, just fill in with that extension number. If it’s an external number, you’ll have to specify the
dial prefix in front of the actual number. In this case, the actual number is 65302387, the dial prefix is 9.
In the forward list, you may disable or enable items based on requirements.
- 58 -
Call forward could be configured by Admin user and the operator user, and even by extension user from extension
user web portal or by extension users from their phones by feature codes, please refer to Call Forward feature
codes.
Follow Me
Always Take Call: If enabled the forwarded call will be answered directly by a destination number, if disabled,
when the forwarded call reaches the destination number, IPPBX system will give the destination number
choices to decline or answer the call.
Record Caller Name: Ask the caller to say his/her name and record the name, so it can be announced to each
destination number.
Add a follow me feature like below.
- 59 -
Select the Extension which will be configured with Follow Me.
Ring Duration (Sec): To set the time in seconds to ring the extension before Follow Me process starts.
Follow Me List: The list of numbers to be reached in order.
Number and Timeout (Sec): The number to be reached and the time to ring this number before trying the
next one. If the number is an external number, don’t forget to add a dial prefix in front of it.
Take the above settings as example, when extension 121 gets an incoming call, if it’s not answered in 30 seconds,
the call will be forwarded firstly to 122 and ring this extension for 30 seconds, if still not answered, it will try
number 65302387 (9 is the dial prefix, not part of the number) for another 30 seconds. If extension 122 answered
the call then 65302387 will not be called. If the call didn’t answer by any of the numbers listed in Follow Me List,
the Follow Me process will end and the caller will be disconnected.
Wake Up Call
Click on Date and Time field to schedule the date and time for the wakeup call.
Click on Now to fill in the blank with the current date and time, and then you can modify as per your requirements.
- 60 -
Or you may choose a date and then click on Set Time to set the exact time of the scheduled wakeup call.
In Extensions field you could select one or more extensions as you wish.
When it’s time for wakeup call, IPPBX system will ring the selected extension/extensions. After user answering the
wakeup call, IPPBX system will give user options to “Confirm” wakeup call or to “Snooze”. If user press a key to
confirm wakeup call then the schedule is completed, if user chooses to snooze, then the wakeup call will ring back
later as per the user selected by key press.
If a wakeup call is not answered, system will try to ring back in the next minute, and will retry 2 times, after which
system will consider the wakeup call completed, and the schedule will be canceled.
Conference
There are totally 10 conference numbers could be used. Only users who dial the same conference number could
hear one another.
There are options for each conference for you to customize the conference feature. Please click the button to
change the options if needed.
- 61 -
Guest Password is for ordinary conference users, only the users who enter the correct password can join in
the conference.
Admin Password is for conference admin, only the user/users who enter the admin password will become
the conference administrator. Conference admin can invite other numbers to join in the conference by using
Conference feature codes.
Dial Permission could be used by the conference admin user to dial other numbers and invite them to join in
the conference. By default, all conferences use Internal dial permission, which means by default the
conference admin could only invite internal extension numbers to join in the conference, if inviting external
number is necessary, please select a valid dial permission which could be used to dial external numbers.
Leader Wait, if enabled, the conference will start when the conference admin entered. Before conference
admin joining in, all other participants will be waiting with background music on.
Announce Callers option causes the IPPBX system to notify all conference participants about new
participants join-in. Before a new participant joining in the conference, the IPPBX system will ask the
participant to say his/her name, once done, system playback the recorded name to other participants and at
the same time, new participant joins in.
Call Recording option determines whether the conferences to be held in this “conference room” should be
recorded or not.
DISA
- 62 -
In the PIN Code dropdown list select a valid PIN Set. The PIN codes of this PIN set will be used to authorize all
callers using the system features and facilities.
Response Timeout(sec):The maximum waiting duration before hanging up if the dialed number is incomplete
or invalid. Defaulted 10 seconds
Digit Timeout(sec):The maximum interval time between digits when typing extension number. Defaulted 5
seconds.
Extension for this DISA: If you want to access DISA by dialing an extension, you can define an extension
number for this DISA.
Dial Permission: Select a dial permission for this DISA so callers will be able to make outbound phone calls
using the trunks on the IPPBX system.
In the Group Number field, a default group number is given. The number could be changed within the Paging
- 63 -
Group Extension Number Range listed on Telephony -> Preferences -> Global PBX Options page, Extension
Ranges section.
In the Name field a name should be given to identify this paging group.
In the Mode dropdown list, if “Simplex” is selected, calling the group number will page on the group
members, if “Duplex”, the group members are able to talk back to the caller (intercom).
In the Group Members field, select the desired user extensions, make sure all extensions you selected are
desktop based IP phones, otherwise if the phone is an analog one, paging/intercom will not work.
Except group paging and intercom, extension users could also paging/intercom an individual extension by using
feature codes, please refer to introductions in Other feature codes section.
Call Queue
- 64 -
Ring All: Ring all available agents until one answers (default).
Leastrecent: Ring the extension of the Agent who has least recently received a call.
Fewestcalls: Ring the extension of the Agent who has taken the fewest number of calls.
Random: Ring the extension of a random Agent.
RRMemory: The system remembers which agent was last called and begins the round robin with the
next agent.
Linear: Starting with the first agent, ring the extension of each agent in turn until the call is answered.
RROrdered: Same as RRMemory, except the queue member order is preserved.
In the Music On Hold dropdown list select a music folder as hold music when callers are waiting in the queue.
Static Agents are extensions that are assumed to always be in the queue. Static agents do not need to “log in”
to the queue, and cannot “log out” of the queue.
Dynamic Agents are extensions that can log in and out of the queue. Extensions selected here will NOT
automatically be logged in to the queue.
More advanced options for call queue is available, please click on button to show advanced options,
they are optional but might be useful to improve the callers’ experiences.
Auto Fill if it’s set to be Yes, and multiple agents are available, the PBX will send one call to each waiting
agent (depending on the ring strategy). Otherwise, it will hold all calls while it tries to find an agent for the
- 65 -
top call in the queue, making the other callers wait.
Agent TimeOut specifies the number of seconds to ring an agent’s extension before sending the call to the
next Agent (based on Ring Strategy).
If an agent’s extension rings and the agent fails to answer the call, Auto Pause option can automatically
pause that agent to stop them receiving further calls from the queue.
Wrap Up time is the amount of time in seconds that an agent has to complete work on a call after which the
call is disconnected.
If Report Hold Time is enabled, it will report to the agent about how long the caller had been waiting in the
queue.
The value of Max Callers limits the maximum amount of callers can wait in the queue (Default is 0 --
unlimited). When the maximum number of callers in the queue is reached, subsequent callers will be sent to
the If no answer destination.
If Add Queue Name Caller ID option is enabled, when an incoming call is distributed to an agent the queue
name will be displayed on the phone screen along with the caller ID. So a call queue agent knows which call
queue the call is coming from. This feature is helpful if an agent belongs to multiple call queues.
Calls that have been waiting in the queue for Max Wait Time(Sec) will be sent to the If no answer destination.
If left blank, there will not be any time limitation of waiting time.
Join Empty option allows callers to enter the queue when no agents are available. If this option is not
enabled, callers will not be able to enter the queue without available agents - callers will be sent to the If no
answer destination.
Leave When Empty option if it's enabled and calls are still in the queue when the last agent logs out, the
remaining callers in the Queue will be transferred to the If no answer destination. This option cannot be used
with Join Empty at the same time.
You may set the system to playback announcements to the callers while they are waiting in the queue. Please click
on the button to setup customized announcements.
- 66 -
Caller Position Announcements is used to tell the callers how they’ve been waiting and the position in the
queue.
Announce Hold Time: Announce to the callers of the time they have been waiting, the first minute
callers waiting in the queue will not hear such announcements.
Announce Position: If set to be Yes, the system will announce the position of the caller is currently
waiting in the queue.
Broadcast Frequency(Sec): To defines how often to announce queue position and estimate hold time.
Periodic Announcements can be used to periodically playback a voice prompts to the callers waiting in the
queue.
Repeat Frequency(Sec): The time interval to repeat this periodic announcements.
Announcements Prompts: To select a voice prompts to be periodically played to the waiting callers.
Destination if no answer sets the final destination for the callers if no one answers the call when they were
in the queue.
After setting up the queue, you may use internal extensions (non-agent extensions) to call the queue number to
verify the queue settings.
Smart DID
In Time of Validation dropdown list choose how long the system to save these outbound call records. When the
records expired, the inbound calls will be routed according to you inbound routes settings.
In Apply to Trunk/Trunks field, you have to select the trunk/trunks Smart DID feature will be applied to.
- 67 -
Phonebook
Phonebook feature for IPPBX is just like a contact list on the mobile phones. You may add contacts to the IPPBX
system, when the contacts calling in, on the ringing user extension phone screen will display the caller number
and the contact name you have added before. If the number didn’t match any contacts in the phonebook, then
only caller number will be displayed on the ringing phone screen.
You may click on the button to add a new contact from the popup window.
Or you may export the phonebook template file to add the contacts by MS Excel and then upload the file to
generate contacts.
Contacts could be added by admin user from admin web interface, by operator from operator web interface and
by extension user from extension user web portal.
A contact added by admin user and operator user is visible to all extension users, but a contact added by an
extension user is only visible to the user who added it and the admin and operator user, other extensions won’t be
able to see it.
LDAP
- 68 -
Feature Codes
Path: Telephony -> Feature Codes
Feature codes can be dialed from user extensions to enable and disable certain features or to achieve some call
features. For example, enable and disable call forward, transfer incoming calls, check voice messages, etc.
Dial *60 and you will enter the main menu of voicemail feature, by specifying the extension number and voicemail
password of the required extension then you can check its voicemail and you can do this for any extension by
following the system voice guidance.
By dialing *61 from an extension and entering the voicemail password for this extension you can follow the voice
guidance to check voicemail of your own extension. Or alternatively, you can configure some advanced options for
your voicemail box.
Call pickup feature codes allow users to pick up calls that are not directed to them by dialing a feature code *8 or
**.
If there’s an incoming call ringing on an extension that belongs to your department, you may dial the general call
pickup feature code *8 (end with #) to pick up the call. While if there are 2 ringing extensions in your department,
by dialing *8 will pick up the first incoming call. If you need to pick up the second incoming call or if you don’t
know which call came first, you may use direct call pickup feature code.
Direct call pickup feature code could be used to pick up an incoming call on a specific extension, no matter the
extension is from the same department or from another department. Just dial ** following by the extension
number (end with #) you’ll be able to pick up the incoming call on that specific extension.
- 69 -
Call Parking feature codes
Call parking feature allows anyone who has received a call to park the call on an extension, allowing any other user
to access the parked call.
To park a call, extension user could dial *4 during a live call, and then listen as the system tells you where you can
retrieve the call (usually extension 41). The second call will be parked on 42, and it continues to park on orderly.
To retrieve the parked calls, user should dial the retrieve number given by the IPPBX system. And this could be
done by any extension.
A call could be parked for maximally 120 seconds before it goes back to the extension which parked it. And the
parking lot (call retrieve numbers) could be monitored by BLF. It’s helpful if the operator wants to know if there
are calls parked on the IPPBX system.
Call Transfer is used to transfer a call in progress to some other destinations. There are two types of call transfer.
Attended call transfer - Where the call is placed on hold, a call is placed to another party, and a conversation
can take place privately before the caller on hold is connected to the new destination. It is also referred to
"Supervised Call Transfer".
Blind call transfer - Where the call is transferred to the other destinations without intervention (the other
destination could ring out and may not be answered for instance).
In a live call, you can press # key and the IPPBX system prompts “Transfer”, you then enter the number to transfer
to, this call will be transferred instantly and the user can hang up. If the transferred number doesn’t answer this
call then it will go to voicemail.
If blind transfer sometimes seems inappropriate, you may use attended transfer feature. In a live call, you can
press *2 and the IPPBX system prompts “Transfer”, you then enter the number to transfer to, after someone
answers your call, you can introduce this call and hang up at which point the call is transferred.
In an attended transfer, if the third party rang for 15 seconds without answering, the extension user will go back to
the caller and the transfer is terminated. You may also manually abort the transfer by pressing * when the third
- 70 -
party is still ringing.
Black list feature codes allow the extension users to add external phone numbers to IPPBX system blacklist from
their phones, consequently the numbers added will not be able to dial in to the IPPBX system.
Adding blacklist numbers from phone by using feature codes is the same as adding blacklist numbers from admin
and operator UI.
Blacklist the last caller allows you to dial *76 to directly add the last caller’s number to the IPPBX blacklist.
You may also dial *75 (end with #) and follow the voice prompts to specify the number you wish to blacklist to add
numbers to the IPPBX system blacklist.
To remove numbers from black list (whitelist a number), you can dial *075 (end with #) and follow the voice
prompts to specify the number you wish to whitelist.
Call Spy allows users to dial the spy feature codes following by an extension number to listen to the call
conversation in real-time.
Normal Spy: For example, extension 410 is talking to someone on the phone, you can dial *90410 (end with #)
to listen to their conversation, however, neither speaker will be able to hear you.
Whisper Spy: Whisper spy is also known as coaching. For example, a new employee is talking to the customer
on the phone, their supervisor can dial *91 following by the employee’s extension number (end with #) to
listen to their conversation. The supervisor can talk to the new employee only without the customer hearing
the conversation.
Barge Spy: Barge spy is similar to an instant 3-way conference call. While an extension user is talking to
someone else on the phone, you can dial *92 following by their extension number (end with #) to talk to
both of the speakers.
- 71 -
Before you can spy on an extension, please enable “Call Spy” option on the extension edit popup
window.
Call queue feature codes are for call queue agent extensions only. They are meaningless to the non-agent
extensions.
Agent Login and Agent Logout are for dynamic agents to login or out of the call queue. And for both static agents
and dynamic agents, they can dial *95 to suspend their extensions temporarily, new calls will not be distributed to
their extensions, until they dial *095 to resume.
Conference feature codes are used by conference admin for inviting participants to join in a conference or for
creating a conference during a normal phone call.
When in a conference room, if the conference admin user presses 0 they will get a dial tone for inviting others to
participate in this conference.
If the invited party agrees to join in the conference, conference admin user can dial ** to return to the conference
with invited party.
If the invited party doesn’t want to join in the conference, conference admin user can press *# to return to the
conference without the invited party.
During a live call the extension user can press *0 to create a dynamic conference room. The other side will
automatically enter the conference as an ordinary participant while the extension user who created this
conference will be requested to enter the conference password to enter. Usually the user needs to enter the
conference admin user password as the user needs to invite others to join in the conference.
- 72 -
After a dynamic conference is created, in reality you have entered a static conference room (by default
90 is the first available conference room). You are able to use conference admin menu to invite others
to the conference and also others can dial 90 to enter this conference.
Except configuring Wakeup Calls from admin and operator web user interface, extension users could request
wakeup calls from their phones directly by feature codes.
Cancel All Wakeup Calls: By dialing this code to cancel all requested wakeup calls.
Direct Wakeup Call Request: Add a wakeup call directly by dialing this feature code followed by a specific
date and time in 8-digit number format, for example, feature code is *55*, you can dial *55*08010730 to add
a wakeup call of 7:30am on August 1st.
Wakeup Call Main Menu: Advanced wakeup call menu for adding, viewing and canceling wakeup calls.
Call forward could be configured from admin and operator web user interface. With the following feature codes,
extension users can activate or deactivate call forward directly from their phones without configuration on the
Web GUI.
For example, a IPPBX requires prefix 9 to call outbound, and the number you want to forward the calls to is
85337096.
Forward All Activate: Dial *71985337096, press 1 to confirm.
Deactivate Forward All: Dial *071.
- 73 -
Activate Forward on Busy: Dial *72985337096, press 1 to confirm.
Deactivate Forward on Busy: Dial *072.
Activate Forward on No Answer: Dial *73985337096, press 1 to confirm.
Deactivate Forward on No Answer: Dial *073.
DND (Do Not Disturb) could be set on the IP phones from the phone level, if the phone doesn’t have DND feature
you may use the DND feature code to set DND from IPPBX system level. Any phone connected to the IPPBX system
can use the DND feature code, no matter it’s IP phone, analog phone or softphone.
Simply dial *74 to enable DND, if you hear a beep sound that means DND is on. Once DND enabled, the extension
will only be able to make calls, and inbound calls will be rejected.
Make sure when you are ready to receive inbound calls, dial *074 to deactivate DND.
Announce WAN Port IP: By dialing this code you'll hear the system announce the IP address of the IPPBX
WAN interface.
Announce LAN Port IP: By dialing this code you'll hear the system announce the IP address of the IPPBX LAN
interface.
Announce Extension Number: By dialing this code you can check the extension number of your phone, either
it’s an IP phone or analog phone.
One Touch Recording: One Touch Recording is also known as Record on Demand. It allows users to record
phone calls selectively. In a live call conversation, an extension user can use feature code *1 to record this call.
- 74 -
With this feature, you don’t have to configure recording all calls for the extensions which may cause heavy
system resource use if some call recordings are not required.
Intercom: The intercom feature code allows you to intercom one extension only. You don’t have to create a
“Paging and Intercom” group for only one extension if you intend to intercom with only that extension.
Paging: The paging feature code allows you to page one extension only. It’s the same as the intercom feature
code, the only difference between paging feature code and intercom feature code is by using intercom
feature code both sides can talk to each other but using paging feature code, only the caller can talk to the
called party.
Audio Console: A speaker could be connected to the 3.5mm audio out (available on IPX-2200 and IPX-2500)
interface, extension user could dial *911 to deliver a public address from the audio out interface.
- 75 -
Preferences
Operator Extension: Choose an extension to be operator extension. When an incoming call has been directed
to voicemail, then by pressing ‘0’ the caller will be put through to the operator extension.
Global Ring Time: If it’s not specifically configured, an incoming call will ring the extension for the time given
here.
Outbound Call Transfer: Allow outbound phone calls to be transferred, if enabled it might cause phone call
problem in certain situations. For example, an outbound phone call had been placed to another IVR system,
the keypress might be recognized as transfer request on your own IPPBX system.
Music On Ringback: If enabled, callers will hear music instead of ringback tone when calling extensions.
Auto Answer: Auto-answer enables the IPPBX to automatically answer the inbound calls from analog ports.
PPI: The P-Preferred-Identity (PPI) header is used among trusted SIP entities (typically intermediaries) to
carry the identity of the user sending a SIP message as it was verified by authentication.
Analog Fast Sent Number: This parameter will always add a # at the end of the numbers dialed through the
PSTN lines, it will cause the carrier to forward the calls immediately instead of waiting till digits timeout. If
your PSTN line carrier supports this feature, you may enable it for faster outbound phone calls via PSTN.
- 76 -
The user extension number and system extension number ranges are defined here to avoid any conflicts within
the IPPBX system. You can modify these number ranges as per your requirements.
VoIP Advanced
UDP Port: SIP over UDP service port. By default IPPBX system uses UDP as SIP transmission protocol. Port
number can be changed here if required. If changed on the IPPBX system, you’ll also have to change on the
SIP clients.
TCP Port: If the IP phones support TCP protocol, you can register SIP extensions over TCP protocol on port
5061.
TLS Port: If the IP phones support TLS protocol, you can register SIP extensions over TLS protocol on port
5062.
ICE Enable: This is specific to clients that support NAT traversal for media via ICE, STUN, TURN. By default,
please keep it enabled, otherwise WebRTC won't work, STUN Server Address can be left blank.
STUN Server Address: By default please keep it blank, if you got available STUN server, please specify the
valid server address, otherwise an invalid STUN server address will cause phone system exception.
RTP Port Range: The UDP ports used by the IPPBX system to carry RTP voice stream. Do not change the port
range or you may encounter audio issue with phone calls.
User Agent: The default user agent string also contains the Asterisk version. If you don't want to expose it,
change the user agent string here.
External Media Address: If you want to map your IPPBX system to the Internet, you should specify the static
- 77 -
public IP address or domain name here.
External Signaling Address: This is similar to External Media Address except that the External Signaling
Address is looked up regularly (every 10s).
UDP Signaling Address Port: Port number of SIP signaling with UDP transport protocol on the public network.
TCP Signaling Address Port: Port number of SIP signaling with TCP transport protocol on the public network.
TLS Signaling Address Port: Port number of SIP signaling with TLS transport protocol on the public network.
Local Net (IP/Netmask Length): Your local network address/addresses.
If you are going to map your IPPBX system to the Internet, the following configurations should be done.
1. SIP port mapping on your router (one of the following: UDP: 5060; TCP: 5061; TLS: 5062).
2. RTP port mapping on your router (UDP: 10001 to 10500).
3. Specify External Media Address and External Signaling Address.
4. Specify your local network address/addresses.
5. For extensions remote registration, enable “Remote Extension” on extension edit popup window.
Mapping your IPPBX to the Internet will be risky, for security precautions please always use strong
passwords.
IAX2 extension support had been enabled by default for all extensions. And IAX2 works on UDP port 4569, you
may modify the port number if required.
Asterisk supports different QoS settings at the application level for various protocols on both signaling and media.
The Type of Service (TOS) byte can be set on outgoing IP packets for various protocols. The TOS byte is used by the
network to provide some level of Quality of Service (QoS) even if the network is congested with other traffic.
- 78 -
Analog Settings
Global Analog Settings are used for configuring the IPPBX system to seamlessly work with the telephone lines from
your telecommunications providers.
Caller ID Signaling: The signaling type applied on the PSTN lines to pass caller ID.
Bell-US—Also known as Bellcore FSK. Used in the Canada, China, Hong Kong and US.
DTMF—Dual Tone Multi-Frequency. Used in Denmark, Finland and Sweden.
V23—Mostly used in UK.
V23-Japan—Mostly used in Japan.
Caller ID Start: Defines when the caller ID starts.
Ring—Caller ID starts when a ring is received.
Polarity—Caller ID starts when polarity reversal starts.
Polarity(India)—Can be used in India.
Before Ring—Caller ID starts before a ring received.
CID Buffer Length: The buffer length can be used to store caller ID info.
Ring Debounce: Sets the minimum time in milliseconds to debounce extraneous ring events.
DTMF Hits Begin: Sampling matching value of DTMF caller ID digits, you can choose 1 to 5 digits been
matched then to consider it as part of the Caller ID.
DTMF Misses End: Sample matching value of DTMF caller ID digits, you can choose 1 to 5 digits been
mismatched then to consider it’s not part of the caller ID.
Detect Caller ID After: Sets the IPPBX to detect Caller ID after how many rings been detected.
Opermode: Set the Opermode for FXO Ports.
ToneZone: Select the tone zone of your country.
Send Caller ID After: Certain countries (UK) have ring tones with different ring tones (ring-ring),which means
the caller ID needs to be set later on, and not just after the first ring, as per the default (1).
Denoise: The denoise parameter will help on noise reduction of the noisy analog lines, especially when gains
have been increased on the lines.
- 79 -
Module Settings
Module Settings are only for configuring digital module cards (El/T1, BRI) on IPX-2200 and IPX-2500
IPPBX systems. Ignore this part if you are using FXS/FXO/GSM/WCDMA modules.
E1 PRI Signaling
E1 module can be installed on both Slot 1 and Slot 2. To ensure IPX-2200/IPX-2500 IPPBX can detect and drive E1
module in the Module Type field, you should choose “E1/T1”.
- 80 -
T1 PRI Signaling
To configure PLANET E1 telephony module to work in T1 mode, please choose T1 in the Mode dropdown list. And
then configure T1 related parameters given by the telephony provider.
T1 runs on same signaling types as E1 mode. And T1 uses different Framing and Coding methods, configure these
parameters according to the details provided by the telephony provider. In most cases CRC4 is not needed for T1
circuit, enable it only when the provider requires it.
After configurations been done, save and reboot the IPPBX system. In the meantime you attach the T1 line to the
T1 interface. After rebooting you should get LED indication with L1 red, L2 red, L3 off, L4 green to indication PRI
CPE signaling. For more details of the LED indications please check IPX-2200 and IPX-2500 chapter in the LED
Indication section.
MFC/R2 Signaling
In the E1 settings section and Signaling field by selecting R2 you are able to configure E1 R2 signaling.
In Signaling field select R2, Framing and Coding should use default value. Below in the R2 Signaling Settings
section set the R2 parameters.
- 81 -
Variant: Protocol variant setting depends on country and carries.
Max ANI: The maximum expected number of ANI digits.
Max DNIS: The expected number of dialed digits.
Get ANI First: The usual behavior for incoming calls is to get the calling party category and the ANI as soon as
possible, and to get the DNIS afterwards. This doesn't work on all systems, so the option to reverse this
behavior is provided.
Advanced Protocol File: Additional configurations for R2 signaling.
Category: Send calling party’s category. Usually National Subscriber works just fine, you can set other options
if needed in real application.
SS7 Signaling
Signaling System No.7 (SS7) is a set of telephony protocols that can be delivered via E1 and T1. In the E1 settings
section and Signaling field by selecting SS7, you are able to configure E1 SS7 signaling.
From the Signaling dropdown list, you should select SS7., Framing and Coding should be used as default value.
Below in the SS7 Settings section set the detailed SS7 parameters.
- 82 -
Please configure these parameters according to the instructions of the service provider or ask for advice from our
support team. Otherwise, please do not change these settings without professional guidance.
BRI Settings
BRI module can only be installed on Slot 2 of PLANET IPX-2200 and IPX-2500 IPPBX systems. The BRI modules you
have received the jumpers on the module should be set on V2 position by default, please refer to following
pictures to check the jumpers before installing.
- 83 -
The jumpers shown in the picture below are for crossover cables and straight cables to connect a BRI connection.
The jumpers for Port 1, 2 and Port 3, 4 are on different position. Attach the BRI lines to these ports and then
configure BRI parameters.
- 84 -
Reports
Call Logs
In the Type dropdown list choose Outbound, Inbound or Internal to search outbound calls, inbound call or
internal calls only.
In From and To fields set the start and end date to search call logs within this period of time.
By specifying the name of a trunk in the Trunk Name field to search the inbound or outbound calls came in or
sent out through this specific trunk only.
In the PIN Code field specify a PIN code of a PIN Set to search outbound calls made by using this PIN code.
The searching results might look like below.
The time when this call took place will be listed in the Start Time column.
In the Call From column lists the original caller of the calls.
In the Call To column lists the first callee but might not be the last.
The Final Callee column lists the extension/destination where the call finally ends.
In the Duration column lists the call duration of each phone calls, this might not be the exact talk time, as
when calling though the FXO ports, IPPBX system will auto answer the inbound calls so IVR works, and it will
auto answer the outbound calls, so the IPPBX could send the numbers out through the PSTN lines.
In the Trunk Name column lists the trunks used by those phone calls. Internal call will not take any trunk so
this blank will be blank for internal calls.
In the PIN Code column, only those outbound calls made out with a PIN code will list the PIN code used here.
This is a good idea to tell which user/users made the call, as the PIN codes are not shared by every extension
user. Every extension may have a PIN different than others or several extension users share a PIN code that is
different than others.
In the Type column it indicates the type of each phone call, inbound, outbound or internal.
In the Status column you could tell if the calls are successfully made or failed for any reason.
The Call Recording column indicates which calls are recorded and which ones are not.
You may download the search results as a CSV file by clicking on the button, or you may
download all the call logs by clicking on .
- 85 -
Call Recordings
Call Recordings
Type could be used to search the call recording according to outbound, inbound and internal calls.
Call From could be used to search according to a specific caller’s number (optional).
Call To could be used to search according to a specific callee’s number (optional).
Trunk Name could be used to search according to the inbound/outbound trunk’s name (optional).
PIN Code could be used only for those calls which are dialed out with PIN codes define in PIN Set (optional).
The searched recordings will be displayed in a list with some detailed information.
You may playback the recording by built-in web player by clicking on the button.
Conference Recordings
From the Number dropdown list, you may specify the conference number and search for recordings of the specific
conference number only.
The searched recordings will be listed with detailed information of when the conference calls were started, the
conference number and the call/record durations. There are also the same options to play back, download and
delete the recording files.
- 86 -
One Touch Recordings
- 87 -
System Logging
Fax Logs
By downloading the .tif file to your operating system you may view the fax details.
In the From and To fields set the start and end date. From the User dropdown list, select the user role if you want
to search per the type of users, optionally if you want to search according to the user’s IP address you may also
specify the IP address in the IP field and then finally click on the button.
The search results are shown below.
The time of when the login action took place, by which user, the source IP address and the actions taken will all be
listed.
You may click on the button to download the search results in CSV format, or click on the
- 88 -
to download all web UI access logs in CSV format.
Advanced Logging
SSH Access Logging can be used to trace the SSH login records.
PBX Logging can be used to analyze the phone services related issues.
The OS Logging can be used to analyze the IPPBX system OS level issues.
Enable the desired type of logging if you are qualified to analyze such kind of logs or if our support team asked for
these kinds of logs for troubleshooting, otherwise please keep them disabled.
- 89 -
System
Storage
Data storage allows you to upload your recording files, log files and voicemail messages to an FTP server through
the Ethernet. Or you may attach an external USB drive to the IPPBX USB interface for saving the above-mentioned
files.
USB Storage
Now you may enable USB storage and configure which kind of files to be saved in the USB drive.
Once done click on the button and it will start to create folders on the USB drive and upload the existing
files to the USB drive too.
- 90 -
The whole process will take a few seconds to few minutes depending on the amount and size of the files. You may
click on the button to check the backup status. When done, the USB Backup Status will change to Backup
End.
From now on the type of files you’ve selected will all be written directly to the USB drive. And can be browsed on
the web GUI just the same as they are saved in the internal system storage.
The volume info of the USB drive could be checked every time when you first sign in to the IPPBX system web GUI
(Admin and Operator user).
Please do remember that, DO NOT remove the USB drive from the IPPBX system unless you have disabled USB
storage and unmounted the USB drive by clicking on the button from System -> Storage -> USB Storage
page.
If your USB drive could not be detected by the IPPBX system, please use USB disk format tool to delete
all partitions on the USB drive and create a single new partition and try again. Before doing this, please
back up the data in your USB drive. It will erase all data on the drive by doing it.
- 91 -
FTP Storage
In the FTP Server Path field you may specify the directory of where to store the uploading files.
From the Frequency dropdown list select the number of days of each uploading.
In the Upload Time field specify the exact time of the uploading.
Once configurations are done, click on the button to connect the IPPBX system with the FTP server. Once
connected, you’ll see the FTP Connect Status has been changed to Connected.
Each time after uploading, the call recordings, voicemails and system logs will be removed from the IPPBX internal
storage; call logs will be kept on the IPPBX system and also will make a duplicate on the FTP server.
- 92 -
Region and Time
Location and time may be configured separately. Both modifying location and time settings require rebooting the
IPPBX system.
The location settings will determine the type of tone (Dial tone, Busy, Congestion tone, etc.) you heard on the
phones, the time zone and also the opermode on the Analog Settings page. So you may not change the location
settings here but adjust the time settings only.
You may set the Time Zone and NTP Server to let the IPPBX system synchronize time from the NTP server. This is
by default how the system time works.
Or you may manually configure the system time.
In the Set Current PBX Time blank, you may manually input the date and time to set it as the current PBX time or
you may click on to synchronize the current time of your operating system. Then click on the
button to save the manually set time to the IPPBX hardware.
- 93 -
Network Settings
Network Profiles
The WAN network interface of IPPBXs could be configured to work in Static IP or DHCP mode. In most cases assign
a static IP would be the best practice. As all the IP phones will communicate with the IPPBX through this IP
address.
On WAN port, gateway and DNS could be configured so the IPPBX could have Internet access. As a result, SIP
trunking and remote extensions could work.
As for LAN, it’s only used when you don’t want the IPPBX system to have Internet access.
Default IP on LAN port is 192.168.0.1 -- you may change this IP but LAN IP should NOT be in the same network
segment as WAN port.
- 94 -
VPN
OpenVPN Server
OpenVPN is an open-source software application that implements virtual private network (VPN) techniques for
creating secure point-to-point or site-to-site connections in routed or bridged configurations and remote access
facilities. It uses a custom security protocol that utilizes SSL/TLS for key exchange. It is capable of traversing
network address translators (NATs) and firewalls. It was written by James Yonan and is published under the GNU
General Public License (GPL).
OpenVPN allows peers to authenticate each other using a pre-shared secret key, certificates, or
username/password. When used in a multi-client server configuration, it allows the server to release an
authentication certificate for every client, using signature and Certificate authority. It uses the OpenSSL encryption
library extensively, as well as the SSLv3/TLSv1 protocol, and contains many security and control features.
To configure OpenVPN server, please click on the button to show the configurations.
- 95 -
Specify your customized information and click on the button to continue.
Click on the button to set up the OpenVPN server.
Port: OpenVPN service port, the default port is 1194. You will need to forward this port on your router for the
clients being able to connect to the server.
Protocol: You can choose either UDP or TCP. But the port forwarding (1194) on your router should be using
the same protocol.
Device Node: TUN or TAP; A TAP device is a virtual Ethernet adapter, while a TUN device is a virtual
point-to-point IP link.
Cipher: Cipher (or cypher) is an algorithm for performing encryption or decryption.
Compress LZO: LZO is an efficient data compression library which is suitable for data de-compression in
real-time.
TLS-Server: TLS is an excellent choice for authentication and key exchange mechanism of OpenVPN.
Remote Network: The OpenVPN client network, VPN server uses the first available IP of the client network.
- 96 -
Route: The route entries adjust the local routing table, telling it which network to route over the VPN.
Client-to-Client: Client-to-Client can enable intercommunication between clients.
Once configurations are done, click on the button to save the configurations and you may create
certificates for the OpenVPN clients now. Each VPN client needs a certificate to be able to connect to the server.
OpenVPN server on IPPBX system can connect up to 20 clients.
Each certificate entry created here is for an OpenVPN client. Download the certificate and extract files inside the
package, 3 files you’ll get and they should be uploaded on a client to be able to connect to this server.
OpenVPN Client
To configure OpenVPN client, please click on the button to show the configurations.
The certificate files downloaded from the OpenVPN server should be uploaded here.
In the CA Certificate field upload the ca.crt file.
In the Client Certificate field upload the xxxx.crt file.
In the Client Key field upload the xxxx.key file.
When done, click on the button to configure the OpenVPN client to connect to the server.
- 97 -
In the Server Address field you should specify the OpenVPN server address, which can be a public IP or a
domain name.
The Port number should be exactly the same as on the OpenVPN server. By default it’s 1194.
The transport Protocol should be exactly the same as on the OpenVPN server. By default UDP is used.
Device Node could be set to TUN or TAP, a TAP device is a virtual Ethernet adapter, while a TUN device is a
virtual point-to-point IP link.
Cipher (or Cypher) is an algorithm for performing encryption or decryption.
Either to enable Compress LZO or not, depends on if you have enabled it on the server.
If Default Gateway enabled, it will use VPN connection as default gateway, data which should be sent to the
default gateway will now be sent though VPN connection.
Once done, click on submit to save the configurations. Finally click on Enable switch to switch on the VPN client
connection.
And you may check the VPN connection status in the VPN Client Status section.
In the VPN client status section the VPN client IP, the VPN type and the connection status will be displayed.
- 98 -
PPTP VPN Server
PPTP (The Point-to-Point Tunneling Protocol) uses a control channel over TCP and a GRE tunnel operating to
encapsulate PPP packets. The intended use of this protocol is to provide security levels and remote access levels
comparable with typical VPN products.
Click on the button to show the configurations.
Remote IP: PPTP VPN remote network IP range, there must be 10 or less available IP addresses between start
IP and end IP.
Local IP: PPTP VPN local server IP address.
Primary DNS: Primary DNS for VPN connection.
Alternative DNS: Secondary DNS for VPN connection.
Timeout(S): Session timeout for PPTP tunnels.
Authentication Method: Choose method/methods for the authentication of the VPN clients.
chap: Challenge Handshake Authentication Protocol, CHAP takes a more sophisticated and secure
approach to authentication by creating a unique challenge phrase (a randomly generated string) for
each authentication.
pap: Password Authenticate Protocol PAP works like a standard login procedure; it uses static user name
and password to authenticate the remote system.
mschap: MS-CHAP is the Microsoft version of the Challenge-Handshake Authentication Protocol.
mschap-v2: Microsoft Challenge Handshake Authentication Protocol version 2 (MS-CHAP v2), this
provides stronger security for remote access connections.
- 99 -
Enable MPPE128 Encryption: Microsoft Point-to-Point Encryption (MPPE) encrypts data in Point-to-Point
Protocol (PPP)-based dial-up connections or Point-to-Point Tunneling Protocol (PPTP) virtual private network
(VPN) connections with 128-bit key.
Debug: Enable debug for PPTP VPN connection, debug information will be written into system logs.
Once server configurations are done, you may create PPTP client users, each user created is for a VPN client to
connect. PPTP VPN server on IPPBX can connect up to 20 PPTP VPN clients.
Remember to set the Availability to Yes, when you don’t want this user to connect, just set Availability to No or
you may remove the user from the VPN user list.
Finally click on the Enable switch to turn the PPTP VPN server on.
To configure PPTP VPN client, please click on the button to show the configurations.
- 100 -
Enable 40/148-bit encryption for MPPE: Tick to enable 40-bit key (standard) or 128-bit key (strong) MPPE
encryption schemes.
Server Address: PPTP VPN server public IP.
Username: PPTP VPN user name given by the VPN server.
Password: PPTP VPN user password given by the VPN server.
Default Gateway: If enabled, all network traffic will go through the PPTP VPN connection.
Once done, click on the button to continue, and now you may click on Enable switch to turn on PPTP VPN
client.
Later it should be connected to the PPTP VPN server, and the connection status will be displayed in the VPN Client
Status section.
In the VPN client status section the VPN client IP, the VPN type and the connection status will be displayed.
- 101 -
Static Routing
DHCP Server
- 102 -
The DHCP clients which obtained IP addresses from the IPPBX system DHCP server will be listed on the right side
of the page, in the DHCP Clients section.
If you want some host or client to always get the same IP address, IP Address Reservation will help.
Just simply specify the MAC address of the client device and associate an IP address with it, and this IP will always
be reserved for this specific client device.
DDNS
- 103 -
services within your LAN via the domain name without needing to know your Dynamic public IP Address.
After setting DDNS, IP PBX phone services can be accessed from remote site via the domain name which your
DDNS provider supplied you. Also remote management is possible, even without a static public IP.
IPPBX system supports the following DDNS service providers:
Easy DDNS
PlanetDDNS.com/
http://dyndns.org/
http://www.noip.com/
http://www.zoneedit.com/
http://www.oray.com/
http://www.3322.net
http://freedns.afraid.org/
Sign up to one of these DDNS service providers’ website and subscribe a dynamic domain name. Once you have
your account details, register it here and you DDNS domain will work with the IPPBX system.
After completing the above, please configure port forwarding on your router/firewall, then you’ll be able to
remote access IPPBX services from the internet using this dynamic domain. For example, you can port forward
port number 443 and then you can access the IPPBX web interface by using the URL:
http://www.planetddns.com/
Security Center
IPPBX system has been preconfigured with a built-in firewall which prevents your IP phone system from
unauthorized access, malicious users and some other attackers.
You may not need to specifically configure the firewall settings but for security precautions please always keep it
on.
Firewall
- 104 -
First of all make sure the Firewall option is enabled. Only consider disabling your firewall if your PLNAET
IPPBX is behind a router/firewall without any port forwarding from the Internet.
Drop Ping will cause the system to ignore ping request. If enabled, you cannot ping the IPPBX system.
Drop All will cause all packets sent to the IPPBX system being dropped, this will cause IPPBX system to block
all communication with the outside world. Except web UI still works in local network, other services will all be
terminated.
Geo IP is a security policy which can be used to grant access of IP addresses from certain countries/regions,
all IP addresses from other countries/regions which are not specified will all be blocked. By default, web UI
will still be accessible. Enabling Geo IP requires Drop All to be enabled too.
To implement Geo IP please follow the steps below.
Step 1: Enable Geo IP and Drop All
Besides selecting the trusted IP addresses from certain countries/regions, you’ll still need to add a common
rule in the Common Rules section to grant access or the local network hosts/devices.
Step 3: Add a common rule to grant access of your local LAN.
- 105 -
IP should be the local network address instead of a single IP address.
Netmask should be the subnet mask of the network address.
The Port range determines which kind of services to be granted. In this case you may leave it blank to
grant local network all access to the IPPBX system.
Mac Address determines the action to be taken according to the Mac address of a device instead of its
IP address, it only works with devices within the same local network because Mac addresses are not
routable. In this case you are going to grant access of all the local network hosts/devices, so you may
leave it blank.
By now, Geo IP security policy should work. The private IP addresses from your local network and the public
IP addresses from the countries/regions you’ve selected should be able to access your IPPBX system. Other IP
addresses will all be blocked.
Common Rules can be used to configure the firewall to grant or deny an IP address or a network from
communicating with the IPPBX system. Even the service port number can be specified so it can grant or deny a
specific IP or network to access a specific service. The priority from high to low of the firewall rules is from the top
of the list to the bottom.
If you are going to grant access of some kind of services to specific IP address or network, add the grant rule/rules
first then add the deny rules. If the order of the rules is not correct you may use the arrows in the Priority column
to adjust the order of the rules.
In the above given example, the 2 rules “AcceptAMI” and “BlockAMI” limited that only the IP addresses from
network 192.168.17.0 can have AMI access. Except IP from this network others will all be denied to access. In this
case, if the “AcceptAMI” rule is moved beneath the “BlockAMI” rule, then the AMI port will be totally lockdown,
no one can access it.
If you are going to add rules to block some IP addresses from accessing some kind of services on the
IPPBX system, be sure you add the correct IP/network address (if not defined, the firewall will consider
as ALL), and the correct service port number (if not defined, the firewall will consider as ALL), otherwise
misconfiguration of a deny rule might cause the IPPBX system total lockdown, only way would be using
Console (IPX-330 and IPX-2100) or HDMI (IPX-2200 and IPX-2500) to unlock the IPPBX from command
lines.
- 106 -
You may specify the service port number and the maximum packets to be accepted on this port number in a
certain time interval. Except the specified number of packets, more packets sent within the time interval will be
dropped by the IPPBX system.
Each of the intrusion detection and prevention rule is configured with a maximum Illegal Attempts and the
Observation time duration, once the Illegal Attempts reached the given value in the given Observation time
duration, the source IP address of where the illegal attempts coming from will be banned by the firewall for the
given time duration specified in Ban for field. Banned IP will be listed on the IP Blacklist page.
Besides the 4 default rules, if you want to add more rules you can do it on the Firewall page Auto Defense section.
- 107 -
IP Blacklist
If an IP address appears incorrectly in the list of rejected IP, you can click on the button to remove it from the
IP blacklist.
IP Whitelist
By adding a trusted IP to the IP whitelist, you may also define which kind of services it could access.
SIP allows the IP to be able to register SIP extensions.
IAX (IAX2) allows the IP to be able to register IAX extensions.
HTTPS allows the IP to access the web UI of the IPPBX system.
SSH allows the IP to access the IPPBX system command lines through SSH.
You’ll only need to add trusted IP addresses to the IP Whitelist when you have configured Drop All or
Geo IP security policies. And in the policies these IP addresses are not included as trusted IP addresses.
Otherwise you don’t have to add them to the IP whitelist.
- 108 -
Email Services
In the Mail Service Provider dropdown list select your Email service provider. If it’s not included here, please
choose Other.
Once you have selected the mail service provider the SMTP Server field will be auto filled. Otherwise you’ll
have to manually input the SMTP Server address.
Default SMTP service Port is 25, but with SSL/TLS it would be 465. Otherwise you’ll have to input the actual
port number your mail service provider uses.
SSL encrypts a communication channel between the IPPBX system and the SMTP server. Most of the mail
service providers have implemented SSL support.
In the Email field input the Email account to be used by the IPPBX system, all mails from the IPPBX system will
be sent out by this mail account.
In Password field input the password of the Email account you have specified.
Once done the above settings, click on the button to make configurations effective. And you may click on
button and input an Email address to send a test email to verify if the mail server is successfully deployed.
You may need to activate SMTP service from your Email web portal before you can successfully
configure SMTP server on the IPPBX system.
- 109 -
Voicemail to Email Settings
The Mail Subject field you can set customized Email subject which will be received by the extension users
when they have new messages.
The Mail Body is also customizable, you may use variables in the mail body to describe the new voice
messages they got. The format of the variables must be the same as listed in the Variables section.
Variables could be used in the mail body to indicate the extension users about their new voice message
details.
With Deliver Message as Attachment option enabled the voice message will be attached to the notify Email,
users may playback the voice messages when they got the notify Email.
With Voicemail to Email enabled and Mail Server configured, the extension users will get Email notifications when
new voice message received on their extensions, just make sure the extensions have their Email addresses
specified.
- 110 -
You may customize the fax notification mail subject and mail body. The variable ${FAX_SENDER} could be used in
mail subject or mail body to describe who sent the fax.
Email Notifications
Storage Usage Alert can be used to notify the administrator about the system internal storage usage when
reached the threshold.
Change Admin Password can be used to notify the administrator about the admin password changing.
System Reboot can be used to notify the administrator after a system reboot. No matter after a manual
reboot or a power failure.
System Reset can be used to notify the administrator before resetting the IPPBX system to factory defaults.
Firmware Upgrade can be used to notify the administrator before upgrading the IPPBX system firmware.
In the Email field you should specify the Email address of who’s responsible to respond to these system
events.
- 111 -
Maintenance
Users
Admin User
Operator User
Root User
- 112 -
Upgrade
PLANET will update the IPPBX firmware at regular intervals for new features and bug fixes. You can visit our official
website www.planet.com.tw to check the updates for your IPPBX system.
The downloaded firmware package should be in .rar or .zip format, please extract the package first and upgrade
with the uImage-md5.xxx file to upgrade your IPPBX system.
Path: Maintenance -> Upgrade
The current firmware version and the last time when the firmware was upgraded will be displayed on the
firmware upgrade screen.
Before upgrading, you may refer to the information and consider if a new firmware upgrading is necessary.
To upgrade the firmware please click on the button to locate the uImage-md5.xxx file, the file
extension “.xxx” should match your IPPBX model, otherwise the upgrade will fail.
After the file is located, click on the button to upgrade. For IPX-330 and IPX-2100, the whole process will
take 4 to 5 minutes, for IPX-2200 and IPX-2500, the whole process will take 2 to 3 minutes, when done please
refresh the web page to re-login.
Firmware upgrade will cause the IPPBX system to restart and as a result all the phone calls going
through the system will be terminated. So please make sure there’re no phone calls going on before
you upgrade.
Diagnostic
PING
- 113 -
Traceroute
The traceroute command is used to discover the routes that the packets actually took while traveling to their
destination.
Path: Maintenance -> Diagnostic -> Traceroute
In the IP Address/Domain Name field specify the IP or domain name that you want to lookup and click on
button to begin tracing.
During the whole process each step will output in the Results field, you can view which routes the packets have
taken before reaching their final destination.
Ethernet Capture
Ethernet capture uses TCPDUMP which is a common pocket analyzer allows users to capture TCP/IP and other
packets being transmitted or received over a network to which the IPPBX is attached. The captured packets can be
downloaded from the IPPBX system and been analyzed on your Windows PC to display the SIP traffic details. It can
be used to debug a VoIP call problem.
Path: Maintenance -> Diagnostic -> Ethernet Capture
To capture the network traffic, you need to select the network interface according to on which the IPPBX system is
working on. Then click on the button to start capturing the network traffic.
- 114 -
Once the process begins, the Start button will change to Stop. At this moment, you should make a call to recur the
phone call problem or ensure some other problem had recurred, so the captured network traffic could content
errors that are helpful for troubleshooting. Once done click on button, and the captured network traffic will
be automatically downloaded.
The downloaded file could be analyzed by Wireshark or you could send the file to PLANET support team for help.
Channel Monitor
Channel Monitor, technically DAHDI Monitor allows you to monitor signal level on analog channel and record the
output to a file. Recorded audio files are by default raw signed linear PCM. You can play it to the speaker to listen
to the phone call signaling on the analog channel. Or you can use a sounds editor to visual display the audio level
at both the Rx (audio Received by Asterisk) and Tx (audio Transmitted by Asterisk).
Usually Channel Monitor can be used to capture the caller ID signaling of an FXO channel. If you are experiencing
caller ID problem you can perform channel monitor on the FXO port and then analyze the captured packets. If
needed, you can send this file to PLANET support for help.
Path: Maintenance -> Diagnostic -> Channel Monitor
Before starting channel monitor, you need to select an FXO interface. Then click on button to capture
signaling on the selected interface.
Once the process started the button will change to Stop. Now you should recur the problem by making a call in
through the selected interface. When the extension started to ring the third time you may hangup and stop
channel monitor by clicking on button. As soon as the channel monitor stopped, the captured signaling will
be automatically downloaded.
If you have knowledge of how to analyze the files you may open them with some sound editors like Wavepad, or
you may send the file to PLANET support team for help.
Backup
Taking a backup on IPPBX system is the same as when you create a recovery point on your Windows system. By
restoring the backup you can recover the IPPBX system configurations to the time point when it was still
functioning well.
Normally the first backup should be taken when you have finished configuring the IPPBX to work for the very first
time. Also, when you have applied new changes to your configuration is always a good time to take another
- 115 -
backup.
Path: Maintenance -> Backup
You may click on the button to take a backup of your IPPBX system when necessary. A backup file will be
generated.
File name is generated according to the software version, date and exact time when the backup is performed. You
may click on button to download the backup to you operating system. Or click on button to delete it
from the IPPBX system.
When you want to restore the backup, you may click on the button. Restoring a backup will cause the system
reboot, so please make sure there are no phone calls going on in the IPPBX system before you doing this.
If you are going to restore an offline backup (backup downloaded to your operating system) please click on the
button.
Backups will not be cleared after a system reset. So you may not need to download the backup to your
operating system. And after a system reset, you may skip the quick setup wizard and go to the backup
page to restore a backup directly to recover your previous configurations.
Reboot
Reset
- 116 -
Method 1: Reset from web UI
Resetting the IPPBX system
Click on button and confirm with the popup window, reset process will begin. During the reset process the
IPPBX system will restart and the whole process will take around 4 to 5mins for IPX-330 and IPX-2100, 2 to 3mins
for IPX-2200 and IPX-2500.
Before resetting you may enable “I’d like to keep the network profiles” option, so after resetting you may still
access the IPPBX system web UI from the same IP. If network profiles had been reset too, you’ll need to access the
IPPBX system via the default IP address.
WAN default IP: 172.16.0.1
LAN Default IP: 192.168.0.1
After resetting when you access the web UI you’ll first see the quick setup wizard, if you choose to use backup file
to restore the system configurations, you may skip the quick setup wizard, if you wish to configure a fresh new
phone system, you may follow the wizard to complete the configurations.
Reset from web UI will clear all system configurations, except if you have enabled “I’d like to keep the
network profiles” option which will keep the network configurations.
Except configurations to be erased, user data will also be erased, including call logs, call recordings,
voicemails, faxes, etc.
By default backups will be kept, so after resetting from web UI you may restore backup directly from
the IPPBX system.
Method 2: Reset by RESET button at system running stage (IPX-330 and IPX-2100 only)
When the IPX-330/IPX-2100 IPPBX system is running, the SYS LED indicator winks once every 2 seconds. Now you
may press and hold the RESET button on the back panel of the IPPBX for about 7 seconds, then the SYS LED will go
off, the IPPBX system will reboot and start the reset process.
Reset IPX-330/IPX-2100 IPPBX this way is the same as resetting from the web UI. Only difference would be you
cannot choose to keep the network profiles, so you will need to access the IPPBX system via the default IP.
Method 3: Reset by RESET button at system booting stage (IPX-330 and IPX-2100 only)
Reset the IPX-330/IPX-2100 IPPBX system by RESET button at system booting stage will erase everything on the
IPPBX system, including backups will be erased as well. Resetting this way will fully recover the IPPBX system to
factory defaults.
So if you wish to restore the IPPBX configurations with a previous backup, please download it to you operating
system first before resetting.
To reset the IPX-330/IPX-2100 IPPBX system at system booting stage, you need to first cut off the power supply.
Press and hold the RESET button then power it on. 4 to 5 seconds later when SYS LED goes off release the RESET
button.
Around 5mins later access the IPPBX system via the default IP address. You’ll first be directed to the quick setup
wizard page, you may start configuring a fresh new phone system or you may skip and upload offline backup to
restore previous configurations.
- 117 -