Obihai Technology, Inc.

OBi Device Administration Guide

Models:

OBi1 Series – OBi100, OBi110

OBi2 Series – OBi200, OBi202

OBi3 Series – OBi300, OBi302

 

        

                                                                                    Version 01092013 – September 2013


Introduction   6

Audience  6

Where to Go for Help  6

Notational Conventions  6

Introduction to OBi Devices  8

Physical Interfaces of the OBi Device  10

Overview of the OBi Device Physical Interfaces  10

Connecting Power to the OBi Device  10

LED Description and LED Behaviour  11

Internet Connection Set-Up and Configuration   13

PHONE Port Set-Up and Configuration   13

Using the OBi as a Paging System    13

Primary Line  14

LINE Port Set-Up and Configuration   15

Features Available on the OBi2 Series and OBi3 Series Models  15

Sharing Files on an External USB Storage Device  15

IP Routing and LAN Switching Features (OBi202 and OBi302 Only) 16

End User Features Available on the OBi 20

OBiTALK Web Portal: 20

OBi Circles of Trust  20

OBiON iPhone & iPod Touch + Android Smart Phone Apps  20

OBiAPP for PC Soft Phone App  20

OBi Works with Your Existing Services  20

Bridge Your Services for Optimum Savings & Convenience  20

Call Forwarding   20

Caller ID – Name & Number  21

Call Waiting   21

3-Way Calling   21

Call Transfer (Attended) 21

Nordic Style Feature Invocation   22

Caller ID Block (Anonymous Calling) 22

Automatic Call Back (Call Return) 22

Repeat Dialing   22

Anonymous Call Block  22

Do Not Disturb  22

Message Waiting Indication – Visual and Tone Based   23

Speed Dialing of 99 OBi Endpoints or Numbers  23

PHONE 1/2 Collaborative Features (OBi202 and OBi302 Only) 23

Star Code Features  24

Call Forward Numbers  26

Configuration and Management Interfaces of the OBi Device  27

Telephone-IVR-Based Local Configuration   27

System Level Configuration Options  28

Network Related Configuration Options  29

Router Related Configuration Options (OBi202 and OBi302 Only) 30

OBiWiFi Network Related Configuration Options (OBi2 Series and OBi3 Series Only) 31

SIP Service Provider Configuration Options  32

OBiTALK Configuration Options  37

Auto Attendant Configuration Options  38

LINE (FXO) Port Configuration Options  39

Customized AA Prompt Recording Options  40

Web Server-Based Local Configuration   41

Web Page Conventions and Icons & Buttons: 42

Firmware: Local OBi Device Update and Management  43

Updating Firmware: 43

Possible Error Messages on Firmware Update Failure: 44

Customized AA Prompts Backup & Restore: 44

Configuration Backup & Restore: 44

Reset Configuration to Factory Default  45

Zero-Touch, Massive Scale Remote Provisioning: 45

ITSP Quick Start Setup Wizard (OBi100 and OBi110) 46

ITSP Quick Start Setup Wizard (OBi202, OBi302) 49

Status Pages  53

System Status  53

LAN Status (OBi202/OBi302 only) 57

Call Status  59

Call History  60

Services, Phone & Line Status  61

Router Configuration (OBi202, OBi302 Only) 64

WAN Settings  64

LAN Settings  68

DHCP Reservation   71

Firewall and DMZ  72

Port Forwarding   73

QoS Settings  74

OBiWiFi Wireless USB Adapter  77

WiFi Settings  78

WiFi Scan   80

System Management Features of the OBi Device  81

Network Settings  81

Automatic Firmware Update & Provisioning   85

Device Administration   91

Device Update  93

SIP Service Provider Features of the OBi Device  93

SIP Registration   94

SIP Outbound Proxy Server  94

DNS Lookup of SIP Servers  94

NAT Traversal Considerations  95

SIP Proxy Server Redundancy and Dual REGISTRATION   95

SIP Privacy  96

STUN and ICE  97

ITSP Driven Distinctive Ringing   97

RTP Statistics – the X-RTP-Stat Header  98

Media Loopback Service  98

Google Voice Service  108

Using SPn as a Proxy for a SIP IP Phone  118

OBiTALK Service Settings  119

Auto Attendant Service  123

Automated Attendant  123

AA Callback Service  123

User Recorded Prompts  124

Customizing AA Prompt Lists  124

Voice Gateways  130

Trunk Groups  132

OBiBlueTooth   133

Pairing OBiBT with Mobile Phone  133

OBiBlueTooth Call Features  134

Phone Interface Features of the OBi Device  138

Repeat Dialing Service  138

Telephone Line Interface Features of the OBi Device  150

Line Port Status Event Package  150

Codec Profile Features of the OBi Device  156

Tone & Ring Patterns  163

Tone Profile Features of the OBi Device  163

Tone Examples: 165

Ring Profile A & B Features of the OBi Device  169

Star Code Profile Features of the OBi Device  175

Star Code Script Variables (VAR) 175

Star Code Script Actions (ACT) 176

Star Code Script Format  177

Star Code Script Examples  177

User Settings Features of the OBi Device  181

Speed Dial Numbers  181

Using Speed Dial Number as Ad Hoc Gateway  181

User Defined Digit Maps  182

Sharing Files on an Attached External USB Storage Device (OBi202 Only) 183

File Sharing Settings  183

File Explorer  188

OBi Call Routing and Digit Map  191

Trunks, Endpoints, and Terminals  191

Supported 2-way Call Bridges on the OBi Device  191

Call Routing – The OBi Way  192

Inbound Call Route Configuration   193

Outbound Call Route Configuration   195

Digit Map Configuration   197

Digit Map Rules and Elements  197

Matching Against Multiple Rules in Digit Map  199

Invoke Second Dial Tone in Digit Map  201

Change Inter-digit Long Timer Dynamically After Partial Match   202

User Defined Digit Maps  202

A User Defined Digit Map For IPv4 Dialing   202

Specifications & Environmental Characteristics of the OBi Device  204

 


 

 

Introduction

Audience

Cloud Service Providers and Managed Service VARs

 

Note to End Users

End users are highly encouraged to use the OBiTALK web portal to configure and manage their OBi devices.  The reason for this is two-fold.  One, the major benefits afforded by the OBi devices are available to be turned on, set-up and modified from within the portal.  What’s more is the application of the functional configuration is controlled by device configuration files tightly integrated with the settings configured by the OBiTALK portal and cloud-based applications managed by Obihai which make possible the device’s “plug-n-play” operation.

 

Where to Go for Help

Obihai has a number of options available to customers who are seeking help regarding their Obihai products.

Obihai Web Site:

1.       Obihai Support Web Site:  http://www.obihai.com/support.html

On this web site visitors will find links to the OBiTALK forum, Documents and Downloads, Tools Tips and Tricks as well as an FAQ / Knowledge Base.

2.       Enter a Support Request at:  http://www.obihai.com/supportTicketForm.php

3.       Go to the OBiTALK forum at:  www.obitalk.com/forum

4.       E-mail the Obihai Support Team at: support@obihai.com

 

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

 

 

 

The OBi110 LINE Port and OBiLINE USB to FXO Adapter

A built-in LINE port is available only on the OBi110 model.  For OBi models that have a USB Port, an OBiLINE USB to FXO adapter accessory may be attached to provide an additional LINE port. As such, references in this document that describe configuration or behavior of the LINE port or “Li” interface apply to the OBi110 or devices with an OBiLINE USB to FXO adapter attached.

 

                    

OBiLINE USB to FXO Adapter

Introduction to OBi Devices

Built with a high-performance system-on-a-chip platform to ensure high quality voice conversations, OBi devices are dedicated systems targeted at applications for voice over IP services.  OBi devices have high availability and reliability because they are always-on to make or receive calls.  With an OBi device, a computer is not required and a computer does not need to be on to talk to people.  To get started, all you need is a phone, power and a connection to the Internet.

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

1

0

1

0

OBi110

Yes – 2 Accounts

Yes

1

1

1

0

OBi200

Yes – 4 Accounts

Yes

1

0*

1

1

OBi202

Yes – 4 Accounts

(SIP only)

Yes

2

0*

2

1

OBi300

Yes – 4 Accounts

Yes

1

0*

1

1

OBi302

Yes – 4 Accounts

(SIP only)

Yes

2

0*

2

1

 

* 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.

 

OBi Devices Are Complemented by Other OBi Products & Services

OBiTALK:  A customer portal for device management allowing members to add people and associated OBi endpoints to “circles of trust” such that additional functionality can be shared amongst authorized users. The OBiTALK portal is also where members can download the OBiAPP and OBiON applications for PCs and the iPhone, iPad, iPod touch & Android devices, respectively.

OBiON for iPhone, iPad, iPod touch & Android Devices:  An application for iPhone, iPad, iPod touch and Android devices which makes possible placing and receiving calls to/from other OBi endpoints.

OBiAPP for PC:  An application for a PC that facilitates placing and receiving calls to/from other OBi endpoints.

 

     


 

Key Features of the OBi Voice Service Bridge / Telephone Adapter:

·         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.).

 

OBiTALK Web Portal Integration

·         Configuration and Management of OBi Endpoints

·         Download OBi Client Applications for PCs, Mobile Phones & Internet Devices

·         Creating & Joining Circles of Trust So You Can Share Your OBi

·         Setting Up Your OBi Endpoint Speed Dial Directory

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)

Physical Interfaces of the OBi Device

Overview of the OBi Device Physical Interfaces

                     

Top Views of the OBi100, OBi110, OBi200/300 and OBi202/OBi302

LED Order (Left to Right): Power Status – Internet Port Activity – LAN Port Activity (OBi202) – PHONE Status – LINE Status (OBi110)

 

       

Rear Views of the OBi100, OBi110, OBi200/300 and OBi202/OBi302

Port Order (L-to-R): LINE Port (OBi110) – PHONE Port(s) – LAN Port (OBi202/OBi302) – Internet Port – 12v DC Power Jack

 

OBi Device Feature Comparison

- Up to 2 OBiBT devices may be used (USB hub required).

- FXO connectivity may be added to OBi2 and OBi3 Series devices with the OBiLINE USB to FXO adapter.

 

 

Connecting Power to the OBi Device

Connect the supplied 12-volt power adapter to the OBi device and the wall outlet or working power strip.  Only use the power adapter supplied with the original packaging to power the OBi device.  Use of any power adaptor other than what was provided with the OBi will void the warranty and may cause the unit to not function at all or cause undesired operation.

LED Description and LED Behaviour

There are four (4) LED lights on the top of the OBi.  They are used to provide the user with a visual indication of the working order and general status of key functional aspects of the OBi device.  Under normal operating conditions the LEDs should show green (solid or blinking) signals.

Here below, are specific details/explanation of the OBi LED description and behaviour.

LED Icon

Light Behavior

What It Means

Off

The OBi is not receiving power.

Solid Green

The OBi is operational.

Flashing Green

The OBi is looking for a DHCP IP address.

Flashing Orange

The OBi is upgrading. DO NOT remove power!

Solid Red

The OBi is non-operational.

LED Icon

Light Behavior

What It Means

Flashing Green (Intermittent)

Light flashes when there is data activity on the OBi Internet Ethernet port.

Flashing Green (Intermittent)

Light flashes when there is data activity on the OBi LAN Ethernet port. (OBi202 Only)

LED Icon

Light Behavior

What It Means

OBi100 & OBi110:

 

 

OBi202 & OBi302:

 

 

 


OBi200/OBi300:

Off

The port is not enabled. Otherwise:

-          If the Primary Line is the PSTN LINE, indicates OBiTALK service is not available.

-          If Primary Line is SP1/SP2/OBiTALK, indicates the corresponding primary service is not available (but the secondary services may still be available).

Solid Green

The phone is ready to be used:

-          If the Primary Line is the PSTN LINE, indicates OBiTALK service is available.

-          If the Primary Line is SP1/SP2/OBiTALK, indicates the corresponding primary service is available.

Flashing Green

The phone is in use.

Fast Flashing Green

The phone is ringing.

 

Programmable using the phone port’s MWILedTimer parameter

Available on Obi2 Series and Obi3 Series Only

New voicemail available (MWI)

LED Icon

Light Behavior

What It Means

OBi110 Only

Off

The port in not enabled.

Solid Green

The line is ready to be used.

Flashing green

The line is in use.

Fast Flashing Green

The line is ringing.

 

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.

 


 

Internet Connection Set-Up and Configuration

Connect one end of an Ethernet cable to the OBi INTERNET port and the other end of the Ethernet cable to an Ethernet port on your Internet router or Ethernet switch. By default the OBi will request an IP, DNS and Internet (WAN) Gateway IP addressing via DHCP. 

PHONE Port Set-Up and Configuration

A phone has a very basic UI (User Interface) for I/O (Input / Output) of signalling or control messages. 

The OBi PHONE port supports input signalling and control messages comprised of: On Hook, Off Hook, Hook Flash, DTMF tones.

The OBi PHONE port supports output signalling and control messages comprised of: Caller ID/CWCID, MWI, DTMF/Tone, Ring, Pol-Rev, CPC, Power Denial.

The OBi PHONE port has a Maximum Sessions capacity of two (2).  This is not configurable.

The OBi PHONE port will reply BUSY to a new incoming call when:

§  The PHONE port already has 2 calls in session.

§  The PHONE port is ringing the phone.

§  The phone is in a dialing or fast busy “Invalid” state.

§  The OBi is already in a FAX call.

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.

When the OBi goes On-Hook during a 3-way Call, this will become a transfer when 2nd (outbound) call is ringing or connected.  If the 2nd (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

 

Using the OBi as a Paging System

You may connect the OBi PHONE port to an external PA system via an RJ11-to-Line-Out connector (available at many popular electronics shops), and enable the PHONE port option UseForPagingOnly. In this configuration, the phone port is expected to be “off-hook” all the time.  The OBi will automatically answer incoming calls.  It will not accept call-waiting. 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:

 

When you want to make a call via a service that is not the Primary Line, you will need to dial that service’s access code before the destination number. 

The default service route access codes are defined as:

·         ** 1 : SIP Service Provider 1  or Google Voice Service 1 (SP1)

·         ** 2 : SIP Service Provider 2 or Google Voice Service 2 (SP2)

·         ** 3 : SIP Service Provider 3  or Google Voice Service 3 (SP3)

·         ** 4 : SIP Service Provider 4 or Google Voice Service 4 (SP4)

·         ** 8 : PSTN Line Port Service (LI) on OBi1101

·         **70: PSTN Line Port Service (LI) on OBi200/OBi202/OBi300/OBi3021 Requires OBiLINE Accessory

·         **8 or **81: OBiBlueTooth 1 Service (BT1)1

·         **82: OBiBlueTooth 2 Service (BT2)1

·         ** 9 : OBiTALK Network (PP)

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.

LINE Port Set-Up and Configuration

Like a PHONE port, a LINE port has a basic UI (User Interface) for I/O (Input / Output) of signalling or control messages:

The OBi LINE port supports the following inputs: DTMF, Polarity, CPC, Caller ID, Ring, Tone

The OBi LINE port supports the following outputs: DTMF/Tone, On Hook, Off Hook, Hook Flash*

The OBi LINE port will assume a call is Connected on the following conditions:

End of dialing for outbound calls

Off-hook for inbound calls

The OBi LINE port will assume a call is Disconnected on the following conditions:

Power Down, CPC, Long Silence, or Disconnect Tone

Note:  The OBi LINE port and system logic will not attempt to invoke or interpret PSTN supplementary services.  This is directly between the user and the Phone Company.

·         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

 

Features Available on the OBi2 Series and OBi3 Series Models

Sharing Files on an External USB Storage Device

The OBi2 Series models have a USB port that can be attached to an external USB storage device, such as a USB flash drive or USB hard disk drive. The device’s native web server includes functionality for browsing the contents on the attached USB device and sharing them selectively with other parties.

There are three levels of access to an attached USB storage device, admin, user, and anonymous. Admin and user level access are protected by a User ID and Password. The admin will have full access while a user level access can be restricted. Anonymous access is limited to read-only without being prompted by the OBi device to enter a User ID or Password. To have admin level access, one must login with the User ID “admin” and provide the corresponding password. To login as a user, one must login with a valid User ID and provide the corresponding password. Up to 10 User IDs can be specified in the OBi device’s configuration for user level access, and each User ID can be enabled individually and assigned a different set of restrictions with the following attributes:

 

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 and LAN Switching Features (OBi202 and OBi302 Only)

OBi202 and OBi302 have two Ethernet ports labelled as the Internet port and the LAN port. The OBi works as a router by default.  All the native voice services and features use the WAN port only when the OBi202/OBi302 is in router mode. The OBi can also be set to work as a 3-port switch (a.k.a. Bridge mode), by changing its OperationMode parameter from Router to Bridge.  Note: One of the switch ports is for OBi202/OBi302 internal use only.

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/OBi302’s 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.

§  If a DMZ host is configured, forward the packet to that LAN IP address.

§  Queue the packet for internal processing.

 

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).

§  DRDOSAttackProtection – Protects against DOS attack if enabled (default is disabled).

§  VPNPassThrough – Blocks all VPN traffic if disabled (default is enabled).

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.

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.

 


 

VLAN Support in Router Mode

In router mode, the OBi202/OBi302 can support VLAN (802.1Q) on the WAN side. When VLAN is enabled, incoming packets from the WAN side not belonging to the same VLAN are dropped, while all outgoing packets to the WAN side are tagged with the configured VLAN ID.  The VLAN support is transparent to the devices on LAN side.  The router removes the VLAN tag when forwarding packets to the LAN side.

 

LAN Switching Features

Instead of acting as a router, the OBi202/OBi302 can be set to work as a 3-port switch. One of the ports is internal and is used by the OBi202/OBi302 CPU only, while the two external ports (labelled as Internet and LAN) can be connected to other devices. This mode of operation is known as the bridge mode. In this mode, all the router features, such DHCP server, firewall and port forwarding, will not take effect. The QoS policy in this case is hardwired such that the native voice and related traffic will always have highest priority (this behavior is not configurable). Furthermore, accessing the OBi device management web pages from either of the two external ports is always allowed.

 

VLAN Support in Bridge Mode

When VLAN is enabled, packets sent to the OBi not belonging to the same VLAN are dropped, while packets sent by the OBi are tagged with the configured VLAN ID. The packets switched directly between the external ports, on the other hand, are not modified by the OBi.


 

End User Features Available on the OBi

OBiTALK Web Portal:

The OBiTALK Web Portal allows you to manage your OBi endpoints and their relation to other endpoints in your Circle of Trust. OBiTALK is a web portal and OBi configuration utility which helps OBi users configure devices for optimum savings and access applications which make using OBi with even more convenience. 

OBi Circles of Trust

The OBiTALK Web Portal is also where you can set-up Circles of Trust. The Circles of Trust provide a means to team-up with other people with OBi devices and endpoints so that everyone’s calls can be made as inexpensively as possible.

OBiON iPhone & iPod Touch + Android Smart Phone Apps

After setting up an account and logging in to the OBiTALK portal, users may download applications for their iPhone and Android smart phones. 

OBiAPP for PC Soft Phone App

After setting up an account and logging in to the OBiTALK portal, users may download applications for their iPhone and Android smart phones.

OBi Works with Your Existing Services

If you do not want to configure a new service in order to make free calls using your Internet connection you can simply plug in your existing analog line from your telco phone service or connect the line coming from an VoIP service (from an ATA or cable EMTA) to the OBi.  Connect your telephone to the OBi’s phone port and you are ready to call other users’ endpoints on the OBiTALK network.

Bridge Your Services for Optimum Savings & Convenience

With the OBi device, you can bridge multiple services to route calls in the most efficient cost-effective way.  You can connect your telco phone service to the OBi at your house and use your PC or Apple iPhone, iPod touch or Android Smart phone to bridge a call from the OBiTALK network to the phone landline or Internet phone service connected to the OBi device at home.

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


 

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.

Caller ID – Name & Number

Caller ID allows you to see the number and (if available) the name of the person calling you.  You can use this information to decide whether or not to answer the call.  You must have a phone (or device) that supports caller ID to use this feature.

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. 

Call Transfer (Attended)

You can transfer a call to a third party using the attended transfer capabilities of the OBi.  To use Attended Call Transfer, while in a call with the party who will be transferred, press the “flash” button or depress and release the switch hook on your phone.  You will be presented with a second dial tone. The party who will be transferred will be placed on hold.  Dial the transfer target.  When the transfer target answers, you will be able to inform them that you intend to connect them with the party on hold.  At this point press the “flash” button or depress and release the switch hook on your phone.  This will connect the party to be transferred, the transfer target and yourself.  You can continue to talk together, as this is now a 3-way call, or you can hang up the phone and the other two parties will remain connected.

 


 

Nordic Style Feature Invocation

In the above description of call waiting, 3-way calling, and call transfer operations, the way the features are invoked is referred to as N. America style. In Nordic regions (such as Sweden, Norway), the same features are invoked by hook flashing followed by a digit 0, 1, 2, 3, or 4 to more precisely control which operations to apply to the calls. For these regions, the phones may also be equipped with an R button for hook flashing. The commands issued to the OBi are referred to as R0, R1, R2, R3, R4, and R5. Here is a summary of the operations:

Commands

Operations

Scenarios

R0

Reject the 2nd incoming call

1st call connected, 2nd call ringing

R1

End the 1st call. Resume or answer the 2nd call

1st call connected, 2nd call on hold or ringing

R2

Hold 1st call. Resume or answer the 2nd call (swap calls)

1st call connected, 2nd call on hold or ringing

R3

Keep the 1st call. Resume or answer the 2nd call (conference)

1st call connected, 2nd call on hold or ringing

R4

Transfer 2nd call peer to the 1st call peer

1st call connected, 2nd call on hold or connected

 

To select the Nordic style of feature invocation, set the parameter PHONE Port::CallCommandSignalMethod to “Nordic Regions (R1, R2, …)”. The default is: N. America.

Caller ID Block (Anonymous Calling)

Caller ID Block allows you to mask your name and number information from appearing on the phone you are calling.  To use Caller ID Block for one call only, dial *67 and then the destination number.  To use Caller ID Block on a persistent basis, dial *81 from the handset attached to the OBi.  All calls will use the Caller ID Block feature until you cancel the Caller ID Block.  To cancel Caller ID Block, dial *82 from the handset attached to the OBi.

Note: This service feature requires ITSP support. While most ITSP services support this service feature, at present, Caller ID Blocking is NOT available with Google Voice service.

Automatic Call Back (Call Return)

Automatic Call Back, also called Call Return can be used to call back the last caller who called you without actually dialing their number.  To use Automatic Call Back, from the phone attached to the OBi, dial *69.  The OBi will then attempt to use the previous callers Caller ID information to make the call.

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.

Anonymous Call Block

Anonymous Call Block allows you to block calls from incoming callers when there is no identifying caller ID name or number.  Incoming calls will be presented with a busy signal.  To use Anonymous Call Block, from the phone attached to the OBi, dial *77.  To cancel Anonymous Call Block, from the phone attached to the OBi, dial *87.

Do Not Disturb

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.

Message Waiting Indication – Visual and Tone Based

Message Waiting Indication allows you to be notified when there is a new voice message for you.  The OBi supports both Visual and Tone based Message Waiting Indication.  With Tone-based Message Waiting Indication, you will know there is a message for you when you hear a “stutter” dial tone right when you first pick up the phone to make a call.  Typically, this stutter tone will be removed once you listen to your message(s).  Visual-based Message Waiting Indication will turn on a light or screen icon on your phone (or phone base station) when there is a message waiting for you.  Typically, this light or icon will go dark when you have listened to your new message(s).

Speed Dialing of 99 OBi Endpoints or Numbers

The OBi device supports Speed Dialing of 99 numbers.  These numbers can be associated with phones reachable via an Internet or landline service or the OBiTALK network.  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.

 

PHONE 1/2 Collaborative Features (OBi202 and OBi302 Only)

While PHONE 1 and PHONE 2 can function independently of each other, the OBi202 and OBi302 also offer some collaborative features to let the two phone ports work together as a mini phone system.

With the factory default digit map and call routing rules, you can dial a single “#” (pound/hash) digit to call from one phone port to ring the other phone port. Depending on the current state of the called phone, one of the following can happen:

  1. 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.

 

Star Code Features

The OBi device supports service features via the handset connected to the PHONE port.  The following Star Codes can be used to access the indicated features. OBi Star Code Enabled Features Apply to All Voice Services.

*03, Request peer device to loopback media in the next outbound call 
*04, Request peer device to loopback RTP packets in the next outbound call 
*05, Tell device to periodically redial the last called number until the called party rings or answers 
*06, Cancel the last repeat dial request 
*07  Redial
*69  Call Return
*81  Block Caller ID (Persistent Mode)
*82  Unblock Caller ID (Persistent Mode)
*67  Block Caller ID (One Time)
*68  Unblock Caller ID (One Time)
*72  Call Forward All (Enter Number + #)
*73  Disable Call Forward All
*60  Call Forward on Busy (Enter Number + #)
*61  Disable Call Forward in Busy
*62  Call Forward on No Answer (Enter Number + #)
*63  Disable Call Forward No Answer
*77  Block Anonymous Calls
*87  Unblock Anonymous Calls
*56  Enable Call Waiting
*57  Disable Call Waiting
*78  Do Not Disturb – Turn On
*79  Do Not Disturb – Disable
*66  Repeat Dial
*86  Disable Repeat Dial
*74  Speed Dial Set-Up (Enter SD No. [1-99] then Tel No. + #) ∞
*75  Speed Dial Read-Back (Enter SD No.)  
*76, Clear a Speed Dial
*96, Barge In
*98, Blind Transfer
*4711, Use G711 Only on the next outbound call
*4729, Use G729 Only on the next outbound call

*28, Make OBiBT Bluetooth Adapter discoverable for the next 120s (OBI202 only) and set it as OBiBlueTooth 1*
*29, Make OBiBT Bluetooth Adapter discoverable for the next 120s (OBI202 only) and set it as OBiBlueTooth 2*

∞ 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.

 

 


 

Call Forward Numbers

There is one set of Call Forward Settings per voice service on the OBi, such that the settings apply to incoming calls on that service only. However calls may be forwarded to numbers on the same service or on another service. Therefore each call forward number stored in the OBi configuration MUST include call routing information to let the device know which voice service should be used to forward the call to. The general format of a call forward number is:          

TK(number)

Note: TK is the abbreviated name of a voice service.

Valid values of TK are SP1 for the SP1 Voice Service (with ITSP A or B), SP2 for the SP2 Voice Service (with ITSP A or B), LI1 for the PSTN service (on the LINE Port), or PP1 for the OBiTALK Service.

The number to forward to must be in the final form that is acceptable by the service provider. OBi will not apply any Digit Map or Call Routing Rules on it.

Examples: SP1(14089991234), PP1(ob200333456)

 

You may also set the call forward number to a phone port (ph, ph1 or ph2) or the AA (aa)

Configuration and Management Interfaces of the OBi Device

Telephone-IVR-Based Local Configuration

The OBi utilizes an interactive voice response (IVR) system for both its configuration and day-to-day function.  The IVR is, in essence and automated attendant the OBi user will access to either invoke a verbal response from the OBi to provide information to the user (such as IP address) or instruct the OBi to act on the routing / placement of a call to a particular interface.  More information about the Auto Attendant IVR for OBi call processing will be provided later in the document.

There are two IVR menus.

1.       Auto Attendant IVR 1:  Referred to as “aa” (or aa1) for call processing commands.

2.       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

What Can You Do?

                1

Basic Network Status

Your IP address and DHCP status will be read back to you.

Press 0 to repeat the information.

                 2

Advanced Network Status

Your primary & back-up DNS server, primary & back-up NTP server will be read back to you.

Press 0 to repeat the information.

                 3

DHCP Current Value

Your current value will be read back to you and you will be given the option to change the value

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

                 4

IP Address Current Value

Your current value will be read back to you and you will be given the option to change the value. If you elect to enter a new value (static IP address) DHCP will be disabled.

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

                 5

Password Current Value

Your current IVR password value will be read back to you and you will be given the option to change the value.

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

                 6

Please Wait (while OBi is checking for software update)…

This is followed by either:

-    Software Update Available. Press 1 to update software, OR

-    Software Update Not Available

 

If an update is available, press 1 to proceed with the update. The software update process will start as soon as you hang up the phone.

 

Warning: Once the software upgrade process starts, the device’s power LED will blink rapidly. Please make sure the power and network cable stay connected to the unit until the process is complete.

                8

Restore Factory Default

Press 1 to confirm device restore to factory default settings.

Press # to return to device configuration menu.

Press # # to exit IVR.

                 9

Reboot OBi Device

Press 1 to confirm device reboot.

Press # to return to device configuration menu.

Press # # or hang up to exit IVR.

                0

Additional Options

Access other configuration options of the OBi device.

Enter option followed by the # key.

 

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.

 

System Level Configuration Options

Additional Configuration Options Available with the OBi IVR after Pressing * * * 0:

Selection

(Always Press “#” After Entering Selection)

Announcement

What Can You Do?

                1

Firmware Version

The current value of the firmware version will be read back.    

Press 0 to repeat the information.

Press # to enter another configuration selection.

                2

IVR Password

The current value of the IVR password will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                3

Debug Level

The current value of the debug level will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                4

Syslog Server IP Address

The current IP address of the syslog server will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                5

Syslog Server Port

The current value of the syslog server port will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value of 514.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                813

Factory Reset just the Voice configuration parameters. Leave the Router configuration parameters unchanged

Press 1 to confirm.

Press # to enter another configuration selection

                823

Factory Reset just the Router configuration parameters. Leave the Voice configuration parameters unchanged

Press 1 to confirm.

Press # to enter another configuration selection

 

Network Related Configuration Options

Additional Configuration Options Available with the OBi IVR after Pressing * * * 0:

Selection

(Always Press “#” After Entering Selection)

Announcement

What Can You Do?

                20

DHCP Configuration

The current value of the DHCP configuration will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                21

IP Address

The current value of the IP address will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                22

Default Gateway

The current value of the default internet gateway will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                23

Subnet Mask

The current value of the subnet mask will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                24

DNS Server (Primary)

The current value of the primary DNS server will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                26

NTP Server (Primary)

The current value of the primary NTP server will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

 

Router Related Configuration Options (OBi202 and OBi302 Only)

Additional Configuration Options Available with the OBi IVR after Pressing * * * 0:

Selection

Note: Always Press “#” After Entering Selection

Announcement

What Can You Do?

                30

Enable Web Management Access from WAN port

The current value will be read back.   (Effective in Router mode only) 

0: Disable Access from WAN

1: Enable Access from WAN

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                31

Choose Router or Bridge Mode

The current value will be read back.  

0: Router

1: Bridge   

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                32

Enable DHCP Server on LAN side in router mode

The current value will be read back.  

0: Disable DHCP Server

1: Enable DHCP Server

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                33

Enable Firewall in router mode

The current value will be read back. 

0: Disable Firewall

1: Enable Firewall  

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                38

Enable QoS feature in router mode

The current value will be read back.

0: Disable QoS

1: Enable QoS

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

 

 

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

What Can You Do?

                40

DHCP Configuration

The current value of the DHCP configuration will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                41

IP Address

The current value of the IP address will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                42

Default Gateway

The current value of the default internet gateway will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                43

Subnet Mask

The current value of the subnet mask will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                44

DNS Server (Primary)

The current value of the primary DNS server will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                46

NTP Server (Secondary)

The current value of the Secondary NTP server will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

 

 

SIP Service Provider Configuration Options

Additional Configuration Options Available with the OBi IVR after Pressing * * * 0 for SIP Service Provider One (SP1):

Selection

(Always Press “#” After Entering Selection)

Announcement

What Can You Do?

                100

Enable Service Provider One (SP1)

The current value will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                101

Registration State of SP1

The current value will be read back.    

Press 0 to repeat the information.

Press # to enter another configuration selection.

                102

SP1 User ID

The current value will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                167

SP1 Block Caller ID Enable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                168

SP1 Block Anonymous Call Enable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                172

SP1 Call Forward ALL – Enable / Disable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                173

SP1 Call Forward ALL Number

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                174

SP1 Call Forward on Busy – Enable / Disable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                175

SP1 Call Forward on Busy Number

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                176

SP1 Call Forward on No Answer – Enable / Disable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                177

SP1 Call Forward on No Answer Number

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

 

 

Additional Configuration Options Available with the OBi IVR after Pressing * * * 0 for SIP Service Provider Two (SP2):

Selection

(Always Press “#” After Entering Selection)

Announcement

What Can You Do?

                200

Enable Service Provider One (SP2)

The current value will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                201

Registration State of SP2

The current value will be read back.    

Press 0 to repeat the information.

Press # to enter another configuration selection.

                202

SP2 User ID

The current value will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                267

SP2 Block Caller ID Enable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                268

SP2 Block Anonymous Call Enable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                272

SP2 Call Forward ALL – Enable / Disable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                273

SP2 Call Forward ALL Number

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                274

SP2 Call Forward on Busy – Enable / Disable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                275

SP2 Call Forward on Busy Number

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                276

SP2 Call Forward on No Answer – Enable / Disable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                277

SP2 Call Forward on No Answer Number

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

 


 

OBiTALK Configuration Options

Additional Configuration Options Available with the OBi IVR after Pressing * * * 0:

Selection

(Always Press “#” After Entering Selection)

Announcement

What Can You Do?

                900

Enable OBiTALK Service

The current value will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                901

Registration State of OBiTALK

The current value will be read back.    

Press 0 to repeat the information.

Press # to enter another configuration selection.

                967

OBiTALK Block Caller ID Enable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                968

OBiTALK Block Anonymous Call Enable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                972

OBiTALK Call Forward ALL – Enable / Disable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                973

OBiTALK Call Forward ALL Number

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                974

OBiTALK Call Forward on Busy – Enable / Disable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                975

OBiTALK Call Forward on Busy Number

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                976

OBiTALK Call Forward on No Answer – Enable / Disable

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                977

OBiTALK Call Forward on No Answer Number

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

 

 

Auto Attendant Configuration Options

Additional Configuration Options Available with the OBi IVR after Pressing * * * 0:

Selection

(Always Press “#” After Entering Selection)

Announcement

What Can You Do?

                80

Enable / Disable Auto Attendant.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

 


 

LINE (FXO) Port Configuration Options1

Additional Configuration Options Available with the OBi IVR after Pressing * * * 0:

Selection

(Always Press “#” After Entering Selection)

Announcement

What Can You Do?

                90

Enable / Disable FXO LINE Port

The current value will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

                91

FXO State

The current value of the state will be read back.    

Press 0 to repeat the information.

Press # to enter another configuration selection.

                92

Ring Thru Delay

The current value will be read back.    

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

 


 

Customized AA Prompt Recording Options

Additional Configuration Options Available with the OBi IVR after Pressing * * * 0:

Selection

(Always Press “#” After Entering Selection)

Announcement

What Can You Do?

                1001

Option 1001 current value is: (the recorded prompt)

Press 1 to enter a new value.

Press 2 to set the default value.

Press 0 to repeat the information.

Press # to enter another configuration selection.

 

Note: After pressing 1 to record a new prompt, the OBi says “Enter value followed by the # key)\”. At that point, you can press any digit (0-9) to start recording, and then press # to end recording.

Tips: Leave about 1s of gap at the end of recording to avoid unintended truncation by the OBi.

After a new prompt is recorded, Obi immediately plays back the recorded audio, and then presents the following options:

Press 1 to save (save the recorded prompt permanently in long term memory)

Press 2 to re-enter (the last recorded prompt is discarded)

Press 3 to review

Press # to cancel (the last recorded prompt is discarded)

Similarly for Options 1002 - 1010

 

 

 

With these options you can record up to 10 prompts which can be arranged in any combinations and used as customized AA prompts. Each prompt recording is limited to 60s, where the prompt duration is rounded to the nearest number of seconds. A total of 122s is available to store all the recordings. The device will reboot automatically when you hang-up if any of the prompts have been modified and saved. Furthermore you can enter a text description for each recorded prompt as a reminder of the contents of the prompt (under the Voice Services - Auto Attendant configuration page).

 


 

Web Server-Based Local Configuration

 The OBi device has an integrated device management web server which can be accessed from a PC or similar device using a browser.  Although all popular browsers are tested for compatibility with the OBi device management web server, there may be inconsistencies which arise from time to time.  Please contact support@obihai.com if you have any questions about the OBi device management web server and how it appears in your browser window.

Access the OBi Device Management Web Page:

1.       From a phone attached to the OBi, dial * * * to access the OBi Config Attendant.

2.       Choose “1” to hear the IP Address of the OBi read back to you. Write this down.

3.       Enter the OBi IP Address in a local PC web browser address field:

4.       When prompted, enter “admin” for user name and “admin” for password.

When you access the OBi device management web page, you will be prompted for a user name and password.  There are two levels of access to the OBi web page – User Level and Admin Level.  The default “user name / password” for User Level access is “user / user”.  The default “user name / password” for Admin Level access is “admin / admin”.  The Admin and/or User passwords may have been changed using the OBi device web page, provisioning by a service provider or via the OBiTALK web portal (Admin only).  Please be sure you have access to the correct Admin or User password before you attempt to log on to the OBi Device Management Web Page.

The OBi device management web page is organized into sections to allow for a manageable and compartmentalized approach to configuring the many hundreds of parameters available on the OBi device.  Use the expandable / collapsible menu tree on the left side of the page to easily navigate the various configuration parameter sections of the OBi device.

 

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.


 

Web Page Conventions and Icons & Buttons:

Icon / Button

Description

Remark

This icon indicates that there is more information available which might describe the workings, limits or thresholds for the parameter to which it is adjacent. You can mouse over this icon to reveal this information.

 

When a modification has been made to a parameter on a page, the Submit button MUST be clicked before proceeding to another page.

 

If you make changes to a parameter on a page and you do not want to keep them for submission, click the “Clear Changes” button to revert back to the parameter setting present before the most recent change was entered.

 

Click the “Use Defaults Only” button if you want to revert all parameters on a given page to their Default settings.  If you want to revert just one or two parameters on a page to default settings you should use the Default check box found on the right side of the parameter. See next Item.

You will be prompted to confirm that you want all the parameters on the page to revert back to system default settings.

When you wish to modify a parameter away from its default setting, you should un-check the ‘Default’ box.  This will open the parameter field for access and modification.  If there is a non-default setting in a parameter field and you want to revert that parameter back to its default setting, check the “Default” box and the default setting will appear.

Default value of a parameter may be changed with a firmware upgrade. Leaving a parameter at default setting allows the device to use proper default value with the firmware currently installed in the device

This icon indicates that the configuration currently programmed on the OBi device is “set” and “running”.  No reboot is necessary if you have submitted configuration modifications.

This icon does not indicate the currently running configuration is working properly.

After Submitting changes to a web page on the OBi, the “Reboot Required” icon may appear.  In order for the modifications to run, you will need to reboot the OBi.

You can continue to make modifications to OBi parameters – on separate pages if necessary – before you reboot and ”set” the modifications in the running system.

The “Reboot” button is used when the “Reboot Required” icon appears indicating the OBi device requires a reboot to invoke one or more parameter modifications.

When performing a System Configuration Reset, the Reboot button does not need to be pressed.  The OBi will reboot automatically when the “Reset” button is selected.

 

 

Firmware: Local OBi Device Update and Management

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.

 


 

Possible Error Messages on Firmware Update Failure:

Error Message

Description

Suggested Solution

Firmware Package Checksum Error

A corrupted Firmware package file has been used for the update.

Check the file and / or re-download the firmware package and try again.

System Is Busy

The OBi device is busy because one of the phone services is in an active call or device provisioning is in progress.

Try to update again later

Firmware Is Not Modified

The OBi device is already running the same firmware as the one selected for update.

No need to upgrade.

 

Customized AA Prompts Backup & Restore:

Up to 10 individual prompts may be recorded through the device IVR interface (see Telephone-IVR-Based Local Configuration section). These prompts may be backed up into a single file from the web browser. The default name of the file is “backupaa.dat”. The backup file also includes the anotations entered for each recorded prompt.

To restore an AA prompt file onto an OBi, do it exactly like a firmware upgrade via the web browser but provide the device with the prompt file instead of a firmware file. The OBi can detect from the file header that you are trying to upload a prompt file and process the file accordingly. Warning: All the existing prompts in the device will be removed first when applying the backup file; this process cannot be undone.

 

Configuration Backup & Restore:

The current configuration of the OBi device can be backed up and stored as a file in XML format at a user specified location. The default name of the file is “backupxxxxxxxxxxxx.xml”, where the xxxxxxxxxxxxxx represents the MAC address of unit.

When backing up a device’s configuration, you may select the following three options before selection of the “Backup”.

Option

Description

Default Setting

Incl. Running Status

If checked, the value of all status parameters will be included in backup file. Otherwise, status parameters are excluded from the backup

No

Incl. Default Value

If checked, the default value of parameters will be included in the backup file. Otherwise, default values are excluded from the backup

No

Use OBi Version

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

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.

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.

Reset Configuration to Factory Default

The OBi device may be reset to factory default condition. Call history and various statistical information will be removed at the same time.  Resetting the device configuration should be used with extreme caution as the operation cannot be undone. To do this you press the “Reset” button in the Reset Configuration section. A confirmation window will pop up. The OBi device then proceeds to reset the configuration once you confirm that this is indeed what you want to do. The OBi device will reboot automatically when factory reset is completed.

For the OBi202, there are three factory reset options: reset just the voice settings, reset just the router settings, and reset all settings. There is a different IVR option for invoking each factory reset option. By default, the hardware reset button located via an opening on the underside of the OBi202 will reset all settings.  Via software configuration, it can be configured to reset just the voice or just the router settings.

 

Zero-Touch, Massive Scale Remote Provisioning:

OBi ZT or Zero Touch provisioning is a system level approach to deploying and maintaining thousands or millions of OBi devices with high security and control at the device level down to the individual parameter provisioned on each device.  Please contact sales@obihai.com for information regarding the capability, process and practice of using OBi ZT Provisioning. 

 


 

ITSP Quick Start Setup Wizard (OBi100 and OBi110)

The Setup Wizard page displays a collection of commonly used parameters in a condensed format. Each parameter listed here corresponds to a parameter inside one of the parameter groups. The Setup Wizard page may use more user friendly (but similar) parameters name for the actual parameters they mirror.  In other words, if the mirrored parameters are changed from the web page or remote provisioning, the corresponding parameters on the Setup Wizard page will show the same values.

 

The illustration below depicts the OBi device web page Setup Wizard.

 

ITSP Quick Start Setup Parameter Guide (OBi100 and OBi110):

Parameter

Description

Default Setting

 

System Management

Local Time Zone

Local time zone. Mirrors

System Management –

NetworkSettings::

LocalTimeZone

GMT-08:00 (Pacific Time)

Admin Password

Administrator Password, case sensitive. Mirrors

System Management –

Device Admin::

AdminPassword

admin

ITSP Settings

 

 

ITSP SIPProxyServer

Host name or IP address of the SIP proxy server. Mirrors

Service Providers –

ITSP Profile A –

SIP::ProxyServer

 

ITSP SIPProxyServerPort               

Destination port to connect to the SIP server. Mirrors

Service Providers –

ITSP Profile A –

SIP::ProxyServerPort

5060

ITSP AuthUserName

Username used by the device to authenticate to a SIP UAS (User Agent Server) when an outbound SJP Request is challenged with a 401 or 407 response. Mirrors

Voice Services –

SP1 Service::AuthUserName

 

ITSP AuthPassword

Password by the device to authenticate to a SIP UAS (User Agent Server) when an outbound SJP Request is challenged with a 401 or 407 response. Mirrors

Voice Services –

SP1 Service::AuthPassword

 

ITSP URI

If a value is specified for this parameter, it affects the way the device forms its AOR (Address of Record) or Public Address when sending outbound SIP Requests (such as REGISTER and INVITE); otherwise device forms its AOR in the normal way. See description of Voice Services –

SP1 Service::URI for details on how to use this parameter.

Mirrors

Voice Services –

SP1 Service::URI

 

Outbound Settings

Phone PrimaryLine

Indicate which service is the primary line when dialing out. Mirrors

PHONE Port::PrimaryLine

 

PSTN Line

 

Attendant PrimaryLine

Indicate which service is the primary line when dialing out via the AA. Mirrors

Auto Attendant::PrimaryLine

PSTN Line

 

ITSP DigitMap

Digit map controlling the transmission of dialed digit information. Mirrors

Service Providers –

ITSP Profile A –

General::DigitMap

 

 

(1xxxxxxxxxx|<1>[2-9]xxxxxxxxx |011xx.|xx.)

 

Phone DigitMap

Digit map to limit dialable numbers on this port. Mirrors

PHONE Port::DigitMap

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))

 

Phone OutboundCallRoute

Routing rule for outbound calls made from this port. Mirrors

PHONE Port::

OutboundCallRoute

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

Routing rule for inbound calls on this trunk. Mirrors

Voice Services –

SP1 Service::X_InboundCallRoute

ph

 

OBiTALK InboundCallRoute

Routing rule for inbound calls on this trunk. Mirrors

OBiTALK Service::InboundCallRoute

ph

 

POTS-line InboundCallRoute

Routing rule for inbound calls on this trunk. Mirrors

LINE Port::InboundCallRoute

ph

 

 

 


 

ITSP Quick Start Setup Wizard (OBi202, OBi302)

The Setup Wizard page for OBi202 and OBi302 is very similar to that of the OBi1xx, with a few additions to cover the additional ISTP profiles and SP services. The illustration below depicts the OBi202 device web page Setup Wizard.

 

 

 

 

ITSP Quick Start Setup Parameter Guide (OBi202) :

Parameter

Description

Default Setting

 

System Management

Local Time Zone

Local time zone. Mirrors

System Management –

NetworkSettings::

LocalTimeZone

GMT-08:00 (Pacific Time)

Admin Password

Administrator Password, case sensitive. Mirrors

System Management –

Device Admin::

AdminPassword

admin

ITSP Profiles (X = A, B, C, or D)

ITSP X SignalingProtocol

Choose either SIP or Google Voice

Mirrors

Service Providers –

ITSP Profile X

General::SignalingProtocol

 

Note: The Google Voice option is not available on OBi302.

SIP

ITSP X SIPProxyServer

Host name or IP address of the SIP proxy server. Mirrors

Service Providers –

ITSP Profile X

SIP::ProxyServer

 

ITSP X SIPProxyServerPort

Destination port to connect to the SIP server. Mirrors

Service Providers –

ITSP Profile X

SIP::ProxyServerPort

5060

ITSP X DigitMap

Digit map controlling the transmission of dialed digit information. Mirrors

Service Providers –

ITSP Profile X

General::DigitMap

 

 

(1xxxxxxxxxx|<1>[2-9]xxxxxxxxx |011xx.|xx.)

Outbound Settings (N = 1 or 2)

Phone N PrimaryLine

Indicate which service is the primary line when dialing out. Mirrors

PHONE Port N::PrimaryLine

 

SP1 Service

 

Phone N DigitMap

Digit map to limit dialable numbers on this port. Mirrors

PHONE Port N::DigitMap

([1-9]x?*(Mpli)|[1-9]|[1-9][0-9]|911|**0|***|#|

##|**1(Msp1) |**2(Msp2)|**3(Msp3) |

**4(Msp4)|**9(Mpp)|(Mpli))

 

Phone 1 OutboundCallRoute

Routing rule for outbound calls made from this port. Mirrors

PHONE Port 1::

OutboundCallRoute

{([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}

 

Phone 2 OutboundCallRoute

Routing rule for outbound calls made from this port. Mirrors

PHONE Port 2::

OutboundCallRoute

{([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}

 

Attendant PrimaryLine

Indicate which service is the primary line when dialing out via the AA. Mirrors

Auto Attendant::PrimaryLine

SP1 Service

 

Voice Services (n = 1, 2, 3, or 4)

 

SPn ITSP Profile

 

 

 

SPn AuthUserName

Username used by the device to authenticate to a SIP UAS (User Agent Server) when an outbound SJP Request is challenged with a 401 or 407 response. Mirrors

Voice Services –

SPn Service::AuthUserName

 

 

SPn AuthPassword

Password by the device to authenticate to a SIP UAS (User Agent Server) when an outbound SJP Request is challenged with a 401 or 407 response. Mirrors

Voice Services –

SPn Service::AuthPassword

 

 

SPn URI

If a value is specified for this parameter, it affects the way the device forms its AOR (Address of Record) or Public Address when sending outbound SIP Requests (such as REGISTER and INVITE); otherwise device forms its AOR in the normal way. See description of

Voice Services – SPn Service::URI

for details on how to use this parameter.

Mirrors

Voice Services –

SPn Service::URI

 

 

SPn InboundCallRoute

Routing rule for inbound calls on this trunk. Mirrors

Voice Services –

SPn Service::X_InboundCallRoute

ph,ph2

 

OBiTALK InboundCallRoute

Routing rule for inbound calls on this trunk. Mirrors

OBiTALK Service::InboundCallRoute

ph,ph2

 

 

 


 

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.

 

 

 

 

 

 


 

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:       Reboot on Power Cycle

1:       Operating System Reboot

2:       Reboot after Firmware Update via provisioning or phone (***6)

3:       Reboot after New Profile Invoked

4:       Reboot after Parameter Value Change or Firmware has changed and invoked via device web page

5:       Reboot after Factory Reset using the OBi device hardware pin

6:       New Profile Invoked AND Profile URL Changed

7:       Reboot from SIP Notify (Reserved)

8:       Reboot from Telephone Port (IVR)

9:       Reboot from Webpage - No change in parameter value(s) or firmware

10:     Reboot During OBiTALK Signup

11:     Reboot During OBiTALK Signup

12:     Reboot after DHCP server offers IP, GW-IP and/or Netmask different from what the OBi device is currently using

13:     Reboot on Data Networking Link Re-establishment

18:     Reboot on WAN IP address change (OBi202/OBi302 only)

19:     Reboot on LAN IP address change (OBi202/OBi302only)

 

 

OBiBT Bluetooth USB Adapter 1/2 Status

This status is available on OBi202 and OBi302 only. It shows the status regarding the OBiBT USB adapter attached to the unit and the corresponding OBiBlueTooth Services. The following status values are available:

-          No Dongle: No authentic OBiBT dongle detected

-          Connecting <device-name>: Connecting to the named device

-          Disconnected: Not connected with any paired device

-          No Device To Connect: No device paired

-          Service Down: Connected to a mobile phone which does not have an active service (e.g., no SIM card or no signal)

-          Service Disabled: OBiBlueTooth service has been disabled in the OBi configuration

-          Connected to <device-name>: Connected to the named device; OBiBlueTooth service is available only in this state

-          Incoming Call: BT detected an incoming call, but ringing has not started yet

-          Ring <Caller-ID>: Mobile phone is ringing. <Caller-ID> is the caller’s number

-          Outgoing Call: Mobile phone is making a call that is not answered yet

-          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

 

SPn Service Status (n = 1, 2, 3, 4)

Note that SP3 and SP4 Service Status are available on the OBi2 Series and OBi3 Series models only.  The SPn service status values indicate the current state of the service with regard to its configuration (or not) and if configured its registration status.  If there are problems with the registration or authentication of the OBi with a prescribed service, the SIP 4xx error message will be displayed here. This is very useful information for troubleshooting issues with SIP-based services.

 

OBiTALK Service Status

The status of the OBiTALK Service includes the following values:

-          Normal (User Mode): The service is functioning normally

-          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

 

OBiPLUS Service Status

OBiPLUS is a small business collaboration system.  It is an optional service that requires a separate subscription. You may subscribe to this service on OBiTALK.com. The administration of this service is described separately in the OBiPLUS Administration Guide.

The status is available on the OBi202 and OBi302 only. The following status values are available:

-          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.

 

 

LAN Status (OBi202/OBi302 only)

The LAN Status page shows the devices currently on the LAN. There are two sections:

·         Attached Devices: All the devices that the router has discovered on the LAN side; each entry has a MAC address and an IP address

·         DHCP Clients: All the DHCP clients that have an active lease with the DHCP server; each entry has a Client Name, a MAC address, an IP address, and the lease expiration time (in seconds)

 

Below is a screen shot of a typical LAN Status page. This page is available when the OBi202/OBi302 is working in router mode.

 

 

 


 

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

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”.

 

 


 

Services, Phone & Line Status

Statistics relevant to SPn can be found on the SPn Stats page (where n = 1, 2, 3, 4).

 

 

 


sp-stats

 

 

Parameter

Description

Default Setting

Reset Statistics

 

 

ResetStatistics

Resets the statistics for this voice service

NA

RTP Statistics

 

 

PacketsSent

Total RTP packets sent on this line

NA

PacketsReceived

Total RTP packets received on this line

NA

BytesSent

RTP payload bytes sent for this line

NA

BytesReceived

RTP payload bytes received for this line

NA

PacketsLost

Number of RTP packets lost on this line

NA

Overruns

Number of times receive jitter buffer overrun on this line

NA

Underruns

Number of times receive jitter buffer underrun on this line

NA

 

 

 

phone-status

 

 

Parameter

Description

Default Setting

Port Status

 

 

State

Port status, such as on-hook, off-hook, ringing

NA

LoopCurrent

Loop current in mA

NA

VBAT

PHONE port battery voltage in volts. Not applicable for LINE port

NA

TipRingVoltage

Sensed differential Tip/Ring voltage in volts

NA

LastCallerInfo

Caller ID of previous call

NA

 

 

Router Configuration (OBi202, OBi302 Only)

WAN Settings

Below is a screen shot of the WAN Settings device web page.

wan

wan2

 

 

WAN Settings Parameter Guide:

Parameter

Description

Default Setting

Internet Settings

 

 

AddressingType

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)

DHCP

IPAddress

The IP address to assign to the device when AddressingType is set to Static

 

SubnetMask

The subnet mask to use when AddressingType is set to Static

 

DefaultGateway

The default gateway IP address to assign to the device when AddressingType is set to Static

 

DNSServer1

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 DNSServer2 will be tried first, whichever is specified, and then the ones obtained from the DHCP Server if available

 

DNSServer2

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

 

PPPoEACName

PPPoE access concentrator name. Enter if it is required

 

PPPoEServiceName

PPPoE service name. Enter if it is required

 

PPPoEUsername

PPPoE account username provided by your ISP

 

PPPoEPassword

PPPoE account password

 

VLANID

Valid range is 0 – 4094 (4095 is reserved). 0 means VLAN is disabled and egress packets are not tagged by the device. This setting applies to all packets sent by the device

0

VLANPriority

Valid choices are 0 – 7. This setting applies to all packets sent by the device.

0

Local Time

 

 

CurrentLocalTime

Current local date and time of the device (read only)

 

Time Service Settings

 

 

NTPServer1

Hostname or IP address of the first NTP server

pool.ntp.org

NTPServer2

Hostname or IP address of the second NTP server

 

LocalTimeZone

Local time zone. Available choices are:

-          GMT-12:00(Int'l Dateline West)

-          GMT-11:00(Samoa)

-          GMT-10:00(Hawaii)

-          GMT-09:00(Alaska)

-          GMT-08:00(Pacific Time)

-          GMT-07:00(Mountain Time)

-          GMT-06:00(Central Time)

-          GMT-05:00(Eastern Time)

-          GMT-04:00(Atlantic Time)

-          GMT-03:30(Newfoundland)

-          GMT-03:00(Buenos Aires,Greenland)

-          GMT-02:00(Mid-Atlantic)

-          GMT-01:00

-          GMT+00:00(London,Lisbon)

-          GMT+01:00(Rome,Paris,Madrid)

-          GMT+02:00(Athens,Cairo)

-          GMT+03:00(Moscow,Baghdad)

-          GMT+04:00(Abu Dhabi)

-          GMT+04:30(Kabul)

-          GMT+05:00(Islamabad,Karachi)

-          GMT+05:30(New Delhi)

-          GMT+05:45(Kathmandu)

-          GMT+06:00

-          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)

GMT-08:00

DaylightSavingTimeEnable

Enable daylight saving time on the unit

Yes

DaylightSavingTimeStart

Daylight Saving Time Start Date. Format: month/day/weekday/hh:mm::ss, where month=1-12, day=±(1-31), weekday=0,1-7 (0=special, 1=Monday, 7=Sunday), hh=0-23,mm=0-59,ss=0-59.

If weekday=0, daylight saving starts on the given month/day; otherwise it starts on the weekday on or after the given month/day if day > 0, or on the weekday on or before the last-day-of-given-month+day+1 (note that day = -1 equivalent to last day of the month).

:ss may be omitted if the value is 0; :mm:ss may be omitted if mm and ss are both 0.

3/8/7/2

DaylightSavingTimeEnd

Daylight Saving Time End Date. Same format as Start Date

11/1/7/2

DaylightSavingTimeDiff

Amount of time to add to current time during Daylight Saving Time.

Format: [-]hh:mm:ss.

:ss may be omitted if it is 0; :mm:ss may be omitted if both are 0.

1

 

 

 

DNS Control

 

 

DNSQueryOrder

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

DNS Server1, DNS Server2, DHCP Offered DNS Servers

 

DNSQueryDelay

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)

2

Local DNS Records

 

 

N

 

where N = 1 – 32

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)

wt is optional; 1 is the default if not specified.

pri is optional only if wt is not specified; 1 is the default if not specified.

port is optional; the default to use will be based on the protocol (5060 for SIP, 80 for HTTP, etc.) .

The enclosing curly braces { } are also optional if there is only one R; or

if there is no comma used inside the R.

 

Examples:

_sip._udp+obihai.com=abc,xyz,pqr:5080,{mmm,2},{super.abc.com.}

 

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.

 

 

LAN Settings

Below is a screen shot of the LAN Settings device web page.

lan

 

 

 

 

 

 

LAN Settings Parameter Guide:

Parameter

Description

Default Setting

LAN Settings

 

 

CurrentRouterIPAddress

The current IP address of the router on the LAN side (read only). It is blank if OBi is operating in bridge mode.

 

OperationMode

The Networking Operation Mode for the device. It can be one of the following values:

Router

Bridge

Router

RouterIPAddress

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.

192.168.10.1

SubnetMask

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

255.255.255.0

DHCP Server Settings

 

 

Enable

Enable the DHCP Server on the LAN side

Yes

ClientAddressRangeStart

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

CurrentRouter

IPAddress

ClientAddress

RangeStart

First Client IP Address

255.255.255.0

192.168.10.1

100

192.168.10.100

255.255.255.0

192.168.2.1

50

192.168.2.50

 

 

 

 

100

MaximumClients

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.

50

AddressLeaseTime

IP address lease time in minutes

1440

LocalDomainName

Local Domain Name for the LAN

 

 


 

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.

dhcp-reserv

 

DHCP Reservation Parameter Guide:

Parameter

Description

Default Setting

(Reservation) 1 – 20

 

 

Enable

Enable this reservation

No

ClientName

An optional name for easy identification of the client

 

ClientMACAddress

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)

 

ReservedIPAddress

The IP address to reserve for this client

 

 


 

Firewall and DMZ

Firewall and DMZ apply only when the OBi is set to work in the router mode. The firewall filters incoming packets from the WAN side only. It provides protection against some threats from the WAN side. There is a global firewall enable option which, when disabled, disables all the firewall components. In addition, the three firewall related features, NATRedirection, DRDOSAttackProtection, and VPNPassThrough, will take effect only If firewall is enabled. Below is a screen shot of the Firewall and DMZ device web page.

 

fw_dmz

 

Firewall and DMZ Parameter Guide:

Parameter

Description

Default Setting

Firewall Settings

 

 

Enable

Enable the firewall

No

NATRedirection

Support NATRedirection (a.k.a. NAT Loopback or Hairpin). This setting takes effect only if firewall is enabled; otherwise this feature is disabled

No

DRDOSAttackProtection

Enable the protection against Distributed Reflection Denial of Service. This setting takes effect only if firewall is enabled; otherwise this feature is disabled

No

VPNPassThrough

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

Yes

DMZ Settings

 

 

Enable

Enable DMZ Service

No

HostIPAddress

The IP address of the DMZ server

 

 

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.

port_fwd

 

Port Forwarding Parameter Guide:

Parameter

Description

Default Setting

 

 

 

Enable

Enable this port forwarding rule

No

RuleDescription

The description of this rule

 

Protocol

The transport protocol for the specified port range in this rule. It can take one of the following values:

TCP – TCP only

UDP – UDP only

Both – TCP and UDP

TCP

StartingPort

Starting port number of the forwarded port range

 

EndingPort

Ending port number of the forwarded port range. If it is the same as StartingPort, only the one port equal to the StartingPort will be forwarded

 

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               = (UpstreamBandwidth – RestrictedBandwidth) * Whigh / (Whigh + Wmedium + Wlow)               (Kbps)

   BWmedium        = (UpstreamBandwidth – RestrictedBandwidth) * Wmedium / (Whigh + Wmedium + Wlow)           (Kbps)

  BWlow              = (UpstreamBandwidth – RestrictedBandwidth) * Wlow / (Whigh + Wmedium + Wlow)               (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.

qos2

 


QoS Parameter Guide:

Parameter

Description

Default Setting

QoS General Setting

 

 

Enable

Enable QoS Service (take effect in router mode only)

No

UpStreamBandwidth

The total upstream bandwidth in Kbps

2048

RestrictedBandwidth

The guaranteed bandwidth for Restricted class traffic in Kbps

512

 

 

 

Priority Class Bandwidth Allocation

 

 

High

The guaranteed uplink bandwidth allocation weight for High Priority class traffic. It must be a value between 1 and 10

5

Medium

The guaranteed uplink bandwidth allocation weight for Medium Priority class traffic. It must be a value between 1 and 10

3

Low

The guaranteed uplink bandwidth allocation weight for Low Priority class traffic. It must be a value between 1 and 10

2

DSCP to Priority Class Mapping

 

 

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

 

Note: Restricted class has the highest priority

For N = 8, 10, 12, or 14, the default is Low.

For N = 48 or 56, the default is High.

For all other DSCP codes, the default is Medium

 

 

 

OBiWiFi Wireless USB Adapter

Note: OBiWiFi is available on the OBi2 Series and OBi3 Series models only.

OBiWiFi supports the 8021.11 b/g/n wireless standards so that an OBiWiFi Wireless Adapter may be used with the USB 2.0 port of the OBi2 Series and OBi3 Series devices. From an IP routing point of view, OBiWiFi is an additional WAN interface. If both WAN interfaces are connected (Ethernet port and OBiWiFi), the traffic destined to the WAN side will route through the Ethernet interface only, unless a) the WAN (Ethernet) interface and OBiWiFi are on different subnet and b) the destination address is on the same subnet as OBiWiFi.

If the OBi is set to function as a LAN switch rather than a router, OBiWiFi is disabled internally.


 

WiFi Settings

A screenshot of the WiFi Settings device page is shown below.

 

 


 

WiFi Settings Parameter Guide:

Parameter

Description

Default Setting

Basic Settings

 

 

Enable

Enable OBiWiFi feature. You must have an OBiWiFi dongle attached to the OBi to use the feature

Yes

PreferredAccessPoint

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

None

ShowAccessPointPassword

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

No

Internet Settings

 

 

AddressingType

The method to assign an IP address to this interface. Choose between DHCP or Static

DHCP

IPAddress

The IP address to use if AddressingType = Static

 

SubnetMask

The subnet mask to use if AddressingType = Static

 

DefaultGateway

The default gateway to use if AddressType = Static

 

DNSServer1

An additional DNS Server to use in addition to the ones received from DHCP

 

DNSServer2

An additional DNS Server to use in addition to the ones received from DHCP

 

Access Point N (N=1,2,…,20)

 

 

SSID

SSID of the access point

 

Password

Password or pass-phrase based on the authentication method used by the AP. For WPA, the pass-phrase should be no more than 64 characters. For WEP, the password should be in one of the four formats: 10 HEX digits, 26 HEX digits, 5 ASCII characters, or 13 ASCII characters. The HEX digits can be upper or lower case

 

SecurityEnabled

This is a read only parameter. It indicates if the AP has security enabled or not

 

 

 


 

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.

 


 

System Management Features of the OBi Device

Network Settings

This section applies to OBi100/OBi110 only. For OBi2 Series and OBi3 Series models, please refer to the section WAN Settings.

 

Network Settings Parameter Guide:

Parameter

Description

Default Setting

Internet Settings

 

 

AddressingType

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.

DHCP

IPAddress

The IP address to assign to the device when AddressingType is set to Static.

 

SubnetMask

The subnet mask to use when AddressingType is set to Static.

 

DefaultGateway

The default gateway IP address to assign to the device when AddressingType is set to Static.

 

DNSServer1

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 DNSServer2 will be tried first, whichever is specified, and then the ones obtained from the DHCP Server if available.

 

DNSServer2

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.

 

VLANID

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.

0

VLANPriority

Valid choices are 0 – 7. This setting applies to all packets sent by the device.

0

Local Time

 

 

CurrentLocalTime

Current local date and time of the device

 

Time Service Settings

 

 

NTPServer1

Hostname or IP address of the first NTP server

pool.ntp.org

NTPServer2

Hostname or IP address of the second NTP server

 

LocalTimeZone

Local time zone. Available choices are:

-          GMT-12:00(Int'l Dateline West)

-          GMT-11:00(Samoa)

-          GMT-10:00(Hawaii)

-          GMT-09:00(Alaska)

-          GMT-08:00(Pacific Time)

-          GMT-07:00(Mountain Time)

-          GMT-06:00(Central Time)

-          GMT-05:00(Eastern Time)

-          GMT-04:00(Atlantic Time)

-          GMT-03:30(Newfoundland)

-          GMT-03:00(Buenos Aires,Greenland)

-          GMT-02:00(Mid-Atlantic)

-          GMT-01:00

-          GMT+00:00(London,Lisbon)

-          GMT+01:00(Rome,Paris,Madrid)

-          GMT+02:00(Athens,Cairo)

-          GMT+03:00(Moscow,Baghdad)

-          GMT+04:00(Abu Dhabi)

-          GMT+04:30(Kabul)

-          GMT+05:00(Islamabad,Karachi)

-          GMT+05:30(New Delhi)

-          GMT+05:45(Kathmandu)

-          GMT+06:00

-          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)

GMT-08:00

DaylightSavingTimeEnable

Enable daylight saving time on the unit

Yes

DaylightSavingTimeStart

Daylight Saving Time Start Date. Format: month/day/weekday/hh:mm::ss, where month=1-12, day=±(1-31), weekday=0,1-7 (0=special, 1=Monday, 7=Sunday), hh=0-23,mm=0-59,ss=0-59.

If weekday=0, daylight saving starts on the given month/day; otherwise it starts on the weekday on or after the given month/day if day > 0, or on the weekday on or before the last-day-of-given-month+day+1 (note that day = -1 equivalent to last day of the month).

:ss may be omitted if the value is 0; :mm:ss may be omitted if mm and ss are both 0.

3/8/7/2

DaylightSavingTimeEnd

Daylight Saving Time End Date. Same format as Start Date

11/1/7/2

DaylightSavingTimeDiff

Amount of time to add to current time during Daylight Saving Time.

Format: [-]hh:mm:ss.

:ss may be omitted if it is 0; :mm:ss may be omitted if both are 0.

1

DNS Control

 

 

DNSQueryOrder

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

DNS Server1, DNS Server2, DHCP Offered DNS Servers

 

DNSQueryDelay

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)

2

Local DNS Records

 

 

N

 

where N = 1 – 32

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)

wt is optional; 1 is the default if not specified.

pri is optional only if wt is not specified; 1 is the default if not specified.

port is optional; the default to use will be based on the protocol (5060 for SIP, 80 for HTTP, etc.) .

The enclosing curly braces { } are also optional if there is only one R; or

if there is no comma used inside the R.

 

Examples:

_sip._udp+obihai.com=abc,xyz,pqr:5080,{mmm,2},{super.abc.com.}

 

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.

 

 

                     32 Local DNS Records (numbered 1 – 10 pictured here)

 


Automatic Firmware Update & Provisioning

Auto Provisioning Parameter Guide:

Parameter

Description

Default Setting

Auto Firmware Update

 

 

Method

Current operational method of auto firmware updating. Available choices are:

-          Disabled = Do not check for f/w upgrade from FirmwareURL

-          System Start = Check for f/w upgrade from FirmwareURL just once on system start

-          Periodically = Check for f/w upgrade from FirmwareURL on system start, and then periodically at the interval specified in the Interval paramter

 

Note: First f/w upgrade check on system start will be performed after a random delay of 0-30s

 

 

Disabled

Interval

When Method is set to Periodically, this is the number of seconds between each checking of f/w upgrade check  from FirmwareURL. If value is 0, device checks once only on system start (i.e., equivalent to setting Method to System Start)

0

FirmwareURL

URL of firmware package. URL must include scheme. Supported schemes are http:// and tftp://

 

DnsLookupType

Control what type of DNS record to lookup. Available choices are:

-          A Record Only

-          SRV Record Only

-          - Try Both

 

Note: Option not available on OBi100/OBi110

A Record Only

DnsSrvPrefix

Control whether to add a standard prefix to the domain name when looking up a SRV Record. For HTTP and HTTPS, the prefix to add is “_http._tcp.”. For TFTP, the prefix to add is “_tfto._udp.”

Available choices are:

-          No Prefix

-          With Prefix

-          Try Both

Note: Option not available on OBi100/OBi110

No Prefix

Username

Username for authentication, if needed, if scheme is http://

 

Password

Password for authentication, if needed, if scheme is http://

 

ITSP Provisioning

 

 

Method 

Current operational method of Provisioning. Available choices are:

-          Disabled = Do not download from ConfigURL

-          System Start = Download from ConfigURL just once on system start

-          Periodically = Download from ConfigURL on system start, and then periodically at the interval specified in the Interval paramter

 

Note: First download on system start will be performed after a random delay of 30 – 90s. If there is a firmware update scheduled at the beginning. Or a random delay of 10- 70s..

System Start

Interval 

When Method is set to Periodically, this is the number of seconds between download from ConfigURL. If value is 0, device downloads once only on system start (i.e., equivalent to setting Method to System Start)

0

ConfigURL

URL of config file

tftp://$DHCPOPT66/$MAC.xml

DnsLookupType

Control what type of DNS record to lookup. Available choices are:

-          A Record Only

-          SRV Record Only

-          - Try Both

 

Note: Option not available on OBi100/OBi110

A Record Only

DnsSrvPrefix

Control whether to add a standard prefix to the domain name when looking up a SRV Record. For HTTP and HTTPS, the prefix to add is “_http._tcp.”. For TFTP, the prefix to add is “_tfto._udp.”

Available choices are:

-          No Prefix

-          With Prefix

-          Try Both

Note: Option not available on OBi100/OBi110

No Prefix

GPRM0 to GPRM7

Non-volatile generic parameters which can be referenced in other parameters, such as ConfigURL

 

TPRM0 to TPRM3

Temporary variables used in scripts for ConfigURL. Please refer to device provisioning guide for examples on how to these variables.

 

OBiTALK Provisioning

 

 

Method 

Current operational method of Provisioning. Available choices are:

-          Disabled = Do not download from ConfigURL

-          System Start = Download from ConfigURL just once on system start

-          Periodically = Download from ConfigURL on system start, and then periodically at the interval specified in the Interval paramter

 

Note: First download on system start will be performed after a random delay of 30 – 90s. If there is a firmware update scheduled at the beginning. Or a random delay of 10- 70s..

System Start

Interval 

When Method is set to Periodically, this is the number of seconds between download from ConfigURL. If value is 0, device downloads once only on system start (i.e., equivalent to setting Method to System Start)

0

ConfigURL

URL of config file

tftp://$DHCPOPT66/$MAC.xml

DnsLookupType

Control what type of DNS record to lookup. Available choices are:

-          A Record Only

-          SRV Record Only

-          - Try Both

 

Note: Option not available on OBi100/OBi110

A Record Only

DnsSrvPrefix

Control whether to add a standard prefix to the domain name when looking up a SRV Record. For HTTP and HTTPS, the prefix to add is “_http._tcp.”. For TFTP, the prefix to add is “_tfto._udp.”

Available choices are:

-          No Prefix

-          With Prefix

-          Try Both

Note: Option not available on OBi100/OBi110

No Prefix

GPRM0 to GPRM7

Non-volatile generic parameters which can be referenced in other parameters, such as ConfigURL

 

TPRM0 to TPRM3

Temporary variables used in scripts for ConfigURL. Please refer to device provisioning guide for examples on how to these variables.

 

User Defined Macro 0–3

($UDM0 – $UDM3)

 

 

Value

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

This is a comma separated list of canonical parameter names, where the macro expansion can be used. Up to 3 parameter names may be specified. Specify ANY to allow the macro to expand in any parameter. Example:

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

This is read only status value regarding the syntax of the UDM. “Pass” means that this UDM is valid. Otherwise, it shows the syntax error detected by the device either in the Value or ExpandIn parameters of the UDM.

 

 

 

 

 

$MACRO Expansion Supported by the OBi Device

Macro Name

Description

Where It Can Be Used

MAC

Device MAC address, such as 9CADEF000000

ANY

MACC

Device MAC address with colon, such as 9C:AD:EF:00:00:00

ANY

mac

Device MAC address lower case, with colon, such as 9c:ad:ef:00:00:00

ANY

FWV

Firmware version, such as 1.0.3.1626

ANY

HWV

Hardware version, such as 2.8

ANY

IPA

Device current IP Address, such as 192.168.15.100

ANY

DM

Device Model Name, such as OBi110

ANY

DMN

Device Model Number, such as 110

ANY

OBN

Device OBi Number, such as 200123456

ANY

DSN

Device S/N, such as 88B01NA00000

ANY

GPRMn n=0–7

Value Auto Provisioning::GPRMn

Auto Provisioning::ConfigURL,

Auto Firmware Update::FirmwareURL

TPRMn n=0-3

Value Auto Provisioning::TPRMn

Auto Provisioning::ConfigURL,

Auto Firmware Update::FirmwareURL

UDMn, n=0-3

Value of  User Define Macro n::Value

The value of  User Define Macro n::ExpandIn

 

 

 

 

 

 

 

 

 

 

 

 

 

 


Device Administration

Device Administration Parameter Guide:

Parameter

Description

Default Setting

Web Server

 

 

Port

Web Server Port Number

80

AdminPassword

Administrator Password, case sensitive

admin

UserPassword

User Password, case sensitive

user

AccessFromWAN

Allow access the OBi device management web pages from the WAN side

 

Note: Option available on OBi202/OBi302 only

No

IVR

 

 

Enable

Enable IVR for local configuration

Yes

Password

IVR access password (must be all digits)

 

 

 

Syslog

 

 

Server

IP address of the Syslog Server where the device sends syslog debug messages to. If the value is blank, syslog is disabled

 

Port

Syslog Server Port Number

514

Level

Syslog Message Level

7

TAG

A string of text no longer than 32 characters to prepend every syslog message sent out by this unit.

Note: Option not available on OBi100/OBi110

 

 

 

 

 

HTTP Client

 

 

UserAgent

Value of the User-Agent header in all HTTP Requests which are used in firmware upgrade and auto provisioning.

$DM

TimeOut

A time limit specified in number of seconds such that any file download (firmware or configuration file) by the device via HTTP must be completed within this limit or the device will abort and conclude that the operation has failed for the reason of “taking too long to complete”

600

 

 


 

Device Update

See the section entitled, “Firmware: OBi Device Update and Management” for details on device firmware updates.

 

SIP Service Provider Features of the OBi Device

The following section describes the SIP Service Provider features of the OBi device.  Up to four SIP accounts (two only on OBi1 Series – OBi100 and OBi110), or SIP Trunks, can be configured on the OBi.  For the purposed of this document and elsewhere on OBi device web page, documentation and the OBiTALK portal, the term ITSP is used to describe the logical entity providing the SIP Trunk service to the OBi.  ITSP stands for Internet Telephony Service Provider.  Please note that when the OBi is used in conjunction with an IP PBX, the IP PBX would take the place of the ITSP if it is the entity providing the SIP Trunk account credential and connectivity to the OBi.

Each ITSP configuration is grouped together as an ITSP Profile. We refer to them as ITSP Profile A, B, C[2], and D2 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

 

where X = A or B, n = 1, 2, 3, or 4. Otherwise the service is considered disabled.

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 device’s 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 device’s 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 device’s contact address may be statically configured on the Registration Server.

 

SIP Outbound Proxy Server

An outbound proxy server can be configured on the device such that all outbound requests are sent via the outbound proxy server instead of directly to the SIP Proxy Server or Registration Server.

 

DNS Lookup of SIP Servers

When sending out SIP requests to the server, the device looks up the IP address of the server using standard DNS query if the server is specified as a domain name instead of an IP address. If Outbound Proxy Server is configured, it is used instead 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:

-          Try looking up the name as DNS A Record. If not found.

-          Try looking up the name as DNS SRV Record. If not found.

-          Try looking up the name as DNS SRV Record with “_sip._udp. “ prepended to the hostname. If not found, fail the request.

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.

 

NAT Traversal Considerations

If the device sits behind a NAT (typically the case), it can discover the mapped external address corresponding to its local SIP contact address as seen by the server in one of the following ways:

-          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.

SIP Proxy Server Redundancy and Dual REGISTRATION

Server Redundancy specifically refers to the OBi device’s capability to a) look for a working server to REGISTER with from among a list of candidates, and b) switch to another server once the server that it currently registers with becomes unresponsive. In other words, DEVICE REGISTRATION MUST BE ENABLED in order to use the server redundancy feature. Other SIP requests, such as INVITE or SUBSCRIBE, are sent to the same server that the device currently registers with.

If Outbound Proxy Server is provided, server redundancy is applied to the Outbound Proxy Server instead of the REGISTRATION server. Server redundancy behavior is enabled by enabling the parameter ITSP Profile X – SIP::X_ProxyServerRedundancy (which is disabled by default).

Another requirement for using the server redundancy feature is that the underlying server must be configured in the device as a domain name instead of an IP address. This allows the OBi to collect a list of candidate servers based on DNS query. The domain name may be looked up as DNS A record or DNS SRV record. For A records, all the IP addresses returned by the DNS server are considered to have the same priority. For SRV records, the hosts returned by the DNS server can be each assigned a different priority.

After a list of candidate servers are obtained, the OBi device will first look for a working server according to the stated priority. A working server means one that the device can successfully registers with. This is known as the Primary Server. Subsequently, the device maintains registration with the primary server the usual way. However, if no working server is found after traversing the entire list, device takes a short break and repeats the search in the same order.

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 entry’s 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 server’s 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 caller’s 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 caller’s 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, caller’s 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.

 

STUN and ICE

The OBi supports standard STUN based on RFC3489 and RFC5389 for passing inbound RTP packets to the device sitting behind NAT’s.  The parameters that control STUN feature can be found under the section ITSP Profile X – General::

-          STUNEnable – To Enable this feature (default is NO or FALSE).

-          STUNServer – The IP address or domain name of the external STUN server to use. STUN feature will be disabled if this value is blank, which is the default.

-          X_STUNServerPort – The STUN Server’s listening UDP port. Default value 3478 (standard STUN port).

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:

-          The local (host) address (highest priority)

-          The external (srflx or server reflexive) address

Otherwise only the local host candidate is shown in the device’s 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 peer’s 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 peer’s RTP address (i.e., send to the address where peer’s RTP packets are coming from).

 

ITSP Driven Distinctive Ringing

OBi device offers 10 ring and 10 call-waiting tone patterns in each ring profile. These patterns are numbered from 1 to 10. Each pattern also comes with a configurable name. A different default ring may be assigned to each trunk on the device.

 

An ITSP can tell OBi device which ring to use by name for a call routed to SP1/SP2 by inserting an Alert-Info header in the SIP INVITE sent to the device. The Alert-Info must include a URI. For example:

 

Alert-Info: http://www.xyz.com/some-folder/bellcore-dr4

 

When the device receives this, it will look for a ring tone name or call-waiting tone name in the ring profile that matches the Alert-Info URI. Ring tone names are compared case- insensitively. If a match is found, device plays the corresponding ring or call-waiting tone. Otherwise, device plays the default ring.

 

 

RTP Statistics – the X-RTP-Stat Header

When ending an established call, OBi device can include a summary of the RTP statistics collected during the call in the SIP BYE request or the 200 response to the SIP BYE request sent by the peer device. The summary is carried in an X-RTP-Stat header in the form of a comma separated list of fields. The reported fields are:

PS=[Number of Packets Sent]

PR=[Number of Packets Received]

OS=[Number of bytes sent]

OR=[Number of bytes received]

PL=[Number of packets lost]

JI=[Jitter in milliseconds]

LA=[Decode latency or jitter buffer size in milliseconds]

DU=[Call duration in seconds]

EN=[Last Encoder Used]

DE=[Last Decoder Used]

 

For example:

X-RTP-Stat:PS=1234,OS=34560,PR=1236,OR=24720,JI=1,DU=1230,PL=0,EN=G711U, DE=G711U

 

To enable the X-RTP-Stat feature, the parameter ITSP Profile X – SIP::X_InsertRTPStats must be set to YES (or TRUE).

 

 

Media Loopback Service

The OBi supports the media loopback draft as described in draft-mmusic-media-loopback-13.txt. The following media loopback features are supported by the OBi device:

-          Loopback modes: loopback-source and loopback-mirror

-          Loopback types: rtp-media-loopback and rtp-packet-loopback

-          Loopback packet formats:: encaprtp, loopbkprimer

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:

-          PHONE port is off hook.

-          PHONE port is ringing.

-          PHONE port is onhook with a call on hold.

Device will terminate an inbound media loopback call already in progress when:

-          PHONE port is off-hook.

-          PHONE port is ringing.

To make an outgoing loopback call, user can dial one of the following star codes before dialing the target number:

-          *03 – Make a Media Loopback Call.

-          *04 – Make a RTP Packet Loopback Call.

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.

ITSP Profile A & B (General & SP Info Settings) Parameter Guide:

Parameter