Table of Contents

Advertisement

Obihai Technology, Inc.
Obihai IP Phone Administration Guide
Models:
OBi1062
OBi1032
OBi1022
OBi2062
OBi2162
OBi2182
October 2017
Copyright, Obihai Technology, Inc. 2010-2017. All Rights Reserved.
Copyright material. Do not make copies. Do not distribute.
All contents subject to change without notification.

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the OBi1032 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Obihai Technology OBi1032

  • Page 1 Obihai Technology, Inc. Obihai IP Phone Administration Guide Models: OBi1062 OBi1032 OBi1022 OBi2062 OBi2162 OBi2182 October 2017 Copyright, Obihai Technology, Inc. 2010-2017. All Rights Reserved. Copyright material. Do not make copies. Do not distribute. All contents subject to change without notification.
  • Page 2: Table Of Contents

    SP2 Configuration Options ....................................33 OBiTALK Configuration Options ..................................34 Auto Attendant Configuration Options ................................35 Customized AA Prompt Recording Options ............................... 35 GUI ..................................36 HONE Settings........................................... 36 Preferences ..........................................39 Admin Password ........................................39 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 3 ........................57 VERVIEW OF OMMON RUNK ONFIGURATION Service Enable ........................................57 Service Account Credentials ....................................58 Servers ........................................... 58 Trunk Capacity ........................................58 Basic Incoming Call Handling ....................................58 Basic Outgoing Call Handling ....................................59 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 4 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 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 5 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 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 6 Call Forward Always ......................................111 Call Forward Busy ........................................111 Call Forward No Answer ......................................111 Anonymous Call........................................112 Do Not Disturb ........................................112 BUILT-IN PHONE APPS .......................... 113 ................................113 ERVICES ..................................113 PHONE GUI CUSTOMIZATION ....................... 115 ..................................115 ................................... 115 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 7 <TitleBarStyle> Attributes .....................................157 The <Notifications> Element ....................................158 The <LineKeyTabs> Element ....................................160 Trigger update of a notification icon with an ObihaiIPPhoneExecute XML ......................161 LED P ............................162 ATTERN USTOMIZATION LED Settings Parameters .......................................162 Call State ..........................................162 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 8 ROMPTS AA P ............................188 USTOMIZING ROMPT ISTS VOICE GATEWAYS AND TRUNK GROUPS ....................190 ................................190 OICE ATEWAY ................................. 190 RUNK ROUPS LDAP ..............................191 LDAP S ................................. 191 ERVICE ETUP Client Authentication ......................................193 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 9 1000 ........................ 211 UPPORTED WAY CALL BRIDGES ON THE – T ............................212 OUTING ..........................212 NBOUND OUTE ONFIGURATION ..........................214 UTBOUND OUTE ONFIGURATION DIGIT MAP CONFIGURATION ........................ 217 ....................... 223 ATCHING GAINST ULTIPLE ULES IN IGIT Copyright 2010-2017 Obihai Technology, Inc.
  • Page 10 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 ................................. 248 OICE ERVICES SPn Service Web Page (n = 1, 2, 3, 4, 5, 6) ................................248 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 11 Ring Profile X Web Page (X = A, B) ..................................280 ................................281 ROFILES Star Code Profile X Web Page (X = A, B) ................................281 ................................. 282 ETTINGS User Preferences Web Page ....................................282 Speed Dials Web Page ......................................286 User Defined Digit Maps Web Page ..................................287 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 12: Audience

    OBi Phone Administration Guide OBi Device Provisioning Guide 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 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 13: Notational Conventions

    X_DisplayLabel If a parameter value can include white spaces, such as , you should use just a single space character and no extra space before and after the value. For example: X_DisplayLabel My New Service Copyright 2010-2017 Obihai Technology, Inc.
  • Page 14: Introduction

    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.
  • Page 15 – Order Obihai model OBi1000e MWI Lamp Line Keys Speaker (HD) (LK1– LK3 ) Soft Keys (SK1–SK4) Handset (HD) Programmable Keys (PK1–PK8) Headset Jack (3.5mm) Microphone Figure 1: Front of the OBi1032 IP Phone Copyright 2010-2017 Obihai Technology, Inc.
  • Page 16 Figure 2: Front of the OBi1062 IP Phone Figure 3: Rear of the OBi1032 and OBi1062 IP Phones Copyright 2010-2017 Obihai Technology, Inc.
  • Page 17 Figure 4: OBi1062 with an attached OBi1000e Sidecar (Option Not Available on OBI1022 and OBi2000 Series) Line Keys (LK1–LK5) Programmable Key (PK1: may be used as Next Tab+MWI) Headset Jack (3.5mm) Figure 5: Front of the OBi1022 IP Phone Copyright 2010-2017 Obihai Technology, Inc.
  • Page 18 Stand Mouting Points Power Socket (12V DC ) USB Port Ethernet Switch Port (Supports PoE) Ethernet Passthrough Port Handset Port Figure 6: Rear of the OBi1022 IP Phone Figure 7: Front of the OBi2182 IP Phone Copyright 2010-2017 Obihai Technology, Inc.
  • Page 19: Accessories Available Separately From Obihai

    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. •...
  • Page 20: Connecting The Ob Iip Phone

    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.
  • Page 21: Call Features

    Repeat Dialing • Multicast Paging Groups • Music On Hold Soft Switch Support • BroadSoft • MetaSwitch • FreeSwitch • SkySwitch • Asterisk Integrated GUI Applications • Phone Book • Call History • Party XML Apps Copyright 2010-2017 Obihai Technology, Inc.
  • Page 22: Complementary Obihai Products And Services

    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. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 23: Configuration And Management Interfaces

    (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. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 24: Web Page Conventions And Icons & Buttons

    Required” icon appears indicating the OBi device Configuration Reset, the Reboot requires a reboot to invoke one or more parameter button does not need to be modifications. pressed. The OBi will reboot automatically when the “Reset” button is selected. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 25: Local Configuration Web Page Layout

    • 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) Copyright 2010-2017 Obihai Technology, Inc.
  • Page 26 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 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 27: Phone Screen Capture

    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: <Object> <Name>VoiceService.1.VoiceProfile.1.Line.1.SIP.</Name> <ParameterValueStruct> <Name>AuthUserName</Name> <Value>john.j.smith@gmail.com</Value> </ParameterValueStruct> <ParameterValueStruct> <Name>AuthPassword</Name> Copyright 2010-2017 Obihai Technology, Inc.
  • Page 28: About Zt (Zero Touch): Device Customization At Obihai's Factory

    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. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 29: Obitalk Portals

    Phone Settings:: parameter, and OutboundCallRoute {***:aa2} is the rule, included in the Phone Settings:: parameter. The standard (non- customized) 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)) {([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} Copyright 2010-2017 Obihai Technology, Inc.
  • Page 30: Main Menu

    Restore Factory Default Press 1 to confirm device restore to factory default settings. Press # to return to device configuration menu. Press # # to exit IVR. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 31: Additional Options (Menu 0)

    Press 1 to enter a new value. The current value of the DHCP configuration Press 2 to set the default value. will be read back. Press 0 to repeat the information. Press # to enter another configuration selection. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 32: Sp1 Configuration Options

    Press # to enter another configuration selection. SP1 Block Anonymous Call Enable Press 1 to enter a new value. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 33: Sp2 Configuration Options

    Press # to enter another configuration selection. SP2 Block Caller ID Enable Press 1 to enter a new value. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 34: Obitalk Configuration Options

    Press # to enter another configuration selection. OBiTALK Block Caller ID Enable Press 1 to enter a new value. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 35: Auto Attendant Configuration Options

    Selection Announcement What Can You Do? (Always Press “#” After Entering Selection) 1001 Option 1001 current value is: (the Press 1 to enter a new value. recorded prompt) Press 2 to set the default value. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 36: Phone Gui

    Settings The Phone GUI allows the following parameters to be configured under the “Settings” option of the main menu: • Network AddressingType IP Address Subnet Mask Default Gateway DNS Server1 DNS Server2 DNS Query Order Copyright 2010-2017 Obihai Technology, Inc.
  • Page 37 RX Gain • Storage Device File System Type Capacity • Programmable Keys • Line Keys • Left Line Keys (available on OBi2000 series only) • Side Car 1 (not available on OBi1022 and OBi2000 series) Copyright 2010-2017 Obihai Technology, Inc.
  • Page 38 Device Administration Web Server Port Web Admin Password Web User Password Syslog Server ITSP Provisioning Method ITSP Provisioning Interval ITSP Provisioning Config URL Auto Firmware Update Method Auto Firmware Update Interval Auto Firmware Update URL Copyright 2010-2017 Obihai Technology, Inc.
  • Page 39: Preferences

    BT Headset Mic Gain • Equalizer • Acoustic Echo Cancellation Admin Password The Voice Services and Device Administration options in the GUI are protected by the same admin password used for accessing the phone’s local configuration web pages. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 40: Networking Features

    WAN Settings – Internet DNSServer1 DNSServer2 Settings:: . Note that if the DHCP offer includes DNS Servers, the OBi Phone takes up to 16 servers from the list and uses them together with the explicitly configured servers. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 41: Wifi Interface

    The OBi Phone supports WiFi. While the OBi2182, OBi2162 and OBi1062 has built-in WiFi hardware, the OBi1022, OBi1032 and OBi2062 can connect via WiFi with an OBiWiFi5G adapter connected to USB Port 1 on the back of the phone (note that you MUST NOT connect OBiWiFi5G to USB Port 2). Note that VLAN and LLDP features are not available on WiFi.
  • Page 42: Locally Configured Dns Lookup Table

    Internal path where the Required Required 802_1XCACertificate certificate of the CA that signs the server certificate (for 802.1x authentication) is stored Internal path where the client Required 802_1XClientCertificate certificate (for 802.1x authentication) is stored Copyright 2010-2017 Obihai Technology, Inc.
  • Page 43: Certificates For 802.1X Authentication

    SIP/NOTIFY or HTTP/POST method, or pulled by the phone by invoking an Action URL function via a feature key or softkey. Please refer to this article on how to create a Phone XML App. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 44: Feature Keys

    - Service: Optional. The service or line to bind the key with - MaxCalls: Number of calls to be managed by this Call Key Ringing Call Ended SCA: Error SCA: Idle SCA: Line Seized SCA: Trying SCA: Proceeding SCA: Connected Copyright 2010-2017 Obihai Technology, Inc.
  • Page 45 CPM key to retrieve the call as an additional call on the current phone. Parameters: - Service: Required. The service that provides the parking lot orbit: parking and monitoring function - Number: Required. The parking lot orbit to park and monitor Copyright 2010-2017 Obihai Technology, Inc.
  • Page 46 For example: you may set the number field to [*96]SP1(2113);ptt . The phone then inteprets *96 locally (to request auto-answer on the called party) and makes the call to 2113 using SP1 service. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 47: Using Speed Dial To Store A Feature Access Code Prefix

    Parameters: - Service: Optional. The service to apply this feature on. If no service is specified, the feature applies to all calls on the phone. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 48 This function cannot be bound to any specific voice service. Parameters: None Join/Leave Page Same as the last item except this one applies to Page Group 2 left Group 2. joined Copyright 2010-2017 Obihai Technology, Inc.
  • Page 49 This function cannot bound to any specific voice service. Parameters: None Note that the multiple Line Key Tabs feature can be disabled also by disabling LineKeyTabs User Preferences the option . In that case the “Next Tab” function does nothing. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 50: Line Keys And Virtual Line Keys

    VLK12 under Tab 2, to VLK13 – VLK18 under Tab 3, and to VLK19 – VLK24 under Tab 4. Similarly, on the OBi1032/2062/2162, LK1 – LK3 are mapped to VLK1 – VLK3 under Tab 1, to VLK4 – VLK6 under Tab 2, to VLK7 – VLK9 under Tab 3, and to VLK10 –...
  • Page 51: Left Line Keys And Virtual Left Line Keys

    The programming and functionality of the VLLKs are the same as the LLKs. Programmable Keys There are eight (8) Programmable Keys on the OBi1032/1062 and one (1) on the OBi1022. These are called PK1 – PK8. Programmable Hard Keys There are no Programmable Keys in the OBi2000 series.
  • Page 52 8. Next Tab Function • Next Tab Default The default setup provides the function of changing the (right) line key tab. We do not recommend changing the function of this key. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 53: Side Car Keys

    Call Key. Each call carried out on the phone must be assigned a call key. That is, you will need at least one Call Key to make or receive a call. Each Call Key can hold exactly one call. Usually there are at least a few Call Keys defined on the Copyright 2010-2017 Obihai Technology, Inc.
  • Page 54: Line Monitor Keys

    It only indicates the status whether a call is parked on the orbit or not. Pressing the key once to either park the highlighted call on screen to the orbit if it is not occupied, or retrieve the call from the orbit if it is currently occupied. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 55: Presence Monitor

    For example when the user does not want to be bothered by incoming page, he can temporarily leave the group. The LED color also reflects the current group-joining status as a reminder to the user. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 56: Input Methods

    Ctrl F1/F2/F3/F4//F5/F6 Line Key 1/2/3//4/5/6 Backspace Backspace Ctrl s/S Speaker Backspace Ctrl h/H Headset Ctrl m/M Mute Ctrl 1/2/3/4/5/6/7/8 Programmable Key 1/2/3/4/5/6/7/8 Ctrl + Vol Up Ctrl - Vol Down Copyright 2010-2017 Obihai Technology, Inc.
  • Page 57: Voice Services

    Service Enable Enable Before a trunk can be put into service, it must be enabled in the phone configuration. There is an parameter for each service and this parameter is checked by default. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 58: Service Account Credentials

    2. For other SIP/SP services, the value must be set to no larger than the maximum number of simultaneous calls allowed by the service provider. Basic Incoming Call Handling For each incoming call arriving at the phone from a specific trunk, the phone handles it in the following order: Copyright 2010-2017 Obihai Technology, Inc.
  • Page 59: Basic Outgoing Call Handling

    When only a short number is specified, the phone determines the service to use, where necessary, by going through normal digit map and call routing processing, as explained later in this document. When a full number is specified, the phone uses the number and service as specified without any modification. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 60: Sip/Sp Service

    Note that dynamic address binding through periodic registration is not strictly necessary if the local IP address of the device does not change; the device’s contact address may be statically configured on the Registration Server. Here is a typical REGISTER request generated by the phone: Copyright 2010-2017 Obihai Technology, Inc.
  • Page 61: Third Party Registration

    For X_RegistrationMargin example, if = 0.01 and the expires value is 300, then the next renewal goes out 3s before the expiration time. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 62: Register Final Non-2Xx Response Handling

    OutboundProxy value. In fact, the value should never appear in the SIP requests generated by the phone (unless the OutboundProxy ProxyServer has the same value as the Copyright 2010-2017 Obihai Technology, Inc.
  • Page 63: Dns Lookup Of Sip Servers

    The phone can also include an empty rport parameter in the Via header of outbound SIP requests if the option ITSP X_UseRport Profile X – SIP:: option is enabled. This parameter is sometimes needed to prompt the server to insert an Copyright 2010-2017 Obihai Technology, Inc.
  • Page 64: Keep Alive Messages

    As such, DEVICE REGISTRATION MUST BE ENABLED in order to use the server redundancy feature. Other SIP requests, such as INVITE or SUBSCRIBE, are sent to the same server that the device currently registers with. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 65: Sip Privacy

    = full privacy requested; the OBi will hide both name and number. name = name privacy requested; the OBi will show the number but hide the name. uri = uri privacy requested; the OBi will show the name but hide the number. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 66: Stun And Ice

    Once ICE is completed successfully, the device will further apply the symmetric RTP concept to determine the peer’s RTP address (i.e. send to the address where the peer’s RTP packets are coming from). Copyright 2010-2017 Obihai Technology, Inc.
  • Page 67: Itsp Driven Distinctive Ringing

    NAT or a Firewall. The media loopback feature is controlled by the following parameters (under Phone Settings – Calling Features section): AcceptMediaLoopback – Enable device to accept incoming call that requests media loopback. Default is YES. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 68: A Sip/Sp Configuration Example

    SP1 Service – Credentials X_MyExtension 1003 SP1 Service – Credentials X_ServProvProfile SP3 Service AuthUserName 3409991005 SP3 Service – Credentials AuthPassword c98dfa74{ SP3 Service – Credentials X_MyExtension 1005 SP3 Service – Credentials PrimaryLine Phone Settings Copyright 2010-2017 Obihai Technology, Inc.
  • Page 69: Google Voice™ Service

    Accept the setting of the parameter ITSP Profile X – General:: . The value can be either InBand or RFC2833. Other values will be reverted to RFC2833. Default is RFC2833. Voice Service Features of the OBi Device. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 70: Obitalk Service

    OBiTALK Service OBiTALK is a proprietary protocol developed by Obihai Technology for communications among OBi devices and to OBiTALK device management servers. The protocol is intended for two main purposes: a) Peer-to-peer calling between OBi devices, and b) Device management by OBiTALK servers. Every OBi device comes with one instance of the OBiTALK service with the (fixed) factory-assigned 9-digit device OBi Number as the userid of the service.
  • Page 71: Obibluetooth Service

    The OBi1000 supports Bluetooth connectivity with either a headset or a mobile phone. While the OBi1062 has built-in hardware support for this function, the OBi1032 requires the user to connect an OBiBT USB dongle to USB Port 2 (note: OBiBT Must NOT be connected to USB Port 1). Other than that, the Bluetooth enabled features work similarly in both models.
  • Page 72: Call Features

    End, Resume, Add to Slow blinking red Conf., Transfer, Blind Transfer Ended Call failed due to various reasons, End (i.e. Remove the Slow blinking green such as invalid number, service not Call) available, called party busy, etc. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 73: Core Call Features

    There are three audio paths for calls on the phone: Handset, Speakerphone, and Headset. The headset audio path further supports 3 devices: RJ9 Headset, 3.5mm Headset, and Bluetooth Headset. Only one audio path can be switched Copyright 2010-2017 Obihai Technology, Inc.
  • Page 74: Off-Hook Dialing

    The Primary Line is the preferred line to use for outgoing calls when the number entered by the user does not include a PrimaryLine line-section-prefix (such as **1 or **2). The Primary Line is defined in the parameter Phone Settings:: which must be one of the following values (case-sensitive): SP1 Service SP2 Service SP3 Service Copyright 2010-2017 Obihai Technology, Inc.
  • Page 75: Explicitly Selecting A Line To Make Call

    ID information in a 1xx response to the INVITE or in an UPDATE request sent to the phone before the call is answered. The phone then updates the name and number display accordingly on the screen. This feature is also referred to Calling Line ID. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 76: Handling Incoming Calls

    “Foregrounding” a Call Operations that are said to foreground a call (i.e., bring a call to the “foreground”) include: • Resume Resuming a holding call using the soft key Copyright 2010-2017 Obihai Technology, Inc.
  • Page 77: Call Waiting

    "Transfer" and "Blind Transfer" options. Select the "Transfer" option to perform an attended or semi- attended call transfer, or select the "Blind Transfer" option to perform a blind call transfer. Below is an example of a connected call with the Transfer and Blind Transfer soft keys shown. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 78: Transfer Signaling

    Note also that if the transfer operation eventually fails after completion (from the OBi user's perspective), the original call with the transferee cannot be restored. Transfer Signaling Copyright 2010-2017 Obihai Technology, Inc.
  • Page 79: Limitations Of Transfer By Internal Bridging

    Hence the user can also individually control each call-leg, such as holding or ending any one of them. Two additional features that are useful in this scenario are Call Selective Mute and Coachee Mode as described below. Call Selective Mute Copyright 2010-2017 Obihai Technology, Inc.
  • Page 80: Coachee Mode

    Expanded Call Features Expanded call features go beyond the basics to provide additional features for enhanced productivity and control. Unless noted otherwise, the features described here can be performed by the phone independent of a soft switch. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 81: Auto Answer And Intercom

    Not to play a beep tone on answering. Default is to play the beep tone according to user preference setting delay={value in seconds}: The number of seconds to ring before auto-answering the call. Default is 0 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 82: Auto-Answer When Caller Requests To Barge-In (With Obitalk Service)

    {digit-codes} is a sequence of the following case-sensitve codes: ▪ 0-9,*,#,a,b,c,d – The DTMF digit to send to the peer. Each digit is sent with 100 ms on and 100 ms off ▪ S – Pause for 3s Copyright 2010-2017 Obihai Technology, Inc.
  • Page 83: Block Caller Id

    NOT available with Google Voice service at present. If the feature is offered by the phone for the SIP/SP service, it does the following to the outgoing INVITE: From: “Anonymous” <sip:12345@abc.com>;tag=spx13040-5345425 From: “Anonymous” <sip:anonymous@localhost>;tag=spx13040-5345425 Privacy: id Copyright 2010-2017 Obihai Technology, Inc.
  • Page 84: Block Anonymous Call

    8, BT1, BT2 for OBiBluetooth 1/2, or PP for the OBiTALK Service. The number to forward to must be in the final form that is acceptable by the service provider. The OBi will not apply any Digit Map or Call Routing Rules on it. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 85: Call Forward All

    Features CallForwardOnNoAnswerRingCount SPn Service – Network Provided Services CallForwardUnconditional SPn Service – Network Provided Services CallForwardOnBusy SPn Service – Network Provided Services CallForwardOnNoAnswer SPn Service – Network Provided Services Call Forward Signaling Copyright 2010-2017 Obihai Technology, Inc.
  • Page 86: Limitations Of Call Froward By Internal Bridging

    Parameter Group Parameter Description Controls the stutter tone MWIEnable SPn Service – Calling Features n=1-6 Controls the Message Waiting Light at the top edge VMWIEnable SPn Service – Calling of the OBi1000 Features Copyright 2010-2017 Obihai Technology, Inc.
  • Page 87: Multicast Page Groups

    TTL value of outgoing (multicast) RTP N = 1, 2 packets. Default is AudioCodec Page Group N Audio codec to use for outgoing page. G711U N = 1, 2 Default is TxPacketSize Page Group N Outgoing RTP packetization in Copyright 2010-2017 Obihai Technology, Inc.
  • Page 88: Music On Hold (Moh)

    . The MOH Server number can be an external SIP or OBiTALK addressable device, such as pp(ob600559558) or sp3(moh-server). The expected behavior of the MOH Server device is such that when called, it automatically answers the call and starts streaming audio to the calling device. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 89: Premium Call Features

    For example, the monitored extension may be on a connected call while an incoming call is ringing. Under these circumstances, some soft-switch implementations may only notify the monitoring phones of just one event that it Copyright 2010-2017 Obihai Technology, Inc.
  • Page 90: Blf With Call Park Status

    {userid} attribute). (BroadSoft, FreePBX) For the INVITE+Replaces method, the OBi1000 sends an INVITE with a Replaces header that identifies to the soft-switch the ringing call to pick up from the monitored extension. (MetaSwitch) Copyright 2010-2017 Obihai Technology, Inc.
  • Page 91: Blf Operation: Barge In

    FreeSwitch; this when combined with the ptt flag provides the familiar Intercom user experience Name Key N A nickname or user-friendly name for the monitored extension. It can be used by the phone in some GUI elements N = 1,2,3… Copyright 2010-2017 Obihai Technology, Inc.
  • Page 92: Floating Blf Key Assignment

    OBi1000 is free to assign this reserved BLF to another key when it is running out of free keys to assign. So, if all the BLF keys are floating without specifying they are a suggestion, the order of extension assignment follows precisely the order of the extensions in the list received from the server. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 93: Sip For Blf

    When the soft-switch is capable of notifying call park status for the monitored extension, it is expected the status is reported inside a dialog-info XML as well. Here is an example: <?xml version="1.0" encoding="UTF-8"?> <dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info" xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info" xmlns:bw="http://schema.broadsoft.com/callpark" version="3" state="partial" entity="sip:north00@txasdev87.net"> <dialog id="Y2FsbGhhbGYtMzM6MA=="> <state>confirmed</state> <bw:callpark> <bw:parked> <identity display="Alice south"> sip:9726987601@as.bw.com;user=phone Copyright 2010-2017 Obihai Technology, Inc.
  • Page 94: Blf With Obitalk Service

    With this approach, some BLF implementations also include parking slot monitoring when monitoring an extension. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 95: Call Park Methods

    XML document in the message boxy (Content-Type:application/x-broadworks-callpark-info+xml). Here is an example: <?xml version="1.0" encoding="UTF-8"?> <x-broadworks-callpark-info xmlns="http://schema.broadsoft.com/callpark"> <callpark> <parked> <identity display="Alice south"> sip:876601@as.bw.com;user=phone </identity> </parked> </callpark> </x-broadworks-callpark-info> Copyright 2010-2017 Obihai Technology, Inc.
  • Page 96: Call Park Ring

    0 or equal to 0 to mean play forever. The duration parameter is optional; default value is 60. {i-value} is the interval between the ring bursts in seconds. It must be greater than 0. The interval parameter is optional; default value is 10 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 97: Shared Line And Shared Call Appearances (Sca)

    You must also have the same number Call Appearance feature keys defined to bind to this SP service. A Call Appearance key bound to a shared line behaves similarly to one that is bound to a private Copyright 2010-2017 Obihai Technology, Inc.
  • Page 98: Line Seize

    Typically the state-agent will shorten the subscription interval with the phone who is owning the SCA in order to detect quickly if the phone has crashed or encountered network issues, etc. What Happens When a Call Appearance Key is Pressed Copyright 2010-2017 Obihai Technology, Inc.
  • Page 99: Buddy List

    This user has stepped away from the computer and may take a while to return Away Status (optional): An arbitrary text string usually entered by the user to provide further details of his current Having my lunch break, Back at 1 pm, etc. state. For example: Copyright 2010-2017 Obihai Technology, Inc.
  • Page 100 (using the soft key respectively); all the status values are available to all SP services and are stored as a comma separated list of phrases in the parameter MyStatusHistory PhoneSettings:: Copyright 2010-2017 Obihai Technology, Inc.
  • Page 101: Expanded Buddy List And Groups

    You can configure a feature key with the function to monitor the presence of a buddy in a buddy list. Each presence monitor key monitors exactly one buddy. You can configure as many Presence Monitor keys Copyright 2010-2017 Obihai Technology, Inc.
  • Page 102: Call Recording Controls

    BYE request is displayed in a separate pop up window at the end of the call. There is no configuration for this feature. BroadSoft Call Center Features (SIP only.) This is a suite of features to support call center applications with a BroadSoft soft-switch. Disposition Code Copyright 2010-2017 Obihai Technology, Inc.
  • Page 103: Customer Originated Call Trace

    SP service, right after the first successful registration with the SIP Proxy Server. The expires value of this subscription can be set with the parameter ITSP Profile – SIP – Feature X_BWHotelingSubscribeExpires Configuration:: Copyright 2010-2017 Obihai Technology, Inc.
  • Page 104: Emergency Calls

    OBi1000 after a series of redirections, it may include a history of all the diversion headers (with the latest one appearing first). The OBi1000 will show the call diversion history in the call item of the Calls App, if available. There is no configuration for this feature. BroadSoft AS-Feature-Event Features Copyright 2010-2017 Obihai Technology, Inc.
  • Page 105: Call Forward All

    The only way of access from the phone is by going through the Net Services app. The phone allows the user to get and change the setting of this feature on the server; the setting is submitted to the server with a subscribe request and stored on the server. Call Forward No Answer Copyright 2010-2017 Obihai Technology, Inc.
  • Page 106: Do Not Disturb

    GUI (invoked by pressing and holding down the feature key), or some other means provided by the Soft Switch, such as a web portal for agents. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 107: Security Classification

    {sip-userid} is the SIP Account User ID that is used for SIP Registration on the same SP service, and {sip-domain} is the domain name that is used for SIP Registration on the same SP service. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 108: Network Directories

    There are 4 soft keys available on the network directory results screen: Call Call the highlighted entry Search Enter one or more search fields and press the OK/Enter key to start the search Prev Page Display the previous page of results Copyright 2010-2017 Obihai Technology, Inc.
  • Page 109: Other Pbx Platforms

    The 1-based index of the first result to return by the server; the implied start index is 1 if not specified start Copyright 2010-2017 Obihai Technology, Inc.
  • Page 110: Replace The Built-In Phone Book With A Network Directory

    The user can view and change the following settings of this feature from the phone GUI: • Enable/Disable this feature • Change the Remote Phone Number – note: there is a limitation at present where the number cannot be removed via XSI. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 111: Simultaneous Ring

    Call Forward No Answer To make this function available on the phone, you must enable the option SPn Service – Network Provided CallForwardNoAnswer Services:: . This feature is similar to the CallForwardOnNoAnswer feature that is available Copyright 2010-2017 Obihai Technology, Inc.
  • Page 112: Anonymous Call

    Disturb. Set the Service parameter of the key Feature Key: Define a feature key with the function to the SP service that provides this feature The user can enable/disable this feature from the GUI; the setting is stored on the server. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 113: Built-In Phone Apps

    The ordering and the list of items to include in the 2 level menu are configurable (with the NetServicesMenu1 parameter) Net Dir App The usage depending on the app provider. There are two options: 1. BroadSoft Directory Copyright 2010-2017 Obihai Technology, Inc.
  • Page 114 2. LDAP Copyright 2010-2017 Obihai Technology, Inc.
  • Page 115: Phone Gui Customization

    Key Tabs are disabled, the phone shows no line key tabs in the status bar and one and only one page of VLKs can be used (VLK 1-6 on OBi1062 and VLK 1-3 on OBi1032); the status icons are also flushed to the right corner. To handle...
  • Page 116: Soft Key Set Customization

    Some soft keys that have an on/off (or enabled/disabled or yes/no) state offer a label1 and icon1 option that is used when the underlying function is in the “on” state. The softkey also supports label2, label3, icon2, and icon3 options for to cover the 4 states of an ACD Agent. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 117: Assignable Soft Keys

    ITSP for binding a device to the login username Call Return (Last) Call Return LDAP LDAP directory search ldap Redial Last Number Redial Lines Show a list of available of lines on lines screen to choose from to make a new Copyright 2010-2017 Obihai Technology, Inc.
  • Page 118 For example: send=Ass1234U”Enter Passcode”5678 It is aceeptable to have the send attribute specified in a speed dial without a number (e.g. sd;send=1234#;label=Par k). In this case the speed dial can Copyright 2010-2017 Obihai Technology, Inc.
  • Page 119 Reject the selected incoming (and Ringing reject Reject ringing) call as busy. Start a new call with dialtone Ringing, newcall New Call CallConnected CallHolding, CallConnectin CallParked, SCAInUse End the selected call CallConnectin CallConnected XferTrying XferRinging XferConnecte ConfTrying ConfRinging ConfConnecte Copyright 2010-2017 Obihai Technology, Inc.
  • Page 120 Invoke conference bridge control app cbctl Peer is not a CallConnected Bridge to view who’s on the bridge or to apply conference certain control on the selected Copyright 2010-2017 Obihai Technology, Inc.
  • Page 121 Monitor Monitor a (share) call that is (Share) Call SCAInUse monitor connected at another phone is not connected Pickup Pickup a parked call at the highlighted No call CallParked pickup Copyright 2010-2017 Obihai Technology, Inc.
  • Page 122 SPn Service Sync Disabled ns.dir Load/view/refresh the network Feature NetServices directory on the selected SPn Service Sync Disabled CLog ns.clog Load/view/refresh the network call Feature NetServices history on the selected SPn Service Sync Disabled Copyright 2010-2017 Obihai Technology, Inc.
  • Page 123: Soft Key Set Parameters

    CallConnected Call is connected. Default is IP Phone – Soft Keys – end,hold,conf,transfer,privhold,park,dispcode,escalat Soft Key Sets e,trace,rec.start,rec.stop,rec.pause,rec.resume,tomob CallHolding IP Phone – Soft Keys – Call is holding. Default is Soft Key Sets end,resume,add2conf,conf,transfer,park,dispcode,escal ate,trace,rec.start,rec.stop,rec.pause,rec.resume,tom Copyright 2010-2017 Obihai Technology, Inc.
  • Page 124: Line Key Window Customization

    The information shown on Text Line 1 and 2 can be customized for the following feature key functions: Call Appearance, Speed Dial, Busy Lamp Field, and Action URL, with the following parameters: Parameter Group Parameter Description Copyright 2010-2017 Obihai Technology, Inc.
  • Page 125 TextLine2 IP Phone – Feature Key Textual information to show on Text Line 2 area Customization – Group n Icon IP Phone – Feature Key Internal icon path or HTTP/HTTPS url Customization – Group n Copyright 2010-2017 Obihai Technology, Inc.
  • Page 126 1,2,3 for OBi1032/2062/2162 1,2,3,4,5,6 for OBi1062/2182 Line Key Page. Expands into: 1,2 for OBi1022 1,2,3,4 for OBi1032/1062 and OBi2000 Series Line Key ID. Expands into: 1 – 10 for OBi1022 1 – 12 for OBi1032/2062/2162 1 – 24 for OBi1062/2182...
  • Page 127: Example

    Customization – Call Appearance TextLine2 IP Phone – Feature Key @text1 Customization – Call Appearance TextLine1InCall IP Phone – Feature Key -- @text2 Customization – Call Appearance TextLine2InCall IP Phone – Feature Key @text1 Customization – Call Appearance Copyright 2010-2017 Obihai Technology, Inc.
  • Page 128: Customizable Screen Elements

    (across the top of the <date format="@timeFmt"/> <Notifications list="*"> screen). The value must be a valid <dnd icon="$eval($state==Enabled? <TitleBarStyle> XML as shown in the {http://abc.com/dnd.png}:)"/> </Notifications> example on the right. </TitleBarStyle> The height and width Copyright 2010-2017 Obihai Technology, Inc.
  • Page 129: Using $Macros And @Macros Inside Xml

    "1" for one and only one of the elements. For example: only one of the following elements, <span display="$eval({$pic}==)"> and <span display="$eval({$pic!}=)">, will be shown. Similarly for <span display="$eval($nitems&lt;2)"> and <span display="eval($nitems&gt;1)">. The following table lists the operators that are currently available. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 130 (??me) returns "me" or OP2 (unchanged) otherwise && Syntax: OP1&&OP2 (3&&7) returns "1" Logical AND the numerical value of OP1 and OP2, (3&&8) returns "1" and returns "1" if true, or "0" otherwise. OP1 and Copyright 2010-2017 Obihai Technology, Inc.
  • Page 131 Logical negation of the numerical value of OP1. (!0) reurns "1" OP1 is converted to signed integer before the logical negation Syntax: OP1%OP2 (15%3) returns "0" Return the remainder of dividing the numerical (17%3) returns "2" Copyright 2010-2017 Obihai Technology, Inc.
  • Page 132: Color And Color Pattern

    <text xpos="110" ypos="82" size="18" width="120" resize="10" wrap="0" font="@gfont" textcolor="0x050505">$number</text> <text xpos="110" ypos="106" size="18" width="120" resize="10" wrap="0" font="@gfont" textcolor="0x050505">$cid.org</text> </span> <!-- Show this if nitems > 1 (fits 2 items on screen) --> <span ypos="32" display="$eval($nitems&gt;1)"> Copyright 2010-2017 Obihai Technology, Inc.
  • Page 133: Elements In A Xml

    “0xffffff”. If hlcolor is not specified, it takes the same value as bgcolor. The height attribute determines the height (in number of pixels) of the item on screen. The maximum value is 204 for OBi1032/1062, 171 for OBi1022, and 360 for OBi2000 Series <span>...
  • Page 134: Attributes In A Xml

    Width of the bounding rectangle in pixels xpos <span>, <text>, <img> x-offset from the upper left corner of the parent bounding rectangle in pixels ypos <span>, <text>, <img> y-offset from the upper left corner of the parent bounding rectangle in Copyright 2010-2017 Obihai Technology, Inc.
  • Page 135 = Day in number (1 – 31) y = Year in full number, such as 2015 y2 = Year in 2 digits, such as 15 Other characters such as ‘/’ are treated as separator Copyright 2010-2017 Obihai Technology, Inc.
  • Page 136: Macors That Can Be Used Inside A

    <ScreenItem>; usually item, such as 1/2, 2/2, etc. This is only applicable if the call item is grouped inside a <text> element under a Line Key that controls multiple call appearances. It is an empty Copyright 2010-2017 Obihai Technology, Inc.
  • Page 137 $pic2 Anywhere inside a Whereas $pic is a property of the first conferee, this is the corresponding $pic2 <ScreenItem>; usually property for the second and third conferee respectively used inside a src Copyright 2010-2017 Obihai Technology, Inc.
  • Page 138: Linekeystyles> Xml

    <style> with the id "default". ypos, font, size, textcolor, border, If an attribute is not specified in <style>, it inherits the value from the bordercolor, hidden same attribute in <LineKeyStyles> Copyright 2010-2017 Obihai Technology, Inc.
  • Page 139: Attributes In A Xml

    The ID to refer to this style in the Style field of a Line Key parameter font <LineKeyStyles>, Text font (the value can only be "@gfont" or "@gfont-bold") <style>, <label> size <LineKeyStyles>, Text size <style>, <label> textcolor <LineKeyStyles>, Text color Copyright 2010-2017 Obihai Technology, Inc.
  • Page 140: Macors That Can Be Used In A Xml

    In this example, the defaut line key <style> doubles the normal size of the Line Key Tiles which is suitable for an OBi1032 which has just three Hard Line Keys. Below are the parameter settings and a screen shot of the result.
  • Page 141: Softkeystyles> Xml

    0 to many Soft Keys. By default all Soft Keys width, height, xpos, reference the <style> with the id "default" if the style attribute is not ypos, font, size, specified in the soft key definition. textcolor, border, Copyright 2010-2017 Obihai Technology, Inc.
  • Page 142: Attributes In A Xml

    <SoftKeyStyles>, The color of the border to draw around the bounding box of the widget <style> <icon> Overwrites the soft key icon’s file path or URL Copyright 2010-2017 Obihai Technology, Inc.
  • Page 143: Macors That Can Be Used In A Xml

    URLs. Here are the parameter settings and a screen shot of the result. Home Soft Key Sets redial;icon=dial.png;style=1,cfa;icon=cfwd.png;icon1=cfwd.png;style=1,dnd; icon=dnd_tb.png;icon2=dnd_tb.png;style=1,lines;icon=conf.png;style="1" SoftKeyStyles Screen Item Customization <SoftKeyStyles> <style id='1'> <label hidden='1'/> <icon width='120' align='center'/> </style> </SoftKeyStyles> Copyright 2010-2017 Obihai Technology, Inc.
  • Page 144: Main Menu Customization

    Each item occupies a small rectangular area with the same pixel dimension that is represented by the cell-width and cell-height attributes of Copyright 2010-2017 Obihai Technology, Inc.
  • Page 145: Mainmenu> Xml

    URL via the icon attribute icon2: an additional general purpose icon. You may specify an internal path of the picture file to use, or a http/https URL via the icon2 attribute Copyright 2010-2017 Obihai Technology, Inc.
  • Page 146: Elements In

    Four constants to substitute respectively @c1 - @c4 in item and style attributes. For example the value can be set to the common root path of the image files to be used as icons for all menu items, Copyright 2010-2017 Obihai Technology, Inc.
  • Page 147: Attributes In Element

    An instance of the Call Park Monitor function similar to a feature key with function = Call Park Monitor; the name, number, and service attributes in the <item> have Copyright 2010-2017 Obihai Technology, Inc.
  • Page 148 <item> have the same meaning of those of the feature key bgimg Optional. Internal path or URL of a background picture bgimg (default value) Tomas Ulrik Colorful phone-book calls call-history buddy prod-info settings preferences Copyright 2010-2017 Obihai Technology, Inc.
  • Page 149 Otherwise it is hidden. Combining this with the default background image for calls, it will look like theses when there are 2 active calls and when there are none, respectively: Copyright 2010-2017 Obihai Technology, Inc.
  • Page 150 Shown when blf state is holding Shown when blf state is parked (i.e., a call is parked against the monitored extension) acturl Tomas Ulrik Colorful icon2 Optional. The default is (empty) except for the following item ids: icon2 (default) Description Copyright 2010-2017 Obihai Technology, Inc.
  • Page 151: Macros Available In

    <item id='prod-info' bgimg='prod-info.png' label='Product Info'/> <item id='settings' bgimg='settings.png' label='Settings'/> <item id='preferences' bgimg='preference.png' label='Preferences'/> <item id='buddy' bgimg='buddy.png' label='Buddy List'/> <item id='netcf' bgimg='net-services.png' label='Net Services'/> <item id='netdir' bgimg='net-dir.png' label='Net Dir'/> <item id='sd' bgimg='spd.png' number='14089991001' service='sp1' name='Angelina Jolie' label='Angelina'/> Copyright 2010-2017 Obihai Technology, Inc.
  • Page 152: Mainmenuitemstyles> Xml

    The value is internal file path or http/https URL of the primary icon to display on the tile Optional: hidden, xpos, ypos, width, height, align, valign, resize, aspect <icon2> Required: The value is internal file path or http/https URL of the Copyright 2010-2017 Obihai Technology, Inc.
  • Page 153: Attributes In

    <label>, <label2> Specifies whether to wrap ('1") or truncate ("0") the text when it cannot fit the label's bounding box resize <label>, <label2>, <icon>, For labels, specifies whether to resize ("1") or not ("0") the Copyright 2010-2017 Obihai Technology, Inc.
  • Page 154: Macros Available In

    <style> and all its childs The internal path that stores the buddy’s picture if the <item> referencing the <style> has the attribute id="pres". $item.buddy.name <style> and all its childs The buddy’s name if the <item> referencing the <style> has Copyright 2010-2017 Obihai Technology, Inc.
  • Page 155: Example

    Tomáš Skin. The fourth picture shows the result when there are 2 Line Key Tabs, with the Ulrik Skin. Skin is configured Skin User Preferences User by setting the parameter, number of Line Key Tabs (2 or 4) is configured by setting the Copyright 2010-2017 Obihai Technology, Inc.
  • Page 156 = x pixel-position to start rendering the text ypos = y pixel-position to start rendering the text Variables/Constants used: $prod.obinumber = the 9-digit OBi number of the phone $prod.mac = the MAC address of the phone Copyright 2010-2017 Obihai Technology, Inc.
  • Page 157: Titlebarstyle> Attributes

    $sys.hidetabs = 0 if the LineKeyTabs option is enabled, or 1 otherwise $sys.ntabs = the value of LineKeyMaxTabs (2 or 4) @dispW= the pixel width of the LCD: 480 for OBi1032/1062, 320 for OBi1022, and 800 for OBi2000 Series @lkpg1 = the x-position of Line Key Tab 1 @lkpg1v2 = the skin-dependant x-position of Line Key Tab 1 <my-trash>...
  • Page 158: The Element

    Bluetooth headset audio is active handset: Handset audio is active speaker: Speakephone audio is active headset: Headset audio is active rj9: RJ9 headset audio is active trs: 3.5mm Headset audio is active Copyright 2010-2017 Obihai Technology, Inc.
  • Page 159 USB Keyboard status: Shows a keyboard icon to = no USB keyboard connected indicate that a USB keyboard is connected to the = USB keyboard connected phone Note: $state is alias ofr $sys.usbkb $sys.usbkbcaps = if keyboard caps-lock is on, or otherwise Copyright 2010-2017 Obihai Technology, Inc.
  • Page 160: The Element

    Specifies the background color as a gradient color that varies from white to red vertically (default) <tab-style> Attributes used: valign: Align the text in each tab (the tab number) to the top edge of the bounding box Copyright 2010-2017 Obihai Technology, Inc.
  • Page 161: Trigger Update Of A Notification Icon With An Obihaiipphoneexecute Xml

    The second <ExecuteItem> tells the phone to redraw the icon with the reference refresh-id mytrash. Refer this article for more information on writing Obihai IP Phone XML and how to push the XML to the phone. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 162: Led Pattern Customization

    IP Phone – LED Settings – SCA State PeerRinging IP Phone – LED Settings – SCA State Connected IP Phone – LED Settings – SCA State Held IP Phone – LED Settings – SCA State Copyright 2010-2017 Obihai Technology, Inc.
  • Page 163: Blf State

    For feature key that is assigned the function Presence Monitor. The LED reflects the presence of the monitored entity. Offline IP Phone – LED Settings – Presence State Online IP Phone – LED Settings – ACD Agent State Copyright 2010-2017 Obihai Technology, Inc.
  • Page 164: Feature Key State

    LED pattern when the feature is enabled. Feature Key State ExecFilterDisabled For feature key assigned the function Exec Filter On/Off. This is IP Phone – LED Settings – the LED pattern when the feature is enabled. Feature Key State Copyright 2010-2017 Obihai Technology, Inc.
  • Page 165: Vmwi Lamp

    IP Phone – LED Settings – Describe whether the LED should blink with the given pattern when the phone is ringing. Note that if the pattern is blank, VMWI Lamp ringing will not affect the VMWI Lamp GUI Menu Customization Copyright 2010-2017 Obihai Technology, Inc.
  • Page 166: Preferences Menu

    – GUI Menus Main Menu MainMenu1 IP Phone – Phone Settings For example: – GUI Menus phone-book;Contacts,calls;Current Calls;call- history;Call History Net Services Menu NetServicesMenu1 IP Phone – Phone Settings For example: – GUI Menus bci;Anonymous Call,dnd,cfa,cfb,cfna,acd,bwanw, rmoff,simring Copyright 2010-2017 Obihai Technology, Inc.
  • Page 167: Main Menu Item Ids

    Enter Call Disposition Code exec Executive Call Filter xass Executive Assistance hotel Hoteling clog Network Call History Network Directory rmoff Remote Office secClass Security Class simring Simultaneous Ring Preferences Menu Item IDs Preferences Default Description Copyright 2010-2017 Obihai Technology, Inc.
  • Page 168 Enhanced Dialer Enhanced Dialer (show matching list of recently dialed numbers while dialing) dlkt Default Line Key Tab Default Line Key Tab (the Line Key Tab to fallback to after a configurable duration of idle time) Copyright 2010-2017 Obihai Technology, Inc.
  • Page 169: Settings Menu Item Ids

    Otherwise, if the Cache-Control header is present with the max-age attribute specified, the data file is cached for the number of seconds as specified in the max- Copyright 2010-2017 Obihai Technology, Inc.
  • Page 170: Phone Customization Data

    480Wx272H. JPEG, PNG, BMP, and GIF files are the acceptable file formats. All the pictures stored in this folder will be made available to be selected by the user as background picture (i.e. wall paper) on the phone screen. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 171: Text Fonts Customization

    LibreCaslonText-Italic.ttf opensans OpenSans-Regular.ttf opensans-bold OpenSans-Bold.ttf opensans-italic OpenSans-Italic.ttf opensans-bold-italic OpenSans-BoldItalic.ttf quattrocento Quattrocento-Regular.ttf quattrocento-bold Quattrocento-Bold.ttf terminal-dosis TerminalDosis-Regular.ttf terminal-dosis-bold TerminalDosis-Bold.ttf In addtiion, there are four more built-in fonts: ptsans, ptsans-bold ptsans-italic, ptsans-bold-italic, Font Sample aleo aleo-bold aleo-bold- italic Copyright 2010-2017 Obihai Technology, Inc.
  • Page 172 -bold terminal- dosis terminal- dosis-bold ptsans ptsans-italic ptsans-bold ptsans-bold- italic Copyright 2010-2017 Obihai Technology, Inc.
  • Page 173: Language Customization With Dictionary Files

    Conferencia" mode="i"/> <item key="disp-code" value="Código Disposición" mode="i"/> <item key="DND" value="No Molestar" mode="i"/> <item key="DNR" value="No Suena" mode="i"/> <item key="HOLD" value="En Espera" mode="i"/> <item key="hoteling" value="Hoteling" mode="i"/> <item key="acd" value="ACD Agent State" mode="i"/> Copyright 2010-2017 Obihai Technology, Inc.
  • Page 174 Headset" value="RJ9 Auricular" mode="i"/> <item key="3.5mm Headset" value="3.5mm Auricular" mode="i"/> <item key="BT Headset" value="BT Auricular" mode="i"/> <!-- Call Forward --> <item key="Destination Number" value="Número de Destino" mode="i"/> <item key="Voice Service" value="Servicio de Voz" mode="i"/> Copyright 2010-2017 Obihai Technology, Inc.
  • Page 175 Config. del Admin." mode="i"/> <item key="Unlock Admin Settings" value="Desbloquear Ajustes del Admin." mode="i"/> <!-- Network --> <item key="Network Settings" value="Ajustes de la Red" mode="i"/> <item key="Addressing Type" value="Addressing Type" mode="i"/> <item key="IP Address" value="Direccion IP" mode="i"/> Copyright 2010-2017 Obihai Technology, Inc.
  • Page 176 <item key="Reboot" value="Reiniciar" mode="i"/> <item key="End" value="Final" mode="i"/> <item key="Hold" value="Espera" mode="i"/> <item key="Resume" value="Resumen" mode="i"/> <item key="Add to Conf" value="Unir a Conferencia" mode="i"/> <item key="Conference" value="Conferencia" mode="i"/> <item key="Park" value="Aparcar" mode="i"/> Copyright 2010-2017 Obihai Technology, Inc.
  • Page 177 <item key="Cancel" value="Cancelar" mode="i"/> <item key="Paste" value="Pasar" mode="i"/> <item key="New Folder" value="Nuevo Folder" mode="i"/> <item key="Close" value="Cerrar" mode="i"/> <item key="OK" value="OK" mode="i"/> <item key="Replace" value="Reemplazar" mode="i"/> <item key="Add As New" value="Agragar Como Nuevo" mode="i"/> Copyright 2010-2017 Obihai Technology, Inc.
  • Page 178 Extensión" mode="i"/> <item key="Disposition Code" value="Disposicion de Codigo" mode="i"/> <item key="Forward All Number" value="Remitir Todo Número" mode="i"/> <item key="Unavailable Reason Code" value="No disponible Código de Motivo" mode="i"/> <item key="Enter Query" value="Entrar Consulta" mode="i"/> Copyright 2010-2017 Obihai Technology, Inc.
  • Page 179 Conference Bridge failed" value="Llamada al Puente Conferencia fallado" mode="i"/> <item key="Conference Bridge ended unexpectedly" value="Puente Conferencia terminó inesperadamente" mode="i"/> <item key="Last Call Total Charges" value="Gasto Total de la ultima llamada" mode="i"/> <!-- Network directory --> Copyright 2010-2017 Obihai Technology, Inc.
  • Page 180 “Preferences/Language” in the phone GUI. On the phone configuration web page the value for the Language parameter (under User Settings – User Preferences) is just a string and must be set to one of the available language names. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 181: Phone Book Pictures

    If the MD5 checksum of the downloaded data packages does not match the configured value, the package will be dropped and no data update will be performed. Otherwise, the phone install the downloaded data files into the corresponding folders and then restarts (warm reboot). Copyright 2010-2017 Obihai Technology, Inc.
  • Page 182: Internal Data Storage Paths For User Preferences Settings

    Try Both Username DownloadURL (Optional) Username for authentication if uses the scheme http:// or https:// Password DownloadURL (Optional) Password for authentication if uses the scheme http:// or https:// Internal Data Storage Paths for User Preferences Settings Copyright 2010-2017 Obihai Technology, Inc.
  • Page 183 URL. If a URL is specified in the value, it must start with http:// https:// the phone will download Copyright 2010-2017 Obihai Technology, Inc.
  • Page 184 If a parameter value is to specify the filename of an internally stored data file, the full internal path must be specified. For examples: BackgrounPicture User Settings – User Preferences /scratch/phone/backgnd/CherryBlossom.png DefaultRingtone /data/ringtones/Office A.wav User Settings – User Preferences Copyright 2010-2017 Obihai Technology, Inc.
  • Page 185: Obiphone Xml Applications

    As it is typically not feasible for the App Server to send HTTP requests to the phone, OBi1000 only accepts server pushed XML via SIP NOTIFY requests sent to it over one of the enabled SPn service channel. The SIP NOTIFY must have the Event: obixml with the Content-Type: application/obixml. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 186: Xml App Development

    XML App Development Please refer to the document “OBiPhone XML Application Development Guide” for details on OBiPhone XML syntaxes and and app samples. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 187: Auto Attendant

    3 on the AA menu. Note that $1 can only be used as part of a substitution element in the digit map; it must not be used for matching elements since its value is unknown. Automated Attendant: AA Option Default AA Announcement What Happens Next: Press 1 to continue this call. Ring the phone Copyright 2010-2017 Obihai Technology, Inc.
  • Page 188: User Recorded Prompts

    Prompt Be Played Welcome Welcome to OBi Attendant Once, at the beginning when the AA starts InvalidPin Invalid PIN After user enters an invalid PIN EnterPin Enter PIN Prompts user to enter a valid PIN Copyright 2010-2017 Obihai Technology, Inc.
  • Page 189 Prompts user to enter a valid number after option 2 or option 3 is selected by the user Thank you for choosing Obihai When user presses * or # key to leave the AA Technology. Goodbye. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 190: Voice Gateways And Trunk Groups

    Only trunks can be added to a trunk group. These include: PP, SP1 – SP6, BT, VG1, VG2, …, VG8, TG1, TG2, … TG4. Note that a TG may include another TG (that is, TG can be recursive). However, you must make sure this does not result in infinite recursion. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 191: Ldap

    IP Phone – LDAP – complete and valid LDAP search filter. For example: Search Parameters (|(objectclass=contact)(objectclass=person)) Default value is: (objectclass=*) DefaultSearchFilter IP Phone – LDAP – Specifies how many resuts to display on screen per page. Search Parameters Copyright 2010-2017 Obihai Technology, Inc.
  • Page 192 SASL Authentication Choices are Parameters Disabled Plain Default is Disabled SASL_AuthCID The authentication ID for SASL authentication. The format of this ID depends IP Phone – LDAP – on the actual SASL mechanism used. Search Parameters Copyright 2010-2017 Obihai Technology, Inc.
  • Page 193: Client Authentication

    LDAP soft key in the 4 position, redial,cfwd,dnd,ldap Search Fields By default, the phone presents the following seach fields to the user: Last Name (sn) First Name (givenName) Tel Num (telephoneNumber) Copyright 2010-2017 Obihai Technology, Inc.
  • Page 194: Result Fields

    Refer to the LDAP setup parameter table for the syntax of this parameter. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 195: Sorting Of Results

    Contacts from the Main Menu, it launches the LDAP feature instead of the built-in (local) phone book. Below is the configuration for this: ActionURL phone://netdir User Preferences – Phone Book Settings VoiceService LDAP Phone Settings – Network Directory Copyright 2010-2017 Obihai Technology, Inc.
  • Page 196: Ip Phone Settings

    The user may also dial a Line’s access code before the destination number. The default service route access codes are defined as: • ** 1 for SP1 • ** 2 for SP2 • ** 3 for SP3 • ** 4 for SP4 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 197: Network Directory

    Line Keys This group is used for the configuration of the 24 (12 on the OBi1032) (Virtual) Line Keys as Feature Keys Programmable Keys This group is used for the configuration of the 8 Programmable Keys as Feature Keys...
  • Page 198: Side Car 1 And Side Car 2

    Side Car 1 and Side Car 2 Each group is used for the configuration of the 16 Side Car keys as Feature Keys Copyright 2010-2017 Obihai Technology, Inc.
  • Page 199: Audio Codec Profiles

    For codecs with the same priority setting, the codec appears first on the codec profile web page will be considered as higher priority. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 200: Tone Patterns

    Field - 3/4/5/6 share the same definition, and each field describes one single cadence segment. Together 4 fields form a macro-segment, which will be repeated until tone playback expires. The expression is a string of numeric values with the special notation '/', '(', ')' and ','. It has a complete format as below: Copyright 2010-2017 Obihai Technology, Inc.
  • Page 201: Tone Examples

    2 seconds, then followed by 1.5 seconds silence. The cadence operates repeatedly for 4 seconds. Tone Examples: With these examples, we will show the interpretation of a few common tone patterns: Dial Tone: DIAL, "350-18,440-18" Copyright 2010-2017 Obihai Technology, Inc.
  • Page 202: Stutter Tone

    Stutter dial tone is generated from a mixture of two frequency components: 350 Hz at -18 dBm and 440 Hz at -18 dBm. The expiration time is exact 10 seconds. It has two cadence segments. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 203 The first segment: includes only one on-off sections, on 0.1 second and off 0.1 second, and on-off repeats for 0.6 second. ▪ The second segment: include one on-off section, and has infinite repeating time and infinite tone active time. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 204: Ringtones And Ring Patterns

    Others: Normal ring active time (up to 3 decimated digits) off_0/1/2/3: The ring inactive time in seconds ▪ Negative value: Not allowed ▪ No value: Infinite ring inactive time ▪ Others: Normal ring inactive time (up to 3 decimated digits) Example: 4(.3+2.34,2+1.5) Copyright 2010-2017 Obihai Technology, Inc.
  • Page 205 The above example illustrates a ringing tone comprised of two segments. Ringing is active for 0.3 seconds, followed by 2.34 seconds of silence, then ringing for 2 seconds, and followed by 1.5 seconds of silence. The above cadence operates repeatedly for 4 seconds. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 206: Star Code Profiles

    $LBP1 = Loopback RTP packets once in the next call $CDM1 = Codecs to enable in the next call (temporarily overriding any codec preferences in device configuration). Each bit of its value represents one audio codec: Copyright 2010-2017 Obihai Technology, Inc.
  • Page 207: Star Code Script Actions (Act)

    = a descriptive name of the function of this star code, such as Call Forward Unconditional ▪ action1, action2, … = a valid action with parameters Actions are carried out one-by-one in the order as specified in the script. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 208: Star Code Script Examples

    *03, Request peer device to loopback media in the next outbound call *04, Request peer device to loopback RTP packets in the next outbound call *05, Tell device to periodically redial the last called number until the called party rings or answers Copyright 2010-2017 Obihai Technology, Inc.
  • Page 209 ∞ Note: Be careful with the Speed Dial Set-Up as this will conflict with the Speed Dials set-up on the OBiTALK portal. The Speed Dials that are set-up on the OBiTALK portal will always overwrite anything set-up via the phone connected to the OBi. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 210: User Settings

    8, and the user can dial 8*14085551234 to call 14085551234 using the given gateway. Note: At the present time, only gateways that are accessed with an OBi number can be used this way. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 211: Call Routing

    In this document we refer to the Phone and AA as endpoints. Like the trunks, each endpoint is represented by a 2-letter abbreviation and a 1-based instance identifier: PH = The Phone AA = The Auto Attendant Copyright 2010-2017 Obihai Technology, Inc.
  • Page 212: Call Routing - The Obi Way

    Note that the curly braces may be omitted if there is only one rule in the route. The OR operator is NOT part of the parameter syntax; it is used here to separate alternative values only. A rule has the following format: Copyright 2010-2017 Obihai Technology, Inc.
  • Page 213 Caller-list in a peering object can be empty. It implies the caller-list @|?, meaning any caller number including anonymous. The succeeding ‘>’ cannot be omitted if caller-list is empty but not the callee-list More notes on the arg, cid, and target objects: Copyright 2010-2017 Obihai Technology, Inc.
  • Page 214: Outbound Call Route Configuration

    Note that the curly braces may be omitted if there is only one rule in the route. The OR operator is NOT part of the parameter syntax; it is used here to separate alternative values only. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 215 OutboundCallRoute Remember this fact when crafting your own OutboundCallRoute Examples: {SP1} {:SP1} {@:Sp1} (all equivalent) This rule says: Make all calls using SP1 Service, without any caller-id spoofing or digit transformation Copyright 2010-2017 Obihai Technology, Inc.
  • Page 216 . Remove the **8 prefix from the resulting number before making the call Use the OBiTALK Service to call all numbers that start with **9 and subsequent digits matching OBiTALK DigitMap Service’s . Remove the **9 prefix from the resulting number before making the call Copyright 2010-2017 Obihai Technology, Inc.
  • Page 217: Digit Map Configuration

    The “lowercase x” – x – wildcard matches any digit from 0-9 It is important to note that x is CASE SENSITIVE. Example: If we consider phone numbers within a specific area code, all of the same length, we can write a rule Copyright 2010-2017 Obihai Technology, Inc.
  • Page 218 London number range where each number can take the form of 020 3xxx xxxx, 020 7xxx xxxx or 020 8xxx xxxx – while we could write each of these as individual rules, it is tidier to represent them as follows: 020 [378]xxx xxxx Copyright 2010-2017 Obihai Technology, Inc.
  • Page 219 If we want to add to the start of a dialed number, for example to add 02 to the start of an 8-digit number, we would write: <02>xxxx xxxx or <:02>xxxx xxxx S, S0, S1 … S9 Digit Timer Copyright 2010-2017 Obihai Technology, Inc.
  • Page 220 Let’s consider one of the OBi’s default digit map rules that directs a call preceeded by **2 to SP2. We want to take all the digits after **2 to be matched with SP2’s digit map. To do this we write our rule **2(Msp2) Copyright 2010-2017 Obihai Technology, Inc.
  • Page 221 Brampton area in the UK that has 4 and 5 digit local numbers. Rather than using two rules in our digit map such as (…|xxxx|xxxxx|…) to match the local numbers, we can write a more elegant matching rule as follows: xxxxx? Copyright 2010-2017 Obihai Technology, Inc.
  • Page 222 ( ) and with each rule separated by a | bar as follows: (<1408> xxx xxxx | @. 408 890 6000 | xx.<#> | !08[47]x. | !09x.) Copyright 2010-2017 Obihai Technology, Inc.
  • Page 223: Matching Against Multiple Rules In Digit Map

    Here are some more examples: (<1408>xxx xxxx). As soon as 7 digits are entered, the DMP returns a complete Consider the simple digit map number by prepending the accumulated digits with 1408. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 224: Forcing Interdigit Timeout With The Hash/Pound (#) Key

    – cw10 = Call Waiting Tone 1-10, respectively di = Dial Tone di2 = Second Dial Tone fb = Fast Busy Tone ho = Holding Tone od = Outside Dial Tone pr = Prompt Tone Copyright 2010-2017 Obihai Technology, Inc.
  • Page 225: Change Interdigit Long Timer Dynamically After Partial Match

    <a>,<b>,<c>,<d> is a 1-3 digit pattern in the range 1–255 that identifies one byte of an IP address. The dialed number will be translated into <user-id>@<a>.<b>.<c>.<d> and <user-id>@<a>.<b>.<c>.<d>:<port> respectively. Here are some examples: 1234*192*168*15*113 maps to 1234@192.168.15.113 123456*192*168*15*180*5061 maps to 123456@192.168.15.180:5061 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 226: Administrative Features

    Backing the current configuration to restore it later (or apply it to another phone) Auto Provisioning OBiTALK Provisioning Using OBiTALK portal as the provisioning server ITSP Provisioning Using the ITSP’s provisioning system for provisioning the phones Customization Data Auto Update Copyright 2010-2017 Obihai Technology, Inc.
  • Page 227: Customization Data Package

    Periodically = Download from DownloadURL on system start, and then periodically at the interval specified in the Interval parameter Note: First download on system start will be performed after firmware update and configuration provisioning are complete Copyright 2010-2017 Obihai Technology, Inc.
  • Page 228 SRV Record Only Try Both DnsSrvPrefix Choices are: No Prefix No Prefix With Prefix Try Both Username Optional Username for authentication if URL scheme is http:// Password Optional Password for authentication if URL scheme is http:// Copyright 2010-2017 Obihai Technology, Inc.
  • Page 229: Device Web Page And Configuration Parameter Reference

    CertificateStatus Indicate if a device certificate is installed on the Installed unit CustomizationStatus Indicate if this device is a customized unit Generic OBiBT Dongle Status (VoiceService.1.X_BT.1.Stats.) Status Copyright 2010-2017 Obihai Technology, Inc.
  • Page 230: Reboot Reason Codes

    Call Status of each call is only available during the lifetime of the call. It is removed as soon as the call is ended. The Call Status page shows a number of running call statistics and state parameters for each active call currently in progress. The following information and statistics are shown for each call: Copyright 2010-2017 Obihai Technology, Inc.
  • Page 231: Sp Services Statistics

    Total RTP packets sent on this line PacketsReceived Total RTP packets received on this line BytesSent RTP payload bytes sent for this line BytesReceived RTP payload bytes received for this line PacketsLost Number of RTP packets lost on this line Copyright 2010-2017 Obihai Technology, Inc.
  • Page 232: Obiwifi Configuration Web Page And Parameter Reference

    If your AP does not show up as a listed device on this page, e.g. perhaps its SSID is not broadcast, you may enter its SSID and security credentials manually by clicking the “Add a Network” link. The “Manage Networks” link takes you back to Copyright 2010-2017 Obihai Technology, Inc.
  • Page 233: System Management Parameters

    DNSServer2 will be tried first, whichever is specified, and then the ones obtained from the DHCP Server if available DNSServer2 IP address of the second DNS server to use, in addition to the ones obtained Copyright 2010-2017 Obihai Technology, Inc.
  • Page 234 Hostname or IP address of the second NTP server LocalTimeZone Local time zone. Available choices are: GMT-08:00 GMT-12:00(Int'l Dateline West) GMT-11:00(Samoa) GMT-10:00(Hawaii) GMT-09:00(Alaska) GMT-08:00(Pacific Time) GMT-07:00(Mountain Time) GMT-06:00(Central Time) GMT-05:00(Eastern Time) GMT-04:00(Atlantic Time) GMT-03:30(Newfoundland) GMT-03:00(Buenos Aires,Greenland) GMT-02:00(Mid-Atlantic) GMT-01:00 GMT+00:00(London,Lisbon) GMT+01:00(Rome,Paris,Madrid) GMT+02:00(Athens,Cairo) Copyright 2010-2017 Obihai Technology, Inc.
  • Page 235 Available choices are: 0, 1, 2, 3, 4, and 5. Local DNS Records (X_LocalDNSRec.) One of 32 Local DNS Records (numbered 1 – 32). Each record is a mini script of the following format: Name=A,A,A,... where N = 1 – 32 Name=R,R,R,... Copyright 2010-2017 Obihai Technology, Inc.
  • Page 236: Auto Provisioning Parameters

    FirmwareURL System Start = Check for f/w upgrade from FirmwareURL just once on system start Periodically = Check for f/w upgrade from FirmwareURL on system start, and then periodically at the interval specified in the Copyright 2010-2017 Obihai Technology, Inc.
  • Page 237 Or a random delay of 10- 70s.. Interval When Method is set to Periodically, this is the number of seconds between download from ConfigURL. If value is 0, device downloads once only on system start (i.e., equivalent to setting Method to Copyright 2010-2017 Obihai Technology, Inc.
  • Page 238 Description Where It Can Be Used Device MAC address in upper case, such as 9CADEF000000 MACC Device MAC address in upper case with colon, such as 9C:AD:EF:00:00:00 Device MAC address lower case, such as 9c:adef000000 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 239: Zero-Touch, Massive Scale Remote Provisioning

    User Password, case sensitive user Allow user to create LCD Screenshot from the LCDScreenShot false option in Device Update page IVR (X_DeviceManagement.IVR.) Enable Enable IVR for local configuration true Password IVR access password (must be all digits) Copyright 2010-2017 Obihai Technology, Inc.
  • Page 240: Device Update Web Page

    Firmware Is Not Modified The OBi device is already running the same firmware as the No need to upgrade. one selected for update. Backup (Customized) AA User Prompts Copyright 2010-2017 Obihai Technology, Inc.
  • Page 241: Backup Configuration

    The OBi device will reboot automatically when factory reset is completed. Service Provider Configuration Parameters ITSP Profile X – General Web Page (X = A, B, C, D, E, F) The following configuration parameters are available on this page. Parameter Description Default Setting Copyright 2010-2017 Obihai Technology, Inc.
  • Page 242: Itsp Profile X - Sip Web Page (X = A, B, C, D, E, F)

    Email address to contact this service provider. EmailAddress Maximum Length = 127 characters. ITSP Profile X – SIP Web Page (X = A, B, C, D, E, F) The following configuration parameters are available on this page. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 243 TimerB Value of SIP timer B in ms 32000 TimerD Value of SIP timer D in ms 32000 TimerE Value of SIP timer E in ms TimerF Value of SIP timer F in ms 32000 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 244 X_ProcessDateHeader Enable the device to decode the DATE header sent by the true ITSP in a 200 response to its REGISTER. The DATE header specifies the current GMT time and the device can use to Copyright 2010-2017 Obihai Technology, Inc.
  • Page 245 Enable subscription to the reg event package false X_RegSubscribeExpires reg event subscription expires value 3600 X_BLFSubscribeExpires BLF subscription Expires value 3600 The signaling method to use for shared line/share call X_ShareLineMethod call-info appearances. The following choices are supported: call-info dialog;sla Copyright 2010-2017 Obihai Technology, Inc.
  • Page 246 X_UserEqPhone Enable the insertion of user=phone parameter in INVITE false Request-URI X_UseTelURI Enable the use of tel: in outbound SIP Request-URI and TO- false X_CallWaitingIndication Choices are: false Copyright 2010-2017 Obihai Technology, Inc.
  • Page 247 INVITE request X_DirectedCallPickupMethod Feature Code X_ShareLineMethod call-info X_BLFSubscribeExpires 3600 X_BWCallParkSubscribeExpires 3600 X_BW_CallCenterSubscribeExpires 3600 X_BWHotelingSubscribeExpires 3600 X_ASFeatureEventSbuscribeExpires 3600 X_LineSeizeSubscribeExpires Feature Codes (VoiceService.1.VoiceProfile.k.X_FeatureCode.), k = 1 – 6 for X = A – F, respectively DirectedCallPickup Copyright 2010-2017 Obihai Technology, Inc.
  • Page 248: Itsp Profile X - Rtp Web Page (X = A, B, C, D, E, F)

    SPn Service Enable Enable this line true X_DisplayLabel X_DisplayNumber X_ServProvProfile Select a Service Provider Profile for this service. Choices are A, or B X_RingProfile Select a Ring Profile to ring the PHONE port with for incoming Copyright 2010-2017 Obihai Technology, Inc.
  • Page 249 NOTIFY user parameter is optional; if not specieifed, the request-uri will not have a userid, and the TO header field will use the same userid as the FROM header (which is the local Copyright 2010-2017 Obihai Technology, Inc.
  • Page 250 OBiPLUS system X_AcceptResync Control whether to accept a SIP NOTIFY request with yes without authentication event=resync to trigger a reboot of the device (so it can download new f/w or configuration upon boot up). Available Copyright 2010-2017 Obihai Technology, Inc.
  • Page 251 An alternative user-id to be used in Contact header. Enter Random to let the phone generate a random one. X_EnforceRequestUserID Enforce incoming INVITE request user-id to match AuthUserName or X_ContactUserID X_ShareLine Check this option if this is a shared line false Copyright 2010-2017 Obihai Technology, Inc.
  • Page 252 Note: It is possible for a user to set this parameter from the phone using a Star Code CallForwardOnNoAnswerNumber Directory number to forward all incoming calls when the call is not answered after a period specified in CallForwardNoAnswerRingCount Copyright 2010-2017 Obihai Technology, Inc.
  • Page 253 Note: Option available on OBi200/OBi202 only X_XMPPPriority XMPP Priority to assume by this client for Google Voice when there are multiple clients using the same account. Valid values are 0 (highest) or 32-127 Note: Option available on OBi200/OBi202 only Copyright 2010-2017 Obihai Technology, Inc.
  • Page 254 Park a call (soft key) against current extension with a Feature false Access Code CallParkStatus Get notified if a call is parked against current extension. false Requires BroadSoft CallPickup Retrieve a call (soft key) parked against current extension with a false Feature Access Code Copyright 2010-2017 Obihai Technology, Inc.
  • Page 255 URL OBiStatusFormat Choose the format to report obi-status with. Value can be either obi-status obi-status or dialog-info. The former one is an obihai proprietary XML, the latter a <dialog-info> XML based on RFC4235 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 256: Obitalk Service Configuration

    The UDP or TCP port used by device to send and listens for 10000 OBiTALK messages TryMultiplePorts Enable the unit to try a few random UDP ports until it can true successfully join the OBiTALK network DisplayName Display name to identify the subscriber, for the purpose of Copyright 2010-2017 Obihai Technology, Inc.
  • Page 257 Star Code CallForwardUnconditionalNumber Directory number to forward all incoming calls on this service unconditionally. Maximum Length is 127 characters. Note: It is possible for a user to set this parameter from the Copyright 2010-2017 Obihai Technology, Inc.
  • Page 258 Note: It is possible for a user to set this parameter from the phone using a Star Code AnonymousCallEnable Enable masking of Caller-ID information for all outgoing false calls. If enabled, the called party should perceive the call as coming from an anonymous caller. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 259: Auto Attendant Web Page

    (.wav and .au files in 16-bit linear format at <N> = 1-10 8/11.025/16/22.05/32/44.1/48 kHz sample rate are supported). User<N>Length This is a read-only status parameter. It shows the space occupied by this prompt in number of milliseconds Copyright 2010-2017 Obihai Technology, Inc.
  • Page 260 (code = sp5) SP6 Service (code = sp6) OBiTALK Service (code = pp1) OBiBluetooth (code = bt1) Trunk Group 1 (code=tg1) Trunk Group 2 (code=tg2) The OBi device process the parameter by substituting of the Copyright 2010-2017 Obihai Technology, Inc.
  • Page 261: Gateways And Trunk Groups Web Page

    Voice Gateway n (VoiceService.1.X_VoiceGateway.n.), n = 1 – 8 Enable Enable this voice gateway true Name An arbitrary user-friendly name to identify this gateway (optional) AccessNumber The gateway’s OBiTALK number, including trunk information, such as: PP(ob200112334) or PP(ob300331456) Copyright 2010-2017 Obihai Technology, Inc.
  • Page 262: Obibluetooth Web Page

    CallOnHoldRing The ring pattern to use to ring a phone port to remind holding call on this service DirectoryNumber Informational only. The PSTN number associated with this service Calling Features (VoiceService.1.X_BT.1.CallingFeatures.) CallForwardUnconditionalEnable false Copyright 2010-2017 Obihai Technology, Inc.
  • Page 263: Ip Phone Settings

    {***:aa2}, service to make this call with. {(<**1:>(Msp1)):sp1}, See OBi Call Routing and Digit Map Section for a {(<**2:>(Msp2)):sp2}, description of the syntaxes to specify this {(<**3:>(Msp3)):sp3}, parameter {(<**4:>(Msp4)):sp4}, {(<**8:>(Mbt)):bt}, Copyright 2010-2017 Obihai Technology, Inc.
  • Page 264 The OBi device process the parameter by substituting of the occurrences of pli and (Mpli) in DigitMap, OutboundCallRoute, and CallReturnDigitMaps with the corresponding code and (Mcode). ToneOnPrimaryServiceDown EnableCustomOBiPhoneXml EnableOBiPhoneXmlDownloadURL OBiPhoneXmlDownloadURL LastXmlDownloadURL LastXmlDownloadMD5 GUI Menus (VoiceService.1.Phone.GUI.Menus.) MainMenu1 phone-book,calls,call-history,prod- info,preferences,settings,buddy,net srv,netdir Copyright 2010-2017 Obihai Technology, Inc.
  • Page 265 Headset Mic Gain PreferencesMenu6 headset35mmVol;3.5mm Headset Volume,headset35mmGain;3.5mm Headset Mic Gain,headsetBTVol;BT Headset Volume,headsetBTGain;BT Headset Mic Gain,EqEnable;Equalizer,AecEnable; SettingsMenu1 net;Network,wifi;WiFi,bt;Bluetooth, obiline;OBiLine,flash;Storage,ringfile ;Ringtones,pkeys;Programmable Keys SettingsMenu2 lkeys;Line Keys,sidecar1;Side Car 1,sidecar2;Side Car 2,voice;Voice Services,sd99,clrcache,admin;Devic e Admin,login ProductInfoMenu1 model;Model,obinumber;OBi Number,mac;MAC Address,wfmac;WiFi MAC Copyright 2010-2017 Obihai Technology, Inc.
  • Page 266 3 party answers. In either case, the user can end the call with the second conferee by hook flashing another time and the call reverts to a 2-way call. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 267 B. If value is set to None, no star code will be recognized by OBi device. LastDialedNumber Last number dialed out on the PHONE port LastCallerNumber Last caller's number that rings the PHONE port AcceptMediaLoopback Enable the device to accept incoming media true loopback calls Copyright 2010-2017 Obihai Technology, Inc.
  • Page 268 Hanging up means either on-hook the handset while using the handset, turn off the speakerphone while using the speakerphone, or turn off the headset while using a headset. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 269: Line Keys

    Page Group n (VoiceService.1.Phone.PageGroup.n.), n = 1, 2 GroupName MulticastAddress MulticastPort FullDuplex ParticipantName AudioCodec TxPacketSize RTCPTxInterval SilenceSuppression PushToTalk Line Keys Parameter Description Default Setting Line Key n (VoiceService.1.Phone.LineKey.n.), n = 1 – 24 (12 for OBi1032) Function Service Number Name Copyright 2010-2017 Obihai Technology, Inc.
  • Page 270: Left Line Keys (Obi2000 Series Ony)

    Note: In the OBi2000 series, the 9 programmable hard keys are configured with the same parameters as the corresponding 9 programmable keys. Parameter Description Default Setting Key n (VoiceService.1.Phone.ProgKey.n.), n = 1 – 8 (8 for OBi1032/1062, 1 for OBi1022, 9 for OBi2000 Series) Function Service Number Name...
  • Page 271: Led Settings

    O1000,G1000 SCA (VoiceService.1.Phone.LED.SCA.) Seized R150,X150 Trying PeerRinging Connected Held G500,X500 PrivateHeld R500,X500 Ringing R50,X50 ServiceDown BLF (VoiceService.1.Phone.LED.BLF.) Idle CallParked R100,X1000 Ringing R50,X50 Busy Holding R500,X500 ServiceDown Presence (VoiceService.1.Phone.LED.Presence.) Offline Online Busy Away G500,X500 ExtendedAway R500,X500 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 272 AnonymousCallBlockEnabled AnonymousCallBlockDisabled AutoAnswerIntercomEnabled AutoAnswerIntercomDisabled CallForwardEnabled CallForwardDisabled CallForwardServiceDown CallParkedYes CallParkedNo CallParkMonitorSErviceDown CallWaitingEnabled CallWaitingDisabled DoNotDisturbEnabled DoNotDisturbDisabled DoNotDisturbServiceDown DoNotRingEnabled DoNotRingDisabled ExecFilterEnabled ExecFilterDisabled ExecFilterServiceDown ExecAssistEnabled ExecAssistDisabled ExecAssistDivertOn R100,X500 ExecAssistServiceDown HotelingGuestLoggedOn HotelingGuestLoggedOff HotelingServiceDown NewMessagesWaitingYes NewMessagesWaitingNo MWIServiceDown PageGroupJoined PageGroupLeft PageGroupMeTaling R500,X500 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 273: Soft Key Sets

    XferConnected ConfTrying end,,conf.now ConfRinging end,hold,resume,conf.now ConfConnected ns.bci,ns.dnd,ns.cfa,ns.acd NetServices Feature Key Customization Parameter Description Default Setting Call Appearance (VoiceService.1.Phone.CstmLineKey.Call.) false Enable Boolean. Enable the use of customized feature key display format for key function Call Appearance Copyright 2010-2017 Obihai Technology, Inc.
  • Page 274: Screen Item Customization

    Ringing Calls display on the phone screen CallItem The value is a <ScreenItem> XML to customize the format the Current Calls display on the phone screen CallTransferItem The value is a <ScreenItem> XML to Copyright 2010-2017 Obihai Technology, Inc.
  • Page 275: Codec Profiles

    Call Transfer display on the phone screen. Unlike the last two items which are items in a table, there is only 1 CallTransferItem For OBi1032/1062 and OBi2000 Series ScreenSaverCustomContents The value is a <ScreenItem> XML to <ScreenItem>...
  • Page 276 G726R24 Codec ((VoiceService.1.VoiceProfile.1.Line.n.Codec.List.6.) , n = 1, 2 for X = A, B respectively Codec Codec Name G726-24 Bit rate in bits/sec BitRate 24000 Note: Informational only; not configurable Enable Enable this codec true SilenceSuppression Enable silence suppression for this codec false Copyright 2010-2017 Obihai Technology, Inc.
  • Page 277 Telephone Event ( Codec Codec Name for this RTP event, as used in SDP telephone-event Enable Enable this codec true PayloadType Dynamic Payload type to be used for RFC2833 telephone (DTMF) events. Valid range is 96-127 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 278: Tone Profiles

    Stutter Dial Tone (VoiceService.1.VoiceProfile.n.Tone.Description.8.) , n = 1, 2 for X = A, B respectively ToneName Stutter Dial Tone TonePattern Obihai Tone Pattern Script 350-18,440-18;20;2(.1+.1);() Howling Tone (VoiceService.1.VoiceProfile.n.Tone.Description.9.) , n = 1, 2 for X = A, B respectively Copyright 2010-2017 Obihai Technology, Inc.
  • Page 279 Obihai Tone Pattern Script 385-16;10 Paging Tone (VoiceService.1.VoiceProfile.n.Tone.Description.19.) , n = 1, 2 for X = A, B respectively ToneName Paging Tone (The short tone played before playing the caller’s voice) TonePattern Obihai Tone Pattern Script 480-16;1;(.2+.2) Copyright 2010-2017 Obihai Technology, Inc.
  • Page 280: Ring Profiles

    Ring Pattern 1 (VoiceService.1.VoiceProfile.1.Line.n.Ringer.Description.1.), n = 1,2 for X=A,B respectively RingName Bellcore-dr1 RingPattern 60;(2+4) Ring Pattern 2 (VoiceService.1.VoiceProfile.1.Line.n.Ringer.Description.2.), n = 1,2 for X=A,B respectively RingName Bellcore-dr2 RingPattern 60;(.3+.2,1+.2,.3+4) Ring Pattern 3 (VoiceService.1.VoiceProfile.1.Line.n.Ringer.Description.3.), n = 1,2 for X=A,B respectively RingName Bellcore-dr3 Copyright 2010-2017 Obihai Technology, Inc.
  • Page 281: Star Code Profiles

    *62, Cfwd No Ans, coll($Cfnn), set($Cfn,1) Code12 Default = Disable Call Forward on No Answer Star *63, Disable Cfwd No Ans, set($Cfn,0) Code Code13 Default = Block Anonymous Calls Star Code *77, Block Anonymous Call, set($Bac,1) Copyright 2010-2017 Obihai Technology, Inc.
  • Page 282: User Settings

    • default • 1/31/2014 • 1/31/14 • 1/31 • 31/1/2014 • 31/1/14 • 31/1 • Jan 31, 2014 AutoHomePage Choose the delay to automatically return 1 minute the screen to the HOME (idle) screen. Copyright 2010-2017 Obihai Technology, Inc.
  • Page 283 1. If the option is disabled, calls controlled by different Call Keys are shown on separate screens (as the user scrolls through the calls). Otherwise, calls controlled by different Call Keys may be Copyright 2010-2017 Obihai Technology, Inc.
  • Page 284 You can use $count macro in the http/https URL which is expanded into the number of refreshes when the URL is executed. It starts with 1, 2, 3, …, max- Copyright 2010-2017 Obihai Technology, Inc.
  • Page 285 DefaultLineKeyTab Valid Range: 1 – 4 (for OBi1032/1062 and OBi2000 Series) and 1 – 2 (for OBi1022) DefaultLeftLineKeyTab Valid Range: 1 – 4...
  • Page 286: Speed Dials Web Page

    Otherwise, the phone launches the built-in Phone Book application. Groups A comma sepeated list of group names to Co-Workers, Customers, Family, Friends group contacts within the built-in phone book Speed Dials Web Page Copyright 2010-2017 Obihai Technology, Inc.
  • Page 287: User Defined Digit Maps Web Page

    It must be alphanumeric, not Label containing any spaces, and different from other user-defined or built-in digit map labels DigitMap A valid digit map Copyright 2010-2017 Obihai Technology, Inc.

This manual is also suitable for:

Obi1062Obi2062Obi1022Obi2162Obi2182

Table of Contents