OBiPLUS Administration Guide

OBiPLUS Administration Guide
Obihai Technology, Inc.
OBiPLUS Administration Guide
Version 1.0.1
ABOUT THIS DOCUMENT
4
SCOPE
WHO SHOULD READ THIS
WHERE TO GO FOR HELP
NOTATIONAL CONVENTIONS
4
4
4
4
INTRODUCTION TO OBIPLUS
5
OBIPLUS SOFTWARE LICENSE
A HIGHLIGHT OF OBIPLUS FEATURES
REQUIREMENTS TO USE OBIPLUS
6
6
7
OBIPLUS COMPONENTS
7
DEFAULT NUMBERING PLAN
9
OBIPLUS USER
9
CLIENT OBI – BASIC CONFIGURATION
10
DAY/NIGHT MODE
11
OFFICE HOURS
EXCEPTIONS TO OFFICE HOURS
12
12
THE OP TRUNK
13
INBOUND TRUNKS
14
OUTBOUND TRUNKS
15
USER PROMPTS
15
UPLOAD OR PLAYBACK INDIVIDUAL USERX PROMPT (X = 1 – 20)
BACKUP AND RESTORE USER PROMPTS
16
17
PARKING LOT
17
OVERVIEW
PARTITIONS
MOH SOURCES AND PROMPT LISTS
ACCEPTING CALLER INPUT
CONFIGURATION
17
18
18
19
20
AUTO ATTENDANTS
21
VOICEMAIL IN THE CLOUD
21
OVERVIEW
CONFIGURATION
21
23
PAGING SUPPORT
24
BARGE-IN SUPPORT
24
USING LEGACY IP PHONES WITH OBIPLUS
24
INSTALLATION
IP PHONE EXTENSIONS
IP PHONE AND SIDECAR BUTTONS
Copyright 2010-2012 Obihai Technology, Inc.
25
26
26
2
IP PHONE CONFIGURATION PARAMETERS
USING OBI202 AS PROXY FOR IP PHONES ON A DIFFERENT NETWORK
IP PHONE AUTO-PROVISIONING
28
33
33
OBIPLUS SUBSCRIPTION LICENSE
34
OVERVIEW
MASTER OBI BEHAVIOR
34
34
OBIPLUS CONFIGURATION WIZARD
35
PREPARING YOUR OBI DEVICES FOR OBIPLUS
STARTING THE OBIPLUS WIZARD
PROJECT FILES
CREATING OBIPLUS PROJECTS FROM SCRATCH WITH THE NEW PROJECT WIZARD
OBIPLUS PROJECT EDITING
35
35
35
36
42
OBIPLUS CONFIGURATION PARAMETERS REFERENCE
Copyright 2010-2012 Obihai Technology, Inc.
44
3
About This Document
Scope
This guide describes the additional features provided with an OBiPLUS installation. For device level administration, please
refer to the OBi Device Administration Guide.
Who Should Read This
Cloud Service Providers and Managed Service VARS
Small Business Owners or Managers looking for a cost-effective telephone system
Note to End Users
End users are highly encouraged to use the OBiTALK web portal to configure and manage their OBi devices. The reason for
this is two-fold. One, the major benefits afforded by the OBi devices are available to be turned on, set-up and modified
from within the portal. What’s more is the application of the functional configuration is controlled by device configuration
files tightly integrated with the settings configured by the OBiTALK portal and cloud-based applications managed by Obihai
which make possible the device’s “plug-n-play” operation.
There is an OBiPLUS Wizard on the OBiTALK web portal that can help you setup the system with most common options.
Where to Go for Help
Obihai has a number of options available to customers who are seeking help regarding their Obihai products.
Obihai Web Site:
1.
2.
3.
4.
Obihai Support Web Site: www.obihai.com/support
On this web site visitors will find links to the OBiTALK forum, Documents and Downloads, Tools Tips and Tricks as
well as an FAQ / Knowledge Base.
Enter a Support Request at: http://www.obihai.com/supportTicketForm.php
Go to the OBiTALK forum at: www.obitalk.com/forum
E-mail the Obihai Support Team at: support@obihai.com
Notational Conventions
An OBi device configuration parameter and value is represented in the style
Group Name::ParameterName = Parameter Value
Group Name is the heading of the parameter group on the left side panel of the device configuration web page and may
contain spaces. When a group heading has more than one level, each level is separated with a -, such as
Services Providers - ITSP Profile A – SIP::
ParameterName is the name of the parameter as shown on the web page and MUST NOT CONTAIN ANY SPACES.
Parameter Value is the literal value to assign to the named parameter and may contain spaces. Group Name or its
top level headings may be omitted when the context is clear. Examples:
SP1 Service::AuthUserName = 4082224312
ITSP Profile A - SIP::ProxyServer = sip.myserviceprovider.com
Copyright 2010-2012 Obihai Technology, Inc.
4
Introduction to OBiPLUS
OBiPLUS is a business collaboration system aimed at small offices with up to 12 users. Each installation comprises of a
Master OBi and a number of Client OBis and legacy SIP IP Phones. The Master OBi is a regular OBi202 device with a special
run-time license installed. While any regular OBi device can be used as a Client OBi, a number of popular legacy IP Phone
models are supported as well. See the section Using Legacy IP Phones with OBiPLUS for a complete list of supported IP
Phones. An IP Phone communicates with the Master OBi using standard SIP Protocol. Fig.1 shows a general deployment
scenario of an OBiPLUS system.
Branch Office
Telecommuters
SP Proxy
en
cr y
pte
d
OBiTALK Network
“In the Cloud”
d
ypte
encr
Main Office
ted
ryp
enc
enc
ryp
ted
Master
SP Proxy
Fig. 1: A general deployment scenario for an OBiPLUS system with a mix of OBi devices and legacy IP Phones
The Master OBi software license is based on a yearly subscription model; the software license is validated with OBiTALK
server on each system boot up and then periodically during normal operation. The Master OBi supports two users on its
two built-in phone ports and up to 10 additional users on external Client OBis or IP Phones. The Master OBi and all Client
OBis should be added to the same OBiTALK account so that the whole OBiPLUS system can be easily managed on the
OBiTALK portal with the OBiPLUS Configuration Wizard. IP Phones may also be managed on OBiTALK portal by explicitly
defining each phone in the OBiPLUS Wizard. This document includes some sections to describe in detail how to configure a
legacy IP Phone to work with OBiPLUS.
Normally the Client OBis and IP Phones in the system are installed in the same subnet as the Master OBi, known as an
OBiPLUS Site. These client OBis and IP Phones are said to be “on-site” or “local”. OBiPLUS allows a small number (up to 2) of
Client OBis to be outside the OBiPLUS Site, otherwise known as “offsite” or “remote”. While on-site Client OBis and IP
Phones may be installed on the WAN or the LAN subnet of the Master OBi, installing the legacy IP Phones on the LAN
Copyright 2010-2012 Obihai Technology, Inc.
5
subnet is recommended for simpler network management. Allowing off-site Client OBis and IP Phones on the other hand
would make it possible to support a small branch office or a number of telecommuters seamlessly.
OBiPLUS service is configured on the client OBi as a standard SIP service on any of the SP trunks (SP1 – SP4), with the
corresponding ITSP Parameter ProxyRequire = obiplus. A Client OBi resolves its Master OBi’s network location using
OBiTALK protocol, with the ITSP Parameter Proxy = <master-obi-number>.pnn.obihai.com. Similarly OBiPLUS
service is configured on a legacy IP Phone as a standard SIP service on Extension 1 of the phone. A phone would resolve the
proxy name <master-obi-number>.pnn.obihai.com with standard DNS query.
Similarly on a legacy IP Phone, one has to setup the equivalent of the ProxyRequire and Proxy parameters with the same
value. If the IP address of the Master OBi is static, you may configure the proxy parameter with the IP address instead.
Otherwise an IP Phone would resolve the proxy name with normal DNS query. For that the phone must point the DNS
server to the Master OBi. If the IP Phone is installed on the LAN side of the Master OBi, the phone will automatically find
the Master OBi as its DNS server through DHCP. Otherwise, you may program the WAN IP address of the Master OBi in the
Primary DNS server parameter of the IP Phone.
OBiPLUS Software License
There are two kinds of OBiPLUS software license: Basic and Premium. Here is a summary of what each license covers:
Basic OBiPLUS License
-
Two built-in extensions on the Master OBI plus two more extensions on Client OBis or IP Phones (up to 4 users)
No Remote Site Support; all Client OBis and IP Phones must be installed on the same subnet as the Master OBi
Support Basic IP Phone Functions Only (See diagram below)
Premium OBiPLUS License
-
Two built-in extensions on the Master OBI plus ten more extensions on Client OBis or IP Phones (up to 12 users)
Support up to 4 Remote Sites (such as branch office and telecommuters)
Support Basic and Premium IP Phone Functions (See diagram below)
A Highlight of OBiPLUS Features
-
-
Use one OBi202 unit as the Master OBi device, which has two built-in phone extensions on its PHONE1 and
PHONE2 ports. By default these 2 built-in extensions are assigned the number 100 and 120 respectively. An
additional 10 (or 2 for basic license) extensions may be configured on external Client OBis or Legacy IP Phones; by
default these 10 extensions are numbered as 101 – 110.
All Client OBis and IP Phones can make and receive calls using the Voice Services configured on the Master OBi
Digest authentication of Client OBi or IP Phone with an individually assigned password
20 user recorded prompts, with a combined total capacity of 122s
4 SP trunks available on the Master OBi: SP1, SP2, SP3 and SP4
Parking Lot with 9 different prompt lists that can be played out to different callers simultaneously
A Day Time AA and a Night Time AA dedicated for OBiPLUS Service; each AA can answer 2 calls simultaneously
A caller can be redirected to fork out to 8 numbers from the parking Lot or an AA
Parking Lot can play any combination of user recorded prompts, with a configurable range to play per prompt
Cloud Based Voicemail Service (as part of the SP1/2/3/4 Service on the Master OBi device)
New Voice Mail and Parked Call notifications to Client OBis and IP Phones
Paging and Barge In
Call Routing Rule accepts delay parameter in contact number within a forking list.
Cloud based OBiPLUS configuration wizard with storage for multiple project files
OBiPLUS system status available on OBiTALK portal
Copyright 2010-2012 Obihai Technology, Inc.
6
-
Up to 4 Remote Sites for branch office or telecommuters (premium license only)
Phone buttons for monitoring call park status, voicemail status, and day/night mode status (premium license only)
Requirements to Use OBiPLUS
-
-
An OBi202 device to act as the Master OBi. You must subscribe to an OBiPLUS software license and apply it to the
designated Master OBi device
A number of Client OBi devices or IP phones, depending on how many users you want to use OBiPLUS with. Any
generic OBi device can be used as Client OBi. IP Phones must be one of the supported models
Have one or more Voice Services configured and enabled on the Master OBi. Typically the services can be
configured on the SP trunks which can be through Google Voice or SIP ITSPs. You can also have your voice services
provided through one or more of the voice gateways VG1 – VG8.
You should sign up for an OBiTALK account and add all these OBi devices to the account. This will allow you to use
the OBiPLUS wizard on the OBiTALK portal to configure and manage your OBiPLUS system
Explicitly define each legacy IP Phone in the OBiPLUS setup wizard, by providing the MAC address and phone
model of the phone. You must also give a unique name to identify the phone in an OBiPLUS project.
Copyright 2010-2012 Obihai Technology, Inc.
7
OBiPLUS Components
VM
PH1
(Voice Mail)
PH2
OBiTALK
Service
AA1
SP1
AA2
SP2
Call
Router
SP3
AA3
AA4
MOH
Source1
.
.
.
SP4
PK
OP
(Parking Lot)
(OBiPLUS)
AN
(Announcement)
MOH
Source9
Endpoints
Trunks
Fig. 2: A block diagram of an OBI202 running as an OBiPLUS Master
As illustrated in Fig. 2, there are a few additional terminals in the Master OBi that are not present in a regular OBi device.
These terminals are:
-
OP (OBiPLUS Trunk) – The OP trunk acts pretty much like a normal SP trunk from the perspective of the Call Router
in the sense that it allow a call to be routed to a destination addressed by the extension. Hence the OP trunk has
an InboundCallRoute parameter that is used to route calls to an OBiPLUS entity. The OP trunk on the other hand
acts like a gateway to the client side that routes calls from the client to the other terminals within the Master OBi
Copyright 2010-2012 Obihai Technology, Inc.
8
-
PK (ParkingLot Endpoint) – This endpoint can hold up to 4 calls simultaneously, and can stream recorded prompts
to the holding callers. The prompt list to stream to each caller can be selected from 9 MOH Sources
-
AA3 (Day Time AA) – An AA dedicated to be used during day time. It can accept user input according to its
DigitMap and route the caller to up to 8 destination numbers simultaneously
-
AA4 (Night Time AA) – Similar to AA3 but to used during night time
-
VM (Voicemail Endpoint) – This is actually just a bridge that connects a caller to a SP service to deposit or check
voicemail in the cloud. It supports up to 4 mailboxes; each mailbox is identified with a unique internal numerical ID
The block diagram shows that the Master OBi has two PHONE ports that can be used to support two OBiPLUS extensions.
For example, PH1 can be hooked up with an external paging system, such that an incoming call routed to the PHONE1 Port
is automatically answered (so the paging system must appear to be off-hook to the PHONE1 Port all the time). Any Client
OBi PHONE Port can also be configured to be used with a paging system the same way.
While most of the Client OBis should be connected to the Master OBi over the same subnet, the Master OBi does support a
couple of Client OBis to be located offsite and connect to it remotely.
Default Numbering Plan
While the configurable parameters allow very flexible numbering plan, OBiPLUS comes with a set of default values that can
be readily used in most cases. By default OBiPLUS assigns a 3-digit private extension to each internally addressable entity in
the system. An OBiPLUS entity is a callable object that can be added to a ringlist in a call routing rule. An internally
addressable entity is an entity with a private extension assigned, such as a user (of a PHONE Port), an AA, a voicemail
number, etc.
Below is the default numbering plan for all internally addressable entities:
-
1xx = An extension assigned to a user (of a PHONE Port, on the Master OBi or Client OBi)
-
300 = AA3 (Day Time AA)
-
301 = AA4 (Night Time AA)
-
4xx = Deposit into Voicemail mailbox xx
-
5xx = Check Voicemail mailbox xx
-
6xx = Park a call into parking lot slot xx
-
7xx = Pickup a call from parking lot slot xx
Digits 9 and 8 are used as dial prefixes for making external calls. Digits 0 and 2 are reserved for future expansion.
OBiPLUS User
An OBiPLUS User is the assignee of an IP Phone or an OBi PHONE Port which may be located on the Master OBi or on a
Client OBi. A user can be a live person who uses an IP Phone or a conventional phone attached to an OBi PHONE Port, or a
piece of equipment such as a FAX machine or Paging System connected to an OBi PHONE Port.
Only one user can be assigned to each OBi Phone Port or IP Phone in the system. On the Master OBi device configuration
web page under Voice Services::OBiPLUS Service:: section, you can find the OBiPLUS PhoneN Port Extension:: and
ExtensionX:: (where N = 1 or 2, X = 1 – 10) subsections for configuring the user who is using the Master OBi phone port or
Copyright 2010-2012 Obihai Technology, Inc.
9
one of Client OBi, respectively. The OBiPLUS Phone Port Extension subsection has the following parameters: Name,
Number, MWISubscriptions, and PLSSubscriptions, while each ExtensionX subsection has in addition the parameters:
Enable, LogEnable, AuthPassword, and CallForwardOnOfflineNumber.
The Name and Number parameters are required for every user and must be unique among all users; Number must be a
numerical string such as 115 while Name can be alphanumeric and may contain spaces, such as John F. Thomson Jr.
The MWISubscriptions parameter tells the Master OBi which mailboxes the user is monitoring so that his device can
1
indicate if new messages are present in any one of those mailboxes . This parameter must be specified as a digit map such
that all defined mailboxes with an ID matching the digit map are included. By default the value is (xx.) which includes all
mailboxes in the system. Refer to the Voicemail section of this guide on how to add a mailbox for OBiPLUS.
2
The PLSSubscriptions parameter tells the Master OBi which parking lot slots the user is monitoring so that his device can
indicate if there are any calls are parked in any of those partitions. The device indicates this by playing a short ring
periodically. This parameter must be specified as a digit map such that all parking lot slots with a slot ID matching the digit
map are included. By default the value is (xx.) which includes all slots. Refer to the Parking Lot section of this guide on how
to setup the parking lot.
If the user is assigned a Client OBi, the following additional parameters may be specified:
-
AuthPassword – For the Client OBi device to authenticate to the Master OBi; no service will be granted to the Client OBi
unless it has been successfully authenticated. While not required, the use of AuthPassword is highly recommended.
-
CallFowardOnOfflineNumber – A destination number to forward calls to this user’s extension if his device is not online.
-
Enable – To enable this user and grant service to his OBi
-
LogEnable – Tell the Master OBi whether to include detail message logs involving this Client OBi in the syslog
Client OBi – Basic Configuration
A Client OBi assigned to an OBiPLUS user must have the corresponding information properly configured. The Client OBi sees
OBiPLUS as a SIP ITSP and the service can be configured on one of its SP trunks using one its ITSP profiles. To the Client OBi,
the Master OBi is the SIP Proxy Server for this special SP service. The minimum ITSP Profile and SP Service parameters
needed on the Client OBi are listed below, where the required parameters are shown in red; the unlisted ITSP Profile and SP
Service parameters should be kept at their respective default values.
-
-
Service Providers::ITSP Profile X::General:: section (X = A or B)
o
SignalingProtocol = SIP
o
DigitMap = same as OBiPLUS Service::OBiPLUS Settings::DigitMap on the Master OBi
Service Providers::ITSP Profile X::SIP:: section
1
An OBi device presents Message Waiting Indication (MWI) is to the user by replacing normal dial tone with a stutter tone,
and by turning on the message waiting lamp on the attached phone (if the phone is equipped with such lamp); the latter is
known as Visual Message Waiting Indication (VMWI).
2
PLS stands for Parking Lot Status
Copyright 2010-2012 Obihai Technology, Inc.
10
-
-
-
o
ProxyServer = [Master OBi Number].pnn.obihai.com (such as
200123456.pnn.obihai.com)
o
ProxyRequire = obiplus
o
RegisterExpires = a value between RegMinExpires and RegMaxExpires on the Master OBi OBiPLUS Service
SPn Service:: SPn Service:: section (n = 1 or 2)
o
Enable = checked
o
X_RegisterEnable = checked
o
X_ServProfProfile = A or B according to which ITSP profile is used to configure OBiPLUS Service
o
X_RegisterEnable = checked
SPn Service::SIP Credentials:: section
o
AuthUserName = the Number parameter configured on corresponding Extension section on Master OBi
o
AuthPassword = the AuthPassword parameter configured on corresponding Extension section on Master
OBi
SPn Service::Calling Features:: section
o
CallerIDName = the Name parameter configured on corresponding Extension section on Master OBi
o
MaxSessions = 4
o
MWIEnable = checked
o
X_VMWIEnable = checked
The PHONE Port::PrimaryLine parameter should be set to the SPn service assigned to OBiPLUS, so the user does not need to
dial the **n prefix to make calls using OBiPLUS.
It should be noted that the Client OBIs resolve the IP address of the Master OBi using the OBiTALK protocol. Therefore
OBiTALK Service MUST be enabled on the Client Obis when using OBiPLUS.
For Client OBi devices with two phone ports (an OBi202) can assign each phone port to a different user. Each user account
must be configured on a different SP service on the Client OBi, but the same ITSP Profile should be used for both.
Day/Night Mode
In the Master OBi, you can specify if a call routing rule is to be used during Day Time only or during Night Time only using
the “;D” and “;N” modifier respectively, such as {aa3};D, {aa4};N. Routing rules without such modifiers are applied at all
time. You can tell the Master OBi to assume Day Mode or Night Mode manually, or it can determine this on its own using a
set of rules specified in the OfficeHour and OfficeHourExceptions configuration parameters. Either way you can check if the
Master OBi is currently in Night Mode by checking the (read-only) NightMode status flag on the device web page.
Whether the Master OBi should switch to Night Mode autonomously or only when told to do so is controlled by the
OperationMode parameter, which may have one of the following values:
-
Auto Based On OfficeHour: Let OBi decide on its own based on OfficeHour and OfficeHourExceptions
-
Day Mode: Let OBi assume Day Mode always until this parameter is changed
Copyright 2010-2012 Obihai Technology, Inc.
11
-
Night Mode: Let OBi assume Night Mode always until this parameter is changed
You can set this parameter also by dialing a star code on the Master OBi:
-
dial *10 to select Day Mode
-
dial *11 to select Night Mode
-
dial *12 to let OBi switch to Day/Night Mode on its own
Furthermore, you can setup an IP Phone button to monitor the system’s day/night mode status, turn on/off night mode
manually, and turn on/off auto switching of day/night mode. More on this can be found in the section Using Legacy IP
Phones with OBiPLUS.
Office Hours
OfficeHour is a comma separated list of office hours for each day of the week. The hours must be specified in 24 hour
format. You can specify multiple time segments for the same week day. If a week day is specified more than once on the
list, the value to the right supersedes the value to the left. Below are some examples of OfficeHour:
Mon-Fri; 9:00-17:00,Sat;9:00-12:00
Mon-Sat; 9:00-12:00;1300:18:00,Wed:8:00-18:00
In the first example, there is no lunch break during Mon – Fri. In the second example, a 1-hour lunch break is added for
Mon-Sat, except Wednesday.
Exceptions to Office Hours
OfficeHourException is a comma separated list of exception dates to be excluded from normal office hours. In other words,
any time interval that falls within an exception is considered as Night Mode by the Master OBi. You can specify a time
interval for the same day in the list; the OBi will take the union of all the given intervals. The format of an exception interval
is: <start-timedate>[-<end-timedate>], where <start-timedate> and <end-timedate> is a <timedate> value of the following
format:
<timedate> = <month>/<day>[/<weekday>[/<time>]]
where
[x] = an optonal element
<month> = 1 – 12
<day> = ±(1-31)
<weekday> = 0, 1 – 7 (0=special, 1=Monday, 2=Tuesday, …, 7=Sunday)
<time> = Hour:min:sec (time of the day in 24-hout format)
If <end-timedate> is not specified, it implies the interval ends at mid-night on the same day as the <start-time-date>. If
<weekday> is 0, <timedate> is on the given month/day; otherwise it starts on the weekday on or after the given month/day
if day > 0, or on the weekday on or before the last-day-of-given-month+day+1 (note that day = -1 equivalent to last day of
the month). If <time> is not specified, it is assumed to be mid-night on the same day. Note that this definition of
<timedate> is exactly the same as that used in specifying DaylightSavingTimeStart and DaylightSavingTimeEnd.
Here are some examples of exceptions:
Copyright 2010-2012 Obihai Technology, Inc.
12
o
1/1 (new year day)
o
12/24/0/12:00 – 12/26 (Christmas Eve to one-day after Christmas)
o
5/8/7 (Mother’s day or 2 Sunday in May, for 1 day)
nd
To avoid ambiguity, all intervals specified using a weekday should use a different weekday for the starting and the ending
day if it is to last more than 1 day. Suppose you want to specify Mother’s day and also the following Monday as an
exception, you should add state interval as: 5/8/7-5/9/1 instead of 5/8/7-5/8/1.
The OP Trunk
OP is the short name for the OBiPLUS Service configured on the Master OBi, under the Voice Services::OBiPLUS Service::
section of the device web page. The OP trunk can be considered as voice service on the Master OBi and it behaves pretty
much like a normal SP trunk from the perspective of the Call Router, where the only numbers that you can call out on this
service are the internal extensions defined in OBiPLUS. In other words, when you refer to OP() in a call routing rule, you can
only specify an internal extension inside the parenthesis, such as OP(101), OP(300), etc.
Like a SP trunk, the OP trunk has an InboundCallRoute parameter for routing calls. When a user makes a call using OBiPLUS,
the call is sent to the Master OBi for processing. This call is then subject to routing using this inbound call route to reach its
final destination, similar to the way an incoming call on a SP trunk is routed. On the other hand, calls originated from other
terminals within the Master OBi that are routed to the OP trunk by the system call router are subject to call routing one
more time using the same inbound call route.
Consider this example. You pick up the phone on the Master OBi and dial, say the 3-digit extension of a Client OBi (such as
101). The PHONE Port::OutboundCallRoute has a rule that directs this call to the OP trunk, such as {>(1xx):op}. When
the OP trunk receives this outbound call request via the system call router, it applies the OP trunk InboundCallRoute to
route the call further to the final destination, the Client OBi with the called extension in this case.
Suppose you pick up the same phone but dials a prefix say 9 followed by an 11-digit external number. The PHONE
Port::OutboundCallRoute has a rule that directs the call to the OP trunk, such as {>(9xx.):op}. When the OP trunk
receives this outbound call request via the system call router, again it applies the OP trunk InboundCallRoute to route the
call further to the final destination, which can be one of the SP trunks on the Master OBi in this case. The SP trunk in this
case is known as an outbound trunk in OBiPLUS.
It is not necessary to explicitly spell out all the routing rules in the PHONE Port::OutboundCallRoute to direct certain called
number patterns to the OP trunk, as alluded to in the last example. The OP trunk has a DigitMap parameter where you can
specify all the number patterns that are supposed to route to the OP trunk. Like other trunk layer DigitMap, you can refer
to this DigitMap as (Mop). So you can simply add (Mop) to the PHONE Port::DigitMap and {(Mop):op} the PHONE
Port::OutboundCallRoute parameters on the Master OBi.
The default (Mop) is ([12345]xx|[67]XX|[89]{t=od}(Msp)) which includes the following number patters:
-
Any 3-digit numbers starting with 1, 2, 3, 4, or 5 followed by 2 digits
-
Any 3-digit numbers starting with 6 or 7 followed by 2 digits or *
-
All numbers starting with 8 or 9 followed by a pattern that matches (Msp); OBi will play outside dial tone after the
initial 8 or 9 is entered
The default OP trunk InboundCallRoute is set to:
Copyright 2010-2012 Obihai Technology, Inc.
13
{>100:ph},{>300:aa3},{>301:aa4},{>(1xx):op},{>400:VM(d00)},{>401:VM(d01)},{>500:VM(c00)},
{>501:VM(c01)},{>(<6:park>XX):pk},{>(<7:pickup>XX<;d=0>):pk},{>(<9:>xx.):tg1}
which means in English:
-
Calls to 100 are routed to the PHONE Port
-
Calls to 300 are routed to AA3 (Day Time AA)
-
Calls to 301 are routed to AA4 (Night Time AA)
-
Calls to 1xx (i.e., 1 followed by 2 digits) are routed to OP trunk
-
Calls to 400 are routed to Voicemail to deposit voicemail on the mailbox with ID = 00
-
Calls to 401 are routed to Voicemail to deposit voicemail on the mailbox with ID = 01
-
Calls to 500 are routed to Voicemail to check voicemail on the mailbox with ID = 00
-
Calls to 501 are routed to Voicemail to check voicemail on the mailbox with ID = 01
-
Calls to 6XX (i.e., 6 followed by 2 digit or *) are routed to the parking lot to park the call at the slot represented by
the last 2 digit of the called number
-
Calls to 7XX (i.e., 7 followed by 2 digit or *) are routed to the parking lot to pick up the call at the slot represented
by the last 2 digit of the called number, without any extra delay
-
Calls to 9xx. (i.e., 9 followed by any number of digits) are routed to call out on TG1
It should be clear that the default call routing rules and digit map assume that the Master OBi is using the default
numbering plan for the user extensions, AA, Parking Lot, and Voicemail. If you change the numbering plan for any of these
components, you have to modify the call routing rules and digit map accordingly.
It should also be noted that only the Client OBi extensions are callable over the OB trunk. The other extensions, including
the ones assigned to the Master OBi PHONE Ports, the AAs, the Parking Lot, and the Voicemail mailboxes, may be
considered as virtual extensions that should be “mapped” to the actual Master OBi components they represent. This
mapping MUST be specified in the OBiPLUS InboundCallRoute as shown in the default values of these parameters.
Inbound Trunks
An OBiPLUS inbound trunk refers to a voice service on the Master OBi that admits calls to be routed to one or more of the
OBiPLUS extensions. An inbound trunk can be SP1/2/3/4, PP, or BT (requires an OBiBT dongle that is sold separately). How
inbound calls on the trunk should be routed to OBiPLUS entities is specified as rules in the InboundCallRoute parameter of
the trunk (along with other rules that may not be related to OBiPLUS).
For example, consider the InboundCallRoute
{op(300)};D,{op(101),op(102),op(103),op(400);d=20};N
This rule states:
-
During day time, route the call to ring extension 300
-
During night time, route the call ring extension 101, 102, 103 simultaneously, but ring extension 400 in 20s
Copyright 2010-2012 Obihai Technology, Inc.
14
Note that when the call is routed to OP trunk from an inbound trunk as shown in the last example, the Master OBi applies
the OP trunk’s InboundCallRoute on the called number. Using the default OP trunk InboundCallRoute (see the OP Trunk
Section in this document), you can see that extension 300 is routed to AA3, the Day Time AA, and extension 400 is routed to
Voicemail to deposit message in the mailbox with ID 00.
Outbound Trunks
An outbound trunk refers to a trunk on the Master OBi that can be used to make outbound calls from an OBiPLUS
extension. Outbound trunks can be one or more of the following trunks: SP1-SP4, BT, PP, VG1-VG8, TG1-TG4. Which
outbound trunk to use when an OBiPLUS extension makes an external call must be specified in the InboundCallRoute
parameter under the OBiPLUS Service on the Master OBi. Outbound trunk selection is based on dialed number pattern.
Typically the digit 9 and 8 can be set aside as dial prefixes to conveniently tell OBi that the user is making an external call
instead of another internal extension.
Suppose you have two trunks SP1 and SP2 that can be used for any domestic calls, while SP3 has an unlimited plan for
calling Hong Kong, your OBiPLUS Service InboundCallRoute may look like this:
{>(<9:>(011852xx.)):sp3}, {>(<9:>(Mtg)):tg}, …
Here we have assumed that the trunk group TG1 includes SP1 and SP2 and (Mtg) is just a standard US digit map. Note that
852 is the international country code for calling Hong Kong.
It should be noted that it is however not always necessary to use an extra prefix digit to distinguish outside calls, as long as
the dialing pattern can disambiguate the choice of outbound trunks. For example, if all the internal extensions have 3 digits
and all external calls have more than 3 digits, you can do without the extra prefix 9 and the last routing rule can become:
{>(011852xx.):sp3}, {>(Mtg):tg}, …
User Prompts
User prompts are required for using AA3, AA4, the Parking Lot, and MOH. User prompts must be recorded on or uploaded
to the Master OBi. A total of 20 user prompts can be stored on the Master OBi which has a total capacity of about 120s for
all prompts. Each individual prompt however is limited to 60s. These prompts are referred to as the User1, …, User20
prompts in the OBiPLUS configuration.
User prompt 1 – 20 can be recorded directly on the Master OBi using IVR Menu 0, options 1001# through 1020#,
respectively. To do this, pick up the phone attached to the PHONE Port and dial * * * to invoke the local configuration IVR.
When it answers, enter 0 followed by the corresponding user prompt option (1001#, …., or 1020#). IVR then announces the
current value (or nothing if none recorded for that user prompt). Then you are given the following options:
-
Press 1 to enter a new value
-
Press 2 to set the default value (which is just an empty prompt and the old recorded value is erased)
-
Press 0 to repeat the information
-
Press # to enter another configuration selection.
Note: After pressing 1 to record a new prompt, OBi says “Enter value followed by the # key”. At that point, you can press
any digit (0-9) to start recording, and then press # to end recording.
Tips: Leave about 1s of gap at the end of recording to avoid unintended truncation by the OBi.
Copyright 2010-2012 Obihai Technology, Inc.
15
Immediately after a new prompt is recorded, OBi plays back the recorded audio and then presents the following options:
-
Press 1 to save (save the recorded prompt permanently in long term memory)
-
Press 2 to re-enter (the last recorded prompt is discarded)
-
Press 3 to review
-
Press # to cancel (the last recorded prompt is discarded)
Repeat the above steps for each user prompt that you wish to record. When you are done, you can hang up and the OBi
would reboot itself if you have made any changes to the user prompts so that the changes can take effect.
In order to keep track what has been recorded in each user prompt, you can enter a textual description for each. To do this,
go to the device web page and check under the Auto Attendant::User Prompts section, enter the descriptions in the
parameters UserXDescription for X = 1 – 20, for user prompt 1 – 20 respectively.
Upload or Playback Individual UserX Prompt (X = 1 – 20)
From the device web page under Auto Attendant, you can click on the UserXDescription parameter link to display the
Manage UserX Prompt page, where you can review or replace the prompt by uploading a different one (see below
screenshots). To review the prompt, click “Play” to either play the prompt or save the data in a .AU file on your computer.
To upload a new prompt from your PC, enter the file path and click “Start Upload”. The supported file formats are .AU or
.WAV, 16-bit linear PCM or uLaw/aLaw encoded, mono or stereo, at 8/11.025/16/22.05/32/44.1/48 kHz sample rate.
OBi Device Web Page to Check User Prompt Status
OBi Device Web Page to Playback or Upload a User Prompt
Copyright 2010-2012 Obihai Technology, Inc.
16
Backup and Restore User Prompts
From a web browser, you can backup all the stored prompts in a single data file. On the device web page, check under the
System Management::Device Admin::Backup AA User Prompts section and click the “Backup” button. The prompts will be
stored in the file “backupaa.dat”. The backup file also includes the associated textual descriptions entered for each user
prompt.
To restore an AA prompt file onto an OBi, do it exactly like a firmware upgrade via the web browser but provide the device
with the prompt file instead of a firmware file. The OBi can detect from the file header that you are trying to upload a
prompt file and process the file accordingly. Warning: All the existing prompts in the device will be removed first when
applying the backup file; this process cannot be undone.
Parking Lot
Overview
A parking lot allows a user to place callers on hold to listen to music or announcement, so that he can take other calls or
perform other tasks. As opposed to simply putting the caller on hold, parking a call takes the user completely out-of-theloop, such that his OBi device is no longer involved in the call with the parked caller.
A parked call may be picked up by any user.
A parking lot is an easy and intuitive way for a small office to maintain a call queue. When the entire staff is busy, an
incoming call may be parked automatically after it rings a few times. As soon as a staff member is freed up, he can pick up a
new call from the parking lot, perhaps starting with the one that has been parked the longest.
In OBiPLUS, the parking lot is implemented as an end-point terminal with the short name PK (which can be used in call
routing rules). It can hold up to 4 calls simultaneously. While parked, the caller can:
-
Listen to a list of recorded prompts according to a prompt list
-
Press 1 or more digits to reach another party as allowed by the system; this is specified with a pair for DigitMap and
OutboundCallRoute parameters for the parking lot
The Parking lot has 100 slots where each slot holds 1 call and is addressed with a 2-digit ID (00 – 99). When a user parks a
call, he can explicitly specify which slot ID to park the call at. To pickup the call, the user can also specify explicitly the slot ID
to pick up.
Parking a call is a lot like a normal call transfer. To park a call, user
-
Places the call on hold to invoke 2nd dial tone (hook flash on the OBi phone)
-
On 2nd dial tone, dials 6XX where XX is the parking slot ID
-
Note: X is the digit 0-9 or *. * is a wildcard that lets OBi park at the first available slot in that range
-
When the 2nd call rings (indicating the slot available), transfers the call (on hook the OBi phone).
-
If the 2nd call returns busy (indicating the slot unavailable), user can resume the call (hook flash on the OBi phone) and
retry w/ a different slot
-
By default the parking lot rings for 4s before answering to park the caller; this delay is configurable
-
NOTE: If the user waits for more than the parking lot answer delay after dialing 2nd call, he himself is parked first! In
that case he can still hang up to complete the park operation
Copyright 2010-2012 Obihai Technology, Inc.
17
-
NOTE: Parking yourself by calling 6XX (w/ or w/o a caller on hold) is an easy and the right way to check the prompts
played for that slot
To pickup a call, user
-
Dials 7XX where XX is the slot number. Dial * for X to pick up the oldest call among all matching slots
-
If the call rings, the slot is occupied. Otherwise the call returns busy
-
By default the parking lot rings for 4s before answering to have the slot picked up by the user. This delay is
configurable. User can take advantage of this delay to check if a slot is occupied but not to pick it up by hanging up
before the delay expires
Each OBiPLUS user can watch all or a subset of the slots such that his phone can play a short ring periodically as long as
there is at least 1 parked call in any of the watched slots
Partitions
The parking lot can be viewed as having 10 partitions with 10 slots per partition, such that slots 00-09 is the first partition,
10-19 the second, and so on. Having a few partitions defined lets you control how OBiPLUS automatically finds a slot to park
or to pickup. For example, you can designate slots 50–59 for Sales and slots 60–69 for Support. When the user dials 65* to
park a call, he is asking OBi to find an available slot in the Sales partition. Similarly when the user dials 66* to park the call,
he is asking OBi to find an available slot in the Support partition. Vice versa, another user can dial 75* and 76* to pickup the
oldest call parked in the Sales and the Support partition, respectively.
Each partition may use a different MOH Source: The Sales partition may use MOH Source 2 which says “All of our Sales are
helping other customer, …”, while the Support partition may use MOH Source 3 which says “Please stay on the line for the
next support staff, or open a ticket at www.obihai.com/support...”. To do this simply add these rules routing rules to the
OBiPLUS Service InboundCallRoute and OutboundCallRoute: {>(<6:park>5X<;s=2>):pk}, {>(<6:park>6X<;s=3>):pk}, … Note
the use of the s=2 and s=3 parameters when passing the slot number to the PK terminal.
Each OBiPLUS user can be configured to watch all parking slots or just some of the partitions using the PLSSubcriptions
parameter for that user. For example, set the value of this parameter to (5x) for the Sales partition, (6x) for the Support
partition, or ([56]x) for both the Sales and Support partitions.
MOH Sources and Prompt Lists
MOH stands for Music-on-hold. In OBiPLUS, a MOH Source is a prompt list that can be used by the parking lot to play a
sequence of prompts to the parked callers. There are 9 configurable MOH Sources in the parking lot. They are configured in
the parameters OBiPLUS Services::Parking Lot::MOH SourceX (X = 1– 9).
A prompt list is a comma separated list of prompt elements and control elements. A prompt element can be a system
provided prompt or a user recorded prompt. A system prompt is referred to by its name in the prompt list, such as music,
while a user prompt is referred to by its name surrounded by a pair of %, such as %USER1%, %USER2%, etc. Each prompt
element may include an “r=” parameter that specifies the range to play for that prompt. The full syntax of a prompt
element is:
<Prompt Name>[;r=[<start>][-<end>]]
where
-
[x] indicates an optional element x
Copyright 2010-2012 Obihai Technology, Inc.
18
-
<Prompt Name> = Name of the prompt. Currently available are %User1%, …, %User20%, and music (a system provided
music fragment)
-
<start> = starting point in milliseconds to play the given prompt; play from the beginning if this value equals to 0 or not
specified
-
<end> = ending point in milliseconds to play the given prompt; play to the end if this value equals to 0 or not specified
-
If the [;r=…] parameter is not specified, play the entire prompt from the beginning to the end
Examples of prompt element:
o
%User1%
(play the User1 prompt from the beginning to the end)
o
music;r=1000-8500
(play the music prompt starting from the 1000ms mark to the 8500ms mark
o
%User2%;r=-2500
(play the User2 prompt starting from beginning to the 2500ms mark
o
%User20%;r=1300
(play the User20 prompt starting from the 1300ms mark to the end
o
%User15%;r=32-12
(play anything since <end> < <start>)
A control element in the MOH Source Script starts with the letter ‘&’. The following control elements are supported:
-
&pause([duration]) – Pause for the given duration in seconds. For example: &pause(10)
-
&nopickup – Disallow the call to be picked up by any user; the call will be re-routed when it hits a &call element (see
next) or when the caller enters a valid digit sequence. This option is useful if the call is temporarily parked by an AA to
let the caller listens to some recorded information, such as “Today’s Special”. You must include this control element in
the prompt list if it is to be used for basic Music-On-Hold for calls that are strictly placed on hold instead of parked
-
&call([target]) – Call the target number given in trunk(number) format. For example: &call(sp1(14083331234)),
&call(aa3)
The choice of MOH Source is specified as part of a call routing rule using the optional [s=<moh-source-id>] modifier. For
example, specify PK(park5*;s=2) for choosing MOH Source 2 when parking a caller in the partition 5*. Without the s
modifier specified, the default choice is MOH Source 1. Here are some more examples:
o
AA3 OutboundCallRoute: {>1:op(100),op(101),op(102),pk(park5*;s=2);d=20}
o
OP InboundCallRoute: {>(<6:park>5X<;s=3>):pk}, {>(<6:park>6X<;s=4>):pk}
Accepting Caller Input
While parked, the caller can be allowed to press 1 or more digits to reach another party. For example:
o
Press 0 to return to main menu
o
Press 9 to leave a voicemail
o
Dials a valid 3-digit extension
The allowed digit(s) and digit patterns are specified in the Parking Lot Settings::DigitMap parameter. How the call should
be routed given different caller input is specified in the Parking Lot Settings::OutboundCallRoute parameter. For the last
example:
Copyright 2010-2012 Obihai Technology, Inc.
19
o
DigitMap = (0|9|1xx)
o
OutboundCallRoute: {0:aa3};D,{0:aa4};N,{9:vm(d00)},{(1xx):op}
The prompts should include instructions on what options are available, such as “Press 9 to leave a voicemail”.
Note that ALL parking slots (regardless which partition or MOH Source) share the same DigitMap/OutboundCallRoute.
Hence the options available to the caller are the same regardless which MOH Source is played for him.
Configuration
Parking Lot is an endpoint terminal, referred to as PK in call routing rules. When referring to PK in a call routing rule, you
must specify whether it is for parking a call or picking up a parked call, using the keyword “park” and “pickup” respectively,
followed by the 2-digit parking slot ID either explicitly or with either or both digits masked. Consider the following routing
rules (which would appear in the OBiPLUS Service InboundCallRoute):
{>(65*):PK(park5*;s=2)}, {>(75*):PK(pickup5*;d=0)}
Here we let an OBiPLUS user dial 6 followed by the 5* to park in the 5* partition and 7 followed by the slot ID to pickup the
oldest call in the 5* partition respectively. Furthermore, we specify to use MOH Source2 for the parked calls with the “;s=2”
modifier (without which it would be using the default MOH Source1). We also specify to have 0 delay (i.e., no ring back)
when picking up calls with the “d=” modifier (without which the user will hear 4s of ring back before the call is answered).
The general syntax is
PK(<’park’|’pickup’><slot-id>[;s=<moh-src-id>][;d=<answer-delay>])
where
-
The notation [x] represents an optional element x
-
The notation <’x’|’y’> represents a required element with the value x OR y
-
<slot-id> can be an explicit ID such as 12 or 24, or a partition such as 1* or 5*
-
<moh-src-id> is the ID of the MOH source to use when parking a call; default is 1
-
<answer-delay> is the delay or ringing time in seconds before the call is answered by the parking lot; default is 4
However, more generally, the routing rules to the PK are specified with a different form as the following:
{>(<6:park>5X<;s=2>):PK}, {>(<7:pickup>6X<;d=0>):PK}
This succinct syntax covers the case in the previous example, but also allows the user to dial say “653” or “766” to specify
the slot ID explicitly.
On the other hand, suppose you have an inbound trunk SP1 which you want to ring extensions 100, 101, 102, but
automatically park the all in partition 5* if the call is not answered in 20s. This is the InboundCallRoute for SP1:
{op(100),op(101),op(107),pk(park5*;s=2);d=20}
Copyright 2010-2012 Obihai Technology, Inc.
20
Auto Attendants
A basic auto attendant can be programmed to automatically answer an incoming call after a few rings, plays a greeting
message followed by a menu of options, lets the caller select an option or dials an extension and routes the call accordingly.
The caller should be able to “dial ahead” before the AA finishes the announcement. If the caller does not choose any option
after a timeout, the AA can send the call to a predefined destination, such as a live attendant at extension 100 or to leave a
voicemail.
OBiPLUS offers two identical AA instances, the AA3 and AA4. By convention we apply AA3 during Day Time and AA4 during
Night Time. We also refer to AA3 as the Day Time AA and AA$ the Night Time AA. Each instance has its own set of
configurable prompt lists, digit map, outbound call route, answer delay, and a number to call when user does not enter
anything.
AA3 and AA4 have the following configurable prompt lists:
-
Welcome – This prompt list is the greeting message played once by the AA right after it answers an incoming call
-
Menu – This prompt is repeated twice by the AA after the initial greeting; typically it should describe the options
available for the caller, such as “press 1 for sales, 2 for support, 9 to leave a voicemail, etc.”
Refer to the Parking Lot section in this document for a description of Prompt Lists. Note that the &nopickup control element
is not applicable to an AA prompt list.
The AA’s AnswerDelay parameter tells the AA how many milliseconds to let the call ring before picking it up. While playing
the option menu, the AA is ready to accept input from the caller to further direct the call. The acceptable digit(s) and digit
patterns are specified in the AA’s DigitMap parameter. How the call should be routed with respect to the matching digit(s)
or digit patterns is specified in the OutboundCallRoute parameter. For example, suppose the option menu is:
-
Press 1 to reach Sales,
-
Press 2 to reach Support
-
Press 3 for all other inquiries,
-
Press 9 to leave a voicemail
-
Dial directly the 3-digit extension of the party you want to reach
The corresponding DigitMap can be (1|2|3|1xx), while the OutboundCallRoute can be
{1:op(100),op(101),op(102)},{2:op(103),op(104)},{3:op(100)},{9:vm(d00)},{(1xx):op}
where the Sales team comprises of extension 100, 101, and 102, the support team 103 and 104, extension 100 is
designated to answer all other inquiries, and a valid extension is a 3-digit number starting with 1. Furthermore, you can
specify 9 as the NumberOnNoInput so that the caller is sent to leave voicemail if nothing entered after a timeout.
Voicemail in the Cloud
Overview
OBiPLUS does not offer any voicemail services on its own. Rather, it provides a bridge to connect callers to voicemail
services offered by ITSPs in the cloud. For example, Google Voice and most SIP ITSP include some kind of voicemail service
with every user account. The OBiPLUS voicemail bridge allows all OBiPLUS users to share the cloud voicemail services
seamlessly, as if they are accessing a shared local mailbox.
Copyright 2010-2012 Obihai Technology, Inc.
21
Each SP trunk on the Master OBi can also be a provider of cloud voicemail service to OBiPLUS users. The configuration of
the trunk is pretty much the same whether it provides both voice and voicemail services or just voicemail services. The
voicemail service offered by ITSPs (including Google Voice) share the following characteristics:
-
Automatically route an incoming caller on the service to leave voicemail when:
o
Device is down (due to power outage, network down, etc. That is, the caller never reaches the Master OBi)
o
Call not answered after a few rings (that is, the Master OBi does not answer the call at all)
-
Does NOT support transferring a caller to leave voicemail AFTER the call has been answered (from the ITSP point of
view). Note that if the call is answered by an AA and later transferred to ring another internal extension, it is still
considered as answered by the ITSP; so it is impossible to rely on the ITSP to transfer the call for you
-
Route the call originated from the service account to check voicemail if the called number is the same as the DID
number associated with that account. For example, if your SP1 service is associated with the DID number 1234, then
you can check voicemail on that service by calling 1234 using the same SP1 service
-
Has only one mailbox per service account
-
Supports MWI (Message Waiting Indication) signaling show that the device when new voicemail has arrived or cleared.
For a SIP ITSP, this indication is usually sent to the device in SIP NOTIFY message with target URL matching the
corresponding SP service configuration
OBiPLUS abstracts each individual ITSP voicemail service available on the Master OBi as an OBiPLUS “mailbox”
-
Each mailbox can be assigned a 2-digit ID, such as 00, 01, etc.
-
All the ITSP voicemail services installed on the Master OBi would appear to the user as a single voicemail service with
multiple mailboxes; the abstracted voicemail service acts like another OBi terminal with the short name VM
-
To deposit voicemail, user calls the number VM(dxx) where xx is the mailbox ID
-
To check voicemail, user calls the number VM(cxx) where xx is the mailbox ID
-
For convenience, OBiPLUS by default maps op(5xx) to VM(cxx) and op(4xx) to VM(4xx) so you can dial 5xx to check
voicemail and 4xx to leave voicemail
OBiPLUS integrates ITSP voicemail services to provide the following additional functions:
-
Allow an OBiPLUS entity (user, AA, parking lot, etc.) to transfer caller to leave voicemail after the call has been
answered; you can designate which “mailbox” to transfer to
-
Roll a call to over leave voicemail at the mailbox of your choice when it is not answered after an arbitrarily number of
rings of your choice (not subject to the auto-rollover-to-voicemail by the ITSP after a fixed number of rings).
-
Let user dials 5xx to check the mailbox with ID matching xx
-
Let user dials 4xx to leave a message in the mailbox with ID matching xx
-
Let user transfers a caller to the number 4xx to leave a message in the mailbox with ID matching xx. Note that since the
voicemail server may play greeting message immediately when called, it is better to do a blind transfer for this purpose
so the caller will not miss any of the greeting message
Copyright 2010-2012 Obihai Technology, Inc.
22
-
Let users monitor the MWI status of one or more mailboxes
3
One of the limitations of the OBiPLUS voicemail bridge is that the Caller-ID of the original caller (who is leaving voicemail) is
not recorded by the ITSP voicemail server. Therefore it is recommended to include in the voicemail greeting a reminder to
the callers to include their number in the message for returning the calls.
Configuration
You can configure up to 4 mailboxes in OBiPLUS. Each mailbox is abstracted from a generic ITSP provided voicemail service
on one of the SP services/ITSP Profiles on the Master OBi. Each SP service can only support one mailbox. Each mailbox is
configured under the device web page OBiPLUS Services::Voicemail MailboxX:: section (where X = 1, 2, 3, or 4), with the
following parameters:
-
ID – A two-digit ID (00 – 99) to identify the mailbox (note that 0-9 is not equivalent to 00-09; a single digit is not
acceptable here).
-
MWITrunk – Select the SP trunk to monitor MWI signal corresponding to this voicemail service; usually this is the same
trunk used to check voice mail in the same mailbox.
-
CheckVoicemailNumber – The number to call to check voicemail. For example, if your voice service is on SP1and the
DID number associated with that service is 4089991234, this parameter should typically be SP1(14089991234)
-
DepositVoicemailNumber – The number to call to leave voicemail. For example, your voice service is on SP1 and the
DID number associated with it is 4089991234. You need to use another service, say SP2 to leave voicemail on SP1. In
that case the value of this parameter is set to SP2(14089991234). There are a few other things to consider when
leaving voicemail this way:
In your SP1 inbound call route, make sure you do not answer the call if it is from the DID number associated with
SP2. This is because since you know for sure that if the call is originated from SP2, the reason of the call is to
deposit voicemail on SP1. That way the call can be rolled over to voicemail after a few rings by the SP1’s ITSP. To
eliminate the few rings when leaving voicemail, you can try one of the following where applicable:
o
Selectively forward all calls from the number associated with SP2 to voicemail, if the ITSP supports it. This
would be the best way and you must configure this feature on your ITSP’s web site
o
Enable DND or Forward All Calls to VM or an equivalent feature on SP1’s ITSP web site, if available. That
means SP1 will be dedicated to be used for voicemail only since no one else can call
o
If SP1 is Google Voice, you can tell OBi to auto-answer the call and sends a digit 2 when receiving a call from
the number associated with SP2. This tells Google Voice to send the call to leave voicemail. You can add this
rule in the SP1 inbound call route: {14089995678:pk(tovm)} where 14089995678 is the number for SP2
You can specify which mailboxes to be watched by a user by specifying the digit map patterns in the MWISubscriptions
parameter for that user on the Master OBi. This parameter accepts a digit map for its value and the default value is (xx.)
which implies all mailboxes. If for example you set the value to (00|01) on a user extension, then the user is monitoring
MWI events for mailboxes with the ID 00 and 01 only
3
User’s OBi device can play stutter tone or turn on the message waiting lamp on the attached phone if any of the
monitored mailboxes has new voicemail
Copyright 2010-2012 Obihai Technology, Inc.
23
Paging Support
Paging allows a user to call a single number to announce a message to the whole office. It requires some additional basic
audio equipment: An adaptor that connects from the phone port (RJ11) to an audio PA system (via audio RCA or 3.5mm
Jack). The adaptor must also appear to the OBi as an off-hooked phone. Such an adapter is very common and can be found
in most local Radio Shack stores.
The PHONE Port on any OBi (with firmware version 1.3 or later) can be configured to support paging. Once set up this way,
however, the PHONE Port cannot be used to make regular calls. But you can still check IVR with it when you connect a
regular phone to the port. When a user calls the extension of an OBi that has paging support enabled, the called OBi will
automatically answer the call if the phone port is in off-hook state and send audio out to the PA system via the phone port.
Barge-In Support
A user can join a call in-progress on another user’s OBi by calling that user’s extension preceded with *96. This operation is
known as barge-in which is available on all OBi devices running firmware version 1.3 or later. The receiving OBi will play a
special call-waiting tone (with a ring pattern specified in the X_BargeInRing parameter of the SP service) to notify its user
and then adds the incoming call to the conversation to become a 3-way conference call after 4s.
If the receiving OBi is not already on a call, the request to barge-in will be ignored and the call treated as a normal incoming
call.
Using Legacy IP Phones with OBiPLUS
OBiPLUS supports several models of SIP IP Phones as clients. The following models are currently supported:
-
Cisco SPA 303
(3 Line Keys)
-
Cisco SPA 504G
(4 Line Keys with POE)
-
Cisco SPA 508G
(8 Line Keys with POE)
-
Cisco SPA 509G
(12 Line Keys with POE)
-
Cisco SPA 932 Sidecar
(32 Buttons)
This section describes how to install and configure the IP Phones to work with OBiPLUS. This is by no means a
comprehensive guide for using and administering the IP Phones. For detail information regarding the IP phones, please
consult the documentation and websites from the respective IP Phone manufacturers.
Basic Phone Functions (Included With Basic Level OBiPLUS Subscription)
-
Up to 2 Phone Extensions can register with Master OBi
-
All basic call features built into the phones including
o
Incoming and outgoing calls
o
Call Hold/Resume
o
3-way ad hoc conference
o
Call transfer, all flavours, to another extension or an external number, to park, or to leave voicemail
Copyright 2010-2012 Obihai Technology, Inc.
24
-
o
Call forward, all flavours, to another extension or an external number, to park, or to leave voicemail
o
Do Not Disturb (DND) (caller to receive busy call treatment)
o
Ignore a ringing call (caller to receive busy call treatment)
o
Auto-answer an incoming page with speakerphone
o
One or more extensions per phone (i.e., multi-line)
o
Redial
o
LCR (Last Call Return, a la *69)
Speed Dials with one-touch blind transfer to
o
Another extension
o
An external number
o
Park
o
Leave Voicemail
Premium Phone Functions (Require Premium Level OBiPLUS Subscription)
-
All Basic Phone Functions
-
Up to 10 Phone Extensions can register with Master OBi
-
Classic BLF: Use BLF button to monitor if a user is on the phone or if his phone is ringing
-
Use BLF button to monitor and toggle System Day/Night Mode (DNMS)
-
Use BLF button to monitor voicemail status in individual mailbox
-
Use BLF button to monitor and toggle extension sign on/off state (SNOS)
-
Use BLF button to monitor call park status on individual parking lot partition
-
Seamless Telecommuter/Branch Office support via OBiTALK network
-
Extension sign on/off buttons when multiple phones share the same extension number
Installation
Fig. 1 shows a general deployment scenario for an OBiPLUS system. It includes a Main Office where the Master OBi is
located, two phones in a branch office and two telecommuters.
Main Office Installation
IP Phones located in the Main Office may be installed on the LAN side or the WAN side of the Master OBi, through an
Ethernet switch where necessary. When installed on the LAN side of the Master OBi, the phones rely on the Master OBi as
their DHCP server and default gateway; they do not need to know the WAN IP address of the Master OBi. When installed on
the WAN side of the Master OBi, however, an IP Phone needs to figure out the WAN IP address of the Master OBi; this
makes it necessary for the Master OBi to use a static WAN IP address.
Branch Office or Telecommuter Installation
Phones not located in the same network as the Master OBi must be installed on the LAN side of another OBi202 that is set
up to act as a proxy to the phones to access OBiPLUS service. An OBi202 can proxy for up to 4 IP phones.
Copyright 2010-2012 Obihai Technology, Inc.
25
IP Phone Extensions
Each IP Phone comes with a number of physical line keys. Theoretically you can assign as many extensions as the number of
available line keys on each phone. In practice, however, one would normally configure just one extension on each phone
and assign one or two line keys to point to that extension as call buttons.
From the perspective of the IP Phone, the Extensions configured on the phone are referred to as Extension 1, Extension 2,
etc., up to the number of line keys available on that phone model. Each Extension can be configured with a different SIP
account with typical parameters such as: Proxy Server, User ID, Password, etc. We will describe the list of phone parameters
that are required to set up to work with OBiPLUS in a later subsection.
To use the phone with OBiPLUS, you must configure at least one extension on Extension 1 of the phone. If necessary, you
may configure more extensions on any of the available Extensions.
Any spare line key that is not assigned to an Extension as call button can be programmed to monitor certain system event
(such as voicemail or call park status) or as a general purpose speed dial button.
IP Phone and Sidecar Buttons
Each IP Phone line key button or sidecar button can be programmed to provide one of the following functions with
OBiPLUS:
-
Classic BLF (Busy Lamp Field)
o
Monitor the status of a user extension if it is on the phone, or if the phone is ringing
o
The LED would be solid green if the user is not using the phone, and the phone is not ringing
o
The LED would be solid red if the user is on the phone
o
The LED would be blinking red if the phone is ringing
o
When the LED is solid green or red, press the button once to
o
-
-

if there is no active call, call the extension being monitored

if there is an active call, (blind) transfer the active call to the extension being monitored
When the LED is blinking red, press the button once to re-route the call to your phone. You will hear a beep-beep
confirmation tone; the monitored extension will stop ringing, and your phone will start ringing with the caller ID of
the original caller
Call Park Monitor
o
Monitor if any call is currently parked in a certain parking lot partition. Recall that each partition is identified with a
2-digit ID with either or both digits a wildcard, such as 0* for Sales, or 1* for Customer Service, etc.
o
The LED would be solid green if there are no calls parked in that partition
o
The LED would be blinking red if there is one or more calls parked in that partition.
o
The button is also a speed dial to pick up a call from that parking lot partition
o
You may define multiple buttons to monitor multiple parking lot partition simultaneously
Voicemail Monitor
Copyright 2010-2012 Obihai Technology, Inc.
26
-
o
Monitor if a mailbox has new voicemail messages. An OBiPLUS mailbox is identified with a 2-digit ID, such as 00,
01, etc.
o
The LED would be solid green if there is no new voicemail messages in that mailbox
o
The LED would be solid red if there is one or more new voicemail messages in that mailbox
o
The button is also a speed dial to check voicemail in that mailbox
o
You may define multiple buttons to monitor multiple mailboxes simultaneously
System Day/Night Mode Monitor
o
Monitor if the system is currently operating in day mode or night mode
o
Press the button to toggle the system day/night mode
o
-
-
Note that is the current day/night mode is switched automatically based on the definition of office hours, toggling
the day/night mode will also revert to manual day/night mode setting (until auto day/night mode switching is reenabled again)
Extension Sign On/Off State Monitoring
o
Multiple IP Phones or OBis may share the same extension such that a telecommuter, for example, may set up a
device with his extension in each of the locations that he would be working from. OBiPLUS however will only
provide service to only one of the devices: the one that has successfully registered on that shared extension with
the Master OBi most recently. To control which device will get service, you should enable satellite mode on the
sharing devices such that the device will not attempt to register unless the user has sign on. On an OBI device, a
user signs on/off by dialing *01 an *00 respectively. On an IP Phone, a button can be set up to monitor its sign
on/off state and to sign on/off.
o
If the phone has signed on, the LED would be solid green
o
If the phone has not signed on (or signed off), the LED would be solid red
o
Press the button once to toggle the sign on/off state
Speed Dials and One-Touch Call Transfer
o
All buttons can be set up as general purpose speed dials.
o
Pressing a speed dial when there is no other call in the active connected state will simply start a new call to the
stored number
o
Pressing a speed dial when there is a call in active connected state, however, will transfer the call to the stored
number. In other words, it is a short-cut to one-touch call transfer.
o
One-Touch Call Transfer Examples:
o
One-Touch to park a call (speed dial = 60* for Sales, 61* for Customer Support, for instance)
o
One-Touch to send a call to leave voicemail (speed dial = 400 for mailbox 00, 401 for mailbox 01, etc.)
o
One-Touch to transfer a call to any other extension
o
However, make sure you do NOT use one-touch transfer for checking voicemails, picking up parked calls,
toggling system day/night mode, or signing on/off. In other words, do not press those buttons when there
is an active connected call.
Copyright 2010-2012 Obihai Technology, Inc.
27
IP Phone Configuration Parameters
The following table lists the most important phone parameters and values for working with OBiPLUS. Some screen shots of
the phone configuration web page are shown in Figs. 2a-2d with these parameters highlighted.
IP Phone Parameter
[Ext n] Tab, n = 1, 2, 3, …
Proxy
SIP Proxy Require
MOH Server
Display Name
User ID
Password
Register Expires
G722 Enable
G726-16 Enable
G726-24 Enable
G729-40 Enable
Dial Plan
[SIP] Tab
CTI Enable
Send Resp To Src Port
Reg Retry Long Intvl
SIP User Agent Name
Value
<master-obi-number>.pnn.obihai.com:<master-obi-port> (For example:
500789560.pnn.obihai.com)
obiplus
<moh-ext>@<master-obi-number>.pnn.obihai.com:<master-obi-port>
Notes:
o If MOH is not desired for this phone user, leave this value blank
o $PROXY macro is not allowed here
o <moh-ext> is the OBiPLUS extension for parking a call in a partition that is set aside for
MOH. This partition must be assigned a prompt list that includes the &nopickup control
element. For example: 69* (i.e., the partition 690 – 699 is set aside to support MOH; there
should be a rule similar to {>(<6:park>9X<;s=8;d=0>):pk} in the InboundCallRoute
parameter of the OP trunk)
Name of the user of this extension; it could be blank. For example: John J. Steven
Extension assigned to this user. For example: 107
Password to authenticate this SIP account. For example: iJkLmN
60
no
no
no
no
(9,1xxxxxxxxxx|[1-7]xx|[67][0-9*][0-9*])
yes
yes
30
$VERSION (if the phone is not sharing any extension w/ other devices, or it is the Main phone
among the sharing devices)
$VERSION;login=sat (if the phone is sharing its extensions w/ other devices, and it is not
the Main phone among the sharing devices)
[Phone] Tab
Line Key x, x = 1, 2, 3, …
Extension
Share Call Appearance
Extended Function
The Extension for which to assign the key as a call button. Either
1, 2, 3, …
(for Extension 1, Extension 2, etc.)
or
Disabled
(to disable the Line Key or to use for other function than a call button)
Either
private
(if the Line Key is used as a call button on the selected Extension)
or
shared
(if the Line Key is used for other function than a call button)
Blank if this button is not used or used as a call button. Otherwise, it can be set to one of the
following values:
- fnc=sd;ext=<number>@$PROXY
This is a general purpose speed dial where <number> is the target number, such as:
 108
(for calling the extension 108)
 400
(for leaving voicemail in the mailbox with ID=00)
Copyright 2010-2012 Obihai Technology, Inc.
28

-
501
(for checking voicemail in the mailbox with ID=01)
 60*
(for parking a call in the partition with ID=0*)
 6**
(for picking up a call from the partition with ID=**)
 914088906000
(for calling the external number 9 1 408 890 6000)
fnc=blf+sd;sub=7<park-id>@$PROXY;ext=7<park-id>@$PROXY
This is for monitoring the call park partition with the given <park-id> (such as 0* for
Sales, 1* for Customer Service, etc.), and for picking up a call from that partition
-
fnc=blf+sd;sub=5<mb-id>@$PROXY;ext=5<mb-id>@$PROXY
This is for monitoring and checking voicemail in the mailbox with ID = <mb-id> (such as
00 for the Main mailbox, 01 for the Sales mailbox, etc.)
-
fnc=blf+sd;sub=dnms@$PROXY;ext=dnms@$PROXY
This is for monitoring and toggling the system day/night mode status
-
fnc=blf+sd;sub=dnmsauto@$PROXY;ext=dnmsauto@$PROXY
This is for monitoring and selecting auto system day/night mode
-
fnc=blf+sd;sub=blf<ext>@$PROXY;ext=blf<ext>@$PROXY
This is for monitoring the Classic BLF status of the extension <ext>
-
Short Name
Attendant Keys
Subscribe Expires
Subscribe Retry Interval
Server Type
fnc=blf+sd;sub=snos<ext>@$PROXY;ext=7<ext>@$PROXY
This is for monitoring the sign on/off status for the extension <ext> (such as 109)
A short name to remind you the function assigned to that Line Key. Typically one would set
this to the extension number, such as 107 or $USER, if the key is used as a call button for that
extension. If the Line Key is assigned to show call park status, you may set this to PkUpSales for instance.
Note that this parameter is available only if the Line Key has a corresponding label field on
the phone screen. On some phone models, there are Line Keys that do not have any label
field on the phone screen. For example, Line Keys 9 – 12 on a SPA509G do not have a label
field on the screen and therefore do not have a corresponding Short Name parameter.
60
30
Asterisk
Copyright 2010-2012 Obihai Technology, Inc.
29
Figure 3a: A Snapshot of SPA303 Configuration Page - [Ext 1] Tab
Copyright 2010-2012 Obihai Technology, Inc.
30
Figure 3b: A Snapshot of SPA303 Configuration Web Page – [Phone] Tab
Figure 3c: A Snapshot of SPA303 Configuration Web Page – [Attendant Keys] Tab
Copyright 2010-2012 Obihai Technology, Inc.
31
Figure 3d: A Snapshot of Cisco SPA504G Configuration Web Page – [SIP] Tab
Copyright 2010-2012 Obihai Technology, Inc.
32
Using OBi202 As Proxy For IP Phones On A Different Network
When using IP Phones installed on a different network from the Master OBi, you must use another OBi202 to act as the
proxy to bridge between the phone and the Master OBi. Each SP Service (SP1 – SP4) on the OBi202 can be set up to act as
proxy to one IP Phone Extension. Hence each OBi202 can proxy for up to 4 IP Phone Extensions. To enable the proxy mode
on SPx of an OBi202 for the phone extension <ext>, set up the following parameters:
OBi202 Parameter
Value
ITSP Profile M, M = A, B, C, or D
<master-obi-number>.pnn.obihai.com (such as 500896755.pnn.obihai.com)
ProxyServer
Obiplus
ProxyRequire
Yes
X_UseRefer
SPn Service, n = 1, 2, 3 or 4
X_ServProvProfile
X_InboundCallRoute
X_SatelliteMode
X_Proxy
AuthUserName
AuthPassword
MaxSessions
OBiTALK Service
InboundCallRoute
MaxSessions
The ITSP Profile with ProxyServer points to the Master OBi. For example: A
{>snos<ext>:an(0)},{><ext>:SPn(<ext>@local_client)},{<ext>>:SPn}
where <ext> is the extension number to proxy for (such as 107)
yes if it is proxying for a phone extension in satellite mode, or
no otherwise
yes
The extension number <ext> to proxy for. For example: 107
The account password for the extension. For example: iJkLm
6
{><ext1>:SP1(<ext1>@lan_client)},{><ext2>:SP2(<ext2>@lan_client)}, …
8
IP Phone Auto-Provisioning
This section describes how to auto-provision a new IP phone to use with OBiPLUS for the first time from a factory default
state. This method of auto-provisioning requires the
Bootstrap From the LAN side of Master OBi or a Proxying OBi
The DHCP offer from the Master OBi or a Proxying OBi includes its LAN side IP address in an option 66, which the IP phone
will interpret as the TFTP server to download a configuration file. This will eventually lead the phone to download its
configuration file (on every reboot and periodically) at the URL:
http://<Master-OBi-Number>.pnn.obihai.com/ipphone.xml?mac=$MA
This URL is indeed stored in the phone as its “Profile Rule” parameter.
Bootstrap From the WAN side of Master OBi
Select the “Profile Rule” option from the Settings Menu on the phone GUI, and enter manually the following URL:
http://<Master-OBi-WAN-IP-Address>
(such as: http://192.168.15.140) and press the [resync] softkey on the screen. This will eventually lead the phone to
download its configuration file (on every reboot and periodically) at the URL:
Copyright 2010-2012 Obihai Technology, Inc.
33
http://<Master-OBi-Number>.pnn.obihai.com/ipphone.xml?mac=$MA
This URL is indeed stored in the phone as its “Profile Rule” parameter.
Master OBi or Proxying OBi as IP Phone Provisioning Server
As implied above, the Master OBi or a Proxying OBi acts as the provisioning server for the IP phones with this autoprovisioning strategy. The Master OBi generates the configuration files for the IP phones according to the MAC Address
provided with the request. The Master OBi has enough information to generate the configuration necessary to bring up
each IP phone in the system
Moving IP Phones between Main Office and Branch Office
After successful initial provisioning, you can move an IP Phone from the main office to a branch office and vice versa. Note
that an IP Phone MUST be installed on the LAN side of a corresponding Proxying OBi when moved to a branch office. When
you relocate the phone to the LAN side of the Master OBi or a Proxying OBi, the phone should continue to work normally
without needing any reconfiguration. When you relocate the phone to the WAN side of the Master OBi, you only need to
make sure the Primary DNS Server is still pointing to the WAN IP address of the Master OBi. You can check and set this value
from the Phone screen under the Network Settings option of the Settings Menu.
OBiPLUS Subscription License
Overview
OBiPLUS is a subscribed feature set running on OBi202 devices. These features will not be available until a valid license has
been acquired by the device after it boots up. The Master OBi device must have the OBiPLUS Settings::Subscribed
parameter enabled in the profile. Otherwise the Master OBi will not check for OBiPLUS license and therefore will not
function properly. This parameter is enabled if you use the OBiPLUS Configuration Wizard to set up the Master OBi.
All OBiPLUS features will be turned on only if the OBiTALK license server tells the Master OBi that it has a valid license.
Otherwise all OBiPLUS features will be turned off. No reboot necessary when turning OBiPLUS feature set on/off after
license validation
Without a valid OBiPLUS license the Master OBi will continue to function like a regular OBi device.
To purchase an OBiPLUS license, you will need to logon to your OBiTALK account and select the type of license you need.
Currently there are two levels of subscriptions available: Basic and Premium.
Master OBi Behavior
Master OBi maintains a LicenseState status parameter. Possible states (as shown on Status web page) are:
o
Service Not Subscribed – Customer did not subsribe to OBiPLUS
o
Acquiring License – No license or current license has expired; waiting to check w/ license server
o
Basic Active – Basic License is valid and active; all basic OBiPLUS features have been turned on
o
Premium Active – Premium License is valid and active; all OBiPLUS features have been turned on
When the device boots up, the initial value of the LicenseState is “Acquiring License”. The device contacts the OBiPLUS
license server with a short exponential backoff/retry timer until a response is received from the server. If the response
Copyright 2010-2012 Obihai Technology, Inc.
34
indicates that the license is valid, the OBi periodically revalidates the license w/ the server once a day. Otherwise, the OBi
periodically revalidates the license w/ the server every hour until a valid license is received. User may also power cycle the
unit to force it to revalidate the license immediately.
OBiPLUS Configuration Wizard
You should be able to setup a complete OBiPLUS system manually based on the information provided in this guide. An
OBiPLUS Configuration wizard is also available on the OBiTALK portal to simplify the task. The wizard has sufficient flexibility
to meet most customers’ needs, but it may limit your choices in some aspects to make the complexity more manageable.
Note: In order for the wizard to configure your OBiPLUS system, make sure all your devices have auto-provisioning enabled.
For OBi devices that have been added to your OBiTALK account dash board, they are already auto-provisionable by OBiTALK
and the OBiPLUS wizard if you do not explicitly disable OBiTALK provisioning afterwards. IP Phones are also autoprovisionable by factory default.
Preparing Your OBi Devices for OBiPLUS
Before running the OBiPLUS wizard, you should have already picked an OBi202 device to be used as the Master OBi. Here
are some basic steps you need to take to prepare your devices:
o
Add the Master OBi and all Client OBi devices to your OBiTALK account
o
Subscribe to OBiPLUS on the OBiTALK Portal:
o
Configure Voice Services and Trunk Groups on the Master OBi as needed:
4

You must set up one or more voice services on the Master OBi: SP1, SP2, SP3, SP4, BT or PP. In
addition, you can setup TG1, TG2, TG3, TG4, VG1, …, VG8

You can setup Voice services using the wizard or expert page on OBiTALK portal
Starting the OBiPLUS Wizard
Logon to your OBiTALK portal account and make sure you can see all your OBi devices on the dash board. Click OBiPLUS
Wizard from the left side panel of the main page to launch the wizard.
Project Files
The wizard organizes your OBiPLUS system configuration in a project file. You can create and maintain up to 10 project files
in your account. You can delete an old project file or copy a project file into another with a different name. Each project file
is a complete OBiPLUS setup that includes the settings needed on all of your OBi devices included in the installation. Having
multiple project files in your account allows you to experiment with different configurations quickly.
4
When OBiPLUS is subscribed, the Master OBi will be upgraded to the OBiPLUS firmware automatically. The Master OBi
device profile will also be automatically updated to have the hidden parameter OBiPLUS Settings::Subscribed set to “true”,
which enables the device to periodically query OBiTALK for license validation
Copyright 2010-2012 Obihai Technology, Inc.
35
On the first page of the wizard, you are presented with the following choices:
o
New Project Wizard – Quickly create a new, basic but complete project from scratch with a few steps
o
Read Tutorial – Read a short tutorial on how to configure an OBiPLUS system
o
Open Existing Project – Select from a list of existing projects to work on
o
Remove Existing Project – Select from a list of existing projects to remove from your account
o
Start New Project – Start a new empty project from scratch
5
Creating OBiPLUS Projects From Scratch with the New Project Wizard
It is not required to use the New Project Wizard to create a new OBiPLUS project, but it is an easy way to create a new
project from scratch especially if you are new to OBiPLUS configuration. This wizard consists of seven (7) simple steps with a
lot of online help to guide you through the process. You can navigate back and forth among the steps before committing to
create the project at the last step. After creating the project, you can open it to make further edits and to generate the
configuration files to upload to the devices in your target system.
Each step in the new project wizard requests that you fill out a form regarding the users, the phones, or the voice services
in your system. Below is an overview of each step.
Step 1: Define IP Phones
Unlike the OBi devices, you cannot “add” IP phones to your OBiTALK account dashboard. Therefore you must explicitly let
the wizard know about the IP phones that you are planning to use. Note that IP phones are optional equipment; you can
skip this step if you do not intend to use any IP phone. You can always add more IP phones later by editing the project. To
complete this step, you will enter the following information for each IP phone that you plan to use:




Phone Name: A name to uniquely identify the phone in the project, such as “John's Phone”
MAC Address: The MAC Address of the phone (usually printed on the back of the phone). A valid MAC address
has 12 HEX digits with no extra white spaces, such as 008e123456ab
Make/Model: The make/model number of the phone. You can select one of the models from the drop down list
Sidecars: Specify the number of sidecar units that are or will be attached to the phone. Enter either 0 or 1. Note
that the phone model Cisco/SPA303 does not have a side car option, and the corresponding Sidecars value is
always 0
Up to 10 IP Phones may be defined in this step. Some examples are shown in the screenshot below.
5
Tips: If you want to experiment with tweaking a small portion of your configuration, you can save a project with a different
name (using the Save Project As button) and tweak from there, instead of starting a brand new project from scratch
Copyright 2010-2012 Obihai Technology, Inc.
36
New Project Wizard Page – Step 1: Define IP Phones
Step 2: Users
You may define up to 12 users for your system in this step. You specify the following attributes for each user. Only the first
four attributes are required; you can choose default values for the rest in most cases.






OBi Name(OBi Number) or Phone Name(MAC Address): The OBi Phone or IP Phone device to assign to the user.
You can select from the drop down list or enter the value in the box directly. The drop down list is a collection of all
the OBi devices on your OBiTALK account dashboard and the IP phones defined in Step 1
Phone Port: The phone port on the OBi device to use for this user. Each device phone port is assigned to a
different user. For a device with two phone ports, such as the OBi202, each phone port may be assigned to a
different user to support two users per device. Hence the Master OBi may have two users configured on it. This
option will not be shown if an IP phone device is selected for the user
User: User's name, such as, John Doe, Alice, Bob. It must be unique among all the users
Ext.: The 3-digit extension for the user. It must be in the range 100-199 and must be unique among all the users
Use For Paging: Indicate if this extension is for paging only. Unless this user extension is intended to hook up to an
external paging system, you should uncheck this box (default)
MOH: Check this box if you want the caller to hear some music or other recorded announcement of your choice.
Default is unchecked.
-- The following user attributes are less common. Keeping them at default value is sufficient in most cases --
Copyright 2010-2012 Obihai Technology, Inc.
37




ITSP Profile: Select the ITSP Profile on the client OBi to apply the configuration for this user. This option is not
shown if an IP phone or a Master OBi phone port is selected for the user
SP Service: Select the SP Service on the client OBi to apply the configuration for this user. This option is not shown
if an IP phone or a Master OBi phone port is selected for the user
Codec Profile: Select the Codec Profile on the client OBi to apply the configuration for this user. This option is not
shown if an IP phone is selected for the user
Ring Profile: Select the Ring Profile on the client OBi to apply the configuration for this user. This option is not
shown if an IP phone is selected for the user
User and Ext. attributes must be unique among the users. Each user must be assigned a different OBi Phone or IP Phone
device. The Master OBi device must be specified by filling out the OBi device box for either Master:Port1 or Master:Port2;
however it is entirely optional whether to actually assign a user to Master:Port1 or Master:Port2.
The screenshot below shows an example with 7 users defined.
New Project Wizard Page – Step 2: Create Users
Step 3: Groups
A group is a named collection of users. For example, you can define a group named “All” to include the entire staff in the
office. Groups can overlap; a user can be member to more than one group. You are not required to create any group for
your project to use OBiPLUS successfully. However it would simplify some of the configuration tasks. For example, you may
want incoming calls to ring just the Sales team during day time (office hours), but the entire staff during night time (after
hours). With the Sales and All groups defined, you can simply indicate the group name in the project configuration instead
of spelling out individual users to ring in each case.
Copyright 2010-2012 Obihai Technology, Inc.
38
To define a group, provide a name for the group and a list of users as members; each user is separated by a comma. You
can also select users into the group from the drop down list of users defined in the last step. An example with two groups
defined is shown in the Create Groups screenshot below
New Project Wizard Page – Step 3: Create Groups
In some parts of the OBiPLUS wizard, there is a need to distinguish between a group name and a user name (e.g., in a
ringlist definition). The convention is to append a ".group" suffix to the name to indicate that it is referring to a group
instead of a user. For example: All.group, Sales.group, and Customer Support.group.
Step 4: Trunks and Voicemail
A trunk refers to a voice service on the Master OBi. OBiPLUS voicemail feature relies on the voicemail services bundled with
your trunks. Each trunk that includes voicemail service constitutes a mailbox in OBiPLUS. In this step you provide some basic
information about the trunks you want to use for OBiPLUS and whether voicemail service is available for each trunk. You
must not enter the same trunk more than once. You specify the following attributes for each trunk:




Trunk: The standard name of the voice service on the Master OBi: SP1 – SP4
DID Number: The DID number of the trunk, such as 408 890 6000
Has Voicemail: Indicate if this service comes with voicemail
Calling Trunk for Leaving VM: Indicate another trunk to use to call the current trunk’s DID number to leave
voicemail. This must be different from the current trunk
Note that the above implies that you must have a least 2 trunks configured on your Master OBi to use the voicemail feature
effectively.
Based on the information you enter, the wizard will generate a set of voicemail settings in the project to let you:
- Check voicemail by calling internal extension 500 for the first mailbox, 501 for the second, etc.
- Leave voicemail by calling internal extension 400 for the first mailbox, 401 for the second, etc.
The wizard does this assuming that one would call the DID number of a trunk from the same trunk to check voicemail. If
your ITSP requires that you call a different special number to check voicemail, you must open the project later to modify
the check voicemail external number for that trunk.
Copyright 2010-2012 Obihai Technology, Inc.
39
A screenshot of Step 4 is shown below with an example of two mailboxes defined.
New Project Wizard Page – Step 4: Trunks and Voicemail
Step 5: Outgoing Calls
In this step you specify the rules for the Master OBi to select a trunk for making outgoing calls to external number based on
the number dialed. Up to 12 rules can be defined here. If you have multiple trunks that can be used for making calls to
similar number patterns, you can group those trunks into a Trunk Group (such as TG1) on the Master OBi. You may then
specify a rule to use that trunk group for outgoing calls to those number patterns. You must specify a dial prefix (8 or 9) in
each rule that the user must dial for making calls on that trunk. The dial prefix is not part of the target phone number; it will
be stripped by the Master OBi when setting up the call.
The screenshot below shows an example with two rules:
1.
2.
For any number that starts with 9011, use SP1 service
For any number that starts with 9, use TG1 service
Copyright 2010-2012 Obihai Technology, Inc.
40
New Project Wizard Page – Step 5: Outgoing Calls
Step 6: Incoming Calls
You can define up to 8 routing rules for handling incoming calls on the shared voice services (a.k.a. trunks) installed on the
Master OBi. For each rule you specify whether to ring one or more users, one or more groups, or one of the AAs, or any
combination of the above. You can specify one rule for Day Time and a different one for Night Time for the same trunk. You
can also elect to redirect the call to an AA or to the parking lot after it rings for a number of seconds.
The following screenshot shows an example with four inbound call routing rules:
1.
2.
3.
4.
Incoming calls on SP1 during day time are routed to ring the Day Time AA only
Incoming calls on SP2 during day time are routed to ring the Day Time AA only
Incoming calls on SP1 during night time are routed to ring the Sales and the Customer Service group members. If
the call is not answered in 30s, route the call to ring the Night Time AA
Incoming calls on SP2 during night time are routed to ring the Sales and the Customer Service group members. If
the call is not answered in 30s, route the call to ring the Night Time AA
Copyright 2010-2012 Obihai Technology, Inc.
41
New Project Wizard Page – Step 6: Incoming Calls
Note that by default Day Time (a.k.a. Office Hours) is defined as Monday – Friday, 9:00 am – 5:00 pm with no exception; any
time outside this range is regarded as Night Time. You cannot modify the office hours in the New Project Wizard. You can
reopen the project to modify the office hours after you have finished creating it.
Step 7: Create Project
This is the final step of the New Project Wizard. Here you provide a name to the project and press “Create Project” to save
the new project in your account. If the project name collides with an existing project, the wizard will prompt you to either
overwrite the old project or enter another name. After the new project is created, you can open it to make further edits.
New Project Wizard Page – Step 7: Create Project.
OBiPLUS Project Editing
After you have selected a project file or created a new one, the page changes to the standard wizard layout. There are 3
sections in the standard layout: A small top section that shows the name of current project along with a “Save Project As”
button and the time of its last modification. To the left is a list of Topics and Tasks you can jump to directly by clicking the
corresponding link. To the right is the main area where you enter values on a series of forms.
The project is divided into a number of topics as shown on the left side panel. Each topic is further broken down into one or
more tasks where you have the chance to configure a small number of parameters in each task. A task may contain one or
more steps where each step is presented to you as a separate page. Each page comes with extensive HELP which you can
expand to view the full details, or collapse to save space.
Copyright 2010-2012 Obihai Technology, Inc.
42
In the final step of each task there is a Finish button which you can click to commit the changes you made through out the
task to become permanently stored in the project file. Prior to that you can navigate between the steps (if there are more
than one) by pressing the Back and Continue buttons without losing the changes you have made. However if you jump to
another topic or task prior to clicking Finish for the current task, your changes will be discarded.
You can jump to a topic or task by clicking the corresponding link on the left side panel, or just let the wizard guide you
through topic-by-topic from start to finish.
The wizard uses the notation ??<something> to prefix an option value that is no longer valid. For example: ??Test User,
??Sale.group, etc. These errors sometimes happen if you remove an entity (such as a group or an OBi number) after it has
been used elsewhere in the project. The wizard will not remove those invalid options automatically, but rather indicate
those errors to you so you can correct them the way you want. When you run "Generate Config Files", the wizard will also
list these errors as WARNINGS.
To apply the settings as defined in this project, you must launch the “Generate Config Files” topic and click the Generate
button to let the wizard generate a set of configuration files for the OBi devices according to the project. The wizard will
generate device configuration file for the Master OBi and for each of the Client OBis that has been assigned to a user in the
project. If the configuration files include any changes, the affected devices, if online, will automatically reboot (when it is
idle) so that the changes can take effect immediately. At the end of the process, a summary of the configuration files that
have been generated will be shown on the screen. It may also include some warning messages if there are errors detected
in the project.
Here is the list of Topics:
-
Getting Started
-
Master OBi
-
IP Phones
-
Users
-
Groups
-
Inbound Trunks
-
Outbound Trunks
-
Voicemail
-
Office Hours
-
Recorded Prompts
-
Auto Attendants
-
Parking Lot
-
Proxies
-
Generate Config Files
Copyright 2010-2012 Obihai Technology, Inc.
43
OBiPLUS Configuration Parameters Reference
Here is a complete reference to all the OBiPLUS specific parameters that can be found on the OBi device web page (when
OBiPLUS license is active)
Status::System Status
Parameter
OBiPLUS Service Status
LicenseState
Description
Default Setting
Shows the read-only status of your OBiPLUS License. It can be
one of the following values:
1. Not Subscribed = OBiPLUS Service is not subscribed
2. Acquiring License = Contacting OBiTALK to retreat
license information
3. Expired = License has expired
4. Active = License is valid
N/A
Voice Services::OBiPLUS Service
Parameter
OBiPLUS Settings
Enable
RegMinExpires
RegMaxExpires
NumberOfExtensions
RingProfile
CodecProfile
Description
Enable OBiPLUS Service on this unit, which will behave as the
Master OBi
Minimum Registration Expires value to allow a Client OBi to
register with. Unit in seconds
Maximum Registration Expires value to allow a Client OBi to
register with. Unit in seconds
Limit number of user extensions, excluding the local PHONE
Port
Select which profile to ring the phone for a call coming in from
another OBiPLUS extension
Codec profile to use when making a call to another OBiPLUS
extension
DigitMap
The digit map represented by (Mop)
InboundCallRoute
The set of call routing rules to apply to a call coming from a
Client OBi or a call sent to the OP trunk via the OBi system call
router (the originating terminal can be any of the OBi
terminals: SP1-SP4, PP, BT, PH1, PH2, AA1, AA3, AA4, PK, or
OP)
DefaultRing
CallOnHoldRing
BargeInRing
CallParkedRing
OfficeHour
The default ring pattern to ring the phone for calls coming
from another user extension
The ring pattern to ring the phone for holding calls with
another user extension
The call-waiting tone pattern to alert the phone user when
another OBiPLUS user is requesting to barge-in the current call
The ring pattern to notify the user that one or more calls are
parked in the parking lot
A short script specifying normal office hours. OBiPLUS applies
Day Time call routing rules only during normal office hours
that are not inside any Office Hour Exception (see next
parameter)
Default Setting
No
60
300
10
A
A
([12345]xx|[67]XX|[89]{t=od}(
Msp))
{>100:ph},{>300:aa3},{>301:aa4
},{>(1xx):op},{>400:VM(d00)},{>
401:VM(d01)},{>500:VM(c00)},{
>501:VM(c01)},{>(<6:park>XX):
pk},{>(<7:pickup>XX<;d=0>):pk}
,{>(<9:>xx.):tg1}
3
8
4
10
Mon-Fri;9-17
OfficeHourExceptions
Copyright 2010-2012 Obihai Technology, Inc.
44
NightMode
OperationMode
SipDebugOption
Read-only. Indicate if Night Mode is in effect at the moment
There are 3 choices:
1. Auto Based On OfficeHour
2. Day Mode
3. Night Mode
There are 3 choices:
1. Disable
2. All Messages
3. All Messages Except Register
N/A
Auto Based On OfficeHour
Disable
Parking Lot Settings
Source1
SourceX (X = 2–9)
DigitMap
OutboundCallRoute
MOH Source 1. Also the default MOH Source when it is not
specified
MOH Source X
Digit patterns a caller may enter while parked
List of routing rules to redirect the call based on the digits
entered by the caller
Voicemail Mailbox N (N = 1 – 4)
A unique ID for the mailbox; this should be a string with 1 or
ID
more digits. Tips: You should use the same number of digits
for all of your mailboxes, such as 00, 01, 02, etc.
MWIChannel
The SP Service where MWI signal for this mailbox is received
The external number to call to check voicemail in this mailbox.
The number should include trunk information. Usually the
number to call is the same as the DID number assigned to the
CheckVoicemailNumber SP Service that hosts the voicemail service. For example, if the
voicemail service is offered on SP2 and the DID number for
SP2 is 4089991234, then the value of this parameter can be
SP2(14089991234)
The external number to call to deposit voicemail in this
mailbox. The number should include trunk information. The
number to call should be the same as the DID number
assigned to the SP Service that hosts the voicemail service,
and the call must be made from another service. For example,
if the voicemail service is offered on SP2 and the DID number
DepositVoicemailNumb for SP2 is 4089991234, and you have another service on SP1
er
with a different DID number (say 6503334567), then this value
can be SP1(14089991234).
Furthermore, your SP2 InboundCallRoute should have a rule
to block the call coming from SP1’s DID number, such as:
{(x.6503334567):pk(tovm)},… or
{(x.6503334567):},…
OBiPLUS Phone Port
Extension
Name
Number
MWISubscriptions
A Display Name for the user assigned to use the PHONE Port
on the Master OBi device. This value will be used as the user’s
Caller-ID name also for internal calls. Name should be unique
among all the users in the system
An internal extension associated with the PHONE Port on the
Master OBi device
A digit map that specifies the IDs of all the voicemail that this
Copyright 2010-2012 Obihai Technology, Inc.
(xx.)
45
PLSSubscriptions
user is monitoring for MWI
A digit map that specifies the IDs of all the parking lot slots
that this user is monitoring for parked calls
(xx.)
Extension N (N = 1 – 10)
Enable
LogEnable
Name
Number
AuthPassword
CallForwardOnOfflineN
umber
MWISubscriptions
PLSSubscriptions
Enable this Client OBi to access OBiPLUS Service on the Master
OBi
Include the SIP messages involving this Client OBi in the syslog
A Display Name for the user assigned to use the PHONE Port
of this Client OBi. This value will be used as the user’s Caller-ID
name also for internal calls. Name should be unique among all
the users in the system
An internal extension associated with the PHONE Port on this
Client OBi device
A password for the Client OBi to authenticate itself to the
Master OBi
A number to forward calls to this extension if the Client OBi is
not online at the moment. The value must include trunk
information, such as SP1(14083334567)
A digit map that specifies the IDs of all the voicemail that this
user is monitoring for MWI
A digit map that specifies the IDs of all the parking lot slots
that this user is monitoring for parked calls
yes
no
(xx.)
(xx.)
IP Phone N (N = 1 – 10)
A list of phone attributes separated by a space or newline
character for provisioning an IP Phone with the given MAC
address and model number. Each attribute has the syntax
<attribute-name>=”<attribute-value>”
with no white space before and after the ‘=’ sign. Every
character with the pair of double quotes are taken as the
attribute’s value.
Config
The following attributes are supported:
mac: Required. The MAC address of the IP Phone in 12hex-digit format, such as “008e3c123456”
model: Required. The make/model of the phone, such as
"Cisco/SPA504G"
ext: Required. The extension number assigned to the
phone, such as "104". The account will be installed on Ext
1 of the phone
dm: Optional. The dial plan on Ext 1 of the phone, such
as"([1-5]xx|[67][0-9*][0-9*]|9,1 xxx xxx xxxx|9,011
xx.|8,<:1408>[2-9]xxxxxx|8,1 xxx xxx xxxx|8,011 xx.)"
mohs: Optional. The extension number of the MOH
Server, such as "69*"
bn: Optional. A function button to be configured with the
attributes that follow. Valid values are “1”, “2”, … up to
the maximum number of programmable function buttons
on that phone model. Sidecar buttons are numbered the
same way with 100 added to the button number, such as
“101”, ‘102”, …, “132 (there are 32 buttons per sidecar). A
bn attribute is followed by a one of more of the fn, va,
and la attributes. The end of a bn section is marked by
Copyright 2010-2012 Obihai Technology, Inc.
46
-
-
another bn attribute. You must insert a bn=”0” attribute
after the last button
fn: Required. A code that represents the function served
by the current button. This attribute must be located
between two bn attributes. The following codes are
defined:
o “Speed Dial”: A speed dial. Requires a va
attribute with the target number as the value
o “BLF”: Classic BLF. Requires a va attribute with
the extension number to monitor as the value
o “Send To Leave VM”: Blind transfer the current
active call to leave voicemail. Requires a va
attribute with the target mailbox ID, such as
“00”, “01”, …, as the value
o “Send To Park”: Blind transfer the current call to
a parking lot partition. Requires a va attribute
with the parking lot partition mask, such as “0*”,
“1*”, “**”, … as the value
o “Monitor VM”: Monitor if new voicemail
available in a mailbox. Requires a va attribute
with the target mailbox ID, such as “00”, “01”, …
as the value
o “Monitor Park”: Monitor a parking lot partition.
Requires a va attribute with the target parking
lot partition mask, such as “0*”, “1*”, “**”, … as
the value
o “Monitor Night Mode”: Monitor the system’s
day/night mode status. No va attribute required.
o “Auto Night Mode”: Monitor if the system’s auto
day/night mode switching feature is active. No
va attribute required
o “Sign On/Off”: Let user sign on/off an extension.
Requires a va attribute with the extension
number to sign on/off as the value, such as “101”
va: Required if the function code requires it. This attribute
must be located between two bn attributes
la: Optional. A string label to display on the phone screen
next to the current function key. For example “$USER”,
“Park”, “Night”. It should be no longer than 7 characters
due to space limitation. This attribute does not apply for a
sidecar button
Voice Services::Auto Attendant
Parameter
Auto Attendant 3
Enable
DigitMap
OutboundCallRoute
AnswerDelay
NumberOnNoInput
Description
Enable this AA service
A digit map of number patterns that the caller can enter to
redirect the call
A list of call routing rules to redirect the call based on the
number entered by the caller
Default delay in answering incoming calls by this AA. Unit is in
milliseconds.
The number to call when the caller does not enter anything. It
may contain explicit trunk information such as OP(100), or just
Copyright 2010-2012 Obihai Technology, Inc.
Default Setting
4000
9
47
a raw number such as 9. A raw number will be subjected to
digit map processing and call routed determined by the
OutboundCallRoute
Auto Attendant 3
Prompts
Welcome
Menu
Auto Attendant 4
Enable
DigitMap
OutboundCallRoute
AnswerDelay
NumberOnNoInput
The first prompt list played by the AA once upon answering a
call
The prompt list played by the AA twice following the Welcome
prompt. Usually this prompt includes the menu of options the
user can enter, such as “Press 1 for Sales, Press 2 for Support
…”
Enable this AA service
A digit map of number patterns that the caller can enter to
redirect the call
A list of call routing rules to redirect the call based on the
number entered by the caller
Default delay in answering incoming calls by this AA. Unit is in
milliseconds.
The number to call when the caller does not enter anything. It
may contain explicit trunk information such as OP(100), or just
a raw number such as 9. A raw number will be subjected to
digit map processing and call routed determined by the
OutboundCallRoute
Auto Attendant 4
Prompts
Welcome
Menu
The first prompt list played by the AA once upon answering a
call
The prompt list played by the AA twice following the Welcome
prompt. Usually this prompt includes the menu of options the
user can enter, such as “Press 1 for Sales, Press 2 for Support
…”
iPhone, iPad and iPod touch are trademarkes of Apple Computer, Inc.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc.
Google Voice, Google Talk and Android are trademarks of Google, Inc.
OBi, OBiAPP, OBiON and OBiTALK are trademarks of Obihai Technology, Inc.
All other trademarks metioned in this document are property of their respective owners.
This document is provided by Obihai Technology for planning purposes only. No warranty is implied.
Do Not Use For Emergency Service Calls
Obihai Technology does not warrant the availability or quality of the OBiTALK network. Furthermore, Obihai
Technology will not be liable to you or any third party for any costs or damages arising directly and or indirectly
from the use of thisproduct’s hardware & software including without limits any damage, or for any loss whatsoever.
Copyright 2010-2012 Obihai Technology, Inc.
48
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising