Obihai Technology OBi1032, OBi1062, OBi2062, OBi1022, OBi2162 Administration Manual

...

Obihai Technology, Inc.

Obihai IP Phone Administration Guide

Models:

OBi1062

OBi1032

OBi1022

OBi2062

OBi2162

OBi2182

October 2017

All contents subject to change without notification.

AUDIENCE .......................................................................................................................................................................... 12

WHERE TO GO FOR HELP ...................................................................................................................................................... 12

NOTATIONAL CONVENTIONS .................................................................................................................................................. 13

Boolean Values ....................................................................................................................................................................................................... 13

Multiple Choice Values ........................................................................................................................................................................................... 13

Parameter Values ................................................................................................................................................................................................... 13

INTRODUCTION ..................................................................................................................................... 14

OBI IP PHONE HARDWARE .................................................................................................................................................... 14

Accessories Available Separately from Obihai ........................................................................................................................................................ 19

Other Accessories ................................................................................................................................................................................................... 19

CONNECTING THE OBI IP PHONE ............................................................................................................................................ 20

Connecting the Phone to the Network ................................................................................................................................................................... 20

Connecting to the LAN Over Wired Ethernet ......................................................................................................................................................... 20

Connecting to the WLAN Over WiFi ....................................................................................................................................................................... 20

OVERVIEW OF PHONE FEATURES ............................................................................................................................................ 20

Administrative Features ......................................................................................................................................................................................... 20

Voice Features ........................................................................................................................................................................................................ 20

Call Features ........................................................................................................................................................................................................... 21

Soft Switch Support ................................................................................................................................................................................................ 21

Integrated GUI Applications ................................................................................................................................................................................... 21

COMPLEMENTARY OBIHAI PRODUCTS AND SERVICES .................................................................................................................. 22

CONFIGURATION AND MANAGEMENT INTERFACES ................................................................................ 23

DEVICE LOCAL CONFIGURATION .............................................................................................................................................. 23

To access the OBi IP Phone Device Management Web Page: ................................................................................................................................. 23

Web Page Conventions and Icons & Buttons: ........................................................................................................................................................ 24

Local Configuration Web Page Layout .................................................................................................................................................................... 25

Phone Screen Capture ............................................................................................................................................................................................ 27

REMOTE PROVISIONING ........................................................................................................................................................ 27

About ZT (Zero Touch): Device Customization at Obihai’s Factory ......................................................................................................................... 28

OBITALK PORTALS .............................................................................................................................................................. 29

User Portal ............................................................................................................................................................................................................. 29

ITSP Portal ...................................................................................................................................................................Error! Bookmark not defined.

TELEPHONE-IVR-BASED LOCAL CONFIGURATION ....................................................................................................................... 29

Main Menu ............................................................................................................................................................................................................. 30

Additional Options (Menu 0) .................................................................................................................................................................................. 31

System Level Options ........................................................................................................................................................................................ 31

Network Related Configuration Options ........................................................................................................................................................... 31

SP1 Configuration Options ................................................................................................................................................................................ 32

SP2 Configuration Options ................................................................................................................................................................................ 33

OBiTALK Configuration Options ......................................................................................................................................................................... 34

Auto Attendant Configuration Options ............................................................................................................................................................. 35

Customized AA Prompt Recording Options ....................................................................................................................................................... 35

PHONE GUI ........................................................................................................................................................................ 36

Settings................................................................................................................................................................................................................... 36

Preferences ............................................................................................................................................................................................................ 39

Admin Password ..................................................................................................................................................................................................... 39

NETWORKING FEATURES ........................................................................................................................ 40

ETHERNET PORTS ................................................................................................................................................................. 40

WAN INTERFACE ................................................................................................................................................................. 40

VLAN ....................................................................................................................................................................................................................... 40

LLDP ....................................................................................................................................................................................................................... 40

IP Address Assignment ........................................................................................................................................................................................... 40

DNS Servers ............................................................................................................................................................................................................ 40

WIFI INTERFACE .................................................................................................................................................................. 41

DHCP OPTIONS .................................................................................................................................................................. 41

DNS LOOKUP ..................................................................................................................................................................... 41

Lookup Order ......................................................................................................................................................................................................... 41

Locally Configured DNS Lookup Table .................................................................................................................................................................... 42

NTP SERVERS AND LOCAL TIME .............................................................................................................................................. 42

802.1X AUTHENTICATION .................................................................................................................................................... 42

Certificates for 802.1X Authentication ................................................................................................................................................................... 43

FEATURE KEYS........................................................................................................................................ 44

Using Speed Dial to store a Feature Access Code prefix ......................................................................................................................................... 47

LINE KEYS AND VIRTUAL LINE KEYS .......................................................................................................................................... 50

LEFT LINE KEYS AND VIRTUAL LEFT LINE KEYS ............................................................................................................................ 51

PROGRAMMABLE KEYS ......................................................................................................................................................... 51

Programmable Hard Keys ....................................................................................................................................................................................... 51

SIDE CAR KEYS .................................................................................................................................................................... 53

FEATURE KEY CONFIGURATION PARAMETERS ............................................................................................................................ 53

HIGHLIGHTS OF FEATURE KEY FUNCTIONS ................................................................................................................................. 53

Call Keys ................................................................................................................................................................................................................. 53

Line Monitor Keys .................................................................................................................................................................................................. 54

Speed Dial Keys ...................................................................................................................................................................................................... 54

BLF Keys ................................................................................................................................................................................................................. 54

Call Park Monitor Keys ........................................................................................................................................................................................... 54

Presence Monitor ................................................................................................................................................................................................... 55

Group Page Keys .................................................................................................................................................................................................... 55

INPUT METHODS ................................................................................................................................... 56

PHONE KEYPAD ................................................................................................................................................................... 56

USB KEYBOARD .................................................................................................................................................................. 56

VOICE SERVICES ..................................................................................................................................... 57

ITSP PROFILES .................................................................................................................................................................... 57

OVERVIEW OF COMMON TRUNK CONFIGURATION ..................................................................................................................... 57

Service Enable ........................................................................................................................................................................................................ 57

Service Account Credentials ................................................................................................................................................................................... 58

Servers ................................................................................................................................................................................................................... 58

Trunk Capacity ........................................................................................................................................................................................................ 58

Basic Incoming Call Handling .................................................................................................................................................................................. 58

Basic Outgoing Call Handling .................................................................................................................................................................................. 59

SPECIFICATION OF TARGET PHONE NUMBERS ............................................................................................................................ 59

SIP/SP SERVICE ...................................................................................................................................... 60

SIP Registration ...................................................................................................................................................................................................... 60

Third Party Registration ..................................................................................................................................................................................... 61

Registration Period ............................................................................................................................................................................................ 61

REGISTER Final Non-2xx Response Handling ..................................................................................................................................................... 62

SIP Outbound Proxy Server .................................................................................................................................................................................... 62

DNS Lookup of SIP Servers ..................................................................................................................................................................................... 63

NAT Traversal Considerations ................................................................................................................................................................................ 63

Keep Alive Messages ......................................................................................................................................................................................... 64

SIP Proxy Server Redundancy and Dual REGISTRATION ......................................................................................................................................... 64

SIP Privacy .............................................................................................................................................................................................................. 65

STUN and ICE .......................................................................................................................................................................................................... 66

ITSP Driven Distinctive Ringing ............................................................................................................................................................................... 67

RTP Statistics – the X-RTP-Stat Header ................................................................................................................................................................... 67

RTCP ....................................................................................................................................................................................................................... 67

Media Loopback Service ......................................................................................................................................................................................... 67

A SIP/SP Configuration Example ............................................................................................................................................................................. 68

GOOGLE VOICE™ SERVICE ...................................................................................................................... 69

OBITALK SERVICE ................................................................................................................................... 70

OBIBLUETOOTH SERVICE ........................................................................................................................ 71

CALL FEATURES ...................................................................................................................................... 72

PHONE LEVEL AND LINE LEVEL FEATURE ................................................................................................................................... 72

CALL STATES ....................................................................................................................................................................... 72

CORE CALL FEATURES ........................................................................................................................................................... 73

Line Capacity .......................................................................................................................................................................................................... 73

Complex Operations Between Multiple, Diverse Voice Services ............................................................................................................................ 73

Making Outgoing Calls ............................................................................................................................................................................................ 73

Digit Map ........................................................................................................................................................................................................... 73

Audio Path and On/Off-Hook States .................................................................................................................................................................. 73

Off-Hook Dialing ................................................................................................................................................................................................ 74

On-Hook Dialing ................................................................................................................................................................................................ 74

Outbound Call Routes ....................................................................................................................................................................................... 74

Primary Line ...................................................................................................................................................................................................... 74

Explicitly Selecting a Line to make call ............................................................................................................................................................... 75

Dialing “Speed Dials 99” Numbers ..................................................................................................................................................................... 75

Dialing Star Codes .............................................................................................................................................................................................. 75

Called Party Caller ID Display ............................................................................................................................................................................. 75

Handling Incoming Calls ......................................................................................................................................................................................... 76

Inbound Call Routes .......................................................................................................................................................................................... 76

Rejecting Incoming Calls .................................................................................................................................................................................... 76

Caller ID Display ................................................................................................................................................................................................. 76

Ending Calls ............................................................................................................................................................................................................ 76

Holding Calls ........................................................................................................................................................................................................... 76

Resuming Calls ....................................................................................................................................................................................................... 76

“Foregrounding” a Call ........................................................................................................................................................................................... 76

Call Waiting ............................................................................................................................................................................................................ 77

Call Transfer ........................................................................................................................................................................................................... 77

Transfer Signaling .............................................................................................................................................................................................. 78

Limitations of Transfer by Internal Bridging ...................................................................................................................................................... 79

Conference Calls ..................................................................................................................................................................................................... 79

Local Mixing/Bridging ........................................................................................................................................................................................ 79

Call Selective Mute ............................................................................................................................................................................................ 79

Coachee Mode .................................................................................................................................................................................................. 80

External Conference Bridge ............................................................................................................................................................................... 80

No Hold Call (NOHC) ............................................................................................................................................................................................... 80

EXPANDED CALL FEATURES .................................................................................................................................................... 80

Auto Answer and Intercom .................................................................................................................................................................................... 81

Auto-Answer Incoming Call Based on Inbound Call Routing Rules ......................................................................................................................... 81

Auto-Answer when Caller Requests to Barge-In (with OBiTALK Service) ................................................................................................................ 82

Barge-In as a Coach ........................................................................................................................................................................................... 82

Push To Talk ........................................................................................................................................................................................................... 82

Speed Dial Feature Key ........................................................................................................................................................................................... 82

Block Caller ID* ...................................................................................................................................................................................................... 83

Block Anonymous Call ............................................................................................................................................................................................ 84

Calling Line ID Display ............................................................................................................................................................................................. 84

Call Forwarding ...................................................................................................................................................................................................... 84

Call Forward Numbers ....................................................................................................................................................................................... 84

Call Forward ALL ................................................................................................................................................................................................ 85

Call Forward on Busy ......................................................................................................................................................................................... 85

Call forward on No Answer:............................................................................................................................................................................... 85

Call Forward Signaling ....................................................................................................................................................................................... 85

Limitations of Call Froward by Internal Bridging................................................................................................................................................ 86

Do Not Disturb ....................................................................................................................................................................................................... 86

Do Not Ring ............................................................................................................................................................................................................ 86

Message Waiting Indication – Visual and Tone Based ............................................................................................................................................ 86

Multicast Page Groups ........................................................................................................................................................................................... 87

Music On Hold (MOH) ............................................................................................................................................................................................ 88

PREMIUM CALL FEATURES ..................................................................................................................................................... 89

Busy Lamp Field (BLF) ............................................................................................................................................................................................. 89

Single Versus Multiple BLF Event Notification ................................................................................................................................................... 89

BLF with Call Park Status ................................................................................................................................................................................... 90

What Happens When BLF Key is Pressed........................................................................................................................................................... 90

BLF Operation: Speed Dial ................................................................................................................................................................................. 90

BLF Operation: Directed Call Pickup .................................................................................................................................................................. 90

BLF Operation: Barge In ..................................................................................................................................................................................... 91

BLF Operation: Call Pickup ................................................................................................................................................................................. 91

BLF Operation: Resume ..................................................................................................................................................................................... 91

BLF Configuration .............................................................................................................................................................................................. 91

Floating BLF Key Assignment ............................................................................................................................................................................. 92

SIP for BLF.......................................................................................................................................................................................................... 93

BLF With OBiTALK Service ................................................................................................................................................................................. 94

Call Park and Call Pickup ......................................................................................................................................................................................... 94

Call Park Methods ............................................................................................................................................................................................. 95

Call Park Monitor and Call Pickup Methods ...................................................................................................................................................... 95

Call Park Ring ..................................................................................................................................................................................................... 96

Shared Line and Shared Call Appearances (SCA) .................................................................................................................................................... 97

Line Seize ........................................................................................................................................................................................................... 98

What Happens When a Call Appearance Key is Pressed .................................................................................................................................... 98

Buddy List ............................................................................................................................................................................................................... 99

Expanded Buddy List and Groups .....................................................................................................................................................................101

Buddy List Management ...................................................................................................................................................................................101

Call Recording Controls .........................................................................................................................................................................................102

Hold and Talk Event Package .................................................................................................................................................................................102

Advice of Charges (AOC) ........................................................................................................................................................................................102

BroadSoft Call Center Features .............................................................................................................................................................................102

Disposition Code...............................................................................................................................................................................................102

Customer Originated Call Trace ........................................................................................................................................................................103

Escalation .........................................................................................................................................................................................................103

Call Center Information ....................................................................................................................................................................................103

BroadSoft Guest Login/Logout (Hoteling) .............................................................................................................................................................103

Emergency Calls ....................................................................................................................................................................................................104

Call Diversion History ............................................................................................................................................................................................104

BROADSOFT AS-FEATURE-EVENT FEATURES ........................................................................................................................... 104

Call Forward All .....................................................................................................................................................................................................105

Call Forward Busy ..................................................................................................................................................................................................105

Call Forward No Answer ........................................................................................................................................................................................105

ACD Agent State ....................................................................................................................................................................................................106

Security Classification ............................................................................................................................................................................................107

Executive Call Filter ...............................................................................................................................................................................................107

Executive Assistant ................................................................................................................................................................................................107

Call Recording Settings ..........................................................................................................................................................................................107

BROADSOFT XSI FEATURES .................................................................................................................................................. 107

Network Directories ..............................................................................................................................................................................................108

BroadSoft Hosted PBX Platform .......................................................................................................................................................................108

Netwrok Directory Soft Key Options ................................................................................................................................................................108

Other PBX Platforms .........................................................................................................................................................................................109

Replace the Built-In Phone Book with a Network Directory .............................................................................................................................110

Network Call Logs ..................................................................................................................................................................................................110

BroadWorks Anywhere .........................................................................................................................................................................................110

Remote Office .......................................................................................................................................................................................................110

Simultaneous Ring .................................................................................................................................................................................................111

Call Forward Always ..............................................................................................................................................................................................111

Anonymous Call.....................................................................................................................................................................................................112

BUILT-IN PHONE APPS .......................................................................................................................... 113

NET SERVICES APP ............................................................................................................................................................. 113

NET DIR APP..................................................................................................................................................................... 113

PHONE GUI CUSTOMIZATION ............................................................................................................... 115

MAIN MENU .................................................................................................................................................................... 115

LINE KEY TABS................................................................................................................................................................... 115

CONTROLLING MULTIPLE CALLS PER CALL KEY......................................................................................................................... 115

Calls App Behavior .................................................................................................................................................................................................115

SOFT KEY SET CUSTOMIZATION ............................................................................................................................................ 116

Soft Key Set Parameter Syntax ..............................................................................................................................................................................116

Soft Key Specification .......................................................................................................................................................................................116

Assignable Soft Keys ..............................................................................................................................................................................................117

Soft Key Set Parameters: .......................................................................................................................................................................................123

LINE KEY WINDOW CUSTOMIZATION ..................................................................................................................................... 124

EXAMPLE: ........................................................................................................................................................................ 127

CUSTOMIZABLE SCREEN ELEMENTS ....................................................................................................................................... 128

Using $Macros and @Macros inside XML .............................................................................................................................................................129

$eval(expression) ..............................................................................................................................................................................................129

Color and Color Pattern .........................................................................................................................................................................................132

<ScreenItem> XML ................................................................................................................................................................................................132

Elements in a <ScreenItem> XML .....................................................................................................................................................................133

Attributes in a <ScreenItem> XML ....................................................................................................................................................................134

Macors that can be used inside a <ScreenItem> ..............................................................................................................................................136

<LineKeyStyles> XML .............................................................................................................................................................................................138

Elements in a <LineKeyStyles> XML ..................................................................................................................................................................138

Attributes in a <LineKeyStyles> XML ................................................................................................................................................................139

Macors that can be used in a <LineKeyStyles> XML .........................................................................................................................................140

Example 1: Double Size Line Key Screen Tiles ...................................................................................................................................................140

<SoftKeyStyles> XML .............................................................................................................................................................................................141

Elements in a <SoftKeyStyles> XML ..................................................................................................................................................................141

Attributes in a <SoftKeyStyles> XML.................................................................................................................................................................142

Macors that can be used in a <SoftKeyStyles> XML .........................................................................................................................................143

Example 1: Use Icons Only for Home Screen Soft Keys ....................................................................................................................................143

MAIN MENU CUSTOMIZATION ............................................................................................................................................. 144

<MainMenu> XML .................................................................................................................................................................................................145

General Structure .............................................................................................................................................................................................145

Elements in <MainMenu> ................................................................................................................................................................................146

Attributes in <MainMenu> ...............................................................................................................................................................................146

Attributes in <MainMenu> <item> Element .....................................................................................................................................................147

Macros available in <MainMenu> ....................................................................................................................................................................151

Example ............................................................................................................................................................................................................151

<MainMenuItemStyles> XML ................................................................................................................................................................................152

General structure: ............................................................................................................................................................................................152

Elements in <MainMenuItemStyles> ................................................................................................................................................................152

Attributes in <MainMenuItemStyles> ..............................................................................................................................................................153

Macros available in <MainMenuItemStyles> ....................................................................................................................................................154

TITLE BAR CUSTOMIZATION ................................................................................................................................................. 155

<TitleBarStyle> Attributes .....................................................................................................................................................................................157

The <Notifications> Element .................................................................................................................................................................................158

The <LineKeyTabs> Element ..................................................................................................................................................................................160

Trigger update of a notification icon with an ObihaiIPPhoneExecute XML ...........................................................................................................161

LED PATTERN CUSTOMIZATION ............................................................................................................................................ 162

LED Settings Parameters .......................................................................................................................................................................................162

Call State ...............................................................................................................................................................................................................162

SCA State ...............................................................................................................................................................................................................162

BLF State................................................................................................................................................................................................................163

Service State ..........................................................................................................................................................................................................163

Presence State .......................................................................................................................................................................................................163

Feature Key State ..................................................................................................................................................................................................164

VMWI Lamp ...........................................................................................................................................................................................................165

GUI MENU CUSTOMIZATION ............................................................................................................................................... 165

Preferences Menu .................................................................................................................................................................................................166

Settings Menu .......................................................................................................................................................................................................166

Product Information Menu ...................................................................................................................................................................................166

Net Services Menu ................................................................................................................................................................................................166

Main Menu Item IDs ..............................................................................................................................................................................................167

Net Services Menu Item IDs ..................................................................................................................................................................................167

Preferences Menu Item IDs ...................................................................................................................................................................................167

Settings Menu Item IDs .........................................................................................................................................................................................169

Product Info Menu Item IDs ..................................................................................................................................................................................169

CACHE CONTROL OF DOWNLOADED (TEMPORARY) DATA .......................................................................................................... 169

PHONE CUSTOMIZATION DATA ............................................................................................................................................. 170

Startup Splash Screen ............................................................................................................................................................................................170

Background Pictures ..............................................................................................................................................................................................170

Text Fonts Customization ......................................................................................................................................................................................171

Language Customization with Dictionary Files ......................................................................................................................................................173

Phone Book Pictures .............................................................................................................................................................................................181

Ring Tones .............................................................................................................................................................................................................181

Phone Customization Data Package ......................................................................................................................................................................181

Uploading Customization Data Package to the Phone ..........................................................................................................................................181

INTERNAL DATA STORAGE PATHS FOR USER PREFERENCES SETTINGS ........................................................................................... 182

OBIPHONE XML APPLICATIONS ............................................................................................................ 185

ACTION URLS – PULL MODEL .............................................................................................................................................. 185

Action URL Feature Key .........................................................................................................................................................................................185

Action URL Soft Key ...............................................................................................................................................................................................185

SIP NOTIFY – PUSH MODEL ................................................................................................................................................. 185

XML APP DEVELOPMENT .................................................................................................................................................... 186

AUTO ATTENDANT ............................................................................................................................... 187

AA CALLBACK SERVICE ........................................................................................................................................................ 187

USER RECORDED PROMPTS.................................................................................................................................................. 188

CUSTOMIZING AA PROMPT LISTS .......................................................................................................................................... 188

VOICE GATEWAYS AND TRUNK GROUPS ............................................................................................... 190

VOICE GATEWAY ............................................................................................................................................................... 190

TRUNK GROUPS ................................................................................................................................................................. 190

LDAP ................................................................................................................................................... 191

LDAP SERVICE SETUP ......................................................................................................................................................... 191

Client Authentication ............................................................................................................................................................................................193

LDAP DIRECTORY SEARCH APPLICATION ................................................................................................................................ 193

Invoke LDAP by Main Menu – Directories Option .................................................................................................................................................193

Invoke LDAP by Main Menu – Network Directory Option .....................................................................................................................................193

Invoke LDP by Soft Key - LDAP ...............................................................................................................................................................................193

Search Fields .........................................................................................................................................................................................................193

Result Fields ..........................................................................................................................................................................................................194

Sorting of Results ..................................................................................................................................................................................................195

REPLACE THE BUILT-IN PHONE BOOK WITH LDAP ................................................................................................................... 195

IP PHONE SETTINGS ............................................................................................................................. 196

PHONE SETTINGS ............................................................................................................................................................... 196

DigitMap and OutboundCallRoute ........................................................................................................................................................................196

Network Directory .................................................................................................................................................................................................197

User Preferences Settings .....................................................................................................................................................................................197

Page Groups 1 and 2 .............................................................................................................................................................................................197

LINE KEYS ......................................................................................................................................................................... 197

PROGRAMMABLE KEYS ....................................................................................................................................................... 197

SIDE CAR 1 AND SIDE CAR 2 ................................................................................................................................................ 198

AUDIO CODEC PROFILES ....................................................................................................................... 199

TONE PATTERNS .................................................................................................................................. 200

TONE PROFILE FEATURES OF THE OBI DEVICE .......................................................................................................................... 200

TONE EXAMPLES: ............................................................................................................................................................... 201

RINGTONES AND RING PATTERNS ........................................................................................................ 204

STAR CODE PROFILES ........................................................................................................................... 206

STAR CODE SCRIPT VARIABLES (VAR) .................................................................................................................................... 206

STAR CODE SCRIPT ACTIONS (ACT) ....................................................................................................................................... 207

STAR CODE SCRIPT FORMAT ................................................................................................................................................ 207

STAR CODE SCRIPT EXAMPLES .............................................................................................................................................. 208

Default Star Codes .................................................................................................................................................................................................208

USER SETTINGS .................................................................................................................................... 210

SPEED DIAL NUMBERS ........................................................................................................................................................ 210

USING SPEED DIAL NUMBER AS AD HOC GATEWAY .................................................................................................................. 210

CALL ROUTING ..................................................................................................................................... 211

TRUNKS, ENDPOINTS, AND TERMINALS .................................................................................................................................. 211

SUPPORTED 2-WAY CALL BRIDGES ON THE OBI1000 ................................................................................................................ 211

CALL ROUTING – THE OBI WAY ........................................................................................................................................... 212

INBOUND CALL ROUTE CONFIGURATION ................................................................................................................................ 212

OUTBOUND CALL ROUTE CONFIGURATION ............................................................................................................................. 214

DIGIT MAP CONFIGURATION ................................................................................................................ 217

MATCHING AGAINST MULTIPLE RULES IN DIGIT MAP ............................................................................................................... 223

Forcing Interdigit Timeout With The Hash/Pound (#) Key .....................................................................................................................................224

INVOKE SECOND DIAL TONE IN DIGIT MAP ............................................................................................................................. 224

CHANGE INTERDIGIT LONG TIMER DYNAMICALLY AFTER PARTIAL MATCH ..................................................................................... 225

USER DEFINED DIGIT MAPS ................................................................................................................................................. 225

A USER DEFINED DIGIT MAP FOR IPV4 DIALING ..................................................................................................................... 225

ADMINISTRATIVE FEATURES................................................................................................................. 226

NATIVE WEB SERVER .......................................................................................................................................................... 226

SYSLOG ............................................................................................................................................................................ 226

FACTORY RESET ................................................................................................................................................................. 226

FIRMWARE UPDATE ........................................................................................................................................................... 226

Automated Firmware Update ...............................................................................................................................................................................226

CONFIGURATION BACKUP AND RESTORE ................................................................................................................................ 226

AUTO PROVISIONING .......................................................................................................................................................... 226

OBiTALK Provisioning ............................................................................................................................................................................................226

ITSP Provisioning ...................................................................................................................................................................................................226

CUSTOMIZATION DATA AUTO UPDATE ................................................................................................................................... 226

Customization Data Package .................................................................................................................................................................................227

Auto Update Operation .........................................................................................................................................................................................227

Auto Update Configuration Parameters ................................................................................................................................................................227

DEVICE WEB PAGE AND CONFIGURATION PARAMETER REFERENCE....................................................... 229

STATUS ............................................................................................................................................................................ 229

System Status ........................................................................................................................................................................................................229

Reboot Reason Codes............................................................................................................................................................................................230

Call Status Web Page .............................................................................................................................................................................................230

SP Services Statistics..............................................................................................................................................................................................231

OBIWIFI CONFIGURATION WEB PAGE AND PARAMETER REFERENCE ........................................................................................... 232

WiFi Settings Web Page .........................................................................................................................................................................................232

WiFi Scan Web Page ..............................................................................................................................................................................................232

SYSTEM MANAGEMENT PARAMETERS.................................................................................................................................... 233

WAN Parameters ...................................................................................................................................................................................................233

Auto Provisioning Parameters ...............................................................................................................................................................................236

Zero-Touch, Massive Scale Remote Provisioning: .................................................................................................................................................239

Device Admin Parameters .....................................................................................................................................................................................239

DEVICE UPDATE WEB PAGE ................................................................................................................................................. 240

Firmware Update ..................................................................................................................................................................................................240

Possible Error Messages on Firmware Update Failure: ....................................................................................................................................240

Backup (Customized) AA User Prompts .................................................................................................................................................................240

Backup Configuration ............................................................................................................................................................................................241

Restore Configuration ...........................................................................................................................................................................................241

Reset Configuration (to Factory Default) ...............................................................................................................................................................241

SERVICE PROVIDER CONFIGURATION PARAMETERS ................................................................................................................... 241

ITSP Profile X – General Web Page (X = A, B, C, D, E, F) .........................................................................................................................................241

ITSP Profile X – SIP Web Page (X = A, B, C, D, E, F) ...............................................................................................................................................242

ITSP Profile X – RTP Web Page (X = A, B, C, D, E, F) ..............................................................................................................................................248

VOICE SERVICES ................................................................................................................................................................. 248

SPn Service Web Page (n = 1, 2, 3, 4, 5, 6) .............................................................................................................................................................248

OBiTALK Service Configuration ..............................................................................................................................................................................256

Auto Attendant Web Page ....................................................................................................................................................................................259

Gateways and Trunk Groups Web Page ................................................................................................................................................................261

OBiBluetooth Web Page ........................................................................................................................................................................................262

IP PHONE SETTINGS ........................................................................................................................................................... 263

Phone Settings Web Page .....................................................................................................................................................................................263

Line Keys ...............................................................................................................................................................................................................269

Left Line Keys (OBi2000 series ony) .......................................................................................................................................................................270

Programmable Keys ..............................................................................................................................................................................................270

Side Car m, m = 1, 2 ...............................................................................................................................................................................................270

LED Settings ...........................................................................................................................................................................................................271

Soft Key Sets ..........................................................................................................................................................................................................273

Feature Key Customization....................................................................................................................................................................................273

Screen Item Customization ...................................................................................................................................................................................274

CODEC PROFILES................................................................................................................................................................ 275

Codec Profile X Web Page (X = A, B) .....................................................................................................................................................................275

TONE PROFILES ................................................................................................................................................................. 278

Tone Profile X Web Page (X = A, B) ......................................................................................................................................................................278

RING PROFILES .................................................................................................................................................................. 280

Ring Profile X Web Page (X = A, B) .......................................................................................................................................................................280

STAR CODE PROFILES .......................................................................................................................................................... 281

Star Code Profile X Web Page (X = A, B) ................................................................................................................................................................281

USER SETTINGS ................................................................................................................................................................. 282

User Preferences Web Page ..................................................................................................................................................................................282

Speed Dials Web Page ...........................................................................................................................................................................................286

User Defined Digit Maps Web Page ......................................................................................................................................................................287

Audience

Internet Telephony Service Providers (ITSP), Managed Service Value Added Resellers (VAR), Internet Telephony Professionals, and Technology Hobbyists.

Note for Australian readers: Throughout this document we refer to ITSP – treat this term the same as you would for VSP (Voice Service Provider).

Note to End Users

End users are highly encouraged to use the OBiTALK web portal to configure and manage their OBi devices.

Visit www.obitalk.com to create an OBiTALK account and within the portal. Once logged in, click “Add Device” to add your OBi Phone to the portal. You can change all the advanced settings within this guide via the portal by using “OBi Expert” mode. To enter OBi Expert, click on your device and at the next page you’ll see a link to enter the OBi Expert Configuration page. Within this page you can then click another link to bring up the device’s complete set of configuration parameters.

You can enable 1-click expert access from the OBi Dashboard by enabling this option under your user settings within the portal (This option is off by default).

Where to Go for Help

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

• Visit the OBiTALK Documents and Guides found at www.obihai.com/docs-downloads

o OBi Phone Administration Guide o OBi Device Provisioning Guide o OBiTALK Device Management Platform: Frequently Asked Questions

• E-mail the Obihai Service Provider Support Team at: spsupport@obihai.com

• Call us at the Obihai Service Provider Support line: +1 (408) 890-6000

Notational Conventions

A device configuration parameter and its value is represented in the format:

Parameter Group Name::ParameterName = Parameter Value

Parameter Group Name::ParameterName = {replace-this-with-actual-value}

Parameter Group Name is the heading of the parameter group on the left side panel of the device local configuration

or “OBiTALK 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. For example:

SP1 Service::AuthUserName = 4082224312

ITSP Profile A - SIP::ProxyServer = sip.myserviceprovider.com

ProxyServerPort = 5082

[optional values]

Boolean Values

Parameters that take a Boolean (true or false) value can be identified on the phone native configuration web pages (or OBi Expert) by a check box / tick box (instead of an input-box or drop-down list) next to the parameter name. Throughout the document we may loosely refer to a Boolean value as enable/disable or yes/no, but the only valid Boolean parameter values to use in a phone configuration file that is recognized by the phone is either true/false or True/False (case-sensitive). This is equivalent to checked/unchecked on the configuration web pages.

Multiple Choice Values

Parameters that take one of several valid options from a drop-down list on the device message must be provisioned with string values that match exactly one of those choices. Otherwise the device will use the default choice. The matching of provisioned value against valid strings is case-sensitive and does not allow extra spaces.

Parameter Values

When entering a parameter value from the web page or via provisioning, you should avoid adding extra white spaces before or after the parameter value. If the value is a comma separated list of strings, or may contain attributes after a comma or semi-colon, etc, you should also avoid adding extra white space before and after the delimiter. For example:

CertainParameter = 1,2,3,4;a;b;c

If a parameter value can include white spaces, such as X_DisplayLabel, you should use just a single space character and no extra space before and after the value. For example:

X_DisplayLabel = My New Service

Introduction

The Obihai family of IP Phones, including the OBi1022, OBi1032, OBi1062, OBi2062, OBi2162, and OBi2182 support HD Voice with a full-duplex speakerphone, a high-resolution color active-matrix TFT LCD display with a customizable user interface, as well as a large number of fully programmable Feature Keys.

All OBi IP Phone models share the same functionalities:

• Support all standard SIP-based IP PABX and ITSPs/VSPs

• Suited for all service provider and enterprise deployment environments, regardless of size

• For do-it-yourself (DIY) or self-service installations, anyone regardless of whether they are a home user, small

business, or a corporate IT department can easily install, setup and manage the OBi IP Phone

• Integrate seamlessly with popular softswitch architectures such as BroadSoft, FreePBX, Asterisk, Elastix,

Metaswitch and FreeSwitch, to name a few

• Cloud management via OBiTALK.com with both a user portal as well as an ITSP partner portal (what we call the

Device Management Platform (DMP) with an optional RESTful API

OBi IP Phone Hardware

This section summarizes the hardware characteristics of each OBi IP Phone. The following table provides a specification summary for each model, while figures 1 through 4 show the front and back of each OBi IP Phone as well as the phone with an attached OBi1000e and OBi2000e Sidecar.

OBi1062

OBi1032

OBi1022

OBi2062

OBi2162

OBi2182

LCD Display

480x272, 4.3” Color TFT

480x272, 4.3”

Color TFT

320x160, 3.5”

Color TFT

800x480, 5” Color TFT

Ethernet Ports

2x GigE

2x Fast Ethernet

2x GigE

2x GigE PoE

Yes

Line Keys/Virtual Line Keys

6/24

3/12

5/10

3/12

6/24

Left Line Keys/Virtual Line Keys

0 0 0

3/12

6/24 Programmable Keys

8 8 1 0 0 0 Programmable Hard Keys

0 0 0 9 9

9 USB 2.0 Ports

2x USB 2.0

1x USB 2.0

2x USB 2.0

3.5mm Headset Jack

Yes

Yes RJ9 Headset Port

Yes

Electronic Hook Switch (EHS) Support

Yes (requires optional OBiEHS)

Yes (requires optional OBiEHS Kit)

Yes (requires optional OBiEHS)

WiFi

Yes (built-in for

2.4G; requires OBiWiFi USB Adapter for Dual Band)

Yes (requires OBiWiFi USB Adapter)

Yes (built-in Dual Band WiFi)

Yes (built-in Dual Band WiFi) Bluetooth

Yes (built-in)

Yes (requires OBiBT USB Adapter)

Yes (built-in; supports HD Voice)

FXO Telco Line Service

Yes (requires OBiLINE USB Adapter)

HD Voice

Yes

HD Full-Duplex Speakerphone

Yes

Message Waiting Light

Yes

Yes (via Programmable Key)

Yes

Sidecar* Support

Sidecars are available separately from Obihai. Each sidecar provides 16 additional feature keys – Order Obihai model OBi1000e

Yes, 16 Keys per sidecar (up to 2)

Figure 1: Front of the OBi1032 IP Phone

Line Keys (LK1– LK3 )

Programmable Keys (PK1–PK8)

Headset Jack (3.5mm)

MWI Lamp

Soft Keys (SK1–SK4)

Handset (HD)

Microphone

Speaker (HD)

Figure 2: Front of the OBi1062 IP Phone

Figure 3: Rear of the OBi1032 and OBi1062 IP Phones

Figure 4: OBi1062 with an attached OBi1000e Sidecar (Option Not Available on OBI1022 and OBi2000 Series)

Figure 5: Front of the OBi1022 IP Phone

Programmable Key (PK1: may be used as Next Tab+MWI)

Headset Jack (3.5mm)

Line Keys (LK1–LK5)

Sidecar 1

Sidecar Keys (SK1–SK16)

Figure 6: Rear of the OBi1022 IP Phone

Figure 7: Front of the OBi2182 IP Phone

Ethernet Switch Port (Supports PoE)

USB Port

Ethernet Passthrough Port

Power Socket (12V DC )

Handset Port

Wall Mounting Points

Stand Mouting Points

Figure 7: Back of the OBi2182 IP Phone

Accessories Available Separately from Obihai

The OBi IP Phone supports the following accessories:

• OBiWiFi5G USB Adapter: To connect the OBi IP Phone to a WiFi network

• OBiBT USB Adapter: To attach Bluetooth devices such as headsets and mobile phones

• OBiLINE FXO Adapter (Not available on OBi1022): To connect to a Plain Old Telephone System (POTS), for

example, to connect the OBi to the PSTN via phone jack provided by your telephone company or to connect to an analog PABX

• OBi1000e Sidecar (For OBi1032 and OBi1062 only): To provide 16 additional feature keys. Up to two sidecars

may be daisy chained from the auxiliary (AUX) port on the rear of the OBi1032 or OBi1062.

• OBi2000e Sidecar (For OBi2000 Series models only): To provide 24 additional line keys with labels displayed by

an LCD screen. Up to two sidecars may be daisy chained from the auxiliary (AUX) port at the attach points on rear of the OBi2000 Series IP Phone.

• USB Headsets

• USB Keyboard: For text entry using a standard keyboard

Other Accessories

The OBi IP Phone also supports the following storage devices for copying ring tones, background images and other media to the device:

• USB Disk Drives

• USB Thumb Drives

Connecting the OBi IP Phone

The OBi can be powered in two ways:

• Using an Ethernet switch that supports Power over Ethernet (PoE): Connect the Ethernet Switch Port (marked

SW) on the rear of the OBi to a PoE Ethernet switch using a Category-5 (or better) Ethernet cable

• Connecting an OBiPA 12V DC Power Adapter: Plug the 12V jack into the 12V socket on the back of the OBi IP

Phone, then connect AC (mains) adapter to the AC (mains) power socket.

Connecting the Phone to the Network

You must connect the phone to a wired LAN or WiFi network in order to obtain phone service. In most cases your network will require an internet connection and your service provider will set out requirements for the required capacity of your connection to support voice services. In some cases the OBi IP Phone may be deployed on a LAN or WAN with no Internet access – for example in a corporate environment within a voice-only VLAN.

Connecting to the LAN Over Wired Ethernet

Connect a Category-5 (or better) Ethernet cable from an available switch port to the RJ45 Port labeled SW on the back of the phone. Note that the SW port also supports PoE - if it is connected to a standard PoE switch port, it can draw power from the switch without needing to connect to an OBiPA 12V DC power adapter (sold separately).

Connecting to the WLAN Over WiFi

The OBi IP Phone can also connect to a phone service over a WiFi network. The OBi2162 and OBi2182 phones have built-in dual-band WiFi (802.11ac 2.4/5GHz), the OBi1062 has built-in WiFi (802.11n 2.4GHz), whereas the OBi1022, OBi1032 and OBi2062 can connect to WiFi using the OBiWiFi5G accessory. The phone must join the wireless network by connecting to a WiFi Access Point (AP). The user may use the WiFi setup utility within the Settings app to scan for APs that are nearby, identify the correct AP by its broadcast SSID (WiFi network name) and connect to it. If security is enabled on the AP, an input prompt will pop up on the screen to let you enter the WiFi access password. Upon entry of correct credentials and connection to WiFi the network, the screen will display an icon on the status bar that indicates the access point is connected and also shows the signal strength. For further setup information, read “WiFi Setup” in the “OBi Phone Apps” section of this document.

Overview of Phone Features

Administrative Features

• Web pages of phone status and configuration of all parameters

• Remote Provisioning

• OBiTALK Provisioning

• Automated Firmware Update

Voice Features

• Six (6) SIP or Google Voice (GV) Accounts

• Universal inter- and intra service two-way call bridging among the 6 SIP/GV services, the OBiTALK service, and

the OBiBluetooth service

• Universal intra- and inter-service call transfer and call forward by local call bridging

• Automatic Attendant with customizable audio prompts that may be recorded directly on the phone

• SIP Support for Voice Over IP

• OBiTALK Managed VoIP Network for OBi Endpoint Devices & Applications

• High Quality Voice Encoding Using G.711, G.726, G.729, G.722, iLBC, and OPUS Algorithms

• Recursive Digit Maps and Associated Call Routing (Outbound and Inbound)

Call Features

• Message Waiting Indication - Visual and Tone Based

• Four Way Conference Calling with Local Mixing

• Caller ID and Calling Line ID Presentation

• Call Waiting

• Call Forward - Unconditional

• Call Forward on Busy

• Call Forward on No Answer

• Call Transfer

• Call Park

• Anonymous Call

• Block Anonymous Call

• Do Not Disturb

• Call Return

• Repeat Dialing

• Multicast Paging Groups

• Music On Hold

Soft Switch Support

• BroadSoft

• MetaSwitch

• FreeSwitch

• SkySwitch

• Asterisk

Integrated GUI Applications

• Phone Book

• Call History

• 3

Party XML Apps

Complementary Obihai Products and Services

OBi1000 IP Phones 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.

OBiTALK Device Management Platform (DMP): A cloud-based management tether to the OBi endpoints for secure and remote provisioning, real-time call status reporting and troubleshooting, device UI management and more. Taking in a form of a web portal and an API, the OBiTALK DMP provides access to the configurations of the multiple endpoints regardless of location, making it as if they are virtually sitting right at your desk.

The OBiTALK DMP is designed for use of service providers, system integrators and value-added resellers (VAR) deploying OBi Universal Adapters and IP Phones. When a user is logged in, they can manage all their OBi endpoints remotely, enabling fast and easy device deployment and maintenance.

Contact partner@obihai.com to learn more about the OBiTALK DMP, and how to sign up to receive access.

Configuration and Management Interfaces

There are several ways to configure and manage the OBi IP Phone. Use the method (or combination of methods) that best suit your deployment scenario.

Device Local Configuration

The OBi IP Phone has an integrated device management web server that can be accessed from any standard (desktop or tablet) web browser. Although all popular browsers are tested for compatibility with the OBi device management web server, there may be inconsistencies that arise from time to time. Please contact spsupport@obihai.com if you have any questions about the OBi device management web server and how it appears in your browser window.

To access the OBi IP Phone Device Management Web Page:

1. Connect the phone to the LAN

2. From the phone Main Menu, select Settings

3. Under Settings, the first item, Network, shows the IP address of the phone

4. Enter the phone IP Address as the URL of the web site you want to visit in your web browser

5. When prompted by the web browser, enter admin for user name and admin for password. Note that the

password is the standard factory default value. If the value has been changed, enter the correct value instead.

When you access the OBi device management web page, you may be prompted to enter 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 the User Level access is “user / user”. The default “user name / password” for the 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.

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.

Local Configuration Web Page Layout

There are many configurable parameters available on the OBi1000. These parameters are organized into a number of device configuration web pages. By browsing through the web pages you can discover all the parameters that can be configured, then read or set their values. Each web page is divided into three frames: A top frame with the Obihai banner (which can be customized by the administrator), a left frame that lists the links to the available pages, and a main frame that shows the parameters of the currently selected page. An example of a device configuration web page is shown below.

Below is the list of available device configuration web pages:

Status

• System Status

• Call Status

• SP Services Stats

OBiWiFi Configuration

• WiFi Settings

• WIFi Scan

System Management

• WAN Settings

• Auto Provisioning

• Device Admin

• Device Update

Service Providers

ITSP Profile A (repeated for ITSP Profile B, C, D, E, and F)

• General

• SIP

• RTP

Voice Services

• SP1 Service

• SP2 Service

• SP3 Service

• SP4 Service

• SP5 Service

• SP6 Service

• OBiTALK Service

• Auto Attendant

• Gateways and Trunk Groups

• OBiBluetooth

IP Phone

• Phone Settings

• Line Keys

• Left Line Keys (OBi2000 Series only)

• Programmable Keys

• Side Car 1

• Side Car 2

• Soft Keys

• LED Settings

• LDAP

• Feature Key Customization

Codec Profiles

• Codec Profile A

• Codec Profile B

Tone Settings

• Tone Profile A

• Tone Profile B

Ring Settings

• Ring Profile A

• Ring Profile B

Star Codes

• Star Code Profile A

• Star Code Profile B

User Settings

• User Preferences

• Speed Dials

• User Defined Digit Maps

Phone Screen Capture

From the phone web page, you can take a snapshot of the current phone screen and save it as a a bmp file on your host computer. Here is how:

• Enable the option Device Admin – Web Server::LCDScreenShot

• Open the System Management – Device Update web page of the phone and press the Snap button

Remote Provisioning

This is the process by which the OBi downloads a configuration file from a server, which may be located in the cloud or in the same enterprise. The configuration file may contain all the necessary parameter values for the phone to function normally, it may also tell the device to download an additional configuration file from a different URL, or to download a different firmware to replace the current one, and so on. The configuration file format and parameter naming conventions are proprietary to Obihai but are common across all Obihai products.

There are currently two configuration file formats supported: A full XML format with the XML tags in full text and a short XML format with the XML tags substituted with a single letter abbreviation. The XML structure and parameter naming convention closely follows TR-104. For a full description of the configuration file and parameter names, please refer to the OBi Device Provisioning Guide.

Similar to the way parameters are grouped under different device configuration web pages, parameters are grouped into a number of configuration objects for remote provisioning. In fact you will find a near one-to-one correspondence between these objects and their location within the configuration web pages. To illustrate this, consider the web page SP1 Service, the SIP Credentials section:

The corresponding configuration object in a phone configuration XML file is:

VoiceService.1.VoiceProfile.1.Line.1.SIP.

as shown below:

<Name>VoiceService.1.VoiceProfile.1.Line.1.SIP.</Name>

<Name>AuthUserName</Name>

<Value>john.j.smith@gmail.com</Value>

</ParameterValueStruct>

<Name>AuthPassword</Name>

</ParameterValueStruct>

</ParameterValueStruct>

<Name>X_MyExtension</Name>

</ParameterValueStruct>

<Name>X_XsiUserName</Name>

</ParameterValueStruct>

<Name>X_XsiPassword</Name>

</ParameterValueStruct>

<Name>X_XmppDomain</Name>

</ParameterValueStruct>

<Name>X_XmppUserName</Name>

</ParameterValueStruct>

<Name>X_ContactUserID</Name>

</ParameterValueStruct>

<Name>X_EnforceRequestUserID</Name>

</ParameterValueStruct>

</Object>

Note that the dot (.) at the end of the object name is part of the name that must not be omitted in the XML file. You must use the correct object name in order to create a valid configuration file for the phone. You can find the object name corresponding to each configuration web page/section listed at the end of this document.

About ZT (Zero Touch): Device Customization at Obihai’s Factory

When products are shipped from the factory, they come with a set of default parameter values installed by Obihai for all customers. A service is also available from Obihai such that products shipped to a particular customer can have a small number of parameter values customized for that customer. For example, a very useful parameter to customize is the ITSP Provisioning::ConfigURL parameter which tells the phone where to download a configuration file. With this, the first time a new phone is powered on and connected to the network, it can automatically contact the designated URL to get the initial configuration file; hence the name “Zero-Touch”.

Note: ZT devices must contact OBiTALK.com one time to get the customized values before they can start normal operation. Make sure the device can access the Internet before first use.

OBiTALK Portals

OBiTALK.com is a device management portal website to serve Obihai customers and service providers deploying OBi devices. OBiTALK.com uses remote provisioning to manage OBi devices; it stores, or dynamically generates on demand, a configuration file for each managed device which periodically checks in with the OBiTALK server for configuration updates.

There are two levels of management portals at OBiTALK.com: User and ITSP.

User Portal

Users may add one or more OBi devices to their OBiTALK account to be managed. The portal has setup wizards that help the user configure voice services on any of their devices. Users can also see the detailed status and current parameter values of their devices and easily change settings on multiple devices from within the portal. The User Portal has an upper limit of 20 devices per portal instance.

Device Management Platform (DMP) Portal – for ITSPs

Service providers and system Integrators can add devices to the OBiTALK portal and manage them in ways similar to regular users. Zero Touch (ZT) devices, on the other hand, are added to the corresponding customer’s ITSP account automatically, as soon as the earmarked units are manufactured at the factory. ZT device customers can monitor the status of their units on the portal and check if (and when) new units have contacted the ZT server at OBiTALK.com and are successfully customized.

In addition, service providers and system integrators using the OBiTALK DMP portal can configure their devices on OBiTALK.com in batch mode by defining XML base profiles that may be applied to many units. When a base profile is changed, all units using this base profile will be automatically updated with any changes that have been made.

Telephone-IVR-Based Local Configuration

The OBi1000 has a built in IVR for checking and setting a small but essential subset of configuration parameters. Configuration via the IVR is a legacy configuration method inherited from older OBi products that do not have a display (such as the OBi202 and OBi508). It is included here nevertheless for additional convenience and also so that customers who are already familiar with using the OBi IVR can perform basic configuration tasks without learning new specifics about the phone first.

The IVR is, in essence, an instance of an automated attendant (AA). The OBi offers two instances of AA; referred to as AA1 (or just AA where the suffix 1 is implied) and AA2. The IVR for configuration purposes is AA2, which we will just refer to as the IVR to avoid confusion with AA1, which is the AA used to handle phone calls. AA is covered as the subject of a later section.

To invoke the IVR, the user picks the phone, dials * * * and follows the announced instructions. In order for the * * * number to work, make sure the digit map pattern *** is included in the Phone Settings::DigitMap parameter, and the rule, {***:aa2} is included in the Phone Settings::OutboundCallRoute parameter. The standard (noncustomized) default values of these parameters are, respectively:

([1-9]x?*(Mpli)|[1-9]S9|[1-9][0-9]S9|***|**0|**8(Mbt)|

**1(Msp1)|**2(Msp2)|**3(Msp3)|**4(Msp4)|**9(Mpp)|(Mpli))

and

{([1-9]x?*(Mpli)):pp},{**0:aa},{***:aa2},{(<**1:>(Msp1)):sp1},

{(<**2:>(Msp2)):sp2},{(<**3:>(Msp3)):sp3},{(<**4:>(Msp4)):sp4},

{(<**8:>(Mbt)):bt},{(<**9:>(Mpp)):pp},{(Mpli):pli}

For the meaning of these values, please see the section Digit Maps and Call Routing. Some parameter changes require a reboot to take effect. Changes from the OBiTALK Configuration will trigger the phone to reboot automatically (but will wait for any current calls to end first).

Key Ahead: 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

The Main Menu after starting the IVR is a list of operations that can be selected by entering the corresponding 1-digit option number, as listed below:

Selection

Announcement

What Can You Do?

Basic Network Status Your IP address and DHCP status will be read

back to you.

Press 0 to repeat the information.

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.

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.

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.

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.

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.

Restore Factory Default

Press 1 to confirm device restore to factory default settings.

Press # to return to device configuration menu.

Press # # to exit IVR.

+ 257 hidden pages

Obihai Technology OBi1032, OBi1062, OBi2062, OBi1022, OBi2162 Administration Manual

Specifications and Main Features

Frequently Asked Questions

User Manual