Obi Device Admin Guide
Obi Device Admin Guide
Obi Device Admin Guide
INTRODUCTION
AUDIENCE
WHERE TO GO FOR HELP
NOTATIONAL CONVENTIONS
6
6
6
10
10
10
11
13
13
13
14
15
15
15
16
20
20
20
20
20
20
20
20
21
21
21
21
22
22
22
22
22
22
23
23
23
24
26
27
27
28
29
30
31
32
37
38
39
40
41
42
43
UPDATING FIRMWARE:
POSSIBLE ERROR MESSAGES ON FIRMWARE UPDATE FAILURE:
CUSTOMIZED AA PROMPTS BACKUP & RESTORE:
CONFIGURATION BACKUP & RESTORE:
RESET CONFIGURATION TO FACTORY DEFAULT
ZERO-TOUCH, MASSIVE SCALE REMOTE PROVISIONING:
43
44
44
44
45
45
46
49
STATUS PAGES
53
SYSTEM STATUS
LAN STATUS (OBI202/OBI302 ONLY)
CALL STATUS
CALL HISTORY
53
57
59
60
61
64
WAN SETTINGS
LAN SETTINGS
DHCP RESERVATION
FIREWALL AND DMZ
PORT FORWARDING
QOS SETTINGS
64
68
71
72
73
74
77
WIFI SETTINGS
WIFI SCAN
78
80
81
NETWORK SETTINGS
AUTOMATIC FIRMWARE UPDATE & PROVISIONING
DEVICE ADMINISTRATION
DEVICE UPDATE
81
85
91
93
93
SIP REGISTRATION
SIP OUTBOUND PROXY SERVER
DNS LOOKUP OF SIP SERVERS
NAT TRAVERSAL CONSIDERATIONS
SIP PROXY SERVER REDUNDANCY AND DUAL REGISTRATION
SIP PRIVACY
STUN AND ICE
ITSP DRIVEN DISTINCTIVE RINGING
RTP STATISTICS THE X-RTP-STAT HEADER
MEDIA LOOPBACK SERVICE
94
94
94
95
95
96
97
97
98
98
108
118
119
123
AUTOMATED ATTENDANT
AA CALLBACK SERVICE
USER RECORDED PROMPTS
CUSTOMIZING AA PROMPT LISTS
123
123
124
124
VOICE GATEWAYS
130
TRUNK GROUPS
132
OBIBLUETOOTH
133
133
134
138
138
150
150
156
163
163
165
169
175
175
176
177
177
181
181
181
182
183
183
188
191
191
191
192
193
195
197
197
199
201
202
202
202
204
Introduction
Audience
Cloud Service Providers and Managed Service VARs
2.
3.
4.
Notational Conventions
An OBi device configuration parameter and value is represented in the style listed below:
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
OBi Devices:
Model
VoIP Account
Support
(SIP or Google Voice)
OBiTALK
Support
Phone
Port(s)
Line Port
Ethernet
Port(s)
USB
Port
OBi100
Yes 2 Accounts
Yes
OBi110
Yes 2 Accounts
Yes
OBi200
Yes 4 Accounts
Yes
OBi202
Yes 4 Accounts
(SIP only)
Yes
OBi300
Yes 4 Accounts
Yes
OBi302
Yes 4 Accounts
(SIP only)
Yes
You may connect an OBiLINE USB to FXO adapter to the USB Port of the OBi device to provide an extra Line port. In that case, many of the Line Port
related features and configuration parameters described in this guide will be applicable on that device.
Google Voice Support for Up to Four (4) Google Accounts 2 on the OBi1 Series, 4 on the OBi2 Series
- Google Voice Support Not Available on the OBi3 Series
SIP Service Provider Support for Up to Four (4) SIP Accounts 2 on the OBi1 Series, 4 on the OBi2 and OBi3 Series
Any Available Service Can be Accessed from Each Phone Port Independently
Aggregation and Bridging of SIP and/or Google Voice, OBiTALK & Land Line (POTS) Services**
Automatic Attendant for Simplified Call Routing (AA)
Call Back Service Automatic Call Back to Connect User to the AA to Make a New Call or Ring the Attached Phone
** Land line available on OBi110 or with OBiLINE accessory (OBiLINE works with OBi2 and OBi3 Series devices only.).
Download OBi Client Applications for PCs, Mobile Phones & Internet Devices
Creating & Joining Circles of Trust So You Can Share Your OBi
Configurable to Work with Any SIP Compliant Internet Telephone Service or Google Voice Communications Service
Configurable to Work with Most Loop Start Analog Telephone Lines
Analog Phone & Telephone Line Impedance Agnostic
Robust Telephony Features:
Message Waiting Indication - Visual and Tone Based
Speed Dialing of 99 OBi Endpoints or Numbers
Three Way Conference Calling with Local Mixing
Hook Flash Event Signaling
Caller ID Name & Number
Call Waiting
Call Forward - Unconditional
Call Forward on Busy
Call Forward on No Answer
Call Transfer
Anonymous Call
Block Anonymous Call
Do Not Disturb
Call Return
Repeat Dialing
Powerful Call Routing & Voice Service Features:
SIP Support for Voice and Fax Over IP from Internet Telephony Service Providers
OBiTALK Managed VoIP Network for OBi Endpoint Devices & Applications
High Quality Voice Encoding Using G.711, G.726, G.729 and iLBC (OBi200/OBi202/OBi300/OBi302 only) Algorithms
Recursive Digit Maps & Associated Call Routing (Outbound, Inbound)
10
LED Icon
LED Icon
Light Behavior
What It Means
Off
Solid Green
Flashing Green
Flashing Orange
Solid Red
Light Behavior
What It Means
Light Behavior
What It Means
The port is not enabled. Otherwise:
-
Off
Solid Green
-
Flashing Green
11
OBi110 Only
Light Behavior
What It Means
Off
Solid Green
Flashing green
LED Pattern When Hardware Reset Button Is Pressed for Ten (10) Seconds:
Power LED blinks green slowly for 5 seconds and fast for 4 seconds preceding unit reboot.
12
The OBi PHONE port supports Call Waiting when a 2nd call is an inbound call:
A Hook-Flash (or depressing the Flash button) invokes switching between two (2) calls.
When the OBi PHONE port goes On-Hook this will end current call and invoke a ring for the holding call.
The OBi PHONE port supports 3-way Calling when the second call is an outbound call.
On the first Hook-Flash during an active call the OBi can make a second outbound call.
On the second Hook-Flash, the first call and the second outbound call are placed in a conference.
To remove the second conferenced party, invoke a third Hook-Flash.
nd
When the OBi goes On-Hook during a 3-way Call, this will become a transfer when 2 (outbound) call is ringing or
nd
connected. If the 2 (outbound) call does not succeed, e.g. no answer or busy, then the OBi PHONE port can go to an On
Hook state and will ring as the holding call is still on the line, or simply Hook-Flash to resume the first call.
The OBi PHONE port can select from the following services to which it can complete a call: SP1 Service (SP1), SP2 Service
(SP2), SP3 Service (SP3), SP4 Service (SP4), OBiBlueTooth 1 Service (BT1), OBiBlueTooth 2 Service (BT2), OBiTALK Service
(PP1), and PSTN Line (LI1).
PHONE PORT::DigitMap
PHONE PORT::OutboundCallRoutes
PHONE PORT::CallReturnDigitMaps
13
When the phone port goes from on-hook to off-hook, in case the user needs to dial * * * to invoke the IVR, the OBi will play
a dial tone for 5 seconds. After 5 seconds the OBi will turn silent and be ready to accept an incoming call to page.
Primary Line
By default, devices which come with an analog (PSTN) line port will use this as the Primary Line for outbound calls made
from the PHONE port and via the OBi Auto Attendant. This means that when you dial a new number using the AA, you do
not need to first dial a service route access code. You can select the Primary Line for the PHONE port and for the AA,
respectively, using the parameters PHONE Port::PrimaryLine and Auto Attendant::PrimaryLine.
Depending on the device model, you may add up to two (2) or four (4) SP VoIP services to the OBi, and attach a PSTN line to
the LINE Port as an additional voice service. The VoIP services can be SIP-based services or the Google Voice service (SIP
only on OBi302 and OBi300). In addition, all device models come with the free OBiTALK (peer-to-peer) service. In this
document we sometimes refer to any one of these voice services as a trunk. A trunk group (TG) is a (comma-separated)
ordered list of trunks. If a TG is selected for making an outbound call, the OBi will pick the first available member in that
trunk group for the call. Up to four (4) TGs can be defined in an OBi (see the section Trunk Groups for detail).
You can make one of the available trunks or TG1 as the Primary Line for outbound calls. The Primary Line for the PHONE
port(s) and the Auto Attendant is configured via the OBi device management web page described herein or the OBiTALK
Device Configuration VoIP Service Provider set-up screen also gives the user the option to select a trunk or TG1 as the
Primary Line. The list below summarizes the choices available for selection as the primary line:
SP1 Service
SP2 Service
SP3 Service
SP4 Service
OBiTALK Service
1
PSTN Line
1
OBiBlueTooth
1
OBiBlueTooth 2
Trunk Group 1
1
Trunk Group 2
When you want to make a call via a service that is not the Primary Line, you will need to dial that services access code
before the destination number.
The default service route access codes are defined as:
A dedicated LINE Port is available only on the OBi110 or devices with an attached OBiLINE USB to FXO adapter accessory. OBiBlueTooth is available only
on devices with an attached OBiBT USB adapter accessory. OBiBlueTooth 2 is available only on devices with two OBiBT USB dongles attached. Trunk Group
2 is not available as a choice of primary line on OBi100/OBi110.
14
Service route access codes for calling from the PHONE port can be customized if necessary by modifying PHONE
Port::DigitMap and PHONE Port::OutboundCallRoute. Service route access codes for calling via the Auto
Attendant can be customized if necessary by modifying Auto Attendant::DigitMap and Auto
Attendant::OutboundCallRoute.
Note: Occurrences of (Mpli) and pli are substituted internally with the corresponding abbreviated trunk name of the
selected primary line.
To signal hook-flash to the PSTN Line during a call from the phone attached to the PHONE port, Phone
PORT::HookFlashHandling must be set to Send Flash Hook to PSTN
Home Directory: This specifies where in the device directory tree the user nay start browsing.
File Filter: This specifies which file types the user can see and manipulate. File filters are limited to filename
suffixes such as *.jpg; *.mp3
Write Enable: This specifies whether the user can upload, delete, copy, cut and paste files or create new
directories on the USB device. Note: By default, read/file-download access is granted to all users.
15
Use the following URLs on a web browser to launch the OBi File Explorer:
The File Explore can be launched from either the WAN or LAN side of the OBi. The WAN side access can be disabled in the
configuration.
IP Routing Features
In router mode we refer to the network connected to the OBi Internet Port as the WAN side of the OBi202/OBi302, and the
network connected to the OBi LAN Port the LAN side of the OBi. The WAN side may be connected to another Ethernet
switch or directly to an access device such as a cable or DSL modem for Internet access. The OBi202/OBi302 routes traffic
between the LAN side and the WAN side, thus allowing the devices (such as PCs) attached to the LAN side to share Internet
access. The OBi202/OBi302 supports subnet masks as big as 255.255.255.0 to accommodate up to 253 IP addresses on its
LAN side subnet.
In addition to being a NAT (Network Address Translation) router, the OBi202/OBi302 includes a DHCP server, a DNS
forwarder and a basic firewall. It supports port forwarding, DMZ, QoS, and VLAN (802.1q). The maximum routing
throughput between the WAN and the LAN side is approximately 30 Mbps. This speed can be achieved when there are no
active calls in the system. Otherwise the throughput will be limited to a slower speed to accommodate the load for voice
processing. Note that if the WAN side is connected to an Internet access device directly, then the throughout could be
further limited by the speed of the Internet uplink and downlink.
The OBi202/OBi302 will acquire its WAN side IP address using one of the following methods: Static Address Assignment,
DHCP, or PPPoE. By default, the OBi202/OBi302 acquires its WAN side IP address using DHCP. Also by default, the
OBi202/OBi302s own DHCP server is enabled to support LAN side clients, e.g. PCs. The default LAN side IP address of the
router is 192.168.10.1.
Incoming packets receiving from the WAN side are forwarded by the router according to the following flow:
If firewall is enabled, discard the packet if it is rejected by any one of the active firewall components
If the sending host address matches a valid entry in an internal host binding table, queue the packet for local
processing. This binding table is updated by the router with an internal algorithm.
If the sending host address matches a valid entry in an internal NAT binding table, forward the packet to the
corresponding LAN IP address. The NAT binding table is updated by the router with an internal algorithm.
If the receiving port and protocol matches a reserved pair to support an internal process (e.g. TCP Port 80 for the
OBi202 web server process), queue the packet for local processing.
If the receiving port and protocol matches a port forwarding rule, forward the packet to the LAN IP address
according to that rule.
16
DHCP Server
By default, the built-in DHCP server is enabled on the OBi202/OBi302. It assigns IP address, network mask, DNS server and
default gateway address to the DHCP clients on the LAN side. The default gateway and DNS server have the same IP address
as the LAN side IP address of the router. In the DHCP server configuration, you may select the range of client IP addresses to
give out the Lease Time and the Local Domain Name. Furthermore, by using the DHCP reservation feature, you may reserve
specific IP addresses for some devices with specific MAC addresses. With this, those devices can always be assigned the
same IP addresses reserved for them each time they make a request to the DHCP server. See the LAN Settings and DHCP
Reservation sections for more details.
Firewall
The firewall protects local processes and LAN side clients against certain basic threats from the WAN side (or the Internet),
such as port scanning and a DOS (Denial of Service) attack. The firewall settings also allow you to selectively turn on or off
the following related features:
NATRedirection Supports NAT Redirection (a.k.a NAT Loopback or Hairpin) if enabled (default is disabled).
The settings of these features will take effect only if firewall is enabled. Otherwise, they will take on their respective default
values (that is, no NATRedirection or DRDOSAttackProtection and VPNPasssThrough is allowed).
Port Forwarding
Up to 20 port forwarding rules may be defined on the OBi. For each rule a range of ports and a designated receiving LAN IP
address must be specified such that incoming traffic arriving at any of those ports on the WAN side are forwarded to the
same port at the designated IP address on the LAN side. You may also specify for each rule if it should only apply to packets
transported over UDP, TCP or both.
DMZ
The DMZ host in the router is the default LAN client address to which a packet received from the WAN side is forwarded
when the router fails to find a matching LAN IP address or matching local process to forward the packet to. Note if firewall
is enabled, that the packet is still subject to firewall inspection before forwarding to the DMZ host.
QoS
QoS (Quality of Service) refers to the prioritization of network traffic based on the type of traffic. For example, time critical
traffic such as VoIP may be allocated the highest priority so they can have a better chance of on time delivery to the
destination. On the OBi202, QoS policy applies to upstream traffic (LAN-to-WAN) only. Downstream QoS is entirely up to
the ISP / upstream routers and switches. The upstream traffic is prioritized according to its type of service as indicated by
the DiffServ/TOS bits in the IP header of each packet. In the QoS settings, you may map the 64 possible types of service to
one of the three priority classes: High, Medium and Low. You may also specify the guaranteed minimum upstream
bandwidth for each priority class. LAN side clients indicate the desired priority class of their outbound packets to the router
by marking the DiffServ/TOS bits of their packets accordingly. See the QoS Settings section for more details.
17
In addition to the three priority classes, a fourth priority class known as the Restricted class is available. The Restricted class
has the highest priority among the four classes. The guaranteed bandwidth for the Restricted class is allocated separately
with its own parameter in the configuration.
Note that the total guaranteed bandwidth allocated to all the four priority classes is equal to the total available uplink
bandwidth, which must be specified correctly in the UpStreamBandwidth parameter in the QoS settings for QoS to work
properly.
18
19
Call Forwarding
Call Forwarding allows you to send incoming calls to another number of your choosing. Calls can be forwarded to a number
reachable from the landline service, VoIP service or OBiTALK network. The following types of call forwarding are possible
with the OBi:
Call Forward ALL: When you use Call Forward ALL, all calls are immediately forwarded to the number you indicate when
you turn on the feature. To enable Call Forward ALL, from a phone attached to the OBi, dial *72. You will be prompted to
enter the number to which the calls will be forwarded. Dial the number plus the # key and a confirmation tone will be
heard. To disable Call Forward ALL, dial *73. A confirmation tone will be heard.
Call Forward on Busy: When you use Call Forward on Busy, all calls are forwarded to the number you indicate only when
you are already engaged in a call with your phone attached to the OBi. To enable Call Forward on Busy, from a phone
attached to the OBi, dial *60. You will be prompted to enter the number to which the calls will be forwarded. Dial the
number plus the # key and a confirmation tone will be heard. To disable Call Forward on Busy, dial *61. A confirmation tone
will be heard
20
Call forward on No Answer: When you use Call Forward on No Answer, all calls are forwarded to the number you indicate
only when you do not answer the call with your phone attached to the OBi. To enable Call Forward on No Answer, from a
phone attached to the OBi, dial *62. You will be prompted to enter the number to which the calls will be forwarded. Dial
the number plus the # key and a confirmation tone will be heard. To disable Call Forward on No Answer, dial *63. A
confirmation tone will be heard.
Call Waiting
Call waiting lets you take a second call that comes in when you are already on the phone with another party and not have
to disconnect to take the new call. When you are on the line with the first party, you will hear a tone signalling you there is
a second call coming in. To answer this call, press the flash button on your phone or depress and release the switch hook
on the telephone. The first party will be placed on hold and you will be connected to the second party until you press the
flash button or depress and release the switch hook again.
Since Call Waiting can interfere with fax calls already in progress, it is advised that you configure your fax machine to dial
the Cancel Call Waiting code before it dials the destination fax machine.
3-Way Calling
3-Way Calling allows you to talk to two parties at the same time with everyone on a telephone at a different location. To
use 3-Way Calling, when you are in a call with another party and want to add a second to the conversation, press the
flash button or depress and release the switch hook on your phone. You will be presented with a second dial tone and
the first party will be placed on hold. Dial the second party. When they answer, you will be able to inform them that you
intend to connect them with the first party (now on hold) and have a conference. At this point press the flash button or
depress and release the switch hook on your phone. This will connect the first party, the second party and yourself. You
can all continue to talk together.
21
Operations
R0
R1
R2
R3
R4
Scenarios
nd
st
nd
st
st
nd
st
nd
nd
To select the Nordic style of feature invocation, set the parameter PHONE Port::CallCommandSignalMethod to Nordic
Regions (R1, R2, ). The default is: N. America.
Repeat Dialing
Repeat Dialing is useful when you call a number that is busy and you want to keep trying so that your call gets through
when the far end is available. Repeat dialing will continue to try the last number until the OBi device can complete the call
or Repeat dialing is cancelled. To enable repeat dialing, from the phone attached to the OBi, dial *05 and hang up. To
cancel repeat dialing, from the phone attached to the OBi, dial *06.
Do Not Disturb
22
Do Not Disturb (DND) allows you to set the phone to immediately forward calls made to your OBi to the number set-up as
your voicemail number / account. If no voicemail account is set-up, the OBi will return a busy signal to the caller until you
turn off DND. To turn on DND, from a phone attached to the OBi, dial *78. To turn off DND, from a phone attached to your
OBi, dial *79.
If the called phone is idle (on-hook), it will ring normally with a special Caller-ID that indicates the call is from the
other PHONE Port.
2.
If the called phone is already on a call, the calling phone will barge in to join the call.
3.
If the called phone is on-hook with a call on-hold, the calling phone will pick up and resume that call.
4.
If the called phone is ringing, the calling phone will pick up and aswer that call.
5.
For all other scenarios, the calling phone will hear busy tone.
Note that you can prevent the calling phone port from doing 2, 3 and 4, as they can be disabled by setting the parameter
EnablePhonePortBargeIn to false for that port. In that case, 2 will become normal call-waiting on the called phone, but the
calling phone will hear busy tone for 3 and 4.
You can also transfer an external call from PHONE 1 to PHONE 2 the usual way: while connected on an external all, hook
flash and dial # to ring the other phone, then hang up to transfer when the caller phone rings or answers.
For incoming calls on any trunk (SP1-4 or OBiTALK Service), one can set up the corresponding inbound call route to ring just
PHONE 1 or PHONE 2 or both. The default inbound call routes are setup to ring both phone ports.
For outgoing calls, each phone port has its own digit map and outbound call route configuration, which means that you
have the full flexibility in allocating trunks for making calls from each port independently. Each port may also have a
different primary line assigned; the default however is to set the prmary line to SP1 for both phone ports.
23
*29, Make OBiBT Bluetooth Adapter discoverable for the next 120s (OBI202 only) and set it as OBiBlueTooth 2
24
Note: Be careful with the Speed Dial Set-Up as this will conflict with the Speed Dials set-up on the OBiTALK portal. The
Speed Dials that are set-up on the OBiTALK portal will always overwrite anything set-up via the phone connected to the OBi.
*
Note: You must attach one and only one OBiBT dongle to the unit when using this star code; otherwise the operation will
fail.
25
You may also set the call forward number to a phone port (ph, ph1 or ph2) or the AA (aa)
26
Auto Attendant IVR 1: Referred to as aa (or aa1) for call processing commands.
Auto Attendant IVR 2: Referred to as aa2 for local configuration.
If settings require reboot, it will be done automatically when quitting the IVR.
IVR (AA2) invoked by *** as default.
Tip: By pressing the appropriate button sequence on the telephone key pad, you can barge into the next menu of the IVR
or invoke a command without first waiting for the previous announcement to end.
Main Menu configuration options are accessed by pressing * * * from a phone attached to the PHONE port of the OBi,
followed by a single digit of the option number as listed below:
Selection
Announcement
27
Additional Options
0
Note for OBi202 and OBi302: Options 1 4 apply to the WAN (Ethernet) interface only. These options will appy to OBiWiFi
instead if the WAN (Ethernet) interface is not connected and the OBiWiFi Wireless Adapter is connected to a Wi-Fi access
point. To access similar options that apply specifically to OBiWiFi, we recommend use of options 41 44 instead to avoid
ambiguity.
Firmware Version
IVR Password
28
Debug Level
81
82
Press 1 to confirm.
Press 1 to confirm.
20
Announcement
DHCP Configuration
29
21
IP Address
22
Default Gateway
23
Subnet Mask
24
26
Announcement
30
32
33
0: Disable Firewall
1: Enable Firewall
Enable QoS feature in router mode
The current value will be read back.
38
0: Disable QoS
1: Enable QoS
OBiWiFi Network Related Configuration Options (OBi2 Series and OBi3 Series Only)
Additional Configuration Options Available with the OBi IVR after pressing * * * 0:
Selection
Note: Always Press # After Entering
Selection
Announcement
40
DHCP Configuration
31
41
IP Address
42
Default Gateway
43
Subnet Mask
44
46
Announcement
32
102
SP1 User ID
The current value will be read back.
167
168
172
173
174
33
176
177
Additional Configuration Options Available with the OBi IVR after Pressing * * * 0 for SIP Service Provider Two (SP2):
Selection
(Always Press # After Entering
Selection)
Announcement
SP2 User ID
202
The current value will be read back.
267
34
272
273
274
275
276
35
Number
36
Announcement
967
968
972
973
974
37
976
977
Announcement
38
Announcement
91
FXO State
39
Announcement
1001
40
IMPORTANT: Every configuration page must be submitted individually after changes made on the
page. Otherwise those changes will be discarded once you navigate to another page. Most changes
will require a reboot of the unit (by clicking the reboot button for instance) to take effect. However,
you may reboot the unit just once after you have made and submitted all the necessary changes on
all the pages.
When the device is operating in router mode (OBi202/OBi302 only), the built-in web server may be accessed from the LAN
side or the WAN side. While access from the LAN side is always allowed, for security reasons, the access from the WAN side
may be disabled by configuration. In fact, the WAN side access to the web server is disabled by default. You can enable this
option on the device web page (from the LAN side), or by using the device configuration IVR (* * * 0 option 30) from an
attached telephone.
41
Description
Remark
42
Updating Firmware:
You may upgrade the firmware for your OBi device from the device configuration web page. The firmware file with which
you want to upgrade the device must be stored locally on a computer from which you can access with a web browser.
Follow these steps to upgrade:
Step 1: Select the, System Management Device Update menu on the side panel of the web page.
Step 2: Specify the path of the firmware file by clicking the, Select file to upgrade firmware box or pressing the, Browse
button in the Firmware Update section of the page. This will present a file browser window where you can navigate to and
select the firmware file.
Step 3: Upon selection of the firmware file, press the Update button to start the upgrade process.
The entire process will take about 30 seconds to complete. Note that you MUST NOT disconnect the power from the device
during this procedure. If the new firmware is upgraded successfully, the OBi device will reboot automatically to start
running the new firmware. Otherwise the page will show an error message explaining why upgrade has failed.
43
Description
A corrupted Firmware package file has been used for the
update.
System Is Busy
Suggested Solution
Check the file and / or redownload the firmware
package and try again.
Try to update again later
No need to upgrade.
Description
If checked, the value of all status parameters will be included in
backup file. Otherwise, status parameters are excluded from the
backup
If checked, the default value of parameters will be included in the
backup file. Otherwise, default values are excluded from the
backup
If not checked, the backup file uses XML tags that are compliant
with TR-104 standard. Otherwise, the backup file will be stored in
an OBi proprietary format where the XML tags are not compliant
with TR-104; but the file size will be smaller and the file will be
more readable
Default Setting
No
No
No
When the file browser window pops up for, you can change the filename and choose the location to save the backup file.
Note that different web browser might handle this differently. If the operation is blocked due to the security setting of the
web browser, you should change the security setting temporarily to allow this operation to complete.
When restoring the configuration to a previous backup copy, you will need to specify the backup file you want to restore to
by selecting the Browse button in the Restore Configuration section of the web page. Then, select the Restore button to
start the process. The OBi device will automatically reboot, after the restoration is complete.
44
IMPORTANT Note: All passwords and PINs are excluded from the backup file. Hence they will not be available to restore.
Call history is excluded from the backup, but can be saved as an XML formatted file separately from the Call History web
page.
45
Description
Local time zone. Mirrors
System Management
NetworkSettings::
LocalTimeZone
Administrator Password, case sensitive.
Default Setting
46
Mirrors
System Management
Device Admin::
AdminPassword
ITSP Settings
ITSP SIPProxyServer
ITSP SIPProxyServerPort
ITSP AuthUserName
ITSP AuthPassword
ITSP URI
5060
Outbound Settings
Phone PrimaryLine
Attendant PrimaryLine
ITSP DigitMap
PSTN Line
PSTN Line
(1xxxxxxxxxx|<1>[2-9]xxxxxxxxx |011xx.|xx.)
47
Phone DigitMap
Phone
OutboundCallRoute
For OBi100:
([1-9]x?*(Mpli)|[1-9]|[1-9][0-9]|911|**0|***|#|
**1(Msp1)|**2(Msp2)|**9(Mpp)|(Mpli))
For OBi110:
([1-9]x?*(Mpli)|[1-9]|[1-9][0-9]|911|**0|***|#|
**1(Msp1)|**2(Msp2)|**8(Mli)|**9(Mpp)|(Mpli))
For OBi100:
{([1-9]x?*(Mpli)):pp},
{**0:aa},{***:aa2},
{(<**1:>(Msp1)):sp1},{(<**2:>(Msp2)):sp2},
{(<**9:>(Mpp)):pp},{(Mpli):pli}
For OBi110:
{([1-9]x?*(Mpli)):pp},{(<#:>|911):li},
{**0:aa},{***:aa2},
{(<**1:>(Msp1)):sp1},{(<**2:>(Msp2)):sp2},
{(<**8:>(Mli)):li},{(<**9:>(Mpp)):pp},{(Mpli):pli}
Inbound Settings
ITSP InboundCallRoute
OBiTALK
InboundCallRoute
POTS-line
InboundCallRoute
ph
ph
ph
48
49
Description
ITSP X SIPProxyServer
ITSP X
SIPProxyServerPort
Default Setting
admin
SIP
5060
50
ITSP X DigitMap
SIP::ProxyServerPort
Digit map controlling the transmission of
dialed digit information. Mirrors
Service Providers
ITSP Profile X
General::DigitMap
Outbound Settings (N = 1 or 2)
Indicate which service is the primary line
when dialing out. Mirrors
Phone N PrimaryLine
PHONE Port N::PrimaryLine
Phone N DigitMap
Phone 1
OutboundCallRoute
Phone 2
OutboundCallRoute
(1xxxxxxxxxx|<1>[2-9]xxxxxxxxx |011xx.|xx.)
SP1 Service
([1-9]x?*(Mpli)|[1-9]|[1-9][0-9]|911|**0|***|#|
##|**1(Msp1) |**2(Msp2)|**3(Msp3) |
**4(Msp4)|**9(Mpp)|(Mpli))
{([1-9]x?*(Mpli)):pp},{(<#:>):ph2},{(<##:>):li},
{(<**70:>(Mli)):li},{(<**82:>(Mbt2)):bt2},
{(<**81:>(Mbt)):bt},{(<**8:>(Mbt)):bt},
{**0:aa},{***:aa2},{(<**1:>(Msp1)):sp1},
{(<**2:>(Msp2)):sp2},{(<**3:>(Msp3)):sp3},
{(<**4:>(Msp4)):sp4},{(<**9:>(Mpp)):pp},
{(Mpli):pli}
{([1-9]x?*(Mpli)):pp},{(<#:>):ph},{(<##:>):li},
{(<**70:>(Mli)):li},{(<**82:>(Mbt2)):bt2},
{(<**81:>(Mbt)):bt},{(<**8:>(Mbt)):bt},
{**0:aa},{***:aa2},{(<**1:>(Msp1)):sp1},
{(<**2:>(Msp2)):sp2},{(<**3:>(Msp3)):sp3},
{(<**4:>(Msp4)):sp4},{(<**9:>(Mpp)):pp},
{(Mpli):pli}
SP1 Service
51
SPn InboundCallRoute
OBiTALK
InboundCallRoute
description of
Voice Services SPn Service::URI
for details on how to use this parameter.
Mirrors
Voice Services
SPn Service::URI
Routing rule for inbound calls on this trunk.
Mirrors
Voice Services
SPn Service::X_InboundCallRoute
Routing rule for inbound calls on this trunk.
Mirrors
OBiTALK Service::InboundCallRoute
ph,ph2
ph,ph2
52
Status Pages
System Status
The following series of illustrations are taken from screen shots of the System Status page of an OBi202. The System Status
page is divided into several sections: WAN Status, WiFi Status, Product Information, OBiBlueTooth Service Status, SP1 SP4
Service Status, OBiTALK Service Status, and OBiPLUS Service Status.
53
54
55
WAN Status
The status of the WAN (Ethernet) interface: includes such information as the assigned IP address, default gateway and
subnet mask.
WiFi Status
This status is only available on the OBi202 and OBi302. This shows the status of OBiWiFi and includes such information as
the assigned IP address, default gateway and subnet mask.
Product Information
This status shows some basic product information, as well as the system up-time with the last reboot reason code in
parenthesis. The reboot reason codes are defined below.
Reboot Reason Codes
0:
1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:
12:
13:
18:
19:
56
Voice Disconnected: Mobile phone is in a connected call, but the audio stays in the phone instead of going
to OBiBT
0 Active Calls
1 Active Call: Mobile phone is in a connected call, with audio going to OBiBT
BindingService The external paired device currently connected with the OBiBT
Backing Off: The service is currently down; the device is taking a short pause before retrying connection
N Active Calls (where N = 0, 1, .., up to the maximum number of calls allowed in the configuration
LicenseState The state regarding the OBiPLUS Subscription. Possible values are:
Service not subscribed
Premium Active: Premium level subscription is currently active
Basic Active: Basic level subscription is currently active
License Expired: Service is not available because your last subscription has expired.
57
58
Call Status
The Call Status page shows a number of running call statistics and state parameters for each active call currently in
progress. A sample call status page is shown below.
For each entry on the call status page, the following buttons may be available:
-
Remove: This button is available for all calls. Pressing this button will end that call.
Record: This button is available for calls involving the Phone port only. Pressing this button allows you to record
the current conversation in an audio (.au) file
59
Call History
The OBi Call History page shows the last 400 calls made with the OBi (200 calls only on the OBi100/OBi110). Detailed call
information is available, including what terminals were involved, the name (if available) of the Peer endpoints making the
call and the direction / path the call took.
The Call History page also captures what time various events took place.
The Call History can be saved at any time by clicking on the Save All button. The Call History can be saved as an XML
formatted file called callhistory.xml.
60
61
Parameter
Reset Statistics
ResetStatistics
RTP Statistics
PacketsSent
PacketsReceived
BytesSent
BytesReceived
PacketsLost
Overruns
Underruns
Description
Default Setting
NA
NA
NA
NA
NA
NA
NA
NA
62
Parameter
Port Status
State
LoopCurrent
VBAT
TipRingVoltage
LastCallerInfo
Description
Default Setting
NA
NA
NA
NA
NA
63
64
Default
Setting
Description
Internet Settings
IPAddress
The method used for assigning IP address, subnet mask, default gateway, etc.,
to the device. Available choices are:
DHCP: IP address, default gateway, etc. are assigned by DHCP Server
Static: IP address, default gateway, etc. are taken from the manually
configured values
PPPoE: IP address default gateway, etc. are acquired by PPPoE Protocol
(OBi202, OBi302 only)
The IP address to assign to the device when AddressingType is set to Static
SubnetMask
AddressingType
65
DHCP
DefaultGateway
DNSServer1
DNSServer2
PPPoEACName
PPPoEServiceName
PPPoEUsername
PPPoEPassword
VLANID
VLANPriority
Local Time
CurrentLocalTime
Time Service Settings
NTPServer1
NTPServer2
LocalTimeZone
pool.ntp.org
GMT-08:00
66
DaylightSavingTimeEnable
DaylightSavingTimeStart
DaylightSavingTimeEnd
DaylightSavingTimeDiff
DNS Control
DNSQueryOrder
DNSQueryDelay
GMT+07:00(Bangkok,Jakarta)
GMT+08:00(Beijing,HK,Singapore)
GMT+09:00(Tokyo,Seoul)
GMT+10:00(Sydney,Guam)
GMT+11:00(Solomon Is.)
GMT+12:00(Fiji,Auckland)
Yes
3/8/7/2
When more than one DNS servers are available, the unit will attempt to
resolve a domain name by querying each server sequentially until a successful
result is received. The parameter controls the order in querying the servers.
Available choices are:
- DNS Server1, DNS Server2, DHCP Offered DNS Servers
- DHCP Offered DNS Servers, DNS Server1, DNS Server2
When more than one DNS servers are available, the unit will attempt to
resolve a domain name by querying each server sequentially until a successful
result is received. This parameter controls the number of seconds between
successive DNS query made by the unit for a given domain name. Choices are 0
5 (s)
DNS Server1,
DNS Server2,
DHCP Offered
DNS Servers
One of 32 Local DNS Records (numbered 1 32). Each record is a mini script of
the following format:
Name=A,A,A,...
OR
Name=R,R,R,...
where Name represents the domain name to be resolved locally, and has the
format prefix+domain (such as machine.sip+obihai.com). Everything after
+ is considered as the domain to be appended to the host field in each R on
the right hand side. + is optional; if missing the full domain must be used in
every R.
A represents an A record which is just an ip address, such as 192.168.12.17.
R represents an SRV record and has the format: {host:port,pri,wt} where
- host is a hostname with or without domain part (such as xyz, xyz.abc.com.). A
dot (.) at the end of host indicates it is a complete hostname that does not
require the domain to be appended.
- port is a port number (such as 5060)
- pri is the priority. Valid value is 0(highest) 65535(lowest)
- wt is the weight. Valid value is 0(lowest) 65535(highest)
67
11/1/7/2
1
Note: If the A record of a given hostname cannot be found in any of the Local
DNS Records, the device will attempt to resolve it using external DNS queries.
Any change applied to local DNS Record needs reboot in order to take effect.
LAN Settings
Below is a screen shot of the LAN Settings device web page.
68
Default
Setting
Description
LAN Settings
CurrentRouterIPAddress
OperationMode
The current IP address of the router on the LAN side (read only). It is blank if
OBi is operating in bridge mode.
The Networking Operation Mode for the device. It can be one of the following
69
Router
RouterIPAddress
SubnetMask
ClientAddressRangeStart
values:
Router
Bridge
The LAN side IP address to be used by the router. If it conflicts with the WAN
side IP address, the OBi will automatically pick a different LAN side IP address
to resolve the conflict.
The LAN side Subnet Mask to be used by the router. It can be one of the
following values:
255.255.255.0
255.255.255.128
255.255.255.192
255.255.255.224
255.255.255.240
255.255.255.248
Enable the DHCP Server on the LAN side
The value of this parameter together with the values of
CurrentRouterIPAddress and SubnetMask determine the starting IP address
to assign to DHCP clients. The value of this parameter is the starting value of
the lower bits of the 32-bit starting IP address not masked by the
SubnetMask, and it MUST fit within the unmasked range of the SubnetMask.
Here are some examples:
SubnetMask
255.255.255.0
255.255.255.0
MaximumClients
AddressLeaseTime
LocalDomainName
CurrentRouter
IPAddress
192.168.10.1
192.168.2.1
ClientAddress
RangeStart
100
50
255.255.255.0
Yes
100
First Client IP
Address
192.168.10.100
192.168.2.50
The size of the IP address range from which to pick addresses to assign to
DHCP clients that are not in the DHCP reservation list. If the range extends to
addresses outside of the SubnetMask, a red exclamation mark (!) will be
shown next to the value on the OBi device web page.
IP address lease time in minutes
Local Domain Name for the LAN
192.168.10.1
70
50
1440
DHCP Reservation
You can reserve up to 20 specific IP addresses for the DHCP server to give out to DHCP clients with specific MAC addresses.
Below is a screen shot of the DHCP Reservation web page.
Default
Setting
Description
Enable this reservation
An optional name for easy identification of the client
Client MAC address in the format "xx:xx:xx:xx:xx:xx" (where each x is a hex
digit that can be in the upper or lower case)
The IP address to reserve for this client
No
71
VPNPassThrough
DMZ Settings
Enable
HostIPAddress
Default
Setting
Description
Enable the firewall
Support NATRedirection (a.k.a. NAT Loopback or Hairpin). This setting takes
effect only if firewall is enabled; otherwise this feature is disabled
Enable the protection against Distributed Reflection Denial of Service. This
setting takes effect only if firewall is enabled; otherwise this feature is
disabled
Allow VPN (L2TP, PPTP and IPSEC) traffic to pass through if enabled;
otherwise all VPN traffic are blocked. This setting takes effect only if firewall
is enabled; otherwise this feature is enabled
No
No
72
No
No
Yes
Port Forwarding
A port forwarding rule is useful for supporting a server application on a LAN client, such as FTP Server or HTTP Server. On
the OBi 202 you can define up to 20 port forwarding rules. Below is a screen shot of the Port Forwarding web page.
Parameter
Description
Enable
RuleDescription
Protocol
StartingPort
EndingPort
73
No
TCP
ServerIPAddress
The LAN side IP address to forward the packet to when it is received at a port
on the WAN side within the port range in this rule with matching transport
protocol
QoS Settings
QoS only applies to upstream traffic to the WAN side. The QoS settings described here takes effect in router mode only. It is
based on Traffic Control(TC) and Hierarchy Token Bucket (HTB). Refer to the HTB home pages for details on TC and HTB
(http://luxik.cdi.cz/~devik/qos/htb/).
Four priority classes of upstream traffic are defined in the OBi QoS policy: The Restricted class has the highest priority,
followed by the High, the Medium, and the Low classes. To fully utilize the upstream bandwidth, it is important to have a
relatively accurate upstream bandwidth estimation configured in the UpStreamBandwidth parameter; this tells the OBi the
total upstream bandwidth to allocate to the four priority classes.
The guaranteed uplink bandwidth for Restricted class traffic is configured in the RestrictedBandwidth parameter. The rest
of the upstream bandwidth (the UpStreamBandWidth less the RestrictedBandwidth) is divided among the High,
Medium,and Low classes proportionally according to the assigned weighting factor for each class in the configuration. Let
Whigh, Wmedium, and Wlow be the respective weight assigned to the High, Low, and Medium classes, the corresponding
guaranteed uplink bandwidth for each class is calculated using the following formulae:
BWhigh
(Kbps)
BWmedium
(Kbps)
BWlow
(Kbps)
The native voice related traffic is always classified as Restricted. Other network packets are classified based on the
Differentiated Service Code Point (DSCP) in their IP headers. The 64 possible DSCP codes (0 63) can be mapped into one
of the four priority classes using the configurable DSCP to Priority Class Mapping table.
Below is a screen shot of the QoS Settings web page.
74
75
Description
Default Setting
No
2048
512
5
3
76
Low
N
(N = 0 63)
The priority class to be assigned to the packet which has the DSCP
code equal to N in the IP header. The choices are:
Restricted
High
Medium
Low
77
WiFi Settings
A screenshot of the WiFi Settings device page is shown below.
78
Default
Setting
Description
Basic Settings
Enable
PreferredAccessPoint
ShowAccessPointPassword
Enable OBiWiFi feature. You must have an OBiWiFi dongle attached to the OBi
to use the feature
Indicate which access point to use when more than one remembered AP are
in range. Select from the list: None, Access Point 1, Access Point 2, , Access
Point 20.
This value is automatically populated with the last AP that OBi user chose to
connect explicitly from the device web page
Check this box and press submit to show all the AP passwords in (unmasked)
plain text (no reboot required). The passwords will be masked again following
a reboot of the device
Yes
None
No
Internet Settings
AddressingType
IPAddress
SubnetMask
DefaultGateway
DNSServer1
DNSServer2
Access Point N
(N=1,2,,20)
SSID
Password
SecurityEnabled
79
DHCP
WiFi Scan
The WiFi Scan device page offers a familiar user interface to let you scan for access points in the neighborhood. A
screenshot of this page is shown below. You can click on the page one of the available AP to connect to. If the AP requires
authentication but the OBi does not have any valid credential, a page will be returned to prompt you to enter a password or
pass-phrase and press Connect to continue.
If your AP does not show up as a listed device on this page, e.g. perhaps its SSID is not broadcast, you may enter its SSID and
security credentials manually by clicking the Add a Network link. The Manage Networks link takes you back to the WiFi
Settings device page, whereas the Scan For Networks link reloads this page in order to rescan for the access points in the
neighbourhood.
80
Default
Setting
Description
Internet Settings
AddressingType
IPAddress
SubnetMask
DefaultGateway
DNSServer1
The method used for assigning IP address, subnet mask, default gateway, etc.,
to the device. Available choices are:
DHCP: IP address, default gateway, etc. are assigned by DHCP Server. these
these
Static: IP address, default gateway, etc. are taken from the manually
configured values.
The IP address to assign to the device when AddressingType is set to Static.
The subnet mask to use when AddressingType is set to Static.
The default gateway IP address to assign to the device when AddressingType is
set to Static.
IP address of the first DNS server to use, in addition to the ones obtained from
the DHCP server when DHCP is also enabled. If AddressingType is set to Static,
the device only uses DNSServer1 and DNSServer2 for DNS lookup. It will try up
to 5 DNS servers when attempting to resolve a domain name. DNSServer1 and
81
DHCP
DNSServer2
VLANID
VLANPriority
Local Time
CurrentLocalTime
Time Service Settings
NTPServer1
NTPServer2
LocalTimeZone
DaylightSavingTimeEnable
DaylightSavingTimeStart
DNSServer2 will be tried first, whichever is specified, and then the ones
obtained from the DHCP Server if available.
IP address of the second DNS server to use, in addition to the ones obtained
from the DHCP server when DHCP is also enabled. If AddressingType is set to
Static, the device only uses DNSServer1 and DNSServer2 for DNS lookup. It will
try up to 5 DNS servers when attempting to resolve a domain name.
DNSServer1 and DNSServer2 will be tried first, whichever is specified, and then
the ones obtained from the DHCP Server if available.
Valid range is 0 4094 (4095 is reserved). 0 means VLAN is disabled and egress
packets are not tagged by the divice. This setting applies to all packets sent by
the device.
Valid choices are 0 7. This setting applies to all packets sent by the device.
pool.ntp.org
Yes
3/8/7/2
GMT-08:00
82
DaylightSavingTimeEnd
DaylightSavingTimeDiff
DNS Control
DNSQueryOrder
DNSQueryDelay
83
11/1/7/2
1
DNS Server1,
DNS Server2,
DHCP Offered
DNS Servers
abc.obihai.com=192.168.15.118,192.168.15.108
Note: If the A record of a given hostname cannot be found in any of the Local
DNS Records, the device will attempt to resolve it using external DNS queries.
Any change applied to local DNS Record needs reboot in order to take effect.
84
Description
Default Setting
Disabled
85
Interval
FirmwareURL
DnsLookupType
A Record Only
- Try Both
A Record Only
No Prefix
With Prefix
Try Both
No Prefix
Password
ITSP Provisioning
Current operational method of Provisioning. Available
choices are:
-
Method
System Start
86
Interval
ConfigURL
tftp://$DHCPOPT66/$MAC.xml
DnsLookupType
A Record Only
- Try Both
A Record Only
No Prefix
With Prefix
Try Both
No Prefix
OBiTALK Provisioning
Current operational method of Provisioning. Available
choices are:
Method
System Start
87
Interval
ConfigURL
tftp://$DHCPOPT66/$MAC.xml
DnsLookupType
A Record Only
- Try Both
A Record Only
No Prefix
With Prefix
Try Both
No Prefix
TPRM0 to TPRM3
The value can be any plain text or a valid canonical parameter name
preceded by a $ sign. For example:
$X_DeviceManagement.WebServer.Port
Note: Here you MUST NOT enclose the parameter name following
the $ sign with braces or parentheses.
ExpandIn
88
X_DeviceManagement.HTTPClient.UserAgent
Note: There is no $ sign in front of the parameter name. The macro
cannot be used in any parameter value if this value is set to blank
(the default)
SyntaxCheckResult
Description
MAC
ANY
MACC
ANY
mac
ANY
89
FWV
ANY
HWV
ANY
IPA
ANY
DM
ANY
DMN
ANY
OBN
ANY
DSN
ANY
GPRMn n=0
7
Auto Provisioning::ConfigURL,
Auto Firmware Update::FirmwareURL
TPRMn n=0-3
UDMn, n=0-3
Auto Provisioning::ConfigURL,
Auto Firmware Update::FirmwareURL
The value of User Define Macro n::ExpandIn
90
Device Administration
Description
Default Setting
80
admin
user
No
Syslog
Server
Port
Level
TAG
Yes
514
7
91
HTTP Client
UserAgent
TimeOut
$DM
600
92
Device Update
See the section entitled, Firmware: OBi Device Update and Management for details on device firmware updates.
Each ITSP configuration is grouped together as an ITSP Profile. We refer to them as ITSP Profile A, B, C , and D respectively..
The SP service account specifics on the other hand are grouped under the heading SPn Service, where n = 1, 2, 3 or 4. An
ITSP Profile includes such parameters as ProxyServer, OutboundProxy, and DigitMap, but does not include
account specific parameters. A SP Service includes account specific parameters such as AuthUserName (usually the
phone number of the account), AuthPassword, CallerIDName, and X_ServProfile (which ITSP Profile to
assume). If both SP Service use the same ITSP, then only one ITSP Profile needs to be configured with both SP Services
referred to the same profile.
From the OBi device point of view, the SPn Service using ITSP Profile X is enabled with the following minimal settings:
ITSP Porfile X SIP::ProxyServer = Not Blank
SPn Service::Enabled = Yes
SPn Service::AuthUsername = Not Blank
93
SIP Registration
Device can be setup to periodically register with a SIP Proxy Server or SIP Registration Server. SIP Proxy Server and SIP
Registration Server can be different, although they are usually the same in practice. SIP Proxy Server is a required
parameter that must be configured on the OBi device. The Registration Server is optional and assumed to be the same as
the SIP Proxy Server if it is not configured on the device.
The main purpose of registration is to create and maintain a dynamic binding of the SIP account to the devices local contact
address. Service provider can also rely on this periodic message to infer if the device is online and functional. Each OBi
device takes only one local IP address that is either statically assigned in the devices configuration, or dynamically obtained
from a local DHCP server. The SPn service for n = 1, 2, 3, and 4, on the other hand each uses a different local contact port
for sending and receiving SIP messages (default is 5060, 5061, 5062, and 5063 respectively).
Note that dynamic address binding through periodic registration is not strictly necessary if the local IP address of the device
does not change; the devices contact address may be statically configured on the Registration Server.
94
of the SIP Proxy Server or SIP Registration Server. The resolution of the server domain name into IP address is performed in
the following manner:
-
If the result from the DNS query is a SRV record, the server port is taken from that record also (the server port value
configured on the device is ignored). Otherwise, the server port is taken from the configured value or use 5060 if none
specified.
From the received= and rport= parameters of the VIA header of the REGISTER response sent by the server;
these two parameters tells the device its mapped IP address and port number respectively. This method is used if
periodic registration is enabled on the device
From the response to a STUN binding request the device sent to a STUN server. This method is used by enabling
X_KeepAliveEnable and setting the X_KeepAliveMsgType parameter to stun. In that case, the STUN server is
taken from the X_KeepAliveServer parameter, if it is specified. Otherwise, the keep-alive messages are sent to the
same server where a REGISTER request would be sent to. The latter is the most effective way of using STUN to
discover the mapped external contact address
The device always uses the mapped external contact address in all outbound SIP requests instead of its local contact
address if one is discovered by either method discovered above.
95
While maintaining registration with the Primary Server, the OBi will continually attempt to fallback to one of the candidate
servers that has higher priority than the primary server, if any. The list of candidate servers that the device is trying to
fallback on is known as the primary fallback list, which may be empty.
In addition, an OBi device can be configured to maintain a secondary registration with a server that has lower or equal
priority than the primary server. Secondary registration can be enabled by setting the parameter X_SecondaryRegistration
to YES. If X_ProxyServerRedundancy is NO, however, X_SecondaryRegistration does not take any effect. If this feature is
enabled, as soon as a primary server is found, the OBi will search for a working secondary server in the same manner from
the list of candidate servers that are of lower or equal priority than the primary server. Simarly, once a secondary server is
found, the OBi forms a secondary fallback list to continually attempt to fallback on if the list is not empty.
The interval for checking the primary fallback list and the secondary fallback list are configured in the parameter
X_CheckPrimaryFallbackInterval and X_CheckSecondaryFallbackInterval respectively. These parameters are specified in
seconds and the default value is 60 for both.
Notes:
Secondary server exists implies primary server exists.
If the secondary server exists, it immediately becomes the primary server when the current primary server is fails;
device then starts searching for a new secondary server if the candidate set is not empty.
The candidate list may change (lengthened, shortened, priority changed, etc.) on every DNS renewal (based on the
entrys TTL). Device will rearrange the primary and secondary servers and fallback lists accordingly, whichever
applicable.
If the server redundancy feature is disabled, the device resolves only one IP address from the servers domain name, and
will not attempt to try other IP addresses if the server is not responding.
SIP Privacy
The OBi device observes inbound caller privacy and decodes callers name and number from SIP INVITE requests by
checking the FROM, P-Asserted-Identity (PAID for short), and Remote-Party-ID (RPID for short) message headers. All these
headers may carry callers name and number information.
If PAID is present, device takes the name and number from it. Otherwise, it takes name and number from RPID if it is
present, or from the FROM header otherwise. RPID, if present, will include privacy setting desired by the caller. This privacy
may indicate one of the following options:
-
off = no privacy requested; the OBi will show name and number.
full = full privacy requested; the OBi will hide both name and number.
name = name privacy requested; the OBi will show the number but hide the name.
uri = uri privacy requested; the OBi will show the name but hide the number.
Regardless, if PAID exists or not, the device always takes the privacy setting from the RPID if it is present in the INVITE
request. Note that if the resulting caller name is Anonymous (case- insensitive), device treats it as if the caller is
requesting full privacy.
For outbound calls, callers preferred privacy setting can be stated by the device in a RPID header of the outbound INVITE
request. To enable this behavior, the parameter ITSP Profile X SIP::X_InsertRemotePartyID must be set to YES or TRUE,
which is the default value of this parameter. OBi only supports two outbound caller privacy setting: privacy=off or
privacy=full. The RPID header generated by the device carries the same name and number as the FROM header. If
outbound caller-ID is blocked, the device sets privacy=full in RPID, and also sets the display name in the FROM and RPID
headers to Anonymous for backward compatibility. The device will not insert PAID in outbound INVITE requests.
96
It should be noted that the STUN feature used in this context is only for RTP packets, not SIP signaling packets (which
typically does not require STUN). The device to send out a STUN binding request right before making or answering a call on
SP1/2. If the request is successful, the device decodes the mapped exteranal address and port from the binding response
and use them in the m= and c= lines of its SDP offer or answer sent to the peer device. If the request fails, such as STUN
server not found or not responding, the call will go on without using external address in the SDP.
Standard RTP requires the use of even number port in the m= line. If the external port is not a even number, device changes
the local RTP port and redo STUN, and will continue to do this up to 4 times or until an even external port number is found.
If the 4th trial still results in an odd external port number, the call will go on without using external address in the SDP.
OBi supports standard ICE based on RFC5245. ICE is done on a per call basis for automatically discovering which peer
address is the best route for sending RTP packets. To enable ICE on the device, set the parameter: ITSP Profile X
General::X_ICEEnable to YES (or TRUE). The default, however, is NO (or FALSE).
Note that ICE would be more effective if STUN is also enabled. However STUN not a requirement for using ICE on the
device. If STUN is enabled and an external RTP address different from its local address is discovered, OBi offers two ICE
candidates in its SDP:
-
Otherwise only the local host candidate is shown in the devices SDP. Note that the device uses the srflx address in the m=
and c= lines of the SDP if STUN is enabled and successful.
If ICE is enabled and peers SDP has more than one candidate, device sends STUN requests to each peer candidate from its
local RTP port. As soon as it receives a response from the highest priority candidate, device concludes ICE and uses this
candidate to communicate with the peer subsequently. Otherwise, the OBi allows up to 5s to wait for the response from all
the candidates, and selects the highest priority one that has a response. Once ICE is completed successfully, the device will
further apply symmetric RTP concept to determine the peers RTP address (i.e., send to the address where peers RTP
packets are coming from).
97
When acts as a loopback mirror, OBi device always sends primer packets so that incoming packets can get through
NAT/Firewall. The media loopback feature is controlled by the following parameters (under PHONE Port Calling Features
section):
-
AcceptMediaLoopback Enable device to accept incoming call that requests media loopback. Default is YES.
MediaLoopbackAnswerDelay The delay in millis before the OBi answers a media loopback call. Default is 0.
MediaLoopbackMaxDuration The maximum duration to allow for an incoming media loopback call. Default is 0,
which means the duration is unlimited.
Note that the device will reject incoming media loopback call if:
-
Device will terminate an inbound media loopback call already in progress when:
-
To make an outgoing loopback call, user can dial one of the following star codes before dialing the target number:
-
Note that outbound Media Loopback Call is not subjected to call duration limit; it will last until the user hangs up or until
the called device ends the call.
98
SignalingProtocol
DTMFMethod
X_UseFixedDurationRFC2833DTMF
DigitMap
STUNEnable
STUNServer
X_STUNServerPort
X_ICEEnable
X_SymmetricRTPEnable
Description
Default Setting
SIP
Auto
FALSE
(1xxxxxxxxxx|<1>[29]xxxxxxxxx|011xx.|xx.)
No
3478
No
No
99
100
RegistrarServerPort
RegistrarServerTransport
UserAgentDomain
UserAgentTransport
OutboundProxy
OutboundProxyPort
X_OutboundProxyTransport
X_BypassOutboundProxyInCall
RegistrationPeriod
X_RegistrationMargin
Description
Host name or IP address of the SIP proxy
server
Destination port to connect to the SIP server
Transport protocol to connect to SIP server.
The three choices are UDP, TCP, or TLS
Hostname or IP address of the SIP registrar. If
a value is specified, device sends REGISTER to
the given server; otherwise REGISTER is sent
to ProxyServer
Destination port to connect to SIP registrar
Transport protocol to connect to registrar.
This parameter is reserved for future. The
only choice is UDP
CPE domain string. If empty, device uses
ProxyServer as its own domain to form its
AOR (Address Of Record) or Public Address
when constructing SIP messages (for
example, in the FROM header of outbound
SIP Requests).
Note: If SPx Service::URI is specified,
additional rules applied in forming the AOR.
See description of URI parameter for more
details and examples
Transport protocol for incoming call control
signalling. This parameter is reserved for
future. The only choice is UDP
Host name or IP address of the outbound
proxy. Outbound proxying is disabled if this
parameter is blank.
Destination port to be used in connecting to
the outbound proxy
Control the SIP transport for the outbound
proxy server which may be different from
that of the proxy server. Available choices
are:
UDP
TCP
TLS
Follow ProxyServerTransport
Note: Option not available on OBi100/OBi110
Enable this option to bypass the
OutboundProxy inside a SIP dialog.
Note: Option not available on OBi100/OBi110
Nominal interval between device register in
seconds
Number of seconds before current
registration expires that the OBi should reRegister (e.g. 5s). If value is less than one, it is
Default Setting
5060
UDP
5060
UDP
UDP
5060
Follow ProxyServerTransport
No
60
101
TimerT1
TimerT2
TimerT4
TimerA
TimerB
TimerD
TimerE
TimerF
TimerG
TimerH
TimerI
TimerJ
TimerK
InviteExpires
ReInviteExpires
RegisterExpires
RegistersMinExpires
RegisterRetryInterval
X_RegisterRetryResponseCode
DSCPMark
VLANIDMark
EthernetPriorityMark
X_SpoofCallerID
500
4000
5000
500
32000
32000
500
32000
500
32000
5000
32000
5000
60
10
3600
15
30
(<40[17]:w120>|<40[34]:w120>|<99[01]:w120200>|[4-9]xx)
0
0
3
No
102
X_UseRefer
X_ReferAOR
X_Use302ToCallForward
X_UserAgentName
X_ProcessDateHeader
X_InsertRemotePartyID
X_SessionRefresh
X_AccessList
X_InsertRTPStats
X_MWISubscribe
No
Yes
Yes
OBIHAI/${DM}-${FWV}
Yes
Yes
Yes
Yes
No
103
enabled or not
X_MWISubscribeURI
X_MWISubscribeExpires
X_RegSubscribe
X_RegSubscribeExpires
X_ProxyServerRedundancy
X_SecondaryRegistration
X_CheckPrimaryFallbackInterval
X_CheckSecondaryFallbackInterval
X_ProxyRequire
X_MaxForward
X_AcceptLanguage
X_DnsSrvAutoPrefix
3600
No
3761
No
No
60
60
70
No
104
X_UserEqPhone
X_CallWaitingIndication
X_Support100rel
X_DiscoverPublicAddress
X_UsePublicAddressInVia
X_PublicIPAddress
X_UseRport
X_UseCompactHeader
X_FaxPassThroughSignal
X_IncludeMessageHash
No
No
No
Yes
No
Yes
No
ReINVITE
No
105
X_EchoServer
X_EchoServerPort
X_EnableRFC2543CallHold
DSCPMark
X_UseSSL
RTCP
Enable
TxRepeatInterval
LocalCName
Description
Default Setting
16600
16798
0
Enable RTCP
RTCP packet transmission interval in milliseconds
The canonical name to use in RTCP messages. If
blank, the device will use
No
10000
0
No
106
X_RTCPMux
No
107
Starting with firwmare release 1.2, the following features are supported:
-
MWI (Message Waiting Indication) and VMWI (Visual Message Waiting Indication) for Google Voicemail.
Accept DTMF input from a Google Talk client entered by the user as text messages (only 0 9, *, and # will be
recognized by the device).
Accept the setting of the parameter ITSP Profile A/B General::DTMFMethod. The value can be either InBand or
RFC2833. Other values will be reverted to RFC2933. Default is RFC2833.
108
109
Parameter Guide:
Parameter
Description
Default Setting
Enable
Yes
X_ServProvProfile
X_RingProfile
Select a Ring Profile to ring the PHONE port with for incoming
calls on this service that are routed to the PHONE port. The
ringing pattern will be taken from the given profile. Choices are
A, or B
X_CodecProfile
Select a Codec Profile for all calls on this service. Choices are A,
or B
SPx Service
110
X_InboundCallRoute
ph
X_RegisterEnable
Yes
X_NoRegNoCall
No
X_KeepAliveEnable
No
X_KeepAliveExpires
X_KeepAliveServer
X_KeepAliveServerPort
5060
X_KeepAliveMsgType
The type of keep alive messages to send out periodically if keepalive is enabled. It can be one of the following choices:
keep-alive
Where
NOTIFY may be replaced by any other SIP method, such
as PING,
event parameter is optional and is only applicable if
method is NOTIFY. If event is not specified, the 'keepalive' event will be used with NOTIFY
user parameter is optional; if not specieifed, the
request-uri will not have a userid, and the TO header
field will use the same userid as the FROM header
(which is the local account userid). If user is specified, it
will be used as the userid in the Request-URI and TO
header.
111
15
UDP port where the device sends and listens for SIP messages
DirectoryNumber
X_DefaultRing
Default ring pattern number to ring the PHONE port for incoming
calls on this trunk that are routed to the PHONE port according
to the InboundCallRoute of this service. The ring pattern is taken
from the selected Ring Profile. Valid choices are 1-10
Pattern to ring PHONE port when holding a call on this trunk that
has been connected to the PHONE port. Typically this is a very
short distinctive ring pattern that serves as a reminder to the
user that a call is being on hold. The ring pattern is taken from
the selected Ring Profile. Valid choices are: NO Ring, or 1-10
The ring pattern number to use to ring the PHONE port when a
repeat dial operation on this trunk is successful as the called
party is either ringing or answered
Call Waiting Ring pattern to ring the PHONE port when the
incoming call is requesting to barge-in. This is applicable in a callwaiting scenario on the PHONE port
Ring pattern to ring the PHONE port only as a reminder that
there are some calls parked in the parking lot. This feature is
applicable only in an OBiPLUS solution.
Enable sending of SIP signaling debug information to the syslog
server (if one is configured on the device). Available choices are:
Disable (do not send SIP signaling debug information)
Log All Messages
Log All Except REGISTER Messages
A list of SIP methods to exclude from the syslog for this SP
service. For example: notify, subscribe
Enable satellite mode on this trunk. In this mode, the user must
explicitly sign on (using * code) to receive phone calls on this
trunk. The SIP REGISTER sent by the OBi to the ITSP on this trunk
will indicate if the user wants to sign on (and therefore takes
over the incoming calls for this account). This feature is only
applicable if the service is provided by an OBiPLUS system
X_CallOnHoldRing
X_RepeatDialRing
X_BargeInRing
X_CallParkedRing
X_SIPDebugOption
X_SipDebugExclusion
X_SatelliteMode
X_Proxy
5060
112
10
Disable
No
No
X_ProxyClientConfig
113
X_AcceptResync
114
yes without
authentication
AuthPassword
URI
Some Examples:
1) Let ProxyServer = sip.myitsp.com, AuthUserName =
4089991123, URI=[empty], UserAgentDomain=[empty], then
AOR = [email protected]
2) Change UserAgentDomain to users.myitsp.com, then
AOR = [email protected]
3) Change URI to bobdylan, then
AOR = [email protected]
4) Change URI to [email protected], then
AOR = [email protected]
Note: In all cases, device uses AuthUserName and
AuthUserPassword to compute authorization if challenged by a
401 or 407 response.
SPx Calling Features
CallerIDName
MaxSessions
CallForwardUnconditionalEnable
115
2
No
CallForwardUnconditionalNumber
CallForwardOnBusyEnable
CallForwardOnNoAnswerEnable
CallForwardOnNoAnswerNumber
CallForwardOnNoAnswerRingCount
MWIEnable
MWIEnable2
No
CallForwardOnBusyNumber
X_BlockedCallers
No
116
No
No
X_VMWIEnable
X_VMWIEnable2
MessageWaiting
AnonymousCallBlockEnable
AnonymousCallEnable
DoNotDisturbEnable
X_BridgedOutboundCallMaxDuration
X_AcceptDialogSubscription
X_AcceptLinePortStatusSubscription
X_SkipCallScreening
X_SMSNotify
X_XMPPPriority
X_GTalkSimultaneousRing
X_SRTP
No
No
No
No
No
No
No
Yes
No
Yes
No
Disable SRTP
117
Disable SRTP = Do not use SRTP for all calls; the call will
fail if the peer insists on using SRTP only
Use SRTP Only = Require all calls to use SRTP; the call
will fail if the peer does not support SRTP
Use SRTP When Possible = Use SRTP for a call if the peer
supports SRTP; otherwise fallback to use regular
unencrypted SRTP
118
InboundCallRoute
RingProfile
CodecProfile
Description
Enable the OBiTALK Service (the built-in free voice
service that comes with every OBi Device)
The UDP or TCP port used by device to send and listens
for OBiTALK messages
Enable the unit to try a few random UDP ports until it
can successfully join the OBiTALK network
Display name to identify the subscriber, for the purpose
of displaying a Caller ID Name on the recipients device
Digit map to restrict numbers that can be dialed or
called with this service. See OBi Call Routing and Digit
Map Section for a description of the syntaxes for
specifying a Digit Map.
Routing rule for directing incoming calls on this service.
The default rule is to send all incoming calls to the
PHONE port (ph). See OBi Call Routing and Digit Map
Section for a description of the syntaxes for specifying
this parameter
Select a Ring Profile to ring the PHONE port with when
an incoming call is routed to the PHONE port. Choices
are A, or B
Select a Codec Profile to be used for all calls on this
service. Choices are A, or B.
Default Setting
Yes
10000
No
(<ob>xxxxxxxxx|obxxxxxxxxx)
Ph
119
DefaultRing
CallOnHoldRing
RepeatDialRing
DTMFMethod
UseFixedDurationRFC2833DTMF
AUTO
FALSE
CallForwardUnconditionalNumber
CallForwardOnBusyEnable
Description
Enable call forwarding of all calls unconditionally by the
device. If CallForwardUnconditionalNumber is blank, this
parameter is treated as if it has been set to No.
Default Setting
No
No
120
CallForwardOnBusyNumber
CallForwardOnNoAnswerEnable
CallForwardOnNoAnswerNumber
CallForwardOnNoAnswerRingCount
BlockedCallers
AnonymousCallBlockEnable
AnonymousCallEnable
DoNotDisturbEnable
MaxSessions
No
2
No
No
No
121
AuthUserID1
AuthPassword1
AuthUserID2
AuthPassword2
AuthUserID3
AuthPassword3
AuthUserID4
AuthPassword4
Description
The OBiTALK protocol allows incoming calls to indicate a
target number that is different from this devices OBi
number. The device in that case will attempt to establish
and bridge the call to the target number according to the
rules configured in the trunks InboundCallRoute
parameter. Hence this device acts as a gateway and the
method is referred to direct dialing or 1-stage dialing
(versus 2-stage dialing via the Auto-Attendant). Since the
caller is not able to enter a PIN in such cases, an
automated method based on signalling protocol must be
used to authenticate the caller if authentication is
required. OBi device offers the following choices for this
purpose:
None = Disable authentication
HTTP Digest = Use HTTP Digest with User-ID and
Password pairs. Note that at least one of
AuthPasswordx (x=1,2,3,4) must be specified,
otherwise authentication is disabled.
One of 4 user IDs for authenticating direct dialing callers
One of 4 passwords for authenticating direct dialing
callers
One of 4 user IDs for authenticating direct dialing callers
One of 4 passwords for authenticating direct dialing
callers
One of 4 user IDs for authenticating direct dialing callers
One of 4 passwords for authenticating direct dialing
callers
One of 4 user IDs for authenticating direct dialing callers
One of 4 passwords for authenticating direct dialing
callers
Default Setting
HTTP Digest
Note: If AuthPassword is specified, AuthUserID may be set to blank to let the device use the default value which is a special
hash of the AuthPassword. This is only applicable if the external gateway is also an OBi device that understands how to
generate the default AuthUserID using the same hash function.
122
AA Callback Service
The OBi offers two methods for the AA to call you back at a number that you picked (or designated by the admin of the OBi
device).
The first method is by statically configuring a trunks InboundCallRoute. A rule can be added to the InboundCallRoute
parameter to have the AA call back the callers or any other number, if the caller hangs up before the AA answers. The rule
should indicate that aa(callback-number) is the target destination of the call, where callback-number is the number that
the AA should call back if the caller hangs up before the AA answers the call. For example, the following rule
{(<**1>(14089913313|12121559801)):aa($1)}
says that: if 14089913313 or 12121559801 calls, the call is routed to AA. If caller hangs up before the AA answers, AA calls
the number represented by $1. Recall that $1 is expanded into the caller number after processing by the digit map on the
left side of the colon. In this case it is the callers number prepended by **1. The **1 is required for outbound call routing
when AA calls back; here it indicates SP1 is to be used for calling back (assuming default value of the AA OutboundCallRoute
parameter)
The parameter AA Service::CallbackAnswerDelay controls the number of milliseconds before AA answers when a callback
number is specified as shown in the example. The default value is 10000 ms (10 seconds). Without the (callback-number)
argument, the AA behaves the normal way and the answer delay is governed by the parameter AA Service::AnswerDelay.
The second method is by selecting AA option 3 to Enter a callback number after the AA answers the call. The caller can
explicitly enter the number to be called back by the AA. If a valid number is entered, AA says Thank You and Goodbye,
and then will start calling back 2 seconds after the current call has ended. If number entered is invalid, AA plays SIT tone
followed by an error message. Note that the variable $1 (representing the callers number) is carried over to the
subsequent AA callback call. The AA DigitMap can include $1 to be used in a callback context. For example, the following
rule in the AA DigitMap
(<00:**1$1>| )
says that if the AA dials 00, the device will transforms it into the callers number prepended by **1. In other words, if the
caller wants the AA to callback the current number (typically the case), he can simple enter 00# after selecting option 3 on
the AA menu. Note that $1 can only be used as part of a substitution element in the digit map; it must not be used for
matching elements since its value is unknown.
123
Automated Attendant:
IVR
Announcement
Number
Attendant Announcement
%User2%
%User3%;r=1300-3720
= play User3 prompt starting from 1300ms mark to the 3720ms mark
%User4%;r=3200-1200
124
Each prompt list control elements starts with a & in a prompt list. The following control elements are supported:
&pause(<duration>)
System Default
Prompt Be Played
Welcome
InvalidPin
Invalid PIN
EnterPin
Enter PIN
MenuTitle
Main Menu
Menu
PleaseWait
EnterNumber
Bye
125
126
SpaceAvailable
Description
A text string that describes the contents of this user
prompt
Default Setting
Description
Enable AA. If enabled, the AA will answer an
incoming call that has been routed to it after a
period as specified in AnswerDelay. If disabled, the
AA will not attempt to answer any incoming call.
Default Setting
Yes
DigitMap
For OBi100:
([1-9]x?*(Mpli)|[1-9]|[1-9][0-9]|
<00:$1>|0|**1(Msp1)|
**2(Msp2)|**9(Mpp)|(Mpli))
OutboundCallRoute
For OBi110:
([1-9]x?*(Mpli)|[1-9]|[1-9][0-9]|
<00:$1>|0|**1(Msp1)|
**2(Msp2)|**8(Mli)|**9(Mpp)|
(Mpli))
For OBi200/202/300/302:
([1-9]x?*(Mpli)|[1-9]|[1-9][0-9]|
<00:$1>|0|**1(Msp1)|
**2(Msp2)|**3(Msp3)|
**4(Msp4)|**70(Mli)|**8(Mbt)|*
*81(Mbt)|**82(Mbt2)|
**9(Mpp)|(Mpli))
For OBi100:
{([1-9]x?*(Mpli)):pp},
{0:ph},
{(<**1:>(Msp1)):sp1},
{(<**2:>(Msp2)):sp2},
{(<**9:>(Mpp)):pp},
{(Mpli):pli}
For OBi110:
{([1-9]x?*(Mpli)):pp},
{0:ph},
{(<**1:>(Msp1)):sp1},
{(<**2:>(Msp2)):sp2},
{(<**8:>(Mli)):li},
{(<**9:>(Mpp)):pp},
{(Mpli):pli}
For OBi:202/OBi302:
127
{([1-9]x?*(Mpli)):pp},
{0:ph.ph2},
{(<**1:>(Msp1)):sp1},
{(<**2:>(Msp2)):sp2},
{(<**3:>(Msp3)):sp3},
{(<**4:>(Msp4)):sp4},
{(<**70:>(Mli)):li},
{(<**82:>(Mbt2)):bt2},
{(<**81:>(Mbt)):bt},
{(<**8:>(Mbt)):bt},
{(<**9:>(Mpp)):pp},
{(Mpli):pli}
For OBi:200/OBi300:
{([1-9]x?*(Mpli)):pp},
{0:ph},
{(<**1:>(Msp1)):sp1},
{(<**2:>(Msp2)):sp2},
{(<**3:>(Msp3)):sp3},
{(<**4:>(Msp4)):sp4},
{(<**70:>(Mli)):li},
{(<**82:>(Mbt2)):bt2},
{(<**81:>(Mbt)):bt},
{(<**8:>(Mbt)):bt},
{(<**9:>(Mpp)):pp},
{(Mpli):pli}
PrimaryLine
AnswerDelay
NumberOnNoInput
UsePIN
PSTN Line
4000
0
Note: According to the
default DigitMap and
OutboundCallRoute, calling
0 means calling the PHONE
port
No
128
Description
Prompt List to replace the systems Welcome message
Prompt List to replace the systems InvalidPin message
Prompt List to replace the systems EnterPin message
Prompt List to replace the systems MenuTitle message
Prompt List to replace the systems Menu message
Prompt List to replace the systems PleaseWait message
Prompt List to replace the systems EnterNumber message
Prompt List to replace the systems Bye message
Default Setting
129
Voice Gateways
A gateway in this context is another OBi device which lets incoming OBiTALK callers to call further on one or more of its
trunks (such as SP1, SP2, or LI). The caller can call the gateway first with a normal OBiTALK call, get the AA, and then dial the
target number. For authentication the AA may ask the user to enter a PIN before establishing the second call. This way of
dialing is known as 2-stage dialing.
On the other hand, a gateway can be configured on the originating OBi device such that the caller can dial the target
number directly without going through the AA. We refer to this method of dialing as direct dialing or 1-stage dialing. Since it
is not possible to enter a PIN in the case of direct dialing, a userid/password pair can be configured for the gateway also so
that the device can authenticate with the gateway automatically using HTTP digest method. HTTP digest authentication is
optional. You do not need to provide user/password if the gateway does not require authentication for direct dialing.
OBi allows the user to specify up to 8 gateways. Each gateway is addressed using its factory-assigned OBi Number. A
gateway is conceptually a trunk with its own DigitMap. You can refer to a gateway and its associated DigitMap with the
short trunk name VGn and (Mvgn) respectively, for n = 1, 2, 3, , 8. VGn and (Mvgn) can be used in call routing rules and
digit maps just like other real trunks.
As an example, you can add the rule {(1xxx xxx xxxx):vg2} in PHONE ports OutboundCallRoute to let the device dials out
using VGs when caller dials any 11-digit number starting with 1. On the gateway side, you can add the corresponding rule
{>(1 xxx xxx xxxx):sp1} in the OBiTALK Service::InboundCallRoute to make the call on its SP1 trunk. You can change the last
rule to {(290 333 100|200 444 101)>(1 xxx xxx xxxx):sp1} if you want to limit the gateway to allow just the two stated caller
numbers to make such calls.
Starting with firmware release 1.2, a gateway may also be configured with a SIP URL as the access number to be accessed
by the device over one of the SP trunks. For example, one can set the gateway access number as SP1(some-sipserver.mydomain.com), or SP2(192.168.15.111:5062), etc. Note that when using a SP trunk to access a (SIP) gateway, the
device will:
-
Not use the outbound proxy, ICE, or STUN regardless the settings on the SP trunk.
Use only the devices local address as the SIP Contact, and ignore any NATed address discovered by the device.
Use the gateways SIP URL to form the FROM header of the outbound INVITE.
130
DigitMap
AuthUserID
AuthPassword
Description
Default Setting
Yes
(xx.)
131
Trunk Groups
As the name implies, a trunk group is a group of trunks. If a call is routed to a trunk group, OBi picks one of the available
trunks from the group to make the call. Availability of trunk is based on:
-
Whether the trunks digit map allows the number to call, AND
Whether the trunk has capacity to make one more call
Up to 4 trunk groups can be configured on an OBi device. Each trunk group is conceptually another trunk with its own
DigitMap. A trunk group and its associated DigitMap are referenced using the short name TGn and (Mtgn) respectively,
where n = 1, 2, 3, 4. They can be referenced in other digit maps and call routing rules so that calls may be routed to a
particular trunk group.
1
Only trunks can be added to a trunk group. These include: PP1, SP1, SP2, SP3, SP4, LI1 , VG1, VG2, , VG8, TG1, TG2, TG4.
Note that a TG may include another TG (that is, TG can be recursive). However, you must make sure this does not result in
infinite recursion.
DigitMap
Description
Default Setting
Yes
132
OBiBlueTooth
This feature is available only on models with a USB port i.e. OBi2 Series and OBi3 Series devices.).
The OBiBlueTooth feature requires an OBiBT Bluetooth Adapter USB dongle (sold separately) connected to the USB port of
the OBi device. OBiBT is compatible with Bluetooth 1.1 to 4.0 and supports the HFP (handsfree) profile. When paired with a
mobile phone, OBiBT plays a role similar to a Bluetooth headset from the perspective of the mobile phone.
Up to two OBiBT dongles can be attached to the OBi (requires an external USB hub if more than one). Each dongle must be
set up to associate with either OBiBlueTooth 1 (BT1) Service or ObiBlueTooth 2 (BT2) Service.
133
After an initial pairing and connection with the mobile phone, OBiBT will automatically request connection with the same
phone next time it comes in range. If it still remembers the pairing information with OBiBT, your mobile phone would also
quietly accept the connection request.
You can find the device pairing information for the last 10 paired devices on the OBiBlueTooth device web page under the
Device Settings section. A screenshot of this page is shown below. There are two parameters for each paired device X,
where X = 1, 2, , 10:
PairedDeviceX The name of the paired device.
RemovePairedDeviceX Check this box and press the submit button to remove this device from the paired device
list.
Some exceptions:
If the pairing information is removed from the mobile phone after initial pairing and connection with OBiBT, the
next time it comes in range with OBiBT, the phone may pop up a message to let you know that the device OBi is
requesting connection. You may then manually accept the connection.
If the pairing information is removed from the OBi after initial pairing and connection with a mobile phone, it will
not automatically connect with the phone next time it comes in range. You must then go to your mobile phoness
Bluetooth setup screen and explicitly select the paired device OBi to re-establish connection
OBi remembers the paired devices based on particular OBiBT dongle that is used during pairing. Each OBiBT dongle
has a different hardware ID. If you replace the dongle with a different one, the existing device pairing information
will not be valid and OBi will not be able to recognize the previously paired devices when they are in range
134
135
InboundCallRoute
RingProfile
DefaultRing
CallOnHoldRing
DirectoryNumber
Description
Enable the OBiTALK Service (the built-in free voice
service that comes with every OBi Device)
Digit map to restrict numbers that can be dialed or
called with this service. See OBi Call Routing and Digit
Map Section for a description of the syntaxes for
specifying a Digit Map.
Routing rule for directing incoming calls on this service.
The default rule is to send all incoming calls to the
PHONE port (ph). See OBi Call Routing and Digit Map
Section for a description of the syntaxes for specifying
this parameter
Select a Ring Profile to ring the PHONE port with when
an incoming call is routed to the PHONE port. Choices
are A, or B
Default ring pattern number to ring the PHONE port for
incoming calls on this trunk that are routed to the
PHONE port according to the InboundCallRoute of this
service. The ring pattern is taken from the selected Ring
Profile. Valid choices are 1-10
Pattern to ring PHONE port when holding a call on this
trunk that has been connected to the PHONE port.
Typically this is a very short distinctive ring pattern that
serves as a reminder to the user that a call is being on
hold. The ring pattern is taken from the selected Ring
Profile. Valid choices are: NO Ring, or 1-10
The phone number of the connected mobile phone
service. This is just informational with no significance
Default Setting
Yes
(<ob>xxxxxxxxx|obxxxxxxxxx)
ph
CallForwardUnconditionalNumber
CallForwardOnBusyEnable
Description
Enable call forwarding of all calls unconditionally by the
device. If CallForwardUnconditionalNumber is blank, this
parameter is treated as if it has been set to No.
Default Setting
No
No
136
CallForwardOnBusyNumber
CallForwardOnNoAnswerEnable
CallForwardOnNoAnswerNumber
CallForwardOnNoAnswerRingCount
No
AnonymousCallBlockEnable
No
AnonymousCallEnable
No
BlockedCallers
DoNotDisturbEnable
BridgedOutboundCallMaxDuration
AAAskForConfirm
No
Yes
137
PairedDeviceN, N = 1, 2, , 10
RemovePairedDeviceN, N = 1, 2, ,
10
Description
Check this box and click the submit button to make the
OBiBT device discoverable for the next 120 seconds
Select which paired device is preferred, in the event that
more than one paired device are in range. The value is
automatically set to the device that explicitly requested
connection with OBiBT
The name of the device that has successfully paired with
OBiBT
Check this box and click the submit button to remove
this paired device
Default Setting
No
None
No
RepeatDialInterval = the minimum number of seconds between each redial. Default is 30s.
RepeatDialExpires = the maximum duration in seconds when the repeat dialing remains active. Default is 1800s.
User dials *06 to cancel Repeat Dialing. Only one repeat dial request is supported. Dialing *05 while a repeat dial is in
progress will be rejected with a fast busy tone. If *05 is accepted, the device plays normal dial tone.
Notes:
-
The first redial happens 5s after the phone is on-hook following *05.
When phone is off-hook or rings for an incoming call, device pauses redial and cancels the call if its already dialed
but the peer device is not ringing yet.
As soon as phone goes on hook or ringing stops without any calls on hold, repeat dialing resumes in 5s.
If called party answers before the local caller, device sends normal ringback tone over RTP to the called party.
The ring for alerting local user when the called party rings or answers is taken from outgoing trunks
RepeatDialRing parameter.
Repeat Dial service cannot be used on the LINE port. If the last call was made over the LINE port, dialing *05 will
result in fast busy.
138
Repeat Dial calls are not logged to call history, except the last and successful one when the called party rings or
answers.
139
140
OutboundCallRoute
Description
Default Setting
Yes
For OBi100:
([1-9]x?*(Mpli)|[1-9]|
[1-9][0-9]|911|**0|***|
**1(Msp1)|**2(Msp2)|
**9(Mpp)|(Mpli))
For OBi110:
([1-9]x?*(Mpli)|[1-9]|
[1-9][0-9]|911|**0|***|#|
**1(Msp1)|**2(Msp2)|
**8(Mli)|**9(Mpp)|(Mpli))
For OBi200/202/300/302:
([1-9]x?*(Mpli)|[1-9]S9|
[1-9][0-9]S9|911|**0|***|#|##|
**70(Mli)|**8(Mbt)|**81(Mbt)|
**82(Mbt2)|
**1(Msp1)|**2(Msp2)|
**3(Msp3)|**4(Msp4)|
**9(Mpp)|(Mpli))
For OBi100:
{([1-9]x?*(Mpli)):pp},
{**0:aa},{***:aa2},
{(<**1:>(Msp1)):sp1},
{(<**2:>(Msp2)):sp2},
{(<**9:>(Mpp)):pp},
{(Mpli):pli}
For OBi110:
{([1-9]x?*(Mpli)):pp},
{(<#:>|911):li},
{**0:aa},{***:aa2},
{(<**1:>(Msp1)):sp1},
{(<**2:>(Msp2)):sp2},
{(<**8:>(Mli)):li},
{(<**9:>(Mpp)):pp},
{(Mpli):pli}
141
CallReturnDigitMaps
Call Return is the service where the user can call the last
caller by dialing a star code (*69 by default). OBi device
implements this service by remembering the number of
the last caller in memory. However the stored
information does not include any dialing prefix to tell the
device which voice service to use to call back the last
caller. This list of digit maps serve the purpose of mapping
a callers number to one that includes the desired dialing
prefix used exclusively for call return service.
For OBi100:
{pli:(xx.)},
{sp1:(<**1>xx.)},
{sp2:(<**2>xx.)},
{pp:(<**9>xx.)}
For OBi110:
{pli:(xx.)},
{sp1:(<**1>xx.)},
{sp2:(<**2>xx.)},
{li:(<**8>xx.)},
{pp:(<**9>xx.)}
For OBi202:
{pli:(xx.)},
{sp1:(<**1>xx.)},
142
PrimaryLine
{sp2:(<**2>xx.)},
{sp3:(<**3>xx.)},
{sp4:(<**4>xx.)},
{pp:(<**9>xx.)}
For OBi110:
PSTN Line
For all other models:
SP1 Service
ToneOnPrimaryServiceDown
(OBi202 and OBi302 only)
Notes:
- SP3, SP4, BT1, and BT2 not available on
OBi100/OBi110
- PSTN Line not available on OBi100
- TG2 not selectable as Primary Line on OBi100/OBi110
Select the tone to play in place dial tone when the service
corresponding to the Primary Line is out-of-service.
Choose from:
No Tone
Normal Dial Tone
SIT Tone 1
SIT Tone 2
SIT Tone 3
SIT Tone 4
20
70
Sinusoidal
No
143
DTMFPlaybackLevel
CallerIDMethod
CallerIDTrigger
ChannelTxGain
ChannelRxGain
SilenceDetectSensitivity
46
20
600
-15
FSK(Bell202)
0
0
Medium
144
CallCommandSignalMethod
HookFlashHandling
N. America
CallerIDEnable
Yes
145
CallWaitingCallerIDEnable
MWIEnable
VMWIEnable
CallTransferEnable
ConferenceCallEnable
UseExternalConferenceBridge
Yes
Yes
Yes
Yes
Yes
No
146
CallWaitingEnable
ToneProfile
StarCodeProfile
LastDialedNumber
LastCallerNumber
AcceptMediaLoopback
MediaLoopbackAnswerDelay
MediaLoopbackMaxDuration
RepeatDialInterval
RepeatDialExpires
GenerateCPCSignal
EnableLINEPortBargeIn
Yes
A
A
Yes
0
0
30
1800
For Inbound and Outbound
Calls
No
147
otherwise.
EnablePHONEPortBargeIn
EnableDoubleHookFlash
UseForPagingOnly
TransferWhenHolding
EndHoldingCallWhenHangUp
MOHServiceNumber
PlaySITOnCallFailureCodes
Yes
Yes
No
No
([4-9]xx)
Yes
900
148
HookFlashTimeMin
DoubleHookFlashTimeMin
DoubleHookFlashTimeMax
CPCDelayTime
CPCDuration
DigitMapLongTimer
DigitMapShortTimer
100
100
700
2000
500
10
149
ConnectPolarity
Forward
Forward
150
line in use = The PSTN line is being used by an external handset parallel to the LINE port
pwr down = The PSTN line is disconnected from the LINE port
InboundCallRoute
RingDelay
RingProfile
DefaultRing
CallOnHoldRing
Description
Default Setting
Yes
(xxxxxxxS4|1xxxxxxxxxx|xx.)
ph
5500
151
Tone Profile
DetectOutboundConnectMethod
A
None
DialDelay
DialDigitOnTime
DialDigitOffTime
OutboundCallConfirmTone
DirectoryNumber
Calling Features
CallForwardUnconditionalEnable
500
200
200
No
No
152
CallForwardUnconditionalNumber
CallForwardOnBusyEnable
CallForwardOnNoAnswerEnable
CallForwardOnNoAnswerNumber
CallForwardOnNoAnswerRingCount
DoNotDisturbEnable
No
CallForwardOnBusyNumber
AnonymousCallBlockEnable
No
153
BridgedOutboundCallMaxDuration
CPCTimeThreshold
Description
Default Setting
Enable CPC signal detection. If enabled, OBi will consider the PSTN call
ended once it detects a CPC signal during a connected call on the PSTN
line. It then proceeds to tear down the call and takes the LINE port
hardware to the On-Hook state
Minimum duration in milliseconds to declare CPC signal
Yes
450
154
DetectPolarityReversal
DetectFarEndLongSilence
SilenceDetectSensitivity
SilenceTimeThreshold
DetectDisconnectTone
DisconnectTonePattern
Port Settings
ACImpedance
OnHookSpeed
TipRingVoltageAdjust
MinOperationalLoopCurrent
CurrentLimitingEnable
ChannelTxGain
ChannelRxGain
LineInUseVoltageThreshold
LineInUseCurrentThreshold
CallerIDDetectMethod
DTMFPlaybackLevel
Ring Detection
RingFrequencyMin
RingFrequencyMax
RingThreshold
RingValidationTime
Yes
Yes
Yes
60
Yes
480-30,62030;10;(.25+.25)
Off-hook AC termination
Time for line-side device to go on-hook
Voltage on DCT pin of line-side device, which affects TIP/RING voltage on
the line. Low-voltage countries should use lower TIP/RING voltage
Minimum loop current the LINE port hardware can operate at
Limit loop current to 60 mA per the TBR21 standard
Gain in dB (-15 to 15) to apply to the signal transmit from the OBi to the
PSTN company
Gain in dB (-15 to 15) to apply to the signal received by the OBi from the
PSTN company
Voltage below which to detect a parallel device off-hook when LINE port
hardware is in the On-Hook state
Current (mA) above which to detect a parallel device off-hook when LINE
port hardware is in the Off-Hook state
The Caller ID delivery standard for which the OBi device should assume
when decoding Caller ID signal received from the PSTN company.
Available choices are:
FSK(Bell202)
FSK(V.23)
DTMF(Finland, Sweden)
DTMF(Denmark)
The energy level of DTMF signal transmitted on PSTN line port in dBm (90 to 3)
600
0.5 ms
3.5 V
15
50
40.50-49.50
10 mA
No
0
5
25
12
FSK(Bell 202)
-5
640
155
RingIndicationDelayTime
RingTimeout
RingerImpedance
Time in ms between ring signal validated and valid ring signal indicated
Time (ms) elapsed since last ring threshold crossing to declare ring is over
Synthesized ringer impedance to meet specification in countries, such as
Poland, South Africa, and Slovenia
512
1408
High
156
157
158
159
Description
Default Setting
Codec Name
Bit rate in bits/sec.
Note: Informational only; not configurable
Enable this codec
Enable silence suppression for this codec
Packet size in ms
Priority assigned to this codec (1 is the highest)
Standard payload type for this codec
Note: Informational only; not configurable
G711U
64000
Codec Name
Bit rate in bits/sec Note: Informational only; not configurable
Enable this codec
Enable silence suppression for this codec
Packet size in ms
G711A
64000
Yes
No
20
Yes
No
20
1
0
160
Priority
PayloadType
G729 Codec
Codec
BitRate
Enable
SilenceSuppression
PacketizationPeriod
Priority
PayloadType
G726R32 Codec
Codec
BitRate
Enable
SilenceSuppression
PacketizationPeriod
Priority
PayloadType
4
G726R16 Codec
Codec
BitRate
Enable
SilenceSuppression
PacketizationPeriod
Priority
PayloadType
4
G726R24 Codec
Codec
BitRate
Enable
SilenceSuppression
PacketizationPeriod
Priority
PayloadType
4
G726R40 Codec
Codec
BitRate
Enable
SilenceSuppression
PacketizationPeriod
Priority
2
8
Codec Name
Bit rate in bits/sec
Note: Informational only; not configurable
Enable this codec
Enable silence suppression for this codec
Packet size in ms
Priority assigned to this codec (1 is the highest)
Standard payload type for G.729
Note: Informational only; not configurable
G729
8000
Codec Name
Bit rate in bits/sec
Note: Informational only; not configurable
Enable this codec
Enable silence suppression for this codec
Packet size in ms
Priority assigned to this codec (1 is the highest)
Dynamic Payload type for this codec. Valid range is 96-127
G726-32
Codec Name
Bit rate in bits/sec
Note: Informational only; not configurable
Enable this codec
Enable silence suppression for this codec
Packet size in ms
Priority assigned to this codec (1 is the highest)
Dynamic Payload type for this codec. Valid range is 96-127
G726-16
16000
Codec Name
Bit rate in bits/sec
Note: Informational only; not configurable
Enable this codec
Enable silence suppression for this codec
Packet size in ms
Priority assigned to this codec (1 is the highest)
Dynamic Payload type for this codec. Valid range is 96-127
G726-24
24000
Codec Name
Bit rate in bits/sec
Note: Informational only; not configurable
Enable this codec
Enable silence suppression for this codec
Packet size in ms
Priority assigned to this codec (1 is the highest)
G726-40
40000
Yes
No
20
3
18
32000
Yes
No
20
4
104
Yes
No
20
5
102
Yes
No
20
6
103
Yes
No
20
7
G726R16, G726R24, and G726R40 codecs are only available only on the OBi100/110; iLBC codec is only available on the
OBi200/OBi202/OBi300/OBi302
161
PayloadType
4
iLBC Codec
Codec
BitRate
Enable
SilenceSuppression
PacketizationPeriod
Priority
PayloadType
FAX Event
Codec
Enable
PayloadType
FaxEvents
Telephone Event
Codec
Enable
PayloadType
Encap RTP
Codec
PayloadType
Loopback Primer
Codec
PayloadType
Codec Settings
G726BitPacking
T38Enable
T38Redundancy
FaxPassThroughCodec
105
Codec Name
Bit rate in bits/sec
Two values to choose from: 13333 bps or 15200 bps
Enable this codec
Enable silence suppression for this codec
Packet size in ms. Must be multiples of 30 for 13333 bps or multiples of 20 for
15200 bps
Priority assigned to this codec (1 is the highest)
Dynamic Payload type for this codec. Valid range is 96-127
iLBC
13333
Codec Name. This codec can be used for relaying FAX tone event using RTP
Enable this codec
Dynamic Payload type to be used to indicate this event
Comma separated list of event IDs to indicate (such as CED, CNG)
fax-event
No
100
32
Codec Name. This codec is for relaying DTMF events using RTP
Enable this codec
Dynamic Payload type to be used for RFC2833 telephone (DTMF) events. Valid
range is 96-127
telephone-event
Yes
101
Codec Name. This codec is used to encapsulate RTP packets during a packet
loopback call
Dynamic Payload type for this codec. Valid range is 96-127
encaprtp
Codec Name. The codec is used by the OBi when acts as a media loopback
mirror and before receiving any packets from the loopback source during a
media loopback call
Dynamic Payload type for this codec. Valid range is 96-127
loopbkprimer
big-endian
Yes
No
No
30
5
98
107
108
G711U
162
Field1 Composition:
This field describes frequency components used for tone synthesis and it supports up to three different frequencies.
The frequency expression is a string of numeric values with the notation '+' or '-'.
The numeric values are the frequency's decimal values in Hz and amplitude in dBm (Maximum 3 dBm).
Different frequencies are separated by ',' .
Example: 350-18,440-18,550+2
The above example illustrates the 1st frequency at 350 Hz with strength at -18 dBm, the 2nd frequency: 440 Hz with
strength at -18 dBm and the 3rd frequency: 550 Hz with strength at +2 dBm.
Field2 Composition:
This field describes the overall tone playback duration in seconds.
The expression is a numeric value, and supports up to 3 decimated digits.
The numeric value can negative, zero, positive, or skipped:
Example: 30.234
Meaning: tone playback terminates after 30.234 seconds
163
t(f_0/on_0+off_0,f_1/on_1+off_1,f_2/on_2+off_2,f_3/on_3+off_3)
f_0/1/2/3: a numerical describe which frequency component(s) are used for the synthesis, and it can be one of following 8
options (0 ~ 7)
If no value is provided for f_0/1/2/3, it will automatically use the combination of the first one or two available frequency
components.
on_0/1/2/3: the tone active time in seconds
Example: 4(1/.3+2.34,3/2+1.5)
The above example illustrates using the first frequency to generate tone for 0.3 seconds, followed by 2.34 seconds of
silence, then use a combination of the first and second frequencies to generate tone for 2 seconds, then followed by 1.5
seconds silence. The cadence operates repeatedly for 4 seconds.
164
Tone Examples:
With these examples, we will show the interpretation of a few common tone patterns:
Dial Tone:
DIAL,
"350-18,440-18"
Busy Tone:
BUSY,
"480-18,620-18;10;(.5+.5)"
Prompt Tone:
PROMPT,
"480-16;10"
SIT Tone:
SIT_1,
"985-16,1428-16,1777-16;20;(1/.380+0,2/.380+0,4/.380+0,0/0+4)"
The expiration time is exactly 20 seconds. It has only one cadence segment, which includes 4 on-off sections. The segment
has infinite repeating time:
The 1st on-off section: generated by the 1st frequency component, and it has 0.38 tone second active time and 0
inactive time.
The 2nd on-off section: generated by the 2nd frequency component, and it has 0.38 tone second active time and 0
inactive time.
The 3rd on-off section: generated by the 3rd frequency component, and it has 0.38 tone second active time and 0
inactive time.
165
The 4th on-off section: only generate silence since no frequency component is specified. It has tone 0 second
active time and 4 seconds inactive time.
Stutter Tone:
STUTTER, "350-18,440-18;20;.2(.1+.1);()"
Stutter dial tone is generated from a mixture of two frequency components:
350 Hz at -18 dBm and 440 Hz at -18 dBm. The expiration time for the entire tone is exactly 20 seconds. It has two cadence
segments.
The first segment: includes only one on-off sections, on 0.1 second and off 0.1 second, and on-off repeats for 2s
second.
The second segment: include one on-off section, and has infinite repeating time and infinite tone active time, and
will play until the entire tone duration has elapsed
Description
Default Setting
Dial Tone
Obihai Tone Pattern Script
350-18,440-18;20
Ringback Tone
Obihai Tone Pattern Script
440-18,480-18;-1;(2+4)
166
ToneName
TonePattern
Reorder Tone
ToneName
TonePattern
Confirmation Tone
ToneName
TonePattern
Busy Tone
Obihai Tone Pattern Script
480-18,620-18;10;(.5+.5)
480-18,620-18;10;(.25+.25)
Confirmation Tone
Obihai Tone Pattern Script
600-18;1;(.2+.2)
Description
Default Setting
800-18;30;(.1+10)
385-18,484-18;20
350-18,440-18;20;2(.1+.1);()
480+3,620+3;10;(.125+.125)
480-16;20
167
Description
Default Setting
(Not configurable)
(Not configurable)
(Not configurable)
(Not configurable)
TonePattern
985-16,1428-16,177716;20;(1/.380+0,2/.380+0,4/.380+0,0/0+4)
SIT Tone 2
ToneName
(Not configurable)
TonePattern
DND Dial Tone
ToneName
TonePattern
Conference Tone
ToneName
TonePattern
SIT Tone 1
ToneName
350-18,440-18;20;(.2+.2)
350-18,440-18;20;(.2+.2)
350-16;10;(.1+.1,.1+9.7)
168
TonePattern
914-16,1371-16,177716;20;(1/.274+0,2/.274+0,4/.380+0,0/0+4)
SIT Tone 3
ToneName
TonePattern
(Not configurable)
914-16,1371-16,177716;20;(1/.380+0,2/.380+0,4/.380+0,0/0+4)
SIT Tone 4
ToneName
TonePattern
(Not configurable)
985-16,1371-16,177716;20;(1/.380+0,2/.380+0,4/.380+0,0/0+4)
(Not configurable)
385-16;10
R-Command Tone
Obihai Tone Pattern Script
(Not configurable)
400-16;5
Paging Tone
Obihai Tone Pattern Script
(Not configurable)
480-16;1;(.2+.2)
Field1 Composition:
Field-1 describes the overall ringing duration in seconds.
The expression is a numeric value, and supports up to 3 decimated digits.
The numeric value can negative, zero, and positive:
Example: 30.5
The above example illustrates a ringing tone that terminates after 30.5 seconds.
169
Example: 4(.3+2.34,2+1.5)
The above example illustrates a ringing tone comprised of two segments. Ringing is active for 0.3 seconds, followed by 2.34
seconds of silence, then ringing for 2 seconds, and followed by 1.5 seconds of silence.
The above cadence operates repeatedly for 4 seconds.
170
Parameter
Call Waiting Tone 1
ToneName
TonePattern
Call Waiting Tone 2
ToneName
TonePattern
Call Waiting Tone 3
ToneName
TonePattern
Call Waiting Tone 4
ToneName
TonePattern
Call Waiting Tone 5
ToneName
TonePattern
Description
Distinctive Call Waiting Tone 1. An incoming SIP
INVITE may include the same name in an Alert-Info
header to choose this ring
Obihai Tone Pattern Script
Distinctive Call Waiting Tone 2. An incoming SIP
INVITE may include the same name in an Alert-Info
header to choose this ring
Obihai Tone Pattern Script
Obihai Tone Pattern Script
Distinctive Call Waiting Tone 3. An incoming SIP
INVITE may include the same name in an Alert-Info
header to choose this ring
Obihai Tone Pattern Script
Distinctive Call Waiting Tone 4. An incoming SIP
INVITE may include the same name in an Alert-Info
header to choose this ring
Obihai Tone Pattern Script
Distinctive Call Waiting Tone 5. An incoming SIP
INVITE may include the same name in an Alert-Info
header to choose this ring
Obihai Tone Pattern Script
Default Setting
Bellcore-dr1
440-18;30;(.25+10)
Bellcore-dr2
440-18;30;(.1+.1,.3+.1,.1+10)
Bellcore-dr3
440-18;30;(.1+.1,.1+10)
Bellcore-dr4
440-18;30;(.1+.1,.1+.1,.1+10)
Bellcore-dr5
440-18;30;(.3+.1,.1+.1,.3+10)
171
User-dr1
440-18;30;(.1+.1,.3+.2,.3+10)
User-dr2
440-18;30;(.3+.1,.3+.1,.1+10)
User-dr3
440-18;30;(.3+2)
User-dr4
440-18;30;(.3+2)
User-dr5
440-18;30;(.3+2)
172
RingPattern
Ring Pattern 2
RingName
RingPattern
Ring Pattern 3
RingName
RingPattern
Ring Pattern 4
RingName
RingPattern
Ring Pattern 5
RingName
RingPattern
Ring Pattern 6
RingName
RingPattern
Ring Pattern 7
RingName
RingPattern
Ring Pattern 8
RingName
RingPattern
Ring Pattern 9
RingName
RingPattern
Ring Pattern 10
RingName
RingPattern
Description
Name of the ring. An incoming SIP
INVITE may include the same name in
an Alert-Info header to choose this ring
Obihai tone cadence script
Default Setting
Bellcore-dr1
60;(2+4)
Bellcore-dr2
Bellcore-dr3
Bellcore-dr4
Bellcore-dr5
User-dr1
User-dr2
User-dr3
User-dr4
User-dr5
60;(.3+.2,1+.2,.3+4)
60;(.8+.4,.8+4)
60;(.4+.2,.3+.2,.8+4)
60;(.2+.2,.2+.2,.2+.2,1+4)
60;(.2+.4,.2+.4,.2+4)
60;(.4+.2,.4+.2,.4+4)
60;(.25+9.75)
60;(.25+9.75)
60;(.25+9.75)
173
174
175
$NOEC1 = Disable echo canceller once in the next call on this phone port (phone-port specific; admissible value: 1) (Not
available on OBi100/OBi110)
$NOJI1 = Disable jitter buffer adjustment once in the next call on this phone port (phone-port specific; admissible value: 1)
(Not available on OBi100/OBi110)
$IBDT = Enable in-band DTMF transmission once in the next call on this phone port (phone-port specific; admissible value:
1) (Not available on OBi100/OBi110)
$BCLR = Clear all blocked callers (trunk specific; admissible value: 1)
$CIDG = Enable Generate Caller ID Generation on this phone port (phone-port specific; admissible value: 1 for enable, 0 for
disable)
$CWCIDG = Enable CWCID Generation on this phone port (phone-port specific; admissible value: 1 for enable, 0 for disable)
$MWIG = Enable MWI (Stutter Tone) Generation on this phone port (phone-port specific; admissible value: 1 for enable, 0
for disable)
$VMWIG = Enable VMWI Generation on this phone port (phone-port specific; admissible value: 1 for enable, 0 for disable)
$BXRN = Blind transfer number for the current call on this phone port (phone-port specific; admissible value: a number
representing the blind transfer target). As soon as a complete blind transfer target number is collected, the OBi will (blind)
transfer the current call peer to the target number.
$CDM1 = Codecs to enable in the next call on this phone port (temporarily overriding any codec preferences in device
configuration) (phone-port specific; admissible value: An 8-bit unsigned number where each bit of its value represents one
audio codec:
-
Bit1 = G711a
Bit2 = G726r16
Bit3 = G726r24
Bit4 = G726r32
Bit5 = G726r40
Bit6 = G729
)
$LDN = last dialed number on this phone port (for redial) (phone-port specific; read only)
$LCR = last callers number on this phone port (for call return) (phone-port specific; read only)
$SPD[n] = number for the speed dial n (n = 1 99) (global; admissible value: literal or token representing a phone number)
$CODE = the digit(s) representing the variable part of a star code (see examples below; read only)
Variable names are CASE INSENSITIVE.
176
code = the star code, such as *72. It may contain a variable part enclosed in parenthesis, such as *74(x|xx)
o The variable part as entered by the user are stored in the variable $CODE
name = a descriptive name of the function of this star code, such as Call Forward Unconditional
action1, action2, = a valid action with parameters
Actions are carried out one-by-one in the order as specified in the script.
Restrictions:
Collects a number from the user according to the DigitMap. Then set the CallForwardUnconditionalNumber on all
trunks to the collected value, and set the CallForwardUnconditionalEnable on all trunks to Yes
To modify the script to enable CallForwardUnconditional on SP1 only, change it to
177
Enable masking of caller ID information once for the next call on any trunk
Disable the Echo Canceller for one call on the current phone port
After user dials *74, OBi expects one or two more digits from the user which represent a speed dial slot index (1 to
99). The 1 or 2-digit variable part is stored in the variable $code.
OBi device then plays a prompt tone and proceeds to collect a number from the user according to the DigitMap.
Finally OBi stores the collected number in the given speed dial slot. If the slot already has a number specified, it
will be overwritten quietly with the new value.
After user dials *75, OBi expects one or two more digits from the user which represent a speed dial slot index (1 to
99). The 1 or 2-digit variable part is stored in the variable $code.
OBi device then announces the number stores in the speed dial slot, or says not available if the slot is empty.
178
Code13
Code14
Code15
Code16
Code17
Code18
Code19
Code20
Code21
Description
Default = Redial Star Code
Default = Call Return Star Code
Default = Block Caller ID (Persistent) Star Code
Default = Unblock Caller ID (Persistent) Star
Code
Default = Block Caller ID Once Star Code
Default = Unblock Caller ID Once Star Code
Default = Call Forward Unconditional Star
Code
Default = Disable Call Forward Unconditional
Star Code
Default = Call Forward on Busy Star Code
Default = Disable Call Forward on Busy Star
Code
Default = Call Forward on No Answer Star
Code
Default = Disable Call Forward on No Answer
Star Code
Default = Block Anonymous Calls Star Code
Default = Unblock Anonymous Calls Star Code
Default = Enable Call Waiting Star Code
Default = Disable Call Waiting Star Code
Default = Do Not Disturb Star Code
Default = Disable Do Not Disturb Star Code
Default = Repeat Dial Star Code
Default = Disable Repeat Dial Star Code
Default = Set Speed Dial Star Code
Code22
Code23
Code24
Code25
Code26
Code27
Code28
Code29
Code30
Code5
Code6
Code7
Code8
Code9
Code10
Code11
Code12
Code 31
Code32
Default Setting
*07, Redial, call($Ldn)
*69, Call Return, call($Lcn)
*81, Block Caller ID, set($Bci,1)
*82, Unblock Caller ID, set($Bci,0)
*67, Block Caller ID Once, set($Bci1,1)
*68, Unblock Caller ID Once, set($Ubci1,1)
*72, Cfwd All, coll($Cfan), set($Cfa,1)
*73, Disable Cfwd All, set($Cfa, 0)
*60, Cfwd Busy, coll($Cfbn), set($Cfb,1)
*61, Disable Cfwd Busy, set($Cfb, 0)
*62, Cfwd No Ans, coll($Cfnn), set($Cfn,1)
*63, Disable Cfwd No Ans, set($Cfn,0)
*77, Block Anonymous Call, set($Bac,1)
*87, Unblock Anonymous Call, set($Bac,0)
*56, Enable Call Waiting, set($Cwa,1)
*57, Disable Call Waiting, set($Cwa,0)
*78, Do Not Disturb, set($Dnd,1)
*79, Disable DND, set($Dnd,0)
*66, Repeat Dial, rpdi($Ldn)
*86, Cancel Repeat Dial, rpdi()
*74([1-9]|[1-9]x), Set Speed Dial,
coll($Spd[$Code])
*75([1-9]|[1-9]x), Check Speed Dial,
say($Spd[$Code])
*03, Loopback Media, set($Lbm1,1)
*04, Loopback RTP Packet, set($Lbp1,1)
*4711, Use G711 Only, set($Cdm1,3)
*4729, Use G729 Only, set($Cdm1,4)
*76([1-9]|[1-9]x), Clear Speed Dial,
set($Spd[$Code],)
*98, Blind Transfer, coll($Bxrn)
*96, Barge In, set($Bar1,1)
*28, OBiBT Discoverable, btdscvr(0)
*27, run OBiWiFi as Access Point, wifiap()
*10, Day Mode, set($Opm,0)
Code33
Code34
179
180
181
Parameter
1
2
3
To
99
Description
Speed Dial 1
Speed Dial 2
Speed Dial 3
to
Speed Dial 99
Default Setting
DigitMap
Description
Default Setting
ipd
(xx.<*:@>xx?x?<*:.>xx?x?<*:.>xx?x?<*:.
>xx?x?|xx.<*:@>xx?x?<*:.>xx?x?<*:.>xx
?x?<*:.>xx?x?<*::>xx?x?x?x?)
Note: this default value supports IPv4
dialing
Label
DigitMap
182
Admin: Always enabled and requires login as the admin. Admin level has full access to all the files.
User: The admin can define and enable up to 10 users (User1 User10) in the OBi device configuration with
individual UserID and Password. User must login with the corresponding UserID and Password before he can
access the files. Each user level access can be further limited by three configurable attributes: HomeDirectory,
FileFilter, and WriteEnable. These attributes are explained in the parameter table below.
Anonymous: The admin can enable anonymous access where the user does not need to login. However the access
is limited to read-only for anonymous users.
183
Here is a screen short of the File Sharing Settings device web page.
184
185
Description
Default Setting
Yes
Note: If this option is disabled, you will be denied
from accessing the files from the WAN when you
click on the File Explorer link on the device web
page even if you have logged in as the admin.
Note: This option needs a reboot for this change to
take effect
Anonymous User
Enable
No
FileFilter
/obi_share/anonymous
UserID
No
userN
186
Password
HomeDirectory
FileFilter
/obi_share/userN
WriteEnable
No
187
File Explorer
The File Explorer web page can be launched by clicking the File Explorer link on the OBi device webpage or visit the link:
http://<obi-address>/obi_share. You may be requested to login with a valid UserID and Password. To use the File Explorer
as an anonymous user, visit the link: http://<obi-address>/obi_share/anonymous.
Below is a screen shot of a typical File Explorer web page.
On the left corner of the status bar is a select all checkbox for selecting all the items on the current page. To the right of
the checkbox is the current directory path. On the far right of the status bar is the User ID of the current login user and the
logout button, which are not shown for anonymous level login.
188
The current directory path information is with respect to the home directory of the login user. The symbol represents the
home directory which is always at the root of the path. Each level in the directory path is separated from the previous level
with a slash (/). User can click any directory name in the path shown on the status bar to jump to a different level in the
directory. Click the logout button to logout or login as a different user.
The contents of current directory are listed below the status bar, with all the sub-directories, if any, followed by all the files
in this directory. For example:
As shown above, each sub-directory or file is shown as a selectable item per row, with a selected for operation checkbox
on the left. A sub-directory item has a directory icon ( ) and a directory name. A file item has a filename, the file size in
bytes and the file type. In the current design, the file type is simply the filename suffix, or a pair of <> is shown if the
filename does not have a suffix. You can select one or more items for applying an operation by clicking the corresponding
checkboxes. The available operations that can be applied are shown on the bottom of the page and may depend on the
kind of items or the number of items selected. In the following example, each operation is represented by a special icon on
the bottom line:
Also shown on the far right of the bottom line is the currently available space in bytes on the attached USB storage device,
if the option WriteEnable is true for login user.
The name of each sub-directory item is a link to navigate into that sub-directory. Clicking the link of a file item on the other
hand may show the contents of the file or download the file based on the file type and web browser functionality.
The table below listed the available file sharing operations:
Icon
Operation
Remarks
This operation is available to the admin only. Any unpasted Cut or Copy operation will be forgotten by the
OBi upon this operation.
Eject USB Safely detach the USB storage device from the
OBi.
Upload File Upload a single file from the local host to the USB
storage device.
Create Folder Create a new folder with the given path name if it
does not exist already; an input box will pop up
189
Available only when one or more files or subdirectories are selected. The OBi will pop up a
prompt window to ask for confirmation before
proceeding.
Available only when one or more files or subdirectories are selected.
Copy Link Location Copy the links (URLs) of the selected items to the
clipboard of the local host
190
SP2
Service
yes
yes
yes
yes
yes
SP3
Service
yes
yes
yes
yes
yes
SP4
Service
yes
yes
yes
yes
yes
OBiTALK
Service
yes
yes
yes
yes
yes
LINE Port
(PSTN)
yes
yes
yes
yes
yes
SP1 Service
SP2 Service
SP3 Service
SP4 Service
OBiTALK
Service
LINE Port
yes
yes
yes
yes
yes
no
(PSTN)
BT1
yes
yes
yes
yes
yes
yes
Service
BT2
yes
yes
yes
yes
yes
yes
Service
Note: Highlighted services may not be available on some models and/or require additional accessories.
BT1 Service
(via OBiBT)
yes
yes
yes
yes
yes
BT2 Service
(via OBiBT)
yes
yes
yes
yes
yes
yes
yes
no
yes
yes
no
Each supported service is also referred to as a trunk (a traditional telco term for a physical wire or wires that deliver phone
services to homes or businesses). Each trunk is represented with 2-letter abbreviation and a 1-based instance identifier:
-
The instance identifier may be omitted if it is equal to 1; hence LI is equivalent LI1, PP is equivalent to PP1, etc. These shorthand notations are used heavily in configuring the OBi device, as found in call routes, call forward numbers, and speed dials
parameters. Unless stated otherwise, the abbreviated trunk names are case insensitive.
In addition to all the call bridging functionalities, each OBi has one or two built-in physical PHONE ports for hooking up
analog telephones or FAX machines. The OBi includes a set of features to support its PHONE ports to make it work also as a
full-featured ATA device. Users can place and receive calls on the PHONE ports over any of the trunks.
The OBi also comes with an Auto Attendant for helping callers to direct their calls landed on the device. When an inbound
call is received on the device, it may be routed to the AA which then offers a menu of options to the caller to direct it
further. It could be directed to ring any one or all of the available PHONE ports, or bridged with another call on a trunk
(which the AA dials or sets up on behalf of the caller).
The PHONE ports and the AA are the two entities in the OBi device that calls can terminate (i.e., starts or ends there), as
opposed to the trunks, which rely on the corresponding service providers to terminate the call. In this document we refer to
the PHONE ports and the AA as endpoints. Like the trunks, each endpoint is represented by a 2-letter abbreviation and a 1based instance identifier:
191
Unless stated otherwise, abbreviated endpoint names are case insensitive. A trunk or an endpoint is also referred to as a
Terminal in this document.
The following matrix shows the possible call connections between the endpoints and the trunks:
Supported endpoint calls on the OBi
Any Trunk
PHONE Port
PHONE2 Port
AA
(PHONE1 Port)
Any Trunk
n/a
yes
yes
Yes
yes
no
yes
Yes
PHONE2 Port
yes
yes
no
Yes
AA
yes
yes
yes
No
PHONE Port
(PHONE1 Port)
192
terminal-list := terminal,terminal,.
callee-list := callee|callee|callee|
cid := spoofed-caller-number OR $1
target := number-to-call OR $2
embedded-digit-map := (Mlabel) OR digit-map
Notes:
-
Terminal-list can be empty, which means to block this call. The preceding : cannot be omitted. Up to 4 terminals
may be specified in the list. The listed terminals will be called/rung by OBi simultaneously; we refer to this
operation as forking the call. A terminal may be a trunk or an endpoint.
Abbreviated terminal names are case-insensitive
number and number-to-call are literal strings, such as 14089991234
digit-map is just any proper digit map, such as (1xxx|xx.); make sure to include the enclosing parentheses
193
spoofed-caller-number is a literal string, such as 14081112233, to be used as the caller number for making a new
call on the specified trunk
(Mlabel) is a named digit map, where label is the abbreviated name of any terminal that has a digit map defined:
1
SP1, SP2, SP3, SP4, LI , PP, PH, PH2, or AA
$1 is an internal variable containing the value of the caller number of this inbound call, after any digit map
transformation in the matched caller object of the matched peering object in the peering-list.
$2 is an internal variable containing the called number of this inbound call, after any digit map transformation in
the matched callee object of the matched peering object in the peering-list.
Peering-list is optional in InboundCallRoute. If peering-list is empty, the succeeding : can be omitted also. An
empty peering-list implies a single peering object whose caller object list matches any caller number. That is, the
InboundCallRoutes listed below are all equivalent
o ph
o {ph}
o {:ph}
o {?|@>@:ph}
Callee-list in a peering object can be empty. It implies the callee object @, meaning any called number. The
preceding > can be omitted if callee-list is empty.
Caller-list in a peering object can be empty. It implies the caller-list @|?, meaning any caller number including
anonymous. The succeeding > cannot be omitted if caller-list is empty but not the callee-list
The cid object inside an arg object is optional. If omitted, it implies no caller-ID spoofing when making the call on
the specified trunk. The succeeding > can be omitted is cid is omitted
The target object inside an arg object is optional. If omitted, it implies the target $2, which means to call the
original called number after applying any necessary digit map transformation implied by the rule. The preceding >
cannot be omitted if target is omitted but cid is not
arg object is optional. If omitted, it implies the arg with the target $2 and no cid. If arg is omitted, the succeeding
parentheses ( ) can be omitted also.
An inbound call matches a rule if its caller-number/callee-number matches one of the peering objects of the rule. Peering
objects are tested in the order left and right, and the first matched peering object will win. Rules are also checked in the
order left to right, and the first matched rule will win. Therefore it is important that you place the more specific rules first in
the InboundCallRoute if multiple rules can potentially match the same inbound call.
InboundCallRoute Examples:
1) ph OR {ph} OR {:ph} OR {@|?>@:ph}
(all equivalent)
It says: Ring the PHONE port for all incoming calls. This is the default InboundCallRoute for all trunks.
2) {(14081223330|15103313456):aa},{(1800xx.|1888xx.):},{ph}
It says: Ring both PHONE port and AA for calls coming from 1 408 122 3330 or 1 510 331 3456, block all 800, 888, and
anonymous calls, and ring the PHONE port for all other calls
194
3) {(x.4081113333|x.4152224444):aa},{ph}
It says: Ring the AA for calls coming from any number that ends with 408 111 3333 or 415 222 4444, and ring the PHONE
port for all other calls. Be sure to include the enclosing parentheses in this example since x. is a digit map specific syntax.
4) {200123456:aa},{sp1(14083335678)}
It says: Ring the AA for calls coming from 200123456. For all any other call, bridge it by calling 1 408 333 5678 using SP1
Service
(@ = any number)
cid = spoofed-caller-number
target = number-to-call OR $2
embedded-digit-map = (Mlabel) OR digit-map
195
Notes:
-
The cid object inside an arg object is optional. If omitted, it implies no caller-ID spoofing when making the call on
the specified trunk. The succeeding > can be omitted if cid is omitted.
The target object inside an arg object is optional. If omitted, it implies the target $2, which means to call the
original called number after applying any necessary digit map transformation implied by the rule. The preceding >
cannot be omitted if target is omitted but not the cid.
arg object is optional. If omitted, it implies the arg with the target $2 and no cid
An outbound call matches a rule if its called number matches one of the callee objects of the rule. Callee objects are tested
in the order left and right, and the first matched callee will win. Rules are also checked in the order left to right, and the first
matched rule will win. Therefore it is important that you place the more specific rules first in the OutboundCallRoute if
multiple rules can potentially match the same outbound call.
Note that every endpoint also has a digit map defined. The user dialed number is completely processed with the endpoints
digit map first before it is passed to the OutboundCallRoute for routing decision. Therefore the number used for matching
call routing rules has already incurred the transformations, if any, implied by the digit map. Remember this fact when
crafting your own OutboundCallRoute.
OutboundCallRoute Examples:
1) sp1 OR {SP1} OR {:SP1} OR {@:Sp1}
(all equivalent)
This rule says: Make all calls using SP1 Service, without any caller-id spoofing or digit transformation
2)
{(<#:>|911):li},{**0:aa},{***:aa2},{(Mpli):pli},{(<**1:>(Msp1)):sp1},{(<**2:>(Msp2)):sp2},{(<**8:>(Mli)):li},{(<**9:>(
Mpp)):pp}
This is the default OutboundCallRoute for the PHONE port. It says:
196
Dial # key to connect to the LINE port; OBi will take the LINE port hardware to off-hook but will not dial out any
digit. The net result is that the user will hear dial tone generated by the PSTN company if a working line is
connected to the LINE port. The user may then continue to dial the PSTN number directly to the phone company.
Note that from the OBis point of view, the PSTN call is connected the moment it takes the LINE port to the offhook state!
Use the PSTN Line to call 911
Dial **0 to invoke AA1 or AA
Dial *** to invoke the local device configuration IVR (a.k.a AA2)
(Mpli) and pli will be substituted with the PrimaryLines abbreviated name
Use SP1 Service to call all numbers that start with **1 and subsequent digits matching SP1 Services DigitMap.
Remove the **1 prefix from the resulting number before making the call
Use SP2 Service to call all numbers that start with **2 and subsequent digits matching SP2 Services DigitMap.
Remove the **2 prefix from the resulting number before making the call
Use the LINE port to call all numbers that start with **8 and subsequent digits matching LINE ports DigitMap.
Remove the **8 prefix from the resulting number before making the call
Use the OBiTALK Service to call all numbers that start with **9 and subsequent digits matching OBiTALK Services
DigitMap. Remove the **9 prefix from the resulting number before making the call
A digit map rule is a rule for matching a given sequence of digits. It may contain extra white spaces for readability; all spaces
are removed by the OBi device during parsing. A rule may contain one or more of the following elements:
literals - Any combination of 0-9,*,#,+,-,A-Z,a-z, except m, M, s, S, x, X which have special meaning in the digit map
syntax. It matches digit sequences with exactly the same literals
literals - Everything inside a pair of single quotes is treated as a literal except for the single quote () character.
x - a wild card digit that matches any digit from 0-9. x is CASE SENSITIVE
x. - matches 0 or more x
[123-7] or [135] - A set of 1 or more digits surrounded by pair of [ ]. It matches any digit in the set. The syntax
represents an inclusive digit range, such as 09, 37. So [1237] is equivalent to [17] or [1234567]
S, S0, S1, S2, S9 - Digit timer of 0, 1, 2, ,9 seconds respectively; S is equivalent to S1; S0 is the same as blank.
You can concatenate multiple S elements together if you need more than 9s timeout, such as S9S5 for a 14s
timeout. S is CASE SENSITIVE. It should only be used either as the first element of a rule for hot/warm line
implementation, or as the last element of a rule as a means of overriding the default interdigit timer
<elements:literals> - Substitute the digit sequence matching elements with the given literals. Single quote syntax is
NOT needed or allowed for the literals in this context; special characters may be used here as they do not apply in
this context either. Elements can be empty, in which case the : may be omitted. This case is useful for inserting
197
some extra digits in certain part of the dialed digits. The literals part can be empty also but the : MUST NOT be
omitted. This case is useful for removing part of dialed digits. Elements and literals MUST NOT be both empty.
(map) An embedded digit map for matching subsequent digits.
(Mlabel) A named embedded digit map for matching subsequent digits, where label is one of abbreviated
terminal names. Possible choices are:
o (Msp1) for SP1 Service::DigitMap
o (Msp2) for SP2 Service::DigitMap
o (Msp3) for SP3 Service::DigitMap
o (Msp4) for SP4 Service::DigitMap
o (Mpp) for OBiTALK Service::DigitMap
1
o (Mli) for LINE Port ::DigitMap
o (Mph) for PHONE Port::DigitMap
o (Mph2) for PHONE2 Port::DigitMap
o (Maa) for Auto Attendant::DigitMap
o (MtgN) for TrunkGroupN::DigitMap, N=1,2,3,4
o (MvgN) for VoiceGatewayN::DigitMap, N=1,2,3,4,5,6,7,8
The last two elements imply that the OBi digit maps are recursive. Recursive digit maps allow digit maps to be re-used and
make their specification more compact and readable. It is important that you do not specify digit maps that lead to infinite
recursion. For example, a digit map must not include a named embedded digit map that references itself.
To bar users from calling numbers that match a rule, add a ! in front of that rule in the digit map. The rule is then referred
to as a barring rule.
Lets look at some examples.
1408xxxxxxx Matches any 11-digit number that starts with 1408
011xx. Matches any number that starts with 011 followed by one or more digits
<1408>xxxxxxx Matches any 7-digit number. OBi pre-pends 1408 to the number when making the call
<:1408>xxxxxxx Equivalent to the last example
<+>1xxxxxxxxxx Pre-pends + to any 11-digit number that starts with 1
<**1:>1408xxxxxxx Matches any number that starts with **11408 followed by 7 digits. OBi removes the **1 prefix when
making the call
*74(x|xx) Matches any number that starts with *74, followed by 1 or 2 digits
198
**1(Msp1) Matches any number that starts with **1 and with the rest of digits matching the DigitMap in the SP1
Service
<:1234> Matches an empty phone number and replaces with 1234. This is the syntax for a hotline to 1234
<S0:1234> Equivalent to the last example
<:#> Hotline to the number #
<S0:#> Equivalent to the last example
<S4:1234> Call 1234 if no digits entered for 4s. This is the syntax of a warm line.
xx.853 7683 Matches any number with at least 8 digits and ends with 8537683, such as 15108537683, 98537683
(x.408 223 1122) Matches any number with at least 10 digits and ends with 408 223 1122, such as 4082231122, 1408 223
1122
xx.<#> Adds a # to the end of any number with 1 or more digits
!1900xxx xxxx Barring all 11-digit numbers that start with 1900
[^*]@@. Arbitrarily long alphanumeric sequence (except #) that does not start with *
xx? one or two-digit number
(1xxxxxxxxxxS0|xx.) Arbitrarily long digit sequence not starting with 1; otherwise it is limited to 11 digits
The DMP restarts the interdigit timer on every newly entered digit. The duration of this timer can be either long or short.
The long and the short timer values are set to 10s and 2s respectively by default and are configurable per phone port via
the DigitMapLongTimer and DigitMapShortTimer parameters respectively (execpet on OBi100/OBi110 where the two timer
values are not configurable). Whether to use the long or short interdigit timer depends on the current rule matching states.
The DMP maintains a matching state for each rule in the digit map as it processes each input digit. The following states are
defined:
-
Partially Matched (PM) The rule partially matches the accumulated input sequence. Initially all rules are in this
state before any digit is entered. Rules in this state have the potential of becoming EM or IM as more digits are
entered. Example: 1234 partially matches the rules xxxxxxx, 1xxxx, 1234567, <123:>xxxx.
Exactly Matched (EM) The rule exactly matches the accumulated input sequence. However, any further input
digit will turn this rule into the MM state. Example: 1234 exactly matches the rules xxxx, 1234, 1xxx, <123:5678>x
199
Indefinitely Matched (IM) The rule matches the accumulated input sequence indefinitely, with a variable length
such that the rule can potentially stay as IM as more matching digits are entered. Example: 011853 indefinitely
matches the rules xx., 011xx., <011:>xx.
Mismatch (MM) The rule does not match the accumulated input sequence. This state will not change as more
digits are entered. Example: 1234 mismatches the rules 123, 1xx, 12345
Rules in the EM or IM state are candidates to be selected by the DMP. After processing a new digit, the DMP returns a final
decision if any of the following conditions holds:
1.
2.
Otherwise, DMP starts the short interdigit timer if there is at least one rule in the EM state, or else the long one. When the
interdigit timer expires, DMP makes a timely decision by returning the best matched rule at that moment if one is found, or
else a timeout error. Again if the best matched rule in this case is a barring rule, DMP returns an error instead. Note that
the timer to wait for the first input digit is NOT governed by the interdigit timer, but the duration of dial tone being played
and could be a lot lengthier than the long interdigit timer.
The best matched rule is the one that has the most specific literals matching the input digit sequence. For example, the
input sequence 1234 matches the rule 123x better than 1xxx. On the other hand, an EM rule is always selected over an IM
rule.
Finally, the default interdigit timer can be overridden by appending the Sn element at the end of the rule (n = 09).
200
nd
201
rb = Ringback Tone
ro = Reorder Tone (same as fast busy)
si1 si4 = SIT TONE 1 4, respectively
st = Stutter Tone
0 9, *, #, a d = DTMF 0 9, *, #, A D respectively
Label: An arbitrary string for referencing this digit map in other digit map specification. The value should be 2-16
characters long. For example, friends. In this case, (Mfriends) can be referenced in other digit maps, such as
PHONE Port::DigitMap
DigitMap
By default both parameters are empty, except for User Defined Digit Map 1 (see the section below).
Label: ipd
The map (Mipd) is referenced in the default setting of the DigitMap in ITSP Profile A and B. It supports the following two
forms of IPv4 dialing:
a)
<user-id>*<a>*<b>*<c>*<d>
b) <user-id>*<a>*<b>*<c>*<d>*<port>
where <user-id> is an arbitrary length numeric user-id, such as 100345, <port> is a port number in the range 065535, and
each of <a>,<b>,<c>,<d> is a 1-3 digit pattern in the range 1255 that identifies one byte of an IP address. The dialed
202
number will be translated into <user-id>@<a>.<b>.<c>.<d> and <user-id>@<a>.<b>.<c>.<d>:<port> respectively. Here are
some examples:
1234*192*168*15*113
maps to [email protected]
123456*192*168*15*180*5061
maps to [email protected]:5061
203
Obihai
Browse Obihai Devices
Manufacturer
Obihai
Hardware Designer
Model Name
OBi100
Release Date
March 2011
Microprocessor
Chip Vendor
Obihai SoC
32 bit
Instruction Set
MIPS
Management Configuration
Local Access Interface
IVR, Web Page Password Protected (Admin & User Level Log-in)
Remote Provisioning
SSL via HTTPS , Encrypted XML via HTTP or TFTP Dedicated User Name & Password
Encrypted Binary File via TFTP or HTTP + Dedicated User Name & Password
Customization
LED Indications
Power, Device Status, Upgrade Progress Status, Ethernet Actvty, PHONE Status
RTP Statistics
204
Session Information
Save & Restore Configuration via XML file to / from a Local Folder
Security
Local Access Interface
IVR Password
Data Networking
VoIP
205
VoIP Cont
Telephony
G.726 (40/32/24/16)
G.729a
Codec Pre-selection Code
Voice Processing per SIP Service TX/RX Audio Gain, Echo Cancellation
Adjustable Audio Frames per Packet
Codec Name Assignment
Codec Profile per SIP SP (2) & OBiTALK Service
Dynamic Audio Payload
Packet Loss Concealment
Jitter Buffer (Adaptive)
STUN
ICE
SUBSCRIBE / NOTIFY Framework (RFC 3265)
NOTIFY Dialog, Line Status
SUBSCRIBE Message Summary
VoIP NAT Interworking
DATE Header Support
ALERT-INFO Header Support
Remote-Party-ID (RPID)
P-Asserted-Identity (PAID)
RTP Statistics in BYE Message
Media Loopback Support
Configurable Contact List (Inbound Call Routing)
Automatic Attendant (English) with Configurable Answer Delay
PIN Access Control to AA (Up to 4 PINs)
Recursive Digit Map for Call Routing (AA, Phone, Voice Gateways, Trunk Groups)
AA Configurable Outbound Call Routing Rule
SIP Service Configurable Inbound Call Routing Rule (2)
Direct / Single-Stage Dialing (Route to Voice Gateway)
Fax Pass Through (G.711)
Modem Pass Through (G.711)
In-Band DTMF (G.711)
Out of Voice Band DTMF (RFC 2833)
Out of Voice Band DTMF (INFO Method)
Call Progress Tone Generation
Tone Profile per SIP SP and OBiTALK service
Ring Profile per SIP SP and OBiTALK service
Star Code Profile per SIP SP and OBiTALK service
Full Duplex Audio
G.165, 168 Echo Cancelation
VAD Voice Activity Detection
Silence Suppression
Comfort Noise Generation
Three Way Conference Calling with Local Mixing
Hook Flash Event Signaling
Flash Hook Timer
Caller ID Name & Number per Bellcore, ETSI and DTMF
MWI Message Waiting Indicator
Visual Message Waiting Indication (VMWI)
Daylight Savings Time Support North & South Hemispheres
Caller ID Enable /Disable
Caller ID Number
Caller ID Name (Alphanumeric)
Call Waiting
Maximum Session Control
Call Forward - Unconditional
Call Forward on Busy
Call Forward on No Answer (Ring Count Configurable)
Call Transfer Enable / Disable
Anonymous Call Block
206
Anonymous Call
Do Not Disturb
Call Return
Repeat Dialing
Phone (FXS)
Reset Button
LEDs
LED Indications
Power On, Device Status, Upgrade in Progress Status, Packet RX/TX, Phone Port Status
Certifications
FCC Part 15
Yes Class B
A-Tick
Yes
CE
Yes
207
ICES-003
Yes
RoHS
Yes
WEEE
Yes
UL/cUL
Environmental
Operating Temperature
0 to 45 C (32 to 113 F)
Storage Temperature
Operating Humidity
Non-operating Humidity
Physical Attributes
Dimensions:
(width x depth x height)
Unit Weight:
Shipping Weight
Mounting
Desktop Mountable
Power Supply
Type
Universal Switching with Fixed US, EU, UK or AU Style Plug Prongs (Model Dependent)
Input Power
Output Power
Carton Specifications
Units Per Carton
20 Units
Carton Dimensions
(width x depth x height)
Carton Weight
Miscellaneous
Requirements
Documentation
Package Contents
Warranty
California, USA
Country of Origin
China
HST Code
8517.62.00
140911.100.1
208
OBi110
General
Brand
Obihai
Browse Obihai Devices
Manufacturer
Obihai
Hardware Designer
Model Name
OBi110
Release Date
November 2010
Microprocessor
Chip Vendor
Obihai SoC
32 bit
Instruction Set
MIPS
209
Caller ID Detect Method: FSK (Bell 202), FSK (V.23), DTMF (FI, SE, DK)
DTMF Playback Level
Ring Detection
Ring Frequency Min
Ring Frequency Max
Ring Threshold: 40.50-49.50 Vrms, 19.35-23.65 Vrms, 13.50-16.50 Vrms
Ring Validation Time: 8 Settings
Ring Indication Delay Time: 8 Settings
Ring Timeout: 15 Settings
Ringer Impedance: High, Synthesized
Management Configuration
Local Access Interface
IVR, Web Page Password Protected (Admin & User Level Log-in)
Remote Provisioning
SSL via HTTPS , Encrypted XML via HTTP or TFTP Dedicated User Name & Password
Encrypted Binary File via TFTP or HTTP + Dedicated User Name & Password
Customization
LED Indications
Power, Device Status, Upgrade in Progress Status, Ethernet Activity, PHONE Port Status,
LINE Port Status
RTP Statistics
Session Information
Save & Restore Configuration via XML file to / from a Local Folder
Security
Local Access Interface
IVR Password
210
Data Networking
VoIP
Telephony
211
212
Call Return
Activate Block Caller ID
Deactivate Block Caller ID
Block Caller ID Once
Unblock Caller ID Once
Activate Call Forwarding (All Calls)
Deactivate Call Forwarding (All Calls)
Activate Call Forward on Busy
Deactivate Call Forward on Busy
Activate Call Forward on No Answer
Deactivate Call Forward on No Answer
Activate Block Anonymous Calls
Deactivate Block Anonymous Calls
Activate Call Waiting
Deactivate Call Waiting
Activate Do Not Disturb
Deactivate Do Not Disturb
Activate Repeat Dial
Deactivate Repeat Dial
Phone (FXS)
Line (FXO)
Reset Button
LEDs
LED Indications
Power On, Device Status, Upgrade in Progress Status, Packet RX/TX, Phone Port Status
(Enabled, In-Use), Line Port Status (Enabled, In-Use)
Certifications
FCC Part 15
Yes Class B
FCC Part 68
A-Tick
Yes
CE
Yes
ICES-003
Yes
RoHS
Yes
WEEE
Yes
UL/cUL
Environmental
Operating Temperature
0 to 45 C (32 to 113 F)
Storage Temperature
Operating Humidity
Non-operating Humidity
Physical Attributes
Dimensions
(width x depth x height)
Unit Weight
Shipping Weight
Mounting
213
Power Supply
Type
Universal Switching with Fixed US, EU, UK or AU Style Plug Prongs (Model Dependent)
Input Power
Output Power
Carton Specifications
Units Per Carton
20 Units
Carton Dimensions
(width x depth x height)
Carton Weight
Miscellaneous
Requirements
Documentation
Package Contents
Warranty
California, USA
Country of Origin
China
HST Code
8517.62.00
140911.110.1
214
OBi202 / OBi302
General
Brand
Obihai
Browse Obihai Devices
Manufacturer
Obihai
Hardware Designer
Model Name
OBi202 / OBi302
Release Date
Microprocessor
Width of Machine Word
32 bit
Instruction Set
ARM
Management Configuration
Local Access Interface
IVR, Web Page Password Protected (Admin & User Level Log-in)
Remote Provisioning
SSL via HTTPS , Encrypted XML via HTTP or TFTP Dedicated User Name & Password
Encrypted Binary File via TFTP or HTTP + Dedicated User Name & Password
Customization
LED Indications
Power, Device Status, Upgrade Progress Status, Ethernet Activity, PHONE Status
RTP Statistics
215
Packets Interpolated
Packets Late (Dropped)
Packets Lost
Packet Loss Rate %
Packet Drop Rate %
Jitter Buffer Length - ms
Received Interarrival Jitter - ms
DTMF Digits Received
Jitter Buffer Underruns
Jitter Buffer Overruns
Sequence Number Discontinuities
Skew Compensation - ms
Session Information
Save & Restore Configuration via XML file to / from a Local Folder
Security
Local Access Interface
IVR Password
Data Networking
216
VoIP
Telephony
217
Silence Suppression
Comfort Noise Generation
Three Way Conference Calling with Local Mixing
Hook Flash Event Signaling
Flash Hook Timer
Caller ID Name & Number per Bellcore, ETSI and DTMF
MWI Message Waiting Indicator
Visual Message Waiting Indication (VMWI)
Daylight Savings Time Support North & South Hemispheres
Caller ID Enable /Disable
Caller ID Number
Caller ID Name (Alphanumeric)
Call Waiting
Maximum Session Control
Call Forward - Unconditional
Call Forward on Busy
Call Forward on No Answer (Ring Count Configurable)
Call Transfer Enable / Disable
Anonymous Call Block
Anonymous Call
Do Not Disturb
Call Return
Repeat Dialing
218
LAN
Phone (FXS)
USB
USB 2.0
Reset Button
LEDs
LED Indications
Power On, Status, Upgrade in Progress Status, Packet RX/TX, Phone Port Status
Certifications
FCC Part 15
Yes Class B
A-Tick
Future
CE
Yes
ICES-003
Yes
RoHS
Yes
WEEE
Yes
UL/cUL
Environmental
Operating Temperature
0 to 45 C (32 to 113 F)
Storage Temperature
Operating Humidity
Non-operating Humidity
Physical Attributes
Dimensions:
(width x depth x height)
Unit Weight:
Shipping Weight
390 grams / 14 ounces (Including Power Supply, Ethernet Cable and Packaging)
Mounting
Power Supply
Type
Universal Switching with Fixed US, EU, UK Style Plug Prongs (Model Dependent)
Input Power
Output Power
Carton Specifications
Units Per Carton
20 Units
Carton Dimensions
Carton Weight
Miscellaneous
Requirements
219
Package Contents
Warranty
California, USA
HST Code
8517.62.00
100411.202.2
** For Service Providers Only
iPhone, iPad and iPod touch are trademarks of Apple Computer, 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 mentioned 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 Obihais hardware & software including without limits any damage, or for any loss whatsoever.
220