Obi Device Admin Guide
Obi Device Admin Guide
Obi Device Admin Guide
Models:
OBi110 Voice Service Bridge and Terminal Adapter OBi100 Telephone Adapter and Voice Service Bridge OBi202 VoIP Phone Adapter with Router, 2-Phone Ports, T.38 Fax
Version 11.04.12 11 April 2012 This Revision includes OBi202 (firmware version 3.0)
INTRODUCTION AUDIENCE WHERE TO GO FOR HELP NOTATIONAL CONVENTIONS INTRODUCTION TO OBI DEVICES PHYSICAL INTERFACES OF THE OBI DEVICE OVERVIEW OF THE OBI DEVICE PHYSICAL INTERFACES CONNECTING POWER TO THE OBI DEVICE LED DESCRIPTION AND LED BEHAVIOUR INTERNET CONNECTION SET-UP AND CONFIGURATION PHONE PORT SET-UP AND CONFIGURATION USING THE OBI AS A PAGING SYSTEM PRIMARY LINE LINE PORT SET-UP AND CONFIGURATION FEATURES AVAILABLE ON THE OBI202 MODEL SHARING FILES ON AN EXTERNAL USB STORAGE DEVICE IP ROUTING AND LAN SWITCHING FEATURES (OBI202 ONLY) END USER FEATURES AVAILABLE ON THE OBI OBITALK WEB PORTAL: OBI CIRCLES OF TRUST OBION IPHONE & IPOD TOUCH + ANDROID SMART PHONE APPS OBIAPP FOR PC SOFT PHONE APP OBI WORKS WITH YOUR EXISTING SERVICES BRIDGE YOUR SERVICES FOR OPTIMUM SAVINGS & CONVENIENCE CALL FORWARDING CALLER ID NAME & NUMBER CALL WAITING 3-WAY CALLING CALL TRANSFER (ATTENDED) NORDIC STYLE FEATURE INVOCATION CALLER ID BLOCK (ANONYMOUS CALLING) AUTOMATIC CALL BACK (CALL RETURN) REPEAT DIALING ANONYMOUS CALL BLOCK DO NOT DISTURB MESSAGE WAITING INDICATION VISUAL AND TONE BASED SPEED DIALING OF 99 OBI ENDPOINTS OR NUMBERS PHONE 1/2 COLLABORATIVE FEATURES (OBI202 ONLY) STAR CODE FEATURES CALL FORWARD NUMBERS CONFIGURATION AND MANAGEMENT INTERFACES OF THE OBI DEVICE TELEPHONE-IVR-BASED LOCAL CONFIGURATION
6 6 6 6 7 9 9 9 10 12 12 12 13 14 14 14 15 18 18 18 18 18 18 18 18 19 19 19 19 20 20 20 20 20 20 21 21 21 21 23 24 24
SYSTEM LEVEL CONFIGURATION OPTIONS NETWORK RELATED CONFIGURATION OPTIONS ROUTER RELATED CONFIGURATION OPTIONS (OBI202 ONLY) SIP SERVICE PROVIDER CONFIGURATION OPTIONS OBITALK CONFIGURATION OPTIONS AUTO ATTENDANT CONFIGURATION OPTIONS LINE (FXO) PORT CONFIGURATION OPTIONS CUSTOMIZED AA PROMPT RECORDING OPTIONS WEB SERVER-BASED LOCAL CONFIGURATION WEB PAGE CONVENTIONS AND ICONS & BUTTONS: FIRMWARE: LOCAL OBI DEVICE UPDATE AND MANAGEMENT UPDATING FIRMWARE: POSSIBLE ERROR MESSAGES ON FIRMWARE UPDATE FAILURE: CUSTOMIZED AA PROMPTS BACKUP & RESTORE: CONFIGURATION BACKUP & RESTORE: RESET CONFIGURATION TO FACTORY DEFAULT ZERO-TOUCH, MASSIVE SCALE REMOTE PROVISIONING: ITSP QUICK START SETUP WIZARD (OBI100 AND OBI110) ITSP QUICK START SETUP WIZARD (OBI202) SYSTEM STATUS & CALL STATUS REBOOT REASON CODES LAN STATUS (OBI202 ONLY) CALL STATUS CALL HISTORY SERVICES, PHONE & LINE STATUS ROUTER CONFIGURATION (OBI202 ONLY) WAN SETTINGS LAN SETTINGS DHCP RESERVATION FIREWALL AND DMZ PORT FORWARDING QOS SETTINGS SYSTEM MANAGEMENT FEATURES OF THE OBI DEVICE NETWORK SETTINGS AUTOMATIC FIRMWARE UPDATE & PROVISIONING DEVICE ADMINISTRATION DEVICE UPDATE SIP SERVICE PROVIDER FEATURES OF THE OBI DEVICE SIP REGISTRATION SIP OUTBOUND PROXY SERVER DNS LOOKUP OF SIP SERVERS
25 26 27 28 32 34 35 36 37 38 40 40 40 41 41 42 42 43 46 50 50 52 52 54 55 58 58 62 63 64 65 67 70 70 73 78 79 79 80 80 80
NAT TRAVERSAL CONSIDERATIONS SIP PROXY SERVER REDUNDANCY AND DUAL REGISTRATION SIP PRIVACY STUN AND ICE ITSP DRIVEN DISTINCTIVE RINGING RTP STATISTICS THE X-RTP-STAT HEADER MEDIA LOOPBACK SERVICE GOOGLE VOICE SERVICE OBITALK SERVICE SETTINGS AUTO ATTENDANT SERVICE AUTOMATED ATTENDANT AA CALLBACK SERVICE USER RECORDED PROMPTS CUSTOMIZING AA PROMPT LISTS VOICE GATEWAYS TRUNK GROUPS PHONE INTERFACE FEATURES OF THE OBI DEVICE REPEAT DIALING SERVICE TELEPHONE LINE INTERFACE FEATURES OF THE OBI DEVICE LINE PORT STATUS EVENT PACKAGE CODEC PROFILE FEATURES OF THE OBI DEVICE TONE & RING PATTERNS TONE PROFILE FEATURES OF THE OBI DEVICE TONE EXAMPLES: RING PROFILE A & B FEATURES OF THE OBI DEVICE STAR CODE PROFILE FEATURES OF THE OBI DEVICE STAR CODE SCRIPT VARIABLES (VAR) STAR CODE SCRIPT ACTIONS (ACT) STAR CODE SCRIPT FORMAT STAR CODE SCRIPT EXAMPLES USER SETTINGS FEATURES OF THE OBI DEVICE SPEED DIAL NUMBERS USING SPEED DIAL NUMBER AS AD HOC GATEWAY USER DEFINED DIGIT MAPS SHARING FILES ON AN ATTACHED EXTERNAL USB STORAGE DEVICE (OBI202 ONLY) FILE SHARING SETTINGS FILE EXPLORER OBI CALL ROUTING AND DIGIT MAP
81 81 82 83 83 84 84 91 98 102 102 102 103 103 109 111 113 113 123 123 129 136 136 138 142 146 146 147 147 148 151 151 151 152 152 152 157 160
TRUNKS, ENDPOINTS, AND TERMINALS SUPPORTED 2-WAY CALL BRIDGES ON THE OBI110 CALL ROUTING THE OBI WAY INBOUND CALL ROUTE CONFIGURATION OUTBOUND CALL ROUTE CONFIGURATION DIGIT MAP CONFIGURATION DIGIT MAP RULES AND ELEMENTS MATCHING AGAINST MULTIPLE RULES IN DIGIT MAP INVOKE SECOND DIAL TONE IN DIGIT MAP USER DEFINED DIGIT MAPS A USER DEFINED DIGIT MAP FOR IPV4 DIALING SPECIFICATIONS & ENVIRONMENTAL CHARACTERISTICS OF THE OBI DEVICE
160 160 162 163 165 167 167 169 171 172 172 173
Introduction
Audience
Cloud Service Providers and Managed Service VARS Note to End Users
End users are highly encouraged to use the OBiTALK web portal to configure and manage their OBi devices. The reason for this is two-fold. One, the major benefits afforded by the OBi devices are available to be turned on, set-up and modified from within the portal. Whats more is the application of the functional configuration is controlled by device configuration files tightly integrated with the settings configured by the OBiTALK portal and cloud-based applications managed by Obihai which make possible the devices plug-n-play operation.
2. 3. 4.
Notational Conventions
An OBi device configuration parameter and value is represented in the style Group Name::ParameterName = Parameter Value Group Name is the heading of the parameter group on the left side panel of the device configuration web page and may contain spaces. When a group heading has more than one level, each level is separated with a -, such as Services Providers - ITSP Profile A SIP:: ParameterName is the name of the parameter as shown on the web page and MUST NOT CONTAIN ANY SPACES. Parameter Value is the literal value to assign to the named parameter and may contain spaces. Group Name or its top level headings may be omitted when the context is clear. Examples: SP1 Service::AuthUserName = 4082224312 ITSP Profile A - SIP::ProxyServer = sip.myserviceprovider.com
OBi Devices:
Model OBi100 OBi110 OBi202 VoIP Account Support
(SIP or Google Voice)
Phone Port(s) 1 1 2
Line Port 0 1 0
Ethernet Port(s) 1 1 2
USB Port 0 0 1
Configurable to Work with Any SIP Compliant Internet Telephone Service or Google Voice Communications Service Configurable to Work with Most Loop Start Analog Telephone Lines Analog Phone & Telephone Line Impedance Agnostic Robust Telephony Features: Message Waiting Indication - Visual and Tone Based Speed Dialing of 99 OBi Endpoints or Numbers Three Way Conference Calling with Local Mixing Hook Flash Event Signaling Caller ID Name & Number Call Waiting Call Forward - Unconditional Call Forward on Busy Call Forward on No Answer Call Transfer Anonymous Call Block Anonymous Call Do Not Disturb Call Return Repeat Dialing
Powerful Call Routing & Voice Service Features: SIP Support for Voice and Fax Over IP from Internet Telephony Service Providers OBiTALK Managed VoIP Network for OBi Endpoint Devices & Applications High Quality Voice Encoding Using G.711, G.726, G.729 Algorithms Recursive Digit Maps & Associated Call Routing (Outbound, Inbound)
Top Views of the OBi100, OBi110 and OBi202 LED Order (Left to Right): Power Status Internet Port Activity LAN Port Activity (OBi202) PHONE Status LINE Status (OBi110)
Rear Views of the OBi100, OBi110 and OBi202 Port Order (Left to Right): LINE Port (OBi110) PHONE Port(s) LAN Port (OBi202) Internet Port 12v DC Power Jack
The phone is ready to be used: OBi202: Solid Green If the Primary Line is the PSTN LINE, indicates OBiTALK service is available. If the Primary Line is SP1/SP2/OBiTALK, indicates the corresponding primary service is available.
10
LED Icon
What It Means The port in not enabled. The line is ready to be used. The line is in use. The line is ringing.
OBi110 Only
LED Pattern When Hardware Reset Button Is Pressed for Ten (10) Seconds: Power LED blinks green slowly for 5 seconds and fast for 4 seconds preceeding unit reboot.
11
The OBi PHONE port supports Call Waiting when a 2nd call is an inbound call: A Hook Flash (or depressing the Flash button) invokes switching between two (2) calls. When the OBi PHONE port goes On Hook this will end current call and invoke a ring for the holding call.
The OBi PHONE port supports 3-way Calling when the second call is an outbound call. On the first Hook Flash during an active call the OBi can make a second outbound call. One the second hook flash, the first call and the second outbound call are place in a conference. To remove the second conferenced party, invoke a third Hook Flash. When the OBi goes On Hook during a 3-way Call, this will become a transfer when 2 (outbound) call is ringing or nd connected. If the 2 (outbound) call does not succeed, e.g. no answer or busy, then the OBi PHONE port can go to On Hook state and will ring as the holding call is still on the line, or simply hook flash to resume the first call.
nd
The OBi PHONE port can select from the following services with which it can complete a call: SP1 Service (SP1), SP2 Service (SP2), OBiTalk Service (PP1), and PSTN Line (LI1). PHONE PORT::DigitMap PHONE PORT::OutboundCallRoutes PHONE PORT::CallReturnDigitMaps
12
phone port goes from on-hook to off-hook, in case the user needs to dial * * * to invoke the IVR, the OBi will play a dial tone for 5 seconds. After 5 seconds the OBi will turn silent and be ready to accept an incoming call to page.
Primary Line
By default, devices which come with an analog (PSTN) line port will use this as the Primary Line for outbound calls made from the PHONE port and via the OBi Auto Attendant. This means that when you dial a new number using the AA, you do not need to first dial a service route access code. You can select the Primary Line for the PHONE port and for the AA, respectively, using the parameters PHONE Port::PrimaryLine and Auto Attendant::PrimaryLine. Depending on the device model, you may add up to two (2) or four (4) SP VoIP services to the OBi, and attach a PSTN line to the LINE Port as an additional voice service. The VoIP services can be SIP-based services or Google Voice. In addition, all device models come with the free OBiTALK (peer-to-peer) service. In this document we sometimes refer to any one of these voice services as a trunk and a trunk group (TG) is a (comma-separated) ordered list of trunks. If a TG is selected for making an outbound call, the OBi will pick the first available member in that trunk group for the call. Up to four (4) TGs can be defined in an OBi (see the section Trunk Groups for detail). You can make one of the available trunks or TG1 as the Primary Line for outbound calls. The Primary Line for the PHONE port(s) and the Auto Attendant is configured via the OBi device management web page described herein or the OBiTALK Device Configuration VoIP Service Provider set-up screen also gives the user the option to select a trunk or TG1 as the Primary Line. The list below summarizes the choices available for selection as the primary line: SP1 Service SP2 Service 2 SP3 Service 2 SP4 Service OBiTALK Service 1 PSTN Line Trunk Group 1
When you want to make a call via a service that is not the Primary Line, you will need to dial that services access code before the destination number. The default service route access codes are defined as: ** 1 : SIP Service Provider 1 or Google Voice Service 1 ** 2 : SIP Service Provider 2 or Google Voice Service 2 2 ** 3 : SIP Service Provider 3 or Google Voice Service 3 2 ** 4 : SIP Service Provider 4 or Google Voice Service 4 1 ** 8 : PSTN Line Port Service Provider ** 9 : OBiTALK Network
Service route access codes for calling from the PHONE port can be customized if necessary by modifying PHONE Port::DigitMap and PHONE Port::OutboundCallRoute. Service route access codes for calling via the Auto Attendant can be customized if necessary by modifying Auto Attendant::DigitMap and Auto Attendant::OutboundCallRoute. Note: Occurrences of (Mpli) and pli are substituted internally with the corresponding abbreviated trunk name of the selected primary line.
1
13
Use the following URLs on a web browser to launch the OBi File Explorer: For anonymous level access: http://<OBi-IP-Address>/obi_share/anonymous For admin or user level access: http://<OBi-IP-Address>/obi_share
The File Explore can be launched from either the WAN or LAN side of the OBi. The WAN side access can be disabled in the configuration.
14
IP Routing Features
In router mode we refer to the network connected to the OBi Internet Port as the WAN side of the OBi202, and the network connected to the OBi LAN Port the LAN side of the OBi. The WAN side may be connected to another Ethernet switch or directly to an access device such as a cable or DSL modem for Internet access. The OBi202 routes traffic between the LAN side and the WAN side, thus allowing the devices (such as PCs) attached to the LAN side to share Internet access. The OBi202 supports subnet masks as big as 255.255.255.0 to accomodate up to 253 IP addresses on its LAN side subnet. In addition to being a NAT (Nework Address Translation) router, the OBi202 includes a DHCP server, a DNS forwarder and a basic firewall. It supports port forwarding, DMZ, QoS, and VLAN (802.1q). The maximum routing throughput between the WAN and the LAN side is approximately 30 Mbps. This speed can be achieved when there are no active calls in the system. Otherwise the throughput will be limited to a slower speed to accommodate the load for voice processing. Note that if the WAN side is connected to an Internet access device directly, then the throughout could be be further limited by the speed of the Intenet uplink and downlink. The OBi202 will acquire its WAN side IP address using one of the following methods: Static Address Assignment, DHCP, or PPPoE. By default, the OBi202 acquires its WAN side IP address using DHCP. Also by default, the OBi202s own DHCP server is enabled to support LAN side clients, e.g. PCs. The default LAN side IP address of the router is 192.168.10.1. Incoming packets receiving from the WAN side are fowarded by the router according to the following flow: If firewall is enabled, discard the packet if it is rejected by any one of the active firewall components If the sending host address matches a valid entry in an interal host binding table, queue the packet for local processing. This binding table is updaed by the router with an internal algorithm. If the sending host address matches a valid entry in an internal NAT binding table, forward the packet to the corresponding LAN IP address. The NAT binding table is updated by the router with an internal algorithm. If the receiving port and protocol matches a reserved pair to support an internal process (e.g. TCP Port 80 for the OBi202 web server process), queue the packet for local processing. If the receiving port and protocol matches a port forwarding rule, forward the packet to the LAN IP address according to that rule. If a DMZ host is configured, forward the packet to that LAN IP address. Queue the packet for internal processing.
DHCP Server By default, the built-in DHCP server is enabled on the OBi202. It assigns IP address, network mask, DNS server and default gateway address to the DHCP clients on the LAN side. The default gatway and DNS server have the same IP address as the LAN side IP address of the router. In the DHCP server configuration, you may select the range of client IP addresses to give out the Lease Time and the Local Doamin Name. Furthermore, by using the DHCP reservation feature, you may reserve specific IP addresses for some devices with specific MAC addresses. With this, those devices can always be assigned the same IP addresses reserved for them each time they make a request to the DHCP server. See the LAN Settings and DHCP Reservation sections for more details.
15
Firewall The firewall protects local processes and LAN side clients against certain basic threats from the WAN side (or the Internet), such as port scanning and a DOS (Denial of Service) attack. The firewall settings also allow you to selectively turn on or off the following related features: NATRedirection Supports NAT Redirection (a.k.a NAT Loopback or Haripin) if enabled (default is disabled). DRDOSAttackProtection Protects against DOS attack if enabled (default is disabled). VPNPassThrough Blocks all VPN traffic if disabled (default is enabled).
The settings of these features will take effect only if firewall is enabled. Otherwise, they will take on their respective default values (that is, no NATRedirection or DRDOSAttackProtection and VPNPasssThrough is allowed).
Port Forwarding Up to 20 port forwarding rules may be defined on the OBi. For each rule a range of ports and a designated receiving LAN IP address must be specified such that incoming traffic arriving at any of those ports on the WAN side are forwarded to the same port at the designated IP address on the LAN side. You may also specify for each rule if it should only apply to packets transported over UDP, TCP or both.
DMZ The DMZ host in the router is the default LAN client address to which a packet received from the WAN side is forwarded when the router fails to find a matching LAN IP address or matching local process to forward the packet to. Note if firewall is enabled, that the packet is still subject to firewall inspection before forwarding to the DMZ host.
QoS QoS (Quality of Service) refers to the prioritization of network traffic based on the type of traffic. For example, time critical traffic such as VoIP may be allocated the highest priority so they can have a better chance of on time delivery to the destination. On the OBi202, QoS policy applies to upstream traffic (LAN-to-WAN) only. Downstream QoS is entirely up to the the ISP / upstream routers and switches. The upstream traffic is prioritized according to its type of service as indicated by the DiffServ/TOS bits in the IP header of each packet. In the QoS settings, you may map the 64 possible types of service to one of the three priority classes: High, Medium and Low. You may also specify the guarenteed minimum upstream bandwidth for each priority class. LAN side clients indicate the desired priority class of their outbound packets to the router by marking the DiffServ/TOS bits of their packets accordingly. See the QoS Settings section for more details. In addition to the three priority classes, a fourth priority class known as the Restricted class is available. The Restricted class has the highest priority among the four classes. The guarateed bandwidth for the Restricted class is allocated separately with its own parameter in the configuration. Note that the total guranateed bandwidth allocated to all the four priority classes is equal to the total available uplink bandwidth, which must be specified correctly in the UpStreamBandwidth parameter in the QoS settings for QoS to work properly.
16
VLAN Support in Router Mode In router mode, the OBi202 can support VLAN (802.1Q) on the WAN side. When VLAN is enabled, incoming packets from the WAN side not belonging to the same VLAN are dropped, while all outgoing packets to the WAN side are tagged with the configured VLAN ID. The VLAN support is transparent to the devices on LAN side. The router removes the VLAN tag when forwarding packets to the LAN side.
VLAN Support in Bridge Mode When VLAN is enabled, packets sent to the OBi not belonging to the same VLAN are dropped, while packets sent by the OBi are tagged with the configured VLAN ID. The packets switched directly between the external ports, on the other hand, are not modified by the OBi.
17
Call Forwarding
Call Forwarding allows you to send incoming calls to another number of your choosing. Calls can be forwarded to a number reachable from the landline service, VoIP service or OBiTALK network. The following types of call forwarding are possible with the OBi: Call Forward ALL: When you use Call Forward ALL, all calls are immediately forwarded to the number you indicate when you turn on the feature. To enable Call Forward ALL, from a phone attached to the OBi, dial *72. You will be prompted to enter the number to which the calls will be forwarded. Dial the number plus the # key and a confirmation tone will be heard. To disable Call Forward ALL, dial *73. A confirmation tone will be heard. Call Forward on Busy: When you use Call Forward on Busy, all calls are forwarded to the number you indicate only when you are already engaged in a call with your phone attached to the OBi. To enable Call Forward on Busy, from a phone attached to the OBi, dial *60. You will be prompted to enter the number to which the calls will be forwarded. Dial the number plus the # key and a confirmation tone will be heard. To disable Call Forward on Busy, dial *61. A confirmation tone will be heard
18
Call forward on No Answer: When you use Call Forward on No Answer, all calls are forwarded to the number you indicate only when you do not answer the call with your phone attached to the OBi. To enable Call Forward on No Answer, from a phone attached to the OBi, dial *62. You will be prompted to enter the number to which the calls will be forwarded. Dial the number plus the # key and a confirmation tone will be heard. To disable Call Forward on No Answer, dial *63. A confirmation tone will be heard.
Call Waiting
Call waiting lets you take a second call that comes in when you are already on the phone with another party and not have to disconnect to take the new call. When you are on the line with the first party, you will hear a tone signalling you there is a second call coming in. To answer this call, press the flash button on your phone or depress and release the switch hook on the telephone. The first party will be placed on hold and you will be connected to the second party until you press the flash button or depress and release the switch hook again. Since Call Waiting can interfere with fax calls already in progress, it is advised that you configure your fax machine to dial the Cancel Call Waiting code before it dials the destination fax machine.
3-Way Calling
3-Way Calling allows you to talk to two parties at the same time with everyone on a telephone at a different location. To use 3-Way Calling, when you are in a call with another party and want to add a second to the conversation, press the flash button or depress and release the switch hook on your phone. You will be presented with a second dial tone and the first party will be placed on hold. Dial the second party. When they answer, you will be able to inform them that you intend to connect them with the first party (now on hold) and have a conference. At this point press the flash button or depress and release the switch hook on your phone. This will connect the first party, the second party and yourself. You can all continue to talk together.
19
Scenarios 1 call connected, 2 call ringing 1 call connected, 2 call on hold or ringing st nd 1 call connected, 2 call on hold or ringing st nd 1 call connected, 2 call on hold or ringing st nd 1 call connected, 2 call on hold or connected
st nd st nd
To select the Nordic style of feature invocation, set the parameter PHONE Port::CallCommandSignalMethod to Nordic Regions (R1, R2, ). The default is: N. America.
Repeat Dialing
Repeat Dialing is useful when you call a number that is busy and you want to keep trying so that your call gets through when the far end is available. Repeat dialing will continue to try the last number until the OBi device can complete the call or Repeat dialing is cancelled. To enable repeat dialing, from the phone attached to the OBi, dial *05 and hang up. To cancel repeat dialing, from the phone attached to the OBi, dial *06.
Do Not Disturb
Do Not Disturb (DND) allows you to set the phone to immediately forward calls made to your OBi to the number set-up as your voicemail number / account. If no voicemail account is set-up, the OBi will return a busy signal to the caller until you turn off DND. To turn on DND, from a phone attached to the OBi, dial *78. To turn off DND, from a phone attached to your OBi, dial *79.
20
Note that you can prevent the calling phone port from doing 2, 3 and 4, as they can be disabled by setting the parameter EnablePhonePortBargeIn to false for that port. In that case, 2 will become normal call-waiting on the called phone, but the calling phone will hear busy tone for 3 and 4. You can also transfer an external call from PHONE 1 to PHONE 2 the usual way: while connected on an external all, hook flash and dial # to ring the other phone, then hang up to transfer when the caller phone rings or answers. For incoming calls on any trunk (SP1-4 or OBiTALK Service), one can set up the corresponding inbound call route to ring just PHONE 1 or PHONE 2 or both. The default inbound call routes are setup to ring both phone ports. For outgoing calls, each phone port has its own digit map and outbound call route configuration, which means that you have the full flexibility in allocating trunks for making calls from each port independently. Each port may also have a different primary line assigned; the default however is to set the prmary line to SP1 for both phone ports.
21
*03, Request peer device to loopback media in the next outbound call *04, Request peer device to loopback RTP packets in the next outbound call *05, Tell device to periodically redial the last called number until the called party rings or answers *06, Cancel the last repeat dial request *07 Redial *69 Call Return *81 Block Caller ID (Persistent Mode) *82 Unblock Caller ID (Persistent Mode) *67 Block Caller ID (One Time) *68 Unblock Caller ID (One Time) *72 Call Forward All (Enter Number + #) *73 Disable Call Forward All *60 Call Forward on Busy (Enter Number + #) *61 Disable Call Forward in Busy *62 Call Forward on No Answer (Enter Number + #) *63 Disable Call Forward No Answer *77 Block Anonymous Calls *87 Unblock Anonymous Calls *56 Enable Call Waiting *57 Disable Call Waiting *78 Do Not Disturb Turn On *79 Do Not Disturb Disable *66 Repeat Dial *86 Disable Repeat Dial *74 Speed Dial Set-Up (Enter SD No. [1-99] then Tel No. + #) *75 Speed Dial Read-Back (Enter SD No.) *76, Clear a Speed Dial *96, Barge In *98, Blind Transfer *4711, Use G711 Only on the next outbound call *4729, Use G729 Only on the next outbound call
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.
22
23
If settings require reboot, it will be done automatically when quitting the IVR. IVR (AA2) invoked by *** as default. Tip: By pressing the appropriate button sequence on the telephone key pad, you can barge into the next menu of the IVR or invoke a command without first waiting for the previous announcement to end. Main Menu configuration options are accessed by pressing * * * from a phone attached to the PHONE port of the OBi, followed by a single digit of the option number as listed below: Selection Announcement Basic Network Status 1 Your IP address and DHCP status will be read back to you. Advanced Network Status 2 Your primary & back-up DNS server, primary & back-up NTP server will be read back to you. DHCP Current Value 3 Your current value will be read back to you and you will be given the option to change the value IP Address Current Value Your current value will be read back to you and you will be given the option to change the value. If you elect to enter a new value (static IP address) DHCP will be disabled. Password Current Value 5 Your current IVR password value will be read back to you and you will be given the option to change the value. Press 1 to enter a new value. Press 2 to set the default value. Press 0 to repeat the information. Press 0 to repeat the information. Press 0 to repeat the information. What Can You Do?
Press 1 to enter a new value. Press 2 to set the default value. Press 0 to repeat the information.
Press 1 to enter a new value. Press 2 to set the default value. Press 0 to repeat the information.
24
Please Wait (while OBi is checking for software update) This is followed by either: 6 - Software Update Available. Press 1 to update software, OR - Software Update Not Available
If an update is available, press 1 to proceed with the update. The software update process will start as soon as you hang up the phone.
Warning: Once the software upgrade process starts, the devices power LED will blink rapidly. Please make sure the power and network cable stay connected to the unit until the process is complete. Press 1 to confirm device restore to factory default settings.
Press # to return to device configuration menu. Press # # to exit IVR. Press 1 to confirm device reboot.
Additional Options 0 Access other configuration options of the OBi device. Enter option followed by the # key.
Firmware Version 1 The current value of the firmware version will be read back.
Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value.
IVR Password 2 The current value of the IVR password will be read back.
Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection.
25
Press 1 to enter a new value. Debug Level 3 The current value of the debug level will be read back. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Syslog Server IP Address 4 The current IP address of the syslog server will be read back. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Syslog Server Port 5 The current value of the syslog server port will be read back. Press 2 to set the default value of 514. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to confirm. Press # to enter another configuration selection Press 1 to confirm. Press # to enter another configuration selection
81
Factory Reset just the Voice configuration parameters. Leave the Router configuration parameters unchanged Factory Reset just the Router configuration parameters. Leave the Voice configuration parameters unchanged
82
Press 1 to enter a new value. DHCP Configuration 20 The current value of the DHCP configuration will be read back. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value.
21
26
be read back.
Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value.
Default Gateway 22 The current value of the default internet gateway will be read back.
Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value.
Subnet Mask 23 The current value of the subnet mask will be read back.
Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value.
DNS Server (Primary) 24 The current value of the primary DNS server will be read back.
Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value.
NTP Server (Primary) 26 The current value of the primary NTP server will be read back.
Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection.
Enable Web Management Access from WAN port 30 The current value will be read back. (Effective in Router mode only) 0: Disable Access from WAN 1: Enable Access from WAN
Press 1 to enter a new value. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection.
27
Choose Router or Bridge Mode The current value will be read back. 31 0: Router 1: Bridge Enable DHCP Server on LAN side in router mode 32 The current value will be read back. 0: Disable DHCP Server 1: Enable DHCP Server Enable Firewall in router mode 33 The current value will be read back. 0: Disable Firewall 1: Enable Firewall Enable QoS feature in router mode 38 The current value will be read back. 0: Disable QoS 1: Enable QoS
Press 1 to enter a new value. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. 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. 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. 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.
Press 1 to enter a new value. Enable Service Provider One (SP1) 100 The current value will be read back. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Registration State of SP1 101 The current value will be read back. 102 SP1 User ID Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value.
28
Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value.
167
Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value.
168
Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value.
172
Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value.
173
Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value.
174
Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value. 175 SP1 Call Forward on Busy Number Press 0 to repeat the information. Press # to enter another configuration selection. 176 SP1 Call Forward on No Answer Press 1 to enter a new value.
29
Enable / Disable
Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value.
177
Additional Configuration Options Available with the OBi IVR after Pressing * * * 0 for SIP Service Provider Two (SP2): Selection (Always Press # After Entering Selection) Announcement What Can You Do?
Press 1 to enter a new value. Enable Service Provider One (SP2) 200 The current value will be read back. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Registration State of SP2 201 The current value will be read back. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. SP2 User ID 202 The current value will be read back. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value. 267 SP2 Block Caller ID Enable Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. 268 SP2 Block Anonymous Call Enable Press 2 to set the default value.
30
Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value. 272 SP2 Call Forward ALL Enable / Disable Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value. 273 SP2 Call Forward ALL Number Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value. 274 SP2 Call Forward on Busy Enable / Disable Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value. 275 SP2 Call Forward on Busy Number Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. SP2 Call Forward on No Answer Enable / Disable Press 2 to set the default value. 276 Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. SP2 Call Forward on No Answer Number Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection.
277
31
Press 1 to enter a new value. Enable OBiTALK Service 900 The current value will be read back. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. Registration State of OBiTALK 901 The current value will be read back. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value. 967 OBiTALK Block Caller ID Enable Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value. 968 OBiTALK Block Anonymous Call Enable Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value. 972 OBiTALK Call Forward ALL Enable / Disable Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value. 973 OBiTALK Call Forward ALL Number Press 0 to repeat the information. Press # to enter another configuration selection. 974 OBiTALK Call Forward on Busy Enable / Disable Press 1 to enter a new value. Press 2 to set the default value.
32
Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value. 975 OBiTALK Call Forward on Busy Number Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value. 976 OBiTALK Call Forward on No Answer Enable / Disable Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Press 2 to set the default value. 977 OBiTALK Call Forward on No Answer Number Press 0 to repeat the information. Press # to enter another configuration selection.
33
Press 1 to enter a new value. Press 2 to set the default value. 80 Enable / Disable Auto Attendant. Press 0 to repeat the information. Press # to enter another configuration selection.
34
Press 1 to enter a new value. Enable / Disable FXO LINE Port 90 The current value will be read back. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection. FXO State 91 The current value of the statel will be read back. Press 0 to repeat the information. Press # to enter another configuration selection. Press 1 to enter a new value. Ring Thru Delay 92 The current value will be read back. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection.
35
Press 1 to enter a new value. Press 2 to set the default value. Press 0 to repeat the information. Press # to enter another configuration selection.
Note: After pressing 1 to record a new prompt, the OBi says Enter value followed by the # key)\. At that point, you can press any digit (0-9) to start recording, and then press # to end recording. 1001 Option 1001 current value is: (the recorded prompt) Tips: Leave about 1s of gap at the end of recording to avoid unintended truncation by the OBi. After a new prompt is recorded, Obi immediately plays back the recorded audio, and then presents the following options: Press 1 to save (save the recorded prompt permanently in long term memory) Press 2 to re-enter (the last recorded prompt is discarded) Press 3 to review Press # to cancel (the last recorded prompt is discarded) Similarly for Options 1002 - 1010 With these options you can record up to 10 prompts which can be arranged in any combinations and used as customized AA prompts. Each prompt recording is limited to 60s, where the prompt duration is rounded to the nearest number of seconds. A total of 122s is available to store all the recordings. The device will reboot automatically when you hangup if any of the prompts have been modified and saved. Furthermore you can enter a text description for each recorded prompt as a reminder of the contents of the prompt (under the Voice Services - Auto Attendant configuration page).
36
37
IMPORTANT: Every configuration page must be submitted individually after changes made on the page. Otherwise those changes will be discarded once you navigate to another page. Most changes will require a reboot of the unit (by clicking the reboot button for instance) to take effect. However, you may reboot the unit just once after you have made and submitted all the necessary changes on all the pages.
When the device is operating in router mode (OBi202 only), the built-in web server may be accessed from the LAN side or the WAN side. While access from the LAN side is always allowed, for security reasons, the access from the WAN side may be disabled by configuration. In fact, the WAN side access to the web server is disabled by default. You can enable this option on the device web page (from the LAN side), or by using the device configuration IVR (* * * 0 option 30) from an attached telephone.
Remark
38
If you make changes to a parameter on a page and you do not want to keep them for submission, click the Clear Changes button to revert back to the parameter setting present before the most recent change was entered. Click the Use Defaults Only button if you want to revert all parameters on a given page to their Default settings. If you want to revert just one or two parameters on a page to default settings you should use the Default check box found on the right side of the parameter. See next Item. When you wish to modify a parameter away from its default setting, you should un-check the Default box. This will open the parameter field for access and modification. If there is a nondefault setting in a parameter field and you want to revert that parameter back to its default setting, check the Default box and the default setting will appear. This icon indicates that the configuration currently programmed on the OBi device is set and running. No reboot is necessary if you have submitted configuration modifications. After Submitting changes to a web page on the OBi, the Reboot Required icon may appear. In order for the modifications to run, you will need to reboot the OBi. You will be prompted to confirm that you want all the parameters on the page to revert back to system default settings. Default value of a parameter may be changed with a firmware upgrade. Leaving a parameter at default setting allows the device to use proper default value with the firmware currently installed in the device This icon does not indicate the currently running configuration is working properly. You can continue to make modifications to OBi parameters on separate pages if necessary before you reboot and set the modifications in the running system. When performing a System Configuration Reset, the Reboot button does not need to be pressed. The OBi will reboot automatically when the Reset button is selected.
The Reboot button is used when the Reboot Required icon appears indicating the OBi device requires a reboot to invoke one or more parameter modifications.
39
Updating Firmware:
You may upgrade the firmware for your OBi device from the device configuration web page. The firmware file with which you want to upgrade the device must be stored locally on a computer from which you can access with a web browser. Follow these steps to upgrade: Step 1: Select the, System Management Device Update menu on the side panel of the web page. Step 2: Specify the path of the firmware file by clicking the, Select file to upgrade firmware box or pressing the, Browse button in the Firmware Update section of the page. This will present a file browser window where you can navigate to and select the firmware file. Step 3: Upon selection of the firmware file, press the Update button to start the upgrade process. The entire process will take about 30 seconds to complete. Note that you MUST NOT disconnect the power from the device during this procedure. If the new firmware is upgraded successfully, the OBi device will reboot automatically to start running the new firmware. Otherwise the page will show an error message explaining why upgrade has failed.
40
System Is Busy
The OBi device is busy because one of the phone services is in an active call or device provisioning is in progress. The OBi device is already running the same firmware as the one selected for update.
No need to upgrade.
No
No
When the file browser window pops up for, you can change the filename and choose the location to save the backup file. Note that different web browser might handle this differently. If the operation is blocked due to the security setting of the web browser, you should change the security setting temporarily to allow this operation to complete. When restoring the configuration to a previous backup copy, you will need to specify the backup file you want to restore to by selecting the Browse button in the Restore Configuration section of the web page. Then, select the Restore button to start the process. The OBi device will automatically reboot, after the restoration is complete. IMPORTANT Note: All passwords and PINs are excluded from the backup file. Hence they will not be available to restore. Call history is excluded from the backup, but can be saved as an XML formatted file separately from the Call History web page.
41
42
43
Mirrors System Management Device Admin:: AdminPassword ITSP Settings Host name or IP address of the SIP proxy server. Mirrors Service Providers ITSP Profile A SIP::ProxyServer Destination port to connect to the SIP server. Mirrors Service Providers ITSP Profile A SIP::ProxyServerPort Username used by the device to authenticate to a SIP UAS (User Agent Server) when an outbound SJP Request is challenged with a 401 or 407 response. Mirrors Voice Services SP1 Service::AuthUserName Password by the device to authenticate to a SIP UAS (User Agent Server) when an outbound SJP Request is challenged with a 401 or 407 response. Mirrors Voice Services SP1 Service::AuthPassword If a value is specified for this parameter, it affects the way the device forms its AOR (Address of Record) or Public Address when sending outbound SIP Requests (such as REGISTER and INVITE); otherwise device forms its AOR in the normal way. See description of Voice Services SP1 Service::URI for details on how to use this parameter. Mirrors Voice Services SP1 Service::URI Indicate which service is the primary line when dialing out. Mirrors PHONE Port::PrimaryLine Indicate which service is the primary line when dialing out via the AA. Mirrors Auto Attendant::PrimaryLine Digit map controlling the transmission of dialed digit information. Mirrors Service Providers ITSP Profile A General::DigitMap
ITSP SIPProxyServer
ITSP SIPProxyServerPort
5060
ITSP AuthUserName
ITSP AuthPassword
ITSP URI
Attendant PrimaryLine
PSTN Line
ITSP DigitMap
(1xxxxxxxxxx|<1>[2-9]xxxxxxxxx |011xx.|xx.)
44
Phone DigitMap
Digit map to limit dialable numbers on this port. Mirrors PHONE Port::DigitMap
For OBi100: ([1-9]x?*(Mpli)|[1-9]|[1-9][0-9]|911|**0|***|#| **1(Msp1)|**2(Msp2)|**9(Mpp)|(Mpli)) For OBi110: ([1-9]x?*(Mpli)|[1-9]|[1-9][0-9]|911|**0|***|#| **1(Msp1)|**2(Msp2)|**8(Mli)|**9(Mpp)|(Mpli)) For OBi100: {([1-9]x?*(Mpli)):pp}, {**0:aa},{***:aa2}, {(<**1:>(Msp1)):sp1},{(<**2:>(Msp2)):sp2}, {(<**9:>(Mpp)):pp},{(Mpli):pli} For OBi110: {([1-9]x?*(Mpli)):pp},{(<#:>|911):li}, {**0:aa},{***:aa2}, {(<**1:>(Msp1)):sp1},{(<**2:>(Msp2)):sp2}, {(<**8:>(Mli)):li},{(<**9:>(Mpp)):pp},{(Mpli):pli}
Phone OutboundCallRoute
Routing rule for outbound calls made from this port. Mirrors PHONE Port:: OutboundCallRoute
Inbound Settings ITSP InboundCallRoute Routing rule for inbound calls on this trunk. Mirrors Voice Services SP1 Service::X_InboundCallRoute Routing rule for inbound calls on this trunk. Mirros OBiTALK Service::InboundCallRoute Routing rule for inbound calls on this trunk. Mirros LINE Port::InboundCallRoute ph
ph
ph
45
46
Local time zone. Mirrors System Management Local Time Zone NetworkSettings:: LocalTimeZone Administrator Password, case sensitive. Mirrors Admin Password System Management Device Admin:: AdminPassword ITSP Profiles (X = A, B, C, or D) Choose either SIP or Google Voice Mirrors ITSP X SignalingProtocol Service Providers ITSP Profile X General::SignalingProtocol Host name or IP address of the SIP proxy server. Mirrors ITSP X SIPProxyServer Service Providers ITSP Profile X SIP::ProxyServer Destination port to connect to the SIP server. Mirrors ITSP X Service Providers SIPProxyServerPort ITSP Profile X SIP::ProxyServerPort Digit map controlling the transmission of ITSP X DigitMap dialed digit information. Mirrors
admin
SIP
5060
(1xxxxxxxxxx|<1>[2-9]xxxxxxxxx |011xx.|xx.)
47
Outbound Settings (N = 1 or 2) Indicate which service is the primary line when dialing out. Mirrors Phone N PrimaryLine PHONE Port N::PrimaryLine Digit map to limit dialable numbers on this port. Mirrors PHONE Port N::DigitMap Routing rule for outbound calls made from this port. Mirrors PHONE Port 1:: OutboundCallRoute Routing rule for outbound calls made from this port. Mirrors PHONE Port 2:: OutboundCallRoute
SP1 Service ([1-9]x?*(Mpli)|[1-9]|[1-9][0-9]|911|**0|***|#| **1(Msp1) |**2(Msp2)|**3(Msp3) |**4(Msp4)| **9(Mpp)|(Mpli)) {([1-9]x?*(Mpli)):pp},{(<#:>):ph2},{**0:aa}, {***:aa2},{(<**1:>(Msp1)):sp1}, {(<**2:>(Msp2)):sp2},{(<**3:>(Msp3)):sp3}, {(<**4:>(Msp4)):sp4},{(<**9:>(Mpp)):pp}, {(Mpli):pli} {([1-9]x?*(Mpli)):pp},{(<#:>):ph},{**0:aa}, {***:aa2},{(<**1:>(Msp1)):sp1}, {(<**2:>(Msp2)):sp2},{(<**3:>(Msp3)):sp3}, {(<**4:>(Msp4)):sp4},{(<**9:>(Mpp)):pp}, {(Mpli):pli} SP1 Service
Phone N DigitMap
Phone 1 OutboundCallRoute
Phone 2 OutboundCallRoute
Indicate which service is the primary line Attendant PrimaryLine when dialing out via the AA. Mirrors Auto Attendant::PrimaryLine Voice Services (n = 1, 2, 3, or 4) SPn ITSP Profile Username used by the device to authenticate to a SIP UAS (User Agent Server) when an outbound SJP Request is challenged with a SPn AuthUserName 401 or 407 response. Mirrors Voice Services SPn Service::AuthUserName Password by the device to authenticate to a SIP UAS (User Agent Server) when an outbound SJP Request is challenged with a SPn AuthPassword 401 or 407 response. Mirrors Voice Services SPn Service::AuthPassword If a value is specified for this parameter, it affects the way the device forms its AOR (Address of Record) or Public Address when sending outbound SIP Requests (such as REGISTER and INVITE); otherwise device forms its AOR in the normal way. See SPn URI description of Voice Services SPn Service::URI for details on how to use this parameter. Mirrors Voice Services SPn Service::URI SPn InboundCallRoute Routing rule for inbound calls on this trunk.
ph,ph2
48
OBiTALK InboundCallRoute
Mirrors Voice Services SPn Service::X_InboundCallRoute Routing rule for inbound calls on this trunk. Mirros OBiTALK Service::InboundCallRoute
ph,ph2
49
The status of the OBis connection to the network, system up-time (with last reboot reason code) as well as product information is available on the OBi System Status page.
50
The illustration above shows the service status on the OBi202 (note that SP3 and SP4 Service Status are not available on the 2 2 OBi100 and OBi110). The SPn service value (where n = 1, 2, 3 , or 4 ) will indicate the current state of the service with regard to its configuration (or not) and if configured its registration status. If there are problems with the registration or authentication of the OBi with a prescribed service, the SIP 4xx error message will be displayed here. This is very useful information for troubleshooting issues with SIP-based services.
51
Call Status
The Call Status page shows a number of running call statistics and state parameters for each active call currently in progress. A sample call status page is shown below.
52
For each entry on the call status page, the following buttons may be available: Remove: This button is available for all calls. Pressing this button will end that call. Record: This button is available for calls involving the Phone port only. Pressing this button allows you to record the current conversation in an audio (.au) file
53
Call History
The OBi Call History page shows the last 200 calls made with the OBi (400 calls for the OBi202). Detailed call information is available, including what terminals were involved, the name (if available) of the Peer endpoints making the call and the direction / path the call took. The Call History page also captures what time various events took place. The Call History can be saved at any time by clicking on the Save All button. The Call History can be saved as an XML formatted file called callhistory.xml.
54
55
Parameter Reset Statistics ResetStatistics RTP Statistics PacketsSent PacketsReceived BytesSent BytesReceived PacketsLost Overruns Underruns
Description Resets the statistics for this voice service Total RTP packets sent on this line Total RTP packets received on this line RTP payload bytes sent for this line RTP payload bytes received for this line Number of RTP packets lost on this line Number of times receive jitter buffer overrun on this line Number of times receive jitter buffer underrun on this line
Default Setting NA NA NA NA NA NA NA NA
56
Description Port status, such as on-hook, off-hook, ringing Loop current in mA PHONE port battery voltage in volts. Not applicable for LINE port Sensed differential Tip/Ring voltage in volts Caller ID of previous call
Default Setting NA NA NA NA NA
57
58
AddressingType
DHCP
IPAddress SubnetMask
59
DefaultGateway
DNSServer1
DNSServer2
PPPoEACName PPPoEServiceName PPPoEUsername PPPoEPassword VLANID VLANPriority Local Time CurrentLocalTime Time Service Settings NTPServer1 NTPServer2 LocalTimeZone
The default gateway IP address to assign to the device when AddressingType is set to Static IP address of the first DNS server to use, in addition to the ones obtained from the DHCP server when DHCP is also enabled. If AddressingType is set to Static, the device only uses DNSServer1 and DNSServer2 for DNS lookup. It will try up to 5 DNS servers when attempting to resolve a domain name. DNSServer1 and DNSServer2 will be tried first, whichever is specified, and then the ones obtained from the DHCP Server if available IP address of the second DNS server to use, in addition to the ones obtained from the DHCP server when DHCP is also enabled. If AddressingType is set to Static, the device only uses DNSServer1 and DNSServer2 for DNS lookup. It will try up to 5 DNS servers when attempting to resolve a domain name. DNSServer1 and DNSServer2 will be tried first, whichever is specified, and then the ones obtained from the DHCP Server if available PPPoE access concentrator name. Enter if it is required PPPoE service name. Enter if it is required PPPoE account username provided by your ISP PPPoE account password Valid range is 0 4094 (4095 is reserved). 0 means VLAN is disabled and egress packets are not tagged by the deivce. This setting applies to all packets sent by the deivce Valid choices are 0 7. This setting applies to all packets sent by the device. Current local date and time of the device (read only) Hostname or IP address of the first NTP server Hostname or IP address of the second NTP server Local time zone. Available choices are: GMT-12:00(Int'l Dateline West) GMT-11:00(Samoa) GMT-10:00(Hawaii) GMT-09:00(Alaska) GMT-08:00(Pacific Time) GMT-07:00(Mountain Time) GMT-06:00(Central Time) GMT-05:00(Eastern Time) GMT-04:00(Atlantic Time) GMT-03:30(Newfoundland) GMT-03:00(Buenos Aires,Greenland) GMT-02:00(Mid-Atlantic) GMT-01:00 GMT+00:00(London,Lisbon) GMT+01:00(Rome,Paris,Madrid) GMT+02:00(Athens,Cairo) GMT+03:00(Moscow,Baghdad) GMT+04:00(Abu Dhabi) GMT+04:30(Kabul) GMT+05:00(Islamabad,Karachi) GMT+05:30(New Delhi) GMT+05:45(Kathmandu) GMT+06:00
pool.ntp.org GMT-08:00
60
DaylightSavingTimeEnable DaylightSavingTimeStart
DaylightSavingTimeEnd DaylightSavingTimeDiff
Enable daylight saving time on the unit Daylight Saving Time Start Date. Format: month/day/weekday/hh:mm::ss, where month=1-12, day=(1-31), weekday=0,1-7 (0=special, 1=Monday, 7=Sunday), hh=0-23,mm=0-59,ss=0-59. If weekday=0, daylight saving starts on the given month/day; otherwise it starts on the weekday on or after the given month/day if day > 0, or on the weekday on or before the last-day-of-given-month+day+1 (note that day = -1 equivalent to last day of the month). :ss may be omitted if the value is 0; :mm:ss may be omitted if mm and ss are both 0. Daylight Saving Time End Date. Same format as Start Date Amount of time to add to current time during Daylight Saving Time. Format: [-]hh:mm:ss. :ss may be omitted if it is 0; :mm:ss may be omitted if both are 0. One of 32 Local DNS Records (numbered 1 32). Each record is a mini script of the following format: Name=A,A,A,... OR Name=R,R,R,... where Name represents the domain name to be resolved locally, and has the format prefix+domain (such as machine.sip+obihai.com). Everything after + is considered as the domain to be appended to the host field in each R on the right hand side. + is optional; if missing the full domain must be used in every R. A represents an A record which is just an ip address, such as 192.168.12.17. R represents an SRV record and has the format: {host:port,pri,wt} where - host is a hostname with or without domain part (such as xyz, xyz.abc.com.). A dot (.) at the end of host indicates it is a complete hostname that does not require the domain to be appended. - port is a port number (such as 5060) - pri is the priority. Valid value is 0(highest) 65535(lowest) - wt is the weight. Valid value is 0(lowest) 65535(highest) wt is optional; 1 is the default if not specified. pri is optional only if wt is not specified; 1 is the default if not specified. port is optional; the default to use will be based on the protocol (5060 for SIP, 80 for HTTP, etc.) . The enclosing curly braces { } are also optional if there is only one R; or if there is no comma used inside the R. Examples: _sip._udp+obihai.com=abc,xyz,pqr:5080,{mmm,2},{super.abc.com.} abc.obihai.com=192.168.15.118,192.168.15.108
11/1/7/2 1
61
Note: If the A record of a given hostname cannot be found in any of the Local DNS Records, the device will attempt to resolve it using external DNS queries. Any change applied to local DNS Record needs reboot in order to take effect.
LAN Settings
Below is a screen shot of the LAN Settings device web page.
62
Description
Default Setting
OperationMode
Router
RouterIPAddress
192.168.10.1
SubnetMask
255.255.255.0
Yes
ClientAddressRangeStart
100
192.168.2.1
192.168.10.100 192.168.2.50
The size of the IP address range from which to pick addresses to assign to DHCP clients that are not in the DHCP reservation list. If the range extends to addresses outside of the SubnetMask, a red exclamation mark (!) will be shown next to the value on the OBi device web page. IP address lease time in minutes Local Domain Name for the LAN
50 1440
DHCP Reservation
You can reserve up to 20 specific IP addresses for the DHCP server to give out to DHCP clients with specific MAC addresses. Below is a screen shot of the DHCP Reservation web page.
63
64
DRDOSAttackProtection, and VPNPassThrough, will take effect only If firewall is enabled. Below is a screen shot of the Firewall and DMZ device web page.
Yes
No
Port Forwarding
A port forwarding rule is useful for supporting a server application on a LAN client, such as FTP Server or HTTP Server. On the OBi 202 you can define up to 20 port forwarding rules. Below is a screen shot of the Port Forwarding web page.
65
Protocol
TCP
66
QoS Settings
QoS only applies to upstream traffic to the WAN side. The QoS settings described here takes effect in router mode only. It is based on Traffic Control(TC) and Hierarchy Token Bucket (HTB). Refer to the HTB home pages for details on TC and HTB (http://luxik.cdi.cz/~devik/qos/htb/). Four priority classes of upstream traffic are defined in the OBi QoS policy: The Restricted class has the highest priority, followed by the High, the Medium, and the Low classes. To fully utilize the upstream bandwidth, it is important to have a relatively accurate upstream bandwith estimation configured in the UpStreamBandwidth parameter; this tells the OBi the total upstream bandwidth to allocate to the four priority classes. The guaranteed uplink bandwidth for Restricted class traffice is configured in the RestrictedBandwidth parameter. The rest of the upstream bandwidth (the UpStreamBandWidth less the RestrictedBandwidth) is divided among the High, Medium,and Low classes proportionally according to the assigned weighting factor for each class in the configuration. Let Whigh, Wmedium, and Wlow be the respective weight assigned to the the High, Low, and Medium classes, the corresponding guaranteed uplink bandwidth for each class is calculated using the following formulae: BWhigh BWmedium BWlow = (UpstreamBandwidth RestrictedBandwidth) * Whigh / (Whigh + Wmedium + Wlow) = (UpstreamBandwidth RestrictedBandwidth) * Wmedium / (Whigh + Wmedium + Wlow) = (UpstreamBandwidth RestrictedBandwidth) * Wlow / (Whigh + Wmedium + Wlow) (Kbps) (Kbps) (Kbps)
The native voice related traffic is always classified as Restricted. Other network packets are classified based on the Differentiated Service Code Point (DSCP) in their IP headers. The 64 possible DSCP codes (0 63) can be mapped into one of the four priority classes using the configurable DSCP to Priority Class Mapping table. Below is a screen shot of the QoS Settings web page.
67
68
69
The guaranteed uplink bandwidth allocation weight for Low Priority class traffic. It must be a value bewteen 1 and 10
N (N = 0 63)
The priority class to be assigned to the packet which has the DSCP code equal to N in the IP header. The choices are: Restricted High Medium Low Note: Restricted class has the highest priority
For N = 8, 10, 12, or 14, the default is Low. For N = 48 or 56, the default is High. For all other DSCP codes, the default is Medium
70
Description The method used for assigning IP address, subnet mask, default gateway, etc., to the device. Available choices are: DHCP: IP address, default gateway, etc. are assigned by DHCP Server Static: IP address, default gateway, etc. are taken from the manually configured values The IP address to assign to the device when AddressingType is set to Static The subnet mask to use when AddressingType is set to Static The default gateway IP address to assign to the device when AddressingType is set to Static IP address of the first DNS server to use, in addition to the ones obtained from the DHCP server when DHCP is also enabled. If AddressingType is set to Static, the device only uses DNSServer1 and DNSServer2 for DNS lookup. It will try up to 5 DNS servers when attempting to resolve a domain name. DNSServer1 and DNSServer2 will be tried first, whichever is specified, and then the ones obtained from the DHCP Server if available IP address of the second DNS server to use, in addition to the ones obtained from the DHCP server when DHCP is also enabled. If AddressingType is set to Static, the device only uses DNSServer1 and DNSServer2 for DNS lookup. It will try up to 5 DNS servers when attempting to resolve a domain name. DNSServer1 and DNSServer2 will be tried first, whichever is specified, and then the ones obtained from the DHCP Server if available Valid range is 0 4094 (4095 is reserved). 0 means VLAN is disabled and egress packets are not tagged by the deivce. This setting applies to all packets sent by the deivce Valid choices are 0 7. This setting applies to all packets sent by the device. Current local date and time of the device Hostname or IP address of the first NTP server Hostname or IP address of the second NTP server Local time zone. Available choices are: GMT-12:00(Int'l Dateline West) GMT-11:00(Samoa) GMT-10:00(Hawaii) GMT-09:00(Alaska) GMT-08:00(Pacific Time) GMT-07:00(Mountain Time) GMT-06:00(Central Time) GMT-05:00(Eastern Time) GMT-04:00(Atlantic Time) GMT-03:30(Newfoundland) GMT-03:00(Buenos Aires,Greenland) GMT-02:00(Mid-Atlantic) GMT-01:00 GMT+00:00(London,Lisbon) GMT+01:00(Rome,Paris,Madrid) GMT+02:00(Athens,Cairo) GMT+03:00(Moscow,Baghdad)
Default Setting
AddressingType
DHCP
DNSServer1
DNSServer2
VLANID VLANPriority Local Time CurrentLocalTime Time Service Settings NTPServer1 NTPServer2 LocalTimeZone
pool.ntp.org GMT-08:00
71
DaylightSavingTimeEnable DaylightSavingTimeStart
GMT+04:00(Abu Dhabi) GMT+04:30(Kabul) GMT+05:00(Islamabad,Karachi) GMT+05:30(New Delhi) GMT+05:45(Kathmandu) GMT+06:00 GMT+07:00(Bangkok,Jakarta) GMT+08:00(Beijing,HK,Singapore) GMT+09:00(Tokyo,Seoul) GMT+10:00(Sydney,Guam) GMT+11:00(Solomon Is.) GMT+12:00(Fiji,Auckland) Yes 3/8/7/2
DaylightSavingTimeEnd DaylightSavingTimeDiff
Enable daylight saving time on the unit Daylight Saving Time Start Date. Format: month/day/weekday/hh:mm::ss, where month=1-12, day=(1-31), weekday=0,1-7 (0=special, 1=Monday, 7=Sunday), hh=0-23,mm=0-59,ss=0-59. If weekday=0, daylight saving starts on the given month/day; otherwise it starts on the weekday on or after the given month/day if day > 0, or on the weekday on or before the last-day-of-given-month+day+1 (note that day = -1 equivalent to last day of the month). :ss may be omitted if the value is 0; :mm:ss may be omitted if mm and ss are both 0. Daylight Saving Time End Date. Same format as Start Date Amount of time to add to current time during Daylight Saving Time. Format: [-]hh:mm:ss. :ss may be omitted if it is 0; :mm:ss may be omitted if both are 0. One of 32 Local DNS Records (numbered 1 32). Each record is a mini script of the following format: Name=A,A,A,... OR Name=R,R,R,... where Name represents the domain name to be resolved locally, and has the format prefix+domain (such as machine.sip+obihai.com). Everything after + is considered as the domain to be appended to the host field in each R on the right hand side. + is optional; if missing the full domain must be used in every R. A represents an A record which is just an ip address, such as 192.168.12.17. R represents an SRV record and has the format: {host:port,pri,wt} where - host is a hostname with or without domain part (such as xyz, xyz.abc.com.). A dot (.) at the end of host indicates it is a complete hostname that does not require the domain to be appended. - port is a port number (such as 5060) - pri is the priority. Valid value is 0(highest) 65535(lowest) - wt is the weight. Valid value is 0(lowest) 65535(highest) wt is optional; 1 is the default if not specified. pri is optional only if wt is not specified; 1 is the default if not specified. port is optional; the default to use will be based on the protocol (5060 for SIP, 80 for HTTP, etc.) . The enclosing curly braces { } are also optional if there is only one R; or if there is no comma used inside the R.
11/1/7/2 1
72
Note: If the A record of a given hostname cannot be found in any of the Local DNS Records, the device will attempt to resolve it using external DNS queries. Any change applied to local DNS Record needs reboot in order to take effect.
73
Auto Provisioning Parameter Guide: Parameter Auto Firmware Update Current operational method of auto firmware updating. Available choices are: Method Disabled = Do not check for f/w upgrade from FirmwareURL System Start = Check for f/w upgrade from FirmwareURL just once on system start Periodically = Check for f/w upgrade from FirmwareURL on system start, and then periodically at the interval specified in the Interval paramter Description Default Setting
Disabled
Note: First f/w upgrade check on system start will be performed after a random delay of 0-30s
Interval
74
seconds between each checking of f/w upgrade check from FirmwareURL. If value is 0, device checks once only on system start (i.e., equivalent to setting Method to System Start) FirmwareURL Username Password Auto Provisioning Current operational method of Provisioning. Available choices are: Disabled = Do not download from ConfigURL System Start = Download from ConfigURL just once on system start Periodically = Download from ConfigURL on system start, and then periodically at the interval specified in the Interval paramter URL of firmware package. URL must include scheme. Supported schemes are http:// and tftp:// Username for authentication, if needed, if scheme is http:// Password for authentication, if needed, if scheme is http://
Method
System Start
Note: First download on system start will be performed after a random delay of 30 90s. If there is a firmware update scheduled at the beginning. Or a random delay of 10- 70s.. When Method is set to Periodically, this is the number of seconds between download from ConfigURL. If value is 0, device downloads once only on system start (i.e., equivalent to setting Method to System Start) URL of config file Non-volatile generic parameters which can be referenced in other parameters, such as ConfigURL Temporary variables used in scripts for ConfigURL. Please refer to device provisioning guide for examples on how to these these variables
Interval
tftp://$DHCPOPT66/$MAC.xml
Any plain text, or reference to another parameters full TR104 name prepended by a $ A comma separated list of parameters that are allowed to use this macro expansion. Each parameter must be specified using its full TR-104 name. Specify ANY to allow it in all parameters.
ExpandIn
75
SyntaxCheckResult
This is read only status value regarding the syntax of the UDM. Pass means that this UDM is valid. Otherwise, it shows the syntax error detected by the device either in the Value or ExpandIn parameters of the UDM.
$MACRO Expansion Supported by the OBi Device Macro Name MAC MACC mac FWV HWV Description Device MAC address, such as 9CADEF000000 Device MAC address with colon, such as 9C:AD:EF:00:00:00 Device MAC address lower case, with colon, such as 9c:ad:ef:00:00:00 Firmware version, such as 1.0.3.1626 Hardware version, such as 2.8 Where It Can Be Used ANY ANY ANY ANY ANY
76
IPA DM DMN OBN DSN GPRMn n=0 7 TPRMn n=0-3 UDMn, n=0-3
Device current IP Address, such as 192.168.15.100 Device Model Name, such as OBi110 Device Model Number, such as 110 Device OBi Number, such as 200123456 Device S/N, such as 88B01NA00000 Value Auto Provisioning::GPRMn Value Auto Provisioning::TPRMn Value of User Define Macro n::Value
ANY ANY ANY ANY ANY Auto Provining::ConfigURL, Auto Firmware Update::FirmwareURL Auto Provining::ConfigURL, Auto Firmware Update::FirmwareURL The value of User Define Macro n::ExpandIn
77
Device Administration
Description Web Server Port Number Administrator Password, case sensitive User Password, case sensitive Allow access the OBi device management web pages from the WAN side Enable IVR for local configuration IVR access password (must be all digits)
Syslog Server
IP address of the Syslog Server where the device sends syslog debug messages to. If the value is blank, syslog is disabled Syslog Server Port Number Syslog Message Level Value of the User-Agent header in all HTTP Requests which are used in firmware upgrade and auto provisioning.
514 7 $DM
78
Device Update
See the section entitled, Firmware: OBi Device Update and Management for details on device firmware updates.
79
SIP Registration
Device can be setup to periodically register with a SIP Proxy Server or SIP Registration Server. SIP Proxy Server and SIP Registration Server can be different, although they are usually the same in practice. SIP Proxy Server is a required parameter that must be configured on the OBi device. The Registration Server is optional and assumed to be the same as the SIP Proxy Server if it is not configured on the device. The main purpose of registration is to create and maintain a dynamic binding of the SIP account to the devices local contact address. Service provider can also rely on this periodic message to infer if the device is online and functional. Each OBi device takes only one local IP address that is either statically assigned in the devices configuration, or dynamically obtained 2 2 from a local DHCP server. The SPn service for n = 1, 2, 3 , and 4 , on the other hand each uses a different local contact port for sending and receiving SIP messages (default is 5060, 5061, 5062, and 5063 respectively). Note that dynamic address binding through periodic registration is not strictly necessary if the local IP address of the device does not change; the devices contact address may be statically configured on the Registration Server.
80
of the SIP Proxy Server or SIP Registration Server. The resolution of the server domain name into IP address is performed in the following manner: Try looking up the name as DNS A Record. If not found. Try looking up the name as DNS SRV Record. If not found. Try looking up the name as DNS SRV Record with _sip._udp. prepended to the hostname. If not found, fail the request.
If the result from the DNS query is a SRV record, the server port is taken from that record also (the server port value configured on the device is ignored). Otherwise, the server port is taken from the configured value or use 5060 if none specified.
The device always uses the mapped external contact address in all outbound SIP requests instead of its local contact address if one is discovered by either method discovered above.
81
While maintinaing registration with the Primary Server, the OBi will continually attempt to fallback to one of the candidate servers that has higher priority than the primary server, if any. The list of candidate servers that the device is trying to fallback on is known as the primary fallback list, which may be empty. In addition, an OBi device can be configured to maintain a secondary registration with a server that has lower or equal priority than the primary server. Secondary registration can be enabled by setting the parameter X_SecondaryRegistration to YES. If X_ProxyServerRedundancy is NO, however, X_SecondaryRegistration does not take any effect. If this feature is enabled, as soon as a primary server is found, the OBi will search for a working secondary server in the same manner from the list of candidate servers that are of lower or equal priority than the primary server. Simarly, once a secondary server is found, the OBi forms a secondary fallback list to continually attempt to fallback on if the list is not empty. The interval for checking the primary fallback list and the secondary fallback list are configured in the parameter X_CheckPrimaryFallbackInterval and X_CheckSecondaryFallbackInterval respectively. These parameters are specified in seconds and the default value is 60 for both. Notes: Secondary server exists implies primary server exists. If the secondary server exists, it immediately becomes the primary server when the current primary server is fails; device then starts searching for a new secondary server if the candidate set is not empty. The candidate list may change (lengthened, shortened, priority changed, etc.) on every DNS renewal (based on the entrys TTL). Device will rearrange the primary and secondary servers and fallback lists accordingly, whichever applicable. If the server redundancy feature is disabled, the device resolves only one IP address from the servers domain name, and will not attempt to try other IP addresses if the server is not responding.
SIP Privacy
The OBi device observes inbound caller privacy and decodes callers name and number from SIP INVITE requests by checking the FROM, P-Asserted-Identity (PAID for short), and Remote-Party-ID (RPID for short) message headers. All these headers may carry callers name and number information. If PAID is present, device takes the name and number from it. Otherwise, it takes name and number from RPID if it is present, or from the FROM header otherwise. RPID, if present, will include privacy setting desired by the caller. This privacy may indicate one of the following options: off = no privay requested; the OBi will show name and number. full = full privacy requested; the OBi will hide both name and number. name = name privacy requested; the OBi will show the number but hide the name. uri = uri privacy requested; the OBi will show the name but hide the number.
Regardless, if PAID exists or not, the device always takes the privacy setting from the RPID if it is present in the INVITE request. Note that if the resulting caller name is Anonymous (case-insenstive), device treats it as if the caller is requesting full privacy. For outbound calls, callers preferred privacy setting can be stated by the device in a RPID header of the outbound INVITE request. To enable this behavior, the parameter ITSP Profile X SIP::X_InsertRemotePartyID must be set to YES or TRUE, which is the default value of this parameter. OBi only supports two outbound caller privacy setting: privay=off or privacy=full. The RPID header generated by the device carries the same name and number as the FROM header. If outbound caller-ID is blocked, the device sets privay=full in RPID, and also sets the display name in the FROM and RPID headers to Anonymous for backward compatibility. The device will not insert PAID in outbound INVITE requests.
82
It should be noted that the STUN feature used in this context is only for RTP packets, not SIP signaling packets (which typically does not require STUN). The devices sends out a STUN binding request right before making or answering a call on SP1/2. If the request is successful, the device decodes the mapped exteranl address and port from the binding response and use them in the m= and c= lines of its SDP offer or answer sent to the peer device. If the request fails, such as STUN server not found or not responding, the call will go on without using external address in the SDP. Standard RTP requires the use of even number port in the m= line. If the external port is not a even number, device changes the local RTP port and redo STUN, and will continue to do this up to 4 times or until a even external port number is found. If the 4th trial still results in an odd external port number, the call will go on without using external address in the SDP. OBi supports standard ICE based on RFC5245. ICE is done on a per call basis for automatically discovering which peer address is the best route for sending RTP packets. To enable ICE on the device, set the parameter: ITSP Profile X General::X_ICEEnable to YES (or TRUE). The default, however, is NO (or FALSE). Note that ICE would be more effective if STUN is also enabled. However STUN not a requirement for using ICE on the device. If STUN is enabled and an external RTP address different from its local address is discovered, OBi offers two ICE candidates in its SDP: The local (host) address (highest priority) The external (srflx or server reflesive) address
Otherwise only the local host candidate is shown in the devices SDP. Note that the device uses the srflx address in the m= and c= lines of the SDP if STUN is enabled and successful. If ICE is enabled and peers SDP has more than one candidate, device sends STUN requests to each peer candidate from its local RTP port. As soon as it receives a response from the highest priority candidate, device concludes ICE and uses this candidate to communicate with the peer subsequently. Otherwise, the OBi allows up to 5s to wait for the response from all the candidates, and selects the highest priority one that has a response. Once ICE is completed successfully, the device will further apply symmetric RTP concept to determine the peers RTP address (i.e., send to the address where peers RTP packets are coming from).
83
When acts as a loopback mirror, OBi device always sends primer packets so that incoming packets can get through NAT/Firewall. The media loopback feature is controlled by the following parameters (under PHONE Port Calling Features section): AcceptMediaLoopback Enable device to accept incoming call that requests media loopback. Default is YES. MediaLoopbackAnswerDelay The delay in millis before the OBi answers a media loopback call. Default is 0. MediaLoopbackMaxDuration The maximum duration to allow for an incoming media loopback call. Default is 0, which means the duration is unlimited. PHONE port is off hook. PHONE port is ringing. PHONE port is onhook with a call on hold.
Note that the device will reject incoming media loopback call if: -
Device will terminate an inbound media loopback call already in progress when: PHONE port is off-hook. PHONE port is ringing.
To make an outgoing loopback call, user can dial one of the following star codes before dialing the target number: *03 Make a Media Loopback Call. *04 Make a RTP Packet Loopback Call.
Note that outbound Media Loopback Call is not subjected to call duration limit; it will last until the user hangs up or until the called device ends the call.
84
SignalingProtocol
SIP
DTMFMethod
Auto
X_UseFixedDurationRFC2833DTMF
FALSE
DigitMap
(1xxxxxxxxxx|<1>[29]xxxxxxxxx|011xx.|xx.) No
3478 No
No
85
86
5060 UDP
UserAgentTransport OutboundProxy OutboundProxyPort RegistrationPeriod TimerT1 TimerT2 TimerT4 TimerA TimerB TimerD TimerE TimerF TimerG TimerH TimerI TimerJ TimerK InviteExpires ReInviteExpires RegisterExpires RegistersMinExpires RegisterRetryInterval DSCPMark VLANIDMark EthernetPriorityMark X_SpoofCallerID
UDP
5060 60 500 4000 5000 500 32000 32000 500 32000 500 32000 5000 32000 5000 60 10 3600 15 30 0 0 3 No
87
bridged call (from another trunk, such as PSTN Line or another SP Service). Otherwise, device always its own account information to form the FROM header. Note that most service provider will not allow originating a call if the FROM header field does not match the account credentials. Enable this option only if you are sure that the service provider allows it. For example, an IP PBX may allow it. Enable the use of SIP REFER for call transfer. If disabled, device will bridge the call instead when performing a call transfer (which consume some resources on the device) Enable the use the target's AOR (Address of Record or public address) in Refer-To header of SIP REFER. If disabled, the target's Contact will be used instead Enable the use of 302 resonse to INVITE for call forward. If disabled, device will bridge the call legs instead when forwarding a call (and will consume some resources on the device) If a value is specified, device includes a User-Agent header in all SIP Requests, or a Server header in all SIP responses, that contains exactly the given value Enable the device to deocde the DATE header sent by the ITSP in a 200 response to its REGISTER. The DATE header specifies the current GMT time and the device can use to adjust its local time and date without relying on NTP Enable the device to include a Remote-Party-ID header in its outbound SIP INVITE to indicate to the ITSP the callers preferred privacy setting (either full or none) Enable session refresh signalling (with SIP Re-INVITE) during a connected call. This allows the OBi to detect if the connection with the peer is broken adnormally so it can release the call. Disable this option if the ITSP does not support Re-INVITE sent from the client device. A comma separated list of IP addresses such that the device only accepts SIP requests coming from one of the given addresses. If the list is empty, the device accepts SIP requests from any IP address Enable the device to include a X-RTP-Stat header in a BYE request or 200 response to BYE request at the end of an established call. This header contains a summary of RTP statistics collected during the call. Enable this option to have the device SUBSCRIBE to the message-summary event package to support MWI and VMWI service. Note that device handles NOTIFY of this event package regardless MWISubscribe is enabled or not X_MWISubscribeURI Blank implies to use the same URL as REGISTER for the TO and FROM header as well as the Request-URI Otherwise, if the URI does not contain @, it is user as the
X_UseRefer
No
X_ReferAOR
Yes
X_Use302ToCallForward
Yes
X_UserAgentName
OBIHAI/${DM}-${FWV}
X_ProcessDateHeader
Yes
X_InsertRemotePartyID
Yes
X_SessionRefresh
Yes
X_AccessList
X_InsertRTPStats
Yes
X_MWISubscribe
No
88
userid field in TO/FROM header as well as the Request-URI, which are otherwise same as REGISTER If the URI contains @, it is used in the TO and FROM header as well as the Request-URI as is Note that OBi device forms the Request-URI of SUBSCRIBE the same way as the TO header, with an additional port number X_MWISubscribeExpires X_MWISubscribeExpires: periodic interval to renew SUBSCRIBE (default 3600s) Enable proxy redundancy feature on the device. To use this feature, device registration must be enabled and the SIP Registration Server or Outbound Proxy Server must be configured as a domain name Enable device to register with a secondary server in addition to the primary server. X_ProxyServerRedundancy must be enabled for this parameter to take effect Interval in seconds at which the device should check the primary fallback list of candidate servers Interval in seconds at which the device should check the secondary fallback list of candidate servers If this parameter is not blank, OBi will include a ProxyRequire header stating the value of this parameter in all SIP requests sent to the ITSP Value for the Max-Forward header in all SIP requests sent by the OBi If this parameter is not blank, OBi will include an AcceptLanguage header stating the value of this parameter in all SIP requests sent to the ITSP. Enable this option to let OBi automatically prepend a standard prefix to the domain name when querying DNS Server to resolve the ProxyServer or OutboundProxy name as a SRV record. The standard prefix is _sip._udp. for SIP over UDP, _sip._tcp. For SIP over TCP, and _sip._tls. for SIP over TLS. Enable this option to turn on the support for RFC3262 (reliable provisional SIP responses). If enabled, OBi will announce this support in a SIP Supported header, and will require a caller to use this option if the caller also supports this feature. Enable this option to let the OBi use the public IP address and port it has discovered as its SIP Contact address A static public IPv4 address, if specified, will be used by the OBi to form its SIP Contact address Enable this option to let the OBi insert a blank rport parameter in the VIA header our outbound SIP messages. This option should be turned off if you are using port 3600
X_ProxyServerRedundancy
No
X_SecondaryRegistration
No
60 60
X_MaxForward X_AcceptLanguage
70
X_DnsSrvAutoPrefix
No
X_Support100rel
No
Yes
Yes
89
forwarding on the external router to route inbound SIP messages to the OBi
DSCPMark X_UseSSL
0 No
90
Starting with firwmare release 1.2, the following features are supported: MWI (Message Waiting Indication) and VMWI (Visual Message Waiting Indication) for Google Voicemail. Non-Gmail domain in account name for Google Voice Communications Service. Accept DTMF input from a Google Talk client entered by the user as text messages (only 0 9, *, and # will be recognized by the device). Accept the setting of the parameter ITSP Profile A/B General::DTMFMethod. The value can be either InBand or RFC2833. Other values will be reverted to RFC2933. Default is RFC2833. Voice Service Features of the OBi Device.
91
92
Parameter Guide: Parameter SPx Service Enable X_ServProvProfile X_RingProfile Enable this line Select a Service Provider Profile for this service. Choices are A, or B Select a Ring Profile to ring the PHONE port with for incoming calls on this service that are routed to the PHONE port. The ringing pattern will be taken from the given profile. Choices are A, or B Select a Codec Profile for all calls on this service. Choices are A, or B Routing rule for directing incoming calls on this service. The default rule is to send all incoming calls to the PHONE port (ph). See OBi Call Routing and Digit Map Section for a description of the syntaxes for specifying this parameter Enable registration for this line. If set to YES, device sends periodic SIP REGISTER to the service provider according to the settings in the ITSP Profile. Otherwise, device does not send any SIP REGISTER for the service Enable sending keep alive message. If set to YES, device sends periodic keep-alive messages to the destination specified in X_KeepAliveServer and X_KeepAliveServerPort, at the interval specified in X_KeepAliveExpires. The content of this message is the ascii string keep-alive\r\n Keep alive period in seconds Hostname or IP address of keep alive server UDP port of the keep alive server The type of keep alive messages to send out periodically if keepalive is enabled. It can be one of the following choices: - keep-alive: The string keep-alive - empty: A blank line - stun: A standard STUN binding request; device will use the binding response to form its contact address for REGISTRATION X_UserAgentPort DirectoryNumber X_DefaultRing UDP port where the device sends and listens for SIP messages Directory number associated with this service Default ring pattern number to ring the PHONE port for incoming calls on this trunk that are routed to the PHONE port according to the InboundCallRoute of this service. The ring pattern is taken 1 5060 5060 keep-alive Yes A A Description Default Setting
X_CodecProfile X_InboundCallRoute
A ph
X_RegisterEnable
Yes
X_KeepAliveEnable
No
15
93
X_CallOnHoldRing
X_RepeatDialRing
X_BargeInRing
X_CallParkedRing
X_SIPDebugOption
from the selected Ring Profile. Valid choices are 1-10 Pattern to ring PHONE port when holding a call on this trunk that has been connected to the PHONE port. Typically this is a very short distinctive ring pattern that serves as a reminder to the user that a call is being on hold. The ring pattern is taken from the selected Ring Profile. Valid choices are: NO Ring, or 1-10 The ring pattern number to use to ring the PHONE port when a repeat dial operation on this trunk is successful as the called party is either ringing or answered Call Waiting Ring pattern to ring the PHONE port when the incoming call is requesting to barge-in. This is applicable in a call-waiting scenario on the PHONE port Ring pattern to ring the PHONE port only as a reminder that there are some calls parked in the parking lot. This feature is applicable only in an OBiPLUS solution. Enable sending of SIP signaling debug information to the syslog server (if one is configured on the device). Available choices are: Disable (do not send SIP signaling debug information) Log All Messages Log All Except REGISTER Messages The User ID to authenticate to a SIP UAS (User Agent Server) when an outbound SIP request sent by the device is challenged by the UAS with a 401 or 407 Response The Password (corresponding to AuthUserName) to authenticate to a SIP UAS (User Agent Server) when an outbound SIP request sent by the device is challenged by the UAS with a 401 or 407 Response This parameter affects the way the AOR is formed by the device in outbound SIP Requests. The AOR has the format: user@domain. If the value of URI is empty, device gets the user portion of its AOR from the AuthUserName, and the domain portion the value of ITSP Profiles UserAgentDomain if it is not empty, or that of the ProxyServer otherwise. If the value URI is not empty and does not contain @, it is used as the user portion of the AOR while the domain portion is formed the usual way. If the value of URI contains @, it is interpreted as a full AOR and device takes it as the AOR as is. Some Examples: 1) Let ProxyServer = sip.myitsp.com, AuthUserName = 4089991123, URI=[empty], UserAgentDomain=[empty], then AOR = 4089991123@sip.myitsp.com 2) Change UserAgentDomain to users.myitsp.com, then AOR = 4089991123@users.myitsp.com 3) Change URI to bobdylan, then AOR = bobdylan@users.myitsp.com 4) Change URI to bobdylan@superusers.myitsp.com, then AOR = bobdylan@superusers.myitsp.com
10
Disable
AuthPassword
URI
94
Note: In all cases, device uses AuthUserName and AuthUserPassword to compute authorization if challenged by a 401 or 407 response. SPx Calling Features CallerIDName Display name to identify the subscriber. The display name field is usually inserted in a FROM header in outbound SIP requests (such as INVITE) for the purpose of displaying a Caller ID Name on the recipients device. The maximum number of simultaneous calls that may be established on this service Enable call forwarding of all calls unconditionally by the device. If CallForwardUnconditionalNumber is blank, this parameter is treated as if it has been set to No. Note: It is possible for a user to set this parameter from the phone using a Star Code 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 phone using a Star Code Enable call forwarding of all incoming calls when the device is busy. If CallForwardOnBusyNumber is blank, this parameter is treated as if it has been set to No. Device is considered busy if one of the following conditions holds: This service already reaches the limit of simultaneous calls as specified in MaxSessions DND (Do Not Disturb) Service is enabled on this service If the call is routed to the PHONE port where the phone is in a busy state (such as ringing, dialing, playing reorder, or already having 2 calls in progress) Note: It is possible for a user to set this parameter from the phone using a Star Code Directory number to forward all incoming calls on this service when the device is busy. Maximum Length is 127 characters. Note: It is possible for a user to set this parameter from the phone using a Star Code Enable call forwarding of all incoming calls when the call is not answered after a period as specified in CallForwardOnNoAnswerRingCount. If CallForwardOnNoAnswerNumber is blank, this paramete is treated as if it has been set to No. Note: It is possible for a user to set this parameter from the phone using a Star Code Directory number to foward all incoming calls when the call is not answered after a period specified in CallForwardNoAnswerRingCount Note: It is possible for a user to set this parameter from the phone using a Star Code
MaxSessions CallForwardUnconditionalEnable
2 No
CallForwardUnconditionalNumber
CallForwardOnBusyEnable
No
CallForwardOnBusyNumber
CallForwardOnNoAnswerEnable
No
CallForwardOnNoAnswerNumber
95
CallForwardOnNoAnswerRingCount
Number of rings to be considered by the device as no answer to an incoming call. Note: 1 ring is approximately 6s Enable Message Waiting Indication Service for this service. If enabled, device plays stutter dial tone on the PHONE port (or PHONE1 port) when there are new messages for the subscriber. It will also turn on VMWI signal on the PHONE port (or PHONE1 ort) if X_VMWIEnable is set to Yes Enable Message Waiting Indication Service for this service. If enabled, device plays stutter dial tone on the PHONE2 port when there are new messages for the subscriber. It will also turn on VMWI signal on the PHONE2 port if X_VMWIEnable is set to Yes Enable Visual Message Waiting Indication for this service for the PHONE port (or PHONE1 port) Enable Visual Message Waiting Indication for this service for the PHONE2 port This is a state rather than a configuration parameter, that indicates if there are any new messages for this subscriber on the service providers voicemail system Enable blocking of Anonymous Calls on this service. Anonymous calls are rejected with a SIP 486 (Busy) response and Call Forward On Busy service is not applied. Note: It is possible for a user to set this parameter from the phone using a Star Code Enable masking of Caller-ID information for all outgoing calls. If enabled, the called party should perceive the call as coming from an anonymous caller. Note: It is possible for a user to set this parameter from the phone using a Star Code Enable Do Not Disturb Service. If enabled, all incoming calls on this service are treated as if the device is busy. Note: It is possible for a user to set this parameter from the phone using a Star Code Limit on the call duration in seconds for all outbound calls that are bridged from the same or another trunk. A blank or 0 value implies the call duration is not limited. Enable the device to accept SUBSCRIBE to this trunks dialog event package Enable the device to accept SUBSCRIBE to the LINE port status Enable the device to automatically skip call screening when the underlying ITSP is Google Voice This is a drop down list with 3 choices: - Disable SRTP = Do not use SRTP for all calls; the call will fail if the peer insists on using SRTP only - Use SRTP Only = Require all calls to use SRTP; the call will fail if the peer does not support SRTP - Use SRTP When Possible = Use SRTP for a call if the peer supports SRTP; otherwise fallback to use regular unencrypted SRTP
MWIEnable
No
MWIEnable2
No
No No No
AnonymousCallBlockEnable
No
AnonymousCallEnable
No
DoNotDisturbEnable
No
X_BridgedOutboundCallMaxDuration
96
97
(<ob>xxxxxxxxx|obxxxxxxxxx)
InboundCallRoute
ph
RingProfile
CodecProfile DefaultRing
A 2
98
CallOnHoldRing
RepeatDialRing
DTMFMethod
UseFixedDurationRFC2833DTMF
PHONE port according to the InboundCallRoute of this service. The ring pattern is taken from the selected Ring Profile. Valid choices are 1-10 Pattern to ring PHONE port when holding a call on this trunk that has been connected to the PHONE port. Typically this is a very short distinctive ring pattern that serves as a reminder to the user that a call is being on hold. The ring pattern is taken from the selected Ring Profile. Valid choices are: NO Ring, or 1-10 The ring pattern number to use to ring the PHONE port when a repeat dial operation on this trunk is successful as the called party is either ringing or answered Method to pass DTMF digits to peer device. Available choices are: Inband - DTMF tone are sent as inband audio signal RFC2833 - DTMF tone events are relayed per RFC2833 SIPInfo - DTMF tones are relayed with SIP INFO request Auto - Method to use based on call setup negotiation (either Inband or RFC2833 may be negotiated) When relaying DTMF digit events on this trunk uisng RFC2833, the RFC2833 RTP packets normally will keep streaming for as long as the digit is pressed. With this option set to TRUE, the device sends only one RTP digit event packet with a fixed duration of 150 ms regardless how long the digit has been pressed
AUTO
FALSE
CallForwardUnconditionalNumber
CallForwardOnBusyEnable
No
99
CallForwardOnBusyNumber
the phone using a Star Code Directory number to forward all incoming calls on this service when the device is busy. Maximum Length is 127 characters. Note: It is possible for a user to set this parameter from the phone using a Star Code Enable call forwarding of all incoming calls when the call is not answered after a period as specified in CallForwardOnNoAnswerRingCount. If CallForwardOnNoAnswerNumber is blank, this parameter is treated as if it has been set to No. Note: It is possible for a user to set this parameter from the phone using a Star Code Directory number to foward all incoming calls when the call is not answered after a period specified in CallForwardNoAnswerRingCount Note: It is possible for a user to set this parameter from the phone using a Star Code Number of rings to be considered by the device as no answer to an incoming call. Note: 1 ring is approximately 6s The maximum number of simultaneous calls that may be established on this service Enable blocking of Anonymous Calls on this service. Anonymous calls are rejected with a SIP 486 (Busy) response and Call Forward On Busy service is not applied. Note: It is possible for a user to set this parameter from the phone using a Star Code Enable masking of Caller-ID information for all outgoing calls. If enabled, the called party should perceive the call as coming from an anonymous caller. Note: It is possible for a user to set this parameter from the phone using a Star Code Enable Do Not Disturb Service. If enabled, all incoming calls on this service are treated as if the device is busy. Note: It is possible for a user to set this parameter from the phone using a Star Code
CallForwardOnNoAnswerEnable
No
CallForwardOnNoAnswerNumber
CallForwardOnNoAnswerRingCount
MaxSessions AnonymousCallBlockEnable
2 No
AnonymousCallEnable
No
DoNotDisturbEnable
No
100
Note: If AuthPassword is specified, AuthUserID may be set to blank to let the device use the default value which is a special hash of the AuthPassword. This is only applicable if the external gateway is also an OBi device that understands how to generate the default AuthUserID using the same hash function.
101
AA Callback Service
The OBi offers two methods for the AA to call you back at a number that you picked (or designated by the admin of the OBi device). The first method is by statically configuring a trunks InboundCallRoute. A rule can be added to the InboundCallRoute parameter to have the AA call back the callers or any other number, if the caller hangs up before the AA answers. The rule should indicate that aa(callback-number) is the target destination of the call, where callback-number is the number that the AA should call back if the caller hangs up before the AA answers the call. For example, the following rule {(<**1>(14089913313|12121559801)):aa($1)} says that: if 14089913313 or 12121559801 calls, the call is routed to AA. If caller hangs up before the AA answers, AA calls the number represented by $1. Recall that $1 is expanded into the caller number after processing by the digit map on the left side of the colon. In this case it is the callers number prepended by **1. The **1 is required for outbound call routing when AA calls back; here it indicates SP1 is to be used for calling back (assuming default value of the AA OutboundCallRoute parameter) The parameter AA Service::CallbackAnswerDelay controls the number of milliseconds before AA answers when a callback number is specified as shown in the example. The default value is 10000 ms. Without the (callback-number) argument, the AA behaves the normal way and the answer delay is governed by the parameter AA Service::AnswerDelay. The second method is by selecting AA option 3 to Enter a callback number after the AA answers the call. Caller can explicitly enters the number to be called back by the AA. If a valid number is entered, AA says Thank You and Goodbye, and then starts calling back 2s after the current call has ended. If number entered is invalid, AA plays SIT tone followed by an error message. Note that the variable $1 (representing the callers number) is carried over to the subsequent AA callback call. The AA DigitMap can include $1 to be used in a callback context. For example, the following rule in the AA DigitMap (<00:**1$1>| ) says that if the AA dials 00, the device will transforms it into the callers number prepended by **1. In other words, if the caller wants the AA to callback the current number (typically the case), he can simple enter 00# after selecting option 3 on the AA menu. Note that $1 can only be used as part of a substitution element in the digit map; it must not be used for matching elements since its value is unknown.
102
Automated Attendant:
IVR Announcement Number 1 2 Attendant Announcement Press 1 to continue this call. Press 2 to make a new call. What Happens Next: When accessed from the OBiTalk, If UsePIN authentication is enabled and the user enters a matching PIN, the OBi Attendant will immediately prompt the user to enter number followed by the pound (#) key. If the entered PIN is not a match, the Attendant will give the user two additional attempts to enter the PIN. If the third attempt does not match, the Attendant will announce a thank you message and disconnect the call. If a valid number is entered, AA says Thank you and Goodbye, hangs up, and then callback the number in 2s. It the given number is invalid, AA plays SIT tone followed by an error message. Tips: Caller can simply dial 00# to have the AA call back his current number.
Each prompt list control elements starts with a & in a prompt list. The following control elements are supported: &pause(<duration>) = pause playing for a number of seconds as given by the <duration> parameter
103
An example of prompt list: %User1%;r=105,&pause(3),%User5%,%User9%;r=0-1350,&pause(15) You can replace any of the following AA prompt lists with your own specified prompt lists: AA Prompt List Welcome InvalidPin EnterPin MenuTitle Menu System Default Welcome to OBi Attendant Invalid PIN Enter PIN Main Menu Press 1 to continue this call. Press 2 to make a new all. Press 3 to enter a callback number. Please wait while your call is being connected. Enter number followed by the # key. Thank you for choosing Obihai Technology. Goodbye. Prompt Be Played Once, at the beginning when the AA starts After user enters an invalid PIN Prompts user to enter a valid PIN Once, after Welcome and before announcing the menu options A couple of times after MenuTitle
Once, after user enters a phone number to call Prompts user to enter a valid number after option 2 or option 3 is selected by the user When user presses * or # key to leave the AA
104
105
SpaceAvailable
DigitMap
For OBi100: ([1-9]x?*(Mpli)| [1-9]|[1-9][0-9]| <00:$1>|0| **1(Msp1)| **2(Msp2)| **9(Mpp)| (Mpli)) For OBi110: ([1-9]x?*(Mpli)| [1-9]|[1-9][0-9]| <00:$1>|0| **1(Msp1)| **2(Msp2)| **8(Mli)| **9(Mpp)| (Mpli)) For OBi202: ([1-9]x?*(Mpli)| [1-9]|[1-9][0-9]| <00:$1>|0| **1(Msp1)| **2(Msp2)| **3(Msp3)| **4(Msp4)| **9(Mpp)| (Mpli))
106
OutboundCallRoute
After the caller dials a number that is acceptable by the AA (according to its DigitMap) to make a further call, the device uses this outbound call routing rule to determine which service to make this call with. See OBi Call Routing and Digit Map Section for a description of the syntaxes to specify this parameter Note that while forking to multiple numbers in an AA outbound call routing rule is not supported on OBi100 and OBi110, it is supported on the OBi202. For example, on the OBi202 you may have a rule like this: {0:ph,ph2} which forks to ring both PHONE1 and PHONE2. In general you can have up to 4 destinations is a forking rule. On the other hand, you must not specify more than one destination number on the OBi100 and OBi110.
For OBi100: {([1-9]x?*(Mpli)):pp}, {0:ph}, {(<**1:>(Msp1)):sp1}, {(<**2:>(Msp2)):sp2}, {(<**9:>(Mpp)):pp}, {(Mpli):pli} For OBi110: {([1-9]x?*(Mpli)):pp}, {0:ph}, {(<**1:>(Msp1)):sp1}, {(<**2:>(Msp2)):sp2}, {(<**8:>(Mli)):li}, {(<**9:>(Mpp)):pp}, {(Mpli):pli} For OBi202: {([1-9]x?*(Mpli)):pp}, {0:ph.ph2}, {(<**1:>(Msp1)):sp1}, {(<**2:>(Msp2)):sp2}, {(<**3:>(Msp3)):sp3}, {(<**4:>(Msp4)):sp4}, {(<**9:>(Mpp)):pp}, {(Mpli):pli} PSTN Line
PrimaryLine
By primary line we mean the service that does not require any access code prefix (such as **1 or **9) when dialing; it is the default service to be used for making the call when no explicit access code prefix is entered. This parameter indicates to the device which voice service is considered as the primary line when dialing out via the Auto Attendant. Available choices are: SP1 Service (code = sp1) SP2 Service (code = sp2) 2 SP3 Service (code = sp3) 2 SP4 Service (code = sp4) OBiTALK Service (code = pp1) 1 PSTN Line (code=li1) Trunk Group 1 (code=tg1) The OBi device process the parameter by substituting of the occurrences of pli and (Mpli) in DigitMap and OutboundCallRoute with the corresponding code and (Mcode). For example, if PrimaryLine = PSTN Line, then all occurrences of pli and (Mpli) will be substituted internally with li1 and (Mli1) respectively Period of time in milliseconds that the AA will wait before answering an incoming call that has been routed to it In the case that the caller does not enter any option from the top level menu after the menu has been
AnswerDelay
4000
NumberOnNoInput
107
annouced for 3 times, the AA directs the caller to the number specified in this parameter. If this number is not specified, the AA simply terminates the current call. UsePIN Enable the use of PIN to authenticate callers when they select the option to make a further call. If PIN1, PIN2, PIN3, and PIN4 are all empty, device treats it as if UsePIN is set to No. Otherwise, the caller must enter one of the non-empty PIN in order to proceed, PIN code to make a call (must be all digits). Maximum Length = 15 PIN code to make a call (must be all digits). Maximum Length = 15 PIN code to make a call (must be all digits). Maximum Length = 15 PIN code to make a call (must be all digits). Maximum Length = 15
Note: According to the default DigitMap and OutboundCallRoute, calling 0 means calling the PHONE port No
108
Voice Gateways
A gateway in this context is another OBi device which lets incoming OBiTALK callers to call further on one or more of its trunks (such as SP1, SP2, or LI). The caller can call the gateway first with a normal OBiTALK call, get the AA, and then dial the target number. For authentication the AA may ask the user to enter a PIN before establishing the second call. This way of dialing is known as 2-stage dialing. On the other hand, a gateway can be configured on the originating OBi device such that the caller can dial the target number directly without going through the AA. We refer to this method of dialing as direct dialing or 1-stage dialing. Since it is not possible to enter a PIN in the case of direct dialing, a userid/password pair can be configured for the gateway also so that the deivce can authenticate with the gateway automatically using HTTP digest method. HTTP digest authentication is optional. You do not need to provide user/password if the gateway does not require authentication for direct dialing. OBi allows the user to specify up to 8 gateways. Each gateway is addressed using its factory-assigned OBi Number. A gateway is conceptually a trunk with its own DigitMap. You can refer to a gateway and its associated DigitMap with the short trunk name VGn and (Mvgn) respectively, for n = 1, 2, 3, , 8. VGn and (Mvgn) can be used in call routing rules and digit maps just like other real trunks. As an example, you can add the rule {(1xxx xxx xxxx):vg2} in PHONE ports OutboundCallRoute to let the device dials out using VGs when caller dials any 11-digit number starting with 1. On the gateway side, you can add the corresponding rule {>(1 xxx xxx xxxx):sp1} in the OBiTALK Service::InboundCallRoute to make the call on its SP1 trunk. You can change the last rule to {(290 333 100|200 444 101)>(1 xxx xxx xxxx):sp1} if you want to limit the gateway to allow just the two stated caller numbers to make such calls. Starting with firmware release 1.2, a gateway may also be configured with a SIP URL as the access number to be accessed by the device over one of the SP trunks. For example, one can set the gateway access number as SP1(some-sipserver.mydomain.com), or SP2(192.168.15.111:5062), etc. Note that when using a SP trunk to access a (SIP) gateway, the device will: Not use the outbound proxy, ICE, or STUN regardless the settings on the SP trunk. Use only the devices local address as the SIP Contact, and ignore any natted address discovered by the device. Use the gateways SIP URL to form the FROM header of the outbound INVITE. Use the gateways AuthUserID and AuthPassword for authentication. Apply the symmetric RTP concept.
109
(xx.)
110
Trunk Groups
As the name implies, a trunk group is a group of trunks. If a call is routed to a trunk group, OBi picks one of the available trunks from the group to make the call. Availability of trunk is based on: Whether the trunks digit map allows the number to call, AND Whether the trunk has capacity to make one more call
Up to 4 trunk groups can be configured on an OBi device. Each trunk group is conceptually another trunk with its own DigitMap. A trunk group and its associated DigitMap are referenced using the short name TGn and (Mtgn) respectively, where n = 1, 2, 3, 4. They can be referenced in other digit maps and call routing rules so that calls may be routed to a particular trunk group. Only trunks can be added to a trunk group. These include: PP1, SP1, SP2, SP3 , SP4 , LI1 , VG1, VG2, , VG8, TG1, TG2, TG4. Note that a TG may include another TG (that is, TG can be recursive). However, you must make sure this does not result in infinite recursion.
2 2 1
For TG1, the default for OBi100 and OBi110 is: sp1,sp2 and for OBi202 is: sp1,sp2,sp3,sp4 For other TG, the default is (blank) For TG1, the default is (1xxxxxxxxxx|<1>[2-9] xxxxxxxxx|011xx.|xx.) For other TG, the default is (xx.)
DigitMap
Digit map associated with this trunk group. It can be referenced as (Mtgn)
111
112
User dials *06 to cancel Repeat Dialing. Only one repeat dial request is supported. Dialing *05 while a repeat dial is in progress will be rejected with a fast busy tone. If *05 is accepted, the device plays normal dial tone. Notes: The first redial happens 5s after the phone is onhook following *05 When phone is offhook or rings for an incoming call, device pauses redial and cancels the call if its already dialed but the peer device is not ringing yet. As soon as phone goes on hook or ringing stops without any calls on hold, repeat dialing resumes in 5s If called party answers before the local caller, device sends normal ringback tone over RTP to the called party The ring for alerting local user when the called party rings or answers is taken from outgoing trunks RepeatDialRing parameter Repeat Dial service cannot be used on the LINE port. If the last call was made over the LINE port, dialing *05 will result in fast busy Repeat Dial calls are not logged to call history, except the last and successful one when the called party rings or answers
113
114
OutboundCallRoute
After the caller dials a number that is acceptable according to the DigitMap, OBi device uses this outbound call routing rule to determine which service to make this call with. If no appropriate call route found, OBi plays SIT tone followed by a short error message to let the caller know that there is no call route to place the call. See OBi Call Routing and Digit Map Section for a description of the syntaxes to specify this parameter
115
{(<**1:>(Msp1)):sp1}, {(<**2:>(Msp2)):sp2}, {(<**8:>(Mli)):li}, {(<**9:>(Mpp)):pp}, {(Mpli):pli} For OBi202 PHONE1: {([1-9]x?*(Mpli)):pp}, {(<#:>):ph2}, {**0:aa},{***:aa2}, {(<**1:>(Msp1)):sp1}, {(<**2:>(Msp2)):sp2}, {(<**3:>(Msp3)):sp3}, {(<**4:>(Msp4)):sp4}, {(<**9:>(Mpp)):pp}, {(Mpli):pli} For OBi202 PHONE2: {([1-9]x?*(Mpli)):pp}, {(<#:>):ph}, {**0:aa},{***:aa2}, {(<**1:>(Msp1)):sp1}, {(<**2:>(Msp2)):sp2}, {(<**3:>(Msp3)):sp3}, {(<**4:>(Msp4)):sp4}, {(<**9:>(Mpp)):pp}, {(Mpli):pli} For OBi100: {pli:(xx.)}, {sp1:(<**1>xx.)}, {sp2:(<**2>xx.)}, {pp:(<**9>xx.)} For OBi110: {pli:(xx.)}, {sp1:(<**1>xx.)}, {sp2:(<**2>xx.)}, {li:(<**8>xx.)}, {pp:(<**9>xx.)} For OBi202: {pli:(xx.)}, {sp1:(<**1>xx.)}, {sp2:(<**2>xx.)}, {sp3:(<**3>xx.)}, {sp4:(<**4>xx.)}, {pp:(<**9>xx.)} For OBi100 and OBi202: SP1 Service For OBi110: PSTN Line
CallReturnDigitMaps
Call Return is the service where the user can call the last caller by dialing a star code (*69 by default). OBi device implements this service by remebering the number of the last caller in memory. However the stored information does not include any dialing prefix to tell the device which voice service to use to call back the last caller. This list of digit maps serve the purpose of mapping a callers number to one that includes the desired dialing prefix used exclusively for call return service.
PrimaryLine
By primary line we mean the service that does not require any access code prefix (such as **1 or **9) when dialing; it is the default service to be used for making the call when no explicit access code prefix is entered. This parameter indicates to the device which voice service is considered as the primary line when dialing out from the PHONE port. Available choices are:
116
SP1 Service (code = sp1) SP2 Service (code = sp2) 2 SP3 Service (code = sp3) 2 SP4 Service (code = sp4) OBiTALK Service (code = pp1) 1 PSTN Line (code=li1) Trunk Group 1 (code=tg1) 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). For example, if PrimaryLine = PSTN Line, then all occurrences of pli and (Mpli) will be substituted internally with li1 and (Mli1) respectively Ringer RingFrequency RingVoltage RingWaveform InterleavedRing
4
Ringer frequency in Hz (14 - 68) to apply to the PHONE port when ringing Peak ringer voltage in volts (55 - 82) to apply to the PHONE port when ringing Ringer waveform to apply to the PHONE port when ringing. Choices are Sinusoidal or Trapezoidal When both phone ports are ringing, enabling this option will cause the OBi to interleave the ring signal applied to each port to reduce the chance of overloading the power supply. Tip/Ring Voltage when the attached phone is on hook (30 v to 52 v) Maximum supported current (15 mA to 45 mA) when the attached phone is off-hook PHONE port impedance setting. Availabe choices are (units in ohm if not specified): 600 900 270+(750||150 nF) 220+(820||120 nF) 370+(620||310 nF) 320+(1050||230 nF) 350+(1000||210 nF) 200+(680||100 nF) 600+2.16 uF 900+2.16 uF 600+1 uF 220+(820||115 nF) Out of band DTMF tone playback level in dBm (-90 to 3) Caller ID delivery standard. Choices are: FSK(Bell202) FSK(V.23) DTMF(Finland,Sweden) DTMF(Denmark)
20 70 Sinusoidal No
46 20 600
DTMFPlaybackLevel CallerIDMethod
-15 FSK(Bell202)
117
CallerIDTrigger
Triggering event for on-hook Caller ID signal generation. Choices are: After First Ring After Polarity Reversal Before First Ring Transmit gain in dB (-12 to 12) to apply to signal sent from OBi to the attached phone(s) Receive gain in dB (-12 to 12) to apply to signal received by OBi from the attached phone(s) PHONE port silence detection servers the purpose of driving silence suppression in RTP transmission when the phone Call terminates on SP1/2 or OBiTALK Service and silence suppression is enabled. This parameter is used to set a sensitivity level for OBi silence detection algorithm. Available choices are: Low (harder to detect silence) Medium (suggested) High (easier to detect silence)
0 0 Medium
HookFlashHandling
Select the method to signal a command to the OBi when the phone is off-hook with an active call in connected state, while there is a second call on hold or ringing. The two choices are: - N. America (uses hook switch events only) - Nordic Regions (R1, R2, ), where R = hook flash or the R button, R0 = Reject the 2nd incoming call (applicable only if nd the 2 call is ringing), nd R1 = End current call, resume/answer the 2 call nd R2 = Hold current call, resume/answer the 2 call R3 = Conference the two calls nd st R4 = Transfer 2 call peer to the 1 (not applicable if nd 2 call is ringing) Indicate the Method to Handle Hook Flash. Choices are Handle Hook Flash Locally This is the normal setting, where the device intercepts all the hook flash events detected on the PHONE port, and acts on them accordingly, such as: - Hold current call and start second dial tone for 3-way calls - Start a 3-way conference nd - End call with 2 conferencee in a 3-way conference - Swap between two calls in a call-waiting situation Send Hook Flash Signal to PSTN Device does not act on hook flash events detected on the PHONE port. It either ignores hook flash events OR regenerates similar hook flash events on the PSTN line if the phone user is currently in a call using the PSTN line service when the hook flash event happens.
N. America
118
This option may be useful in cases where the user has traditional call-waiting or 3-way calling services on his PSTN line service; hence he can control those PSTN supplementary services using hook flash signals. However, the OBi in this case would automatically disables its own call-waiting function on the PHONE port, and the user would have no means to tell OBi to make 3-way calls. Note that an alternative way to let OBi generate a hook flash signal to the PSTN line is to use a double hook flash event by hook flashing twice within 700 ms. See the description of the parameter EnableDoubleHookFlash in this table. With this enabled, you can still let the device handle normal hook flash event locally and preserve the call-waiting and 3-way calling functionalities. This option is only available in OBi110 Enable Caller ID Signal generation. This option can be set to Yes even if the attached phone is not capable of displaying Caller ID. There is no harm in sending Caller ID signal while the phone is in the on hook state. Enable Call Waiting Caller ID (CWCID) Signal generation. CWCID signal is sent to the phone when it is in the off hook state. It starts with a handshake between the OBi device and the attached phone, by exchanging audible short tones. OBi will proceed with the transmission of the remaining Caller ID signal only if the handshake succeeds (with a phone is capable of displaying CWCID). In that case the phone mutes the handset earpiece until the CWCID signal is complete. Some users however may still find the audible handshake tones objectionable, especially if their phones do not support CWCID. We recommend to those users to set this option to No, if they do not want CWCID feature, or do not have phones that are capable of displaying CWCID. Enable MWI Signal (stutter dial tone) generation. If enabled, any SP voice service enabled on the device that has MWI Service enabled will trigger the generation of stutter dial tone if there are new voicemails for the subscriber on the service providers voicemail system. Enable VMWI Signal generation. If enabled, any SP voice service enabled on the device that has VMWI Service enabled will trigger the generation of VMWI signal if there are new voicemails for the subscriber on the service providers voicemail system. Enable Call Transfer. Call Transfer, if enabled, is initiated by the user by hanging up the phone in one of the following scenarios: nd - One call on hold while a 2 outgoing call ringing nd - One call on hold while a 2 outgoing call connected nd - One call connected while a 2 outgoing call ringing - 3-way conference with both calls connected
CallerIDEnable
Yes
CallWaitingCallerIDEnable
Yes
MWIEnable
Yes
VMWIEnable
Yes
CallTransferEnable
Yes
119
ConferenceCallEnable
If Call Transfer is disabled, hanging up the phone in the above scenarios simply ends all the calls, except for the one that is holding, which will remain on hold (cases 1 and 2). Enable 3-way Conference Call w/ local audio mixing. Conference Call, if enabled, is initiated by the user by hook flashing the phone in one of the following scenarios: nd - One call on hold while a 2 outgoing call ringing nd - One call on hold while a 2 outgoing call connected We refer to case (1) as an early conference, where the second conferencee is still ringing; the other 2 parties may converse while hearing ringback tone in the background until the 3 party answers. In either case, the user can end the call with the second conferencee by hook flashing another time and the call reverts to a 2-way call. If Conference Call service is disabled, then hook flashing the phone resumes the holding call but ends the second outgoing call in scenario (1), and swaps between the two calls in scenario (2) (as in a call waiting situation) Enable call waiting service. Call Waiting is the situation where a new incoming call is routed to the PHONE port when there is already another call connected. If this service is enabled, OBi plays call-waiting tone to alert the user, as well as generates CWCID signal if CWCID is enabled. The user may then swap between the two calls by hook flashing. If the service is disabled, OBi rejects the incoming call as busy. Note: It is possible for the user to set this parameter from the phone using a Star Code Select a Tone Profile for call progress tone generation. Choices are A, or B Select a Star Code Profile for interpreting Star Codes entered by the user. Choices are None, A, or B. If value is set to None, no star code will be recognized by OBi device. Last number dialed out on the PHONE port Last caller's number that rings the PHONE port Enable the device to accept incoming media loopback calls Delay in milliseconds before the device answers an incoming media loopback call Maximum duration in seconds to allow for an inbound media loopback call. Set the value to blank or 0 to make it unlimited Interval in seconds between redial in a repeat dial operation. Duration of time in seconds when a repeat dial operation remains active. Controls when the device should generate a CPC signal when the remote party hangs up on an established call. The choices are:
Yes
CallWaitingEnable
Yes
ToneProfile StarCodeProfile
A A
Yes 0 0
120
EnableLINEPortBargeIn
- Never - For Inbound Calls Only - For Outbound Calls Only - For Inbound and Outbound Calls This option is useful only when a PSTN line is connected to the OBi110. By default a user can pick up the phone and dial # to connect to the LINE port. If no one else using the PSTN line at that time, the user will hear dial tone from the phone company. On the other hand, if the line is already in use, the user will hear fast busy tone if this option is disabled, or join the current call in progress otherwise.
4
No
EnablePHONEPortBargeIn
This option is only available in OBi110. Enable the caller to barge in when he calls the other phone port from this phone port while the other phone port has an active call in progress, on-hold, or ringing. This option is only available in OBi110. A double hook flash event is two successive hook flash events that are less than 700ms apart (by default). If this event is enabled, the device will generate a hook flash signal on the PSTN line if the phone is currently on a call on the line. This option is useful only if HookFlashHandling is set to Handle Hook Flash Locally. This option is only available in OBi110. Enables the OBi to be used for paging only when the PHONE port is connected to an external PA system (via a RJ11 to line out connector, available from many electronics shops). In such configuration the PHONE port is expected to be off-hook all the time; the OBi will automatically answer an incoming call and will not accept call-waiting. This option provides a short cut to transfer a call to a fixed pre-configured number without dialing it. If a valid number is specified for this parameter, the OBi will transfer the call to the given number when the phone hook flashes and then on-hook (which would normally leave the call holding if this parameter is not specified). The valid number should be a complete number with trunk information, such as SP1(14083334567). Hook Flash is a quick transition of the phones hook switch from Off-Hook state to On-Hook state, and back to Off-Hook state. This parameter specifies the upper time limit in milliseconds such that if the hook switch stays at the intermediate On-Hook state for longer than this time limit, the OBi device will not recognize the state transition as a HOOK FLASH event, but instead as an ON HOOK event followed by an OFF HOOK event Hook Flash is a quick transition of the phones hook switch from Off-Hook state to On-Hook state, and back to
Yes
EnableDoubleHookFlash
Yes
UseForPagingOnly
No
TransferWhenHolding
Timers HookFlashTimeMax
900
HookFlashTimeMin
100
121
DoubleHookFlashTimeMin
Off-Hook state. This parameter specifies the lower time limit in milliseconds such that if the hook switch stays at the intermediate On-Hook state for less than this time limit, the OBi device will not recognize the state transition as a HOOK FLASH event, but consider the hook switch remains at Off-Hook state throughout the transition (in other words, the transition is discarded as a glitch if it happens too quickly) Minimum time apart between two successive hook flash events to be recognizable by the device as a double hook flash event. The unit is in millisconds. This option is only available in OBi110 Maximum time apart between two successive hook flash events to be recognizable by the device as a double hook flash event. The unit is in milliseconds. This option is only available in OBi110 A short delay in milliseconds before OBi generates a CPC signal to the PHONE port after the far end has hung up during a call OBi device generates CPC (Calling Party Control) Signal by removing power from the PHONE port for a short period. This parameter specifies the length of this period in milliseconds. CPC signal tells the attached phone equipment that the far end has ended the call
100
DoubleHookFlashTimeMax
700
CPCDelayTime
2000
CPCDuration
500
ConnectPolarity
Tip/Ring voltage polarity the line is idle, before a call is connected, or after one side hangs up. Choices are: Forward, or Reverse Tip/Ring voltage polarity when the line is connected on a call. Note: By using a different polarity for an Idle and a Connected line, OBi effectively generates a polarity reversal signal to the PHONE port, which can be used to signal the attached phone equipment that the call is either connected or ended.
Forward
Forward
122
123
InboundCallRoute
ph
RingDelay
5500
RingProfile
DefaultRing
CallOnHoldRing
A None
124
on the line as a positive indication of call connected state. - Detect polarity reversal: Device will detect a polarity reversal signal on the line as a positive indication of call connected state. Note that polarity reversal signal is not always generated by the phone company when a call is answered. However, if available, polarity reversal is the most reboust signal for detection of call connected state. If the method is not None, the device will also indicate peer ringing state when it detects ring back signal on the line prior to call connected state. Delay in milliseconds before dialing out the first digit to the PSTN line after the OBi takes the LINE port hardware to the Off-Hook state. This is a simple way to allow the PSTN company time to get ready to receive DTMF signals from the OBi without having the OBi monitor dial tone from the PSTN company Duration in milliseconds of each digit to dial out on the PSTN line Interdigit time in milliseconds when dialing a number on the PSTN line Phone number of the attached PSTN line. Informational only; not used by OBi device Enable call forwarding of all calls unconditionally by the device. If CallForwardUnconditionalNumber is blank, this parameter is treated as if it has been set to No. Note: It is possible for a user to set this parameter from the phone using a Star Code 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 phone using a Star Code Enable call forwarding of all incoming calls when the device is busy. If CallForwardOnBusyNumber is blank, this parameter is treated as if it has been set to No. Device is considered busy if one of the following conditions holds: DND (Do Not Disturb) Service is enabled on this service If the call is routed to the PHONE port when the it is in a busy state (such as ringing, dialing, playing reorder tone, or already having 2 calls in progress)
DialDelay
500
200 200
No
CallForwardUnconditionalNumber
CallForwardOnBusyEnable
No
125
CallForwardOnBusyNumber
Note: It is possible for a user to set this parameter from the phone using a Star Code Directory number to forward all incoming calls on this service when the device is busy. Maximum Length is 127 characters. Note: It is possible for a user to set this parameter from the phone using a Star Code Enable call forwarding of all incoming calls when the call is not answered after a period as specified in CallForwardOnNoAnswerRingCount. If CallForwardOnNoAnswerNumber is blank, this paramete is treated as if it has been set to No. Note: It is possible for a user to set this parameter from the phone using a Star Code Directory number to forward all incoming calls when the call is not answered after a period specified in CallForwardNoAnswerRingCount Note: It is possible for a user to set this parameter from the phone using a Star Code Number of rings to be considered by the device as no answer to an incoming call. Note: 1 ring is approximately 6s Enable blocking of Anonymous Calls on this service. If enabled, anonymous incoming calls will be ignored by the OBi device. Note: It is possible for a user to set this parameter from the phone using a Star Code Enable Do Not Disturb Service. If enabled, all incoming calls on the PSTN line will be treated with busy handling by OBi device. Note: It is possible for a user to set this parameter from the phone using a Star Code Limit on the call duration in seconds for all outbound calls that are bridged from another trunk. A blank or 0 value implies the call duration is not limited.
CallForwardOnNoAnswerEnable
No
CallForwardOnNoAnswerNumber
CallForwardOnNoAnswerRingCount
AnonymousCallBlockEnable
DoNotDisturbEnable
BridgedOutboundCallMaxDuration
126
127
This parameter is used to select a sensitivity level for OBi silence detection. Available choices are: Low (harder to detect silence) Medium (suggested) High (easier to detect silence) SilenceTimeThreshold For OBi to declare that the PSTN line has gone silent, the energy level of the signal received from the far end has to fall below the threshold selected in SilenceSignalThreshold for at least a certain continuous period of time. This parameter specifies the minimum duration of this silent period in seconds. Enable the detection of disconnect tone (as specified in DisconnectTonePattern parameter) as a trigger to end the current call A tone pattern that describes the tone from the phone company when the call is terminated by the peer or by the phone company herself. For example, a fast busy tone or busy tone can be used as the disconnect tone. Off-hook AC termination Time for line-side device to go on-hook Voltage on DCT pin of line-side device, which affects TIP/RING voltage on the line. Low-voltage countries should use lower TIP/RING voltage Minimum loop current the LINE port hardware can operate at Limit loop current to 60 mA per the TBR21 standard Gain in dB (-15 to 15) to apply to the signal transmit from the OBi to the PSTN company Gain in dB (-15 to 15) to apply to the signal received by the OBi from the PSTN company Voltage below which to detect a parallel device off-hook when LINE port hardware is in the On-Hook state Current (mA) above which to detect a parallel device off-hook when LINE port hardware is in the Off-Hook state The Caller ID delivery standard for which the OBi device should assume when decoding Caller ID signal received from the PSTN company. Available choices are: FSK(Bell202) FSK(V.23) DTMF(Finland, Sweden) DTMF(Denmark) The energy level of DTMF signal transmitted on PSTN line port in dBm (90 to 3) Minimum ring frequency to detect Maximum ring frequency to detect Voltages (Vrms) below the lower limit will not trigger ring detection; voltages above the upper limit will Time in ms to validate the ring signal Time in ms between ring signal validated and valid ring signal indicated Time (ms) elapsed since last ring threshold crossing to declare ring is over Synthesized ringer impedance to meet specification in countries, such as Poland, South Africa, and Slovenia 60
DetectDisconnectTone DisconnectTonePattern
Yes 480-30,62030;10;(.25+.25)
Port Settings ACImpedance OnHookSpeed TipRingVoltageAdjust MinOperationalLoopCurrent CurrentLimitingEnable ChannelTxGain ChannelRxGain LineInUseVoltageThreshold LineInUseCurrentThreshold CallerIDDetectMethod
DTMFPlaybackLevel Ring Detection RingFrequencyMin RingFrequencyMax RingThreshold RingValidationTime RingIndicationDelayTime RingTimeout RingerImpedance
-5
128
129
130
131
132
133
Priority PayloadType G729 Codec Codec BitRate Enable SilenceSuppression PacketizationPeriod Priority PayloadType G726R32 Codec Codec BitRate Enable SilenceSuppression PacketizationPeriod Priority PayloadType 5 G726R16 Codec Codec BitRate Enable SilenceSuppression PacketizationPeriod Priority PayloadType G726R24 CodecError! ookmark not defined. Codec BitRate Enable SilenceSuppression PacketizationPeriod Priority PayloadType G726R40 CodecError! ookmark not defined. Codec BitRate Enable SilenceSuppression PacketizationPeriod
5
Priority assigned to this codec (1 is the highest) Standard payload type for G711-alaw Note: Informational only; not configurable Codec Name Bit rate in bits/sec Note: Informational only; not configurable Enable this codec Enable silence suppression for this codec Packet size in ms Priority assigned to this codec (1 is the highest) Standard payload type for G.729 Note: Informational only; not configurable Codec Name Bit rate in bits/sec Note: Informational only; not configurable Enable this codec Enable silence suppression for this codec Packet size in ms Priority assigned to this codec (1 is the highest) Dynamic Payload type for this codec. Valid range is 96-127 Codec Name Bit rate in bits/sec Note: Informational only; not configurable Enable this codec Enable silence suppression for this codec Packet size in ms Priority assigned to this codec (1 is the highest) Dynamic Payload type for this codec. Valid range is 96-127
2 8
Codec Name Bit rate in bits/sec Note: Informational only; not configurable Enable this codec Enable silence suppression for this codec Packet size in ms Priority assigned to this codec (1 is the highest) Dynamic Payload type for this codec. Valid range is 96-127
Codec Name Bit rate in bits/sec Note: Informational only; not configurable Enable this codec Enable silence suppression for this codec Packet size in ms
G726R16, G726R24, and G726R40 codecs are only available only on the OBi100/110; iLBC codec is only available on the OBi202
134
Priority PayloadType iLBC CodecError! ookmark not defined. Codec BitRate Enable SilenceSuppression PacketizationPeriod Priority PayloadType Telephone Event Codec Enable PayloadType Encap RTP Codec PayloadType Loopback Primer Codec
Priority assigned to this codec (1 is the highest) Dynamic Payload type for this codec. Valid range is 96-127
7 105
Codec Name Bit rate in bits/sec Two values to choose from: 13333 bps or 15200 bps Enable this codec Enable silence suppression for this codec Packet size in ms. Must be multiples of 30 for 13333 bps or multiples of 20 for 15200 bps Priority assigned to this codec (1 is the highest) Dynamic Payload type for this codec. Valid range is 96-127 Codec Name. This Enable this codec Dynamic Payload type to be used for RFC2833 telephone (DTMF) events. Valid range is 96-127 Codec Name. This codec is used to encapsulate RTP packets during a packet loopback call Dynamic Payload type for this codec. Valid range is 96-127 Codec Name. The codec is used by the OBi when acts as a media loopback mirror and before receiving any packets from the loopback source during a media loopback call Dynamic Payload type for this codec. Valid range is 96-127 Two values to choose from: big-endian or little-endian Enable the use of T38 (FAX Relay)
135
Field1 Composition:
This field describes frequency components used for tone synthesis and it supports up to three different frequencies. The frequency expression is a string of numeric values with the notation '+' or '-'. The numeric values are the frequency's decimal values in Hz and amplitude in dBm (Maximum 3 dBm). Different frequencies are separated by ',' .
Example: 350-18,440-18,550+2 The above example illustrates the 1st frequency at 350 Hz with strength at -18 dBm, the 2nd frequency: 440 Hz with strength at -18 dBm and the 3rd frequency: 550 Hz with strength at +2 dBm.
Field2 Composition:
This field describes the overall tone playback duration in seconds. The expression is a numeric value, and supports up to 3 decimated digits. The numeric value can negative, zero, positive, or skipped: Negative value: tone plays indefinitely Zero value: tone playback is skipped Positive value: Normal playback duration No value: tone plays indefinitely
136
t(f_0/on_0+off_0,f_1/on_1+off_1,f_2/on_2+off_2,f_3/on_3+off_3)
t: the cadence segment duration in seconds Negative value: tone plays indefinitely No value: tone plays indefinitely Zero value: the duration of this particular segment is zero Positive value: Normal playback duration
f_0/1/2/3: a numerical describe which frequency component(s) are used for the synthesis, and it can be one of following 8 options (0 ~ 7) 0: No frequency specified, i.e., silent tone 1: The 1st frequency 2: The 2nd frequency 3: The 1st and 2nd frequencies 4: The 3rd frequency 5: The 1st and 3rd frequencies 6: The 2nd and 3rd frequencies 7: The 1st and 2nd frequencies if two or more than two frequency components, or the 1st frequency if only one frequency component is available.
If no value is provided for f_0/1/2/3, it will automatically use the combination of the first one or two available frequency components. on_0/1/2/3: the tone active time in seconds Negative value: Not allowed No value: infinite tone active time Others: normal tone active time (up to 3 decimated digits)
off_0/1/2/3: the tone inactive time in seconds Negative value: Not allowed No value: infinite tone inactive time Others: normal tone inactive time (up to 3 decimated digits)
Example: 4(1/.3+2.34,3/2+1.5) The above example illustrates using the first frequency to generate tone for 0.3 seconds, followed by 2.34 seconds of silence, then use a combination of the first and second frequencies to generate tone for 2 seconds, then followed by 1.5 seconds silence. The cadence operates repeatedly for 4 seconds.
137
Tone Examples:
With these examples, we will show the interpretation of a few common tone patterns:
Dial Tone:
DIAL, "350-18,440-18" Dial tone is generated as a mixture of two frequency components: 350 Hz at -18 dBm and 440 Hz at -18 dBm The expiration time is infinite, and tone active time is infinite.
Busy Tone:
BUSY, "480-18,620-18;10;(.5+.5)" Busy tone is generated as a mixture of two frequency components: 480 Hz at -18 dBm and 620 Hz at -18 dBm The expiration time is exactly 10 seconds. It has only one cadence segment, which has tone active 0.5 second and tone inactive 0.5 second.
Prompt Tone:
PROMPT, "480-16;10" Prompt tone is generated from a single frequency component: 480 Hz at -16 dBm. The expiration time is exactly 10 seconds. It has only one cadence segment, which has tone infinite active time.
SIT Tone:
SIT_1, "985-16,1428-16,1777-16;20;(1/.380+0,2/.380+0,4/.380+0,0/0+4)" Special information tone (SIT) is generated from a set of frequency components: 1st frequency: 985 Hz at -16 dBm 2nd frequency: 1428 Hz at -16 dBm 3rd frequency: 1777 Hz at -16 dBm
The expiration time is exactly 20 seconds. It has only one cadence segment, which includes 4 on-off sections. The segment has infinite repeating time: The 1st on-off section: generated by the 1st frequency component, and it has 0.38 tone second active time and 0 inactive time. The 2nd on-off section: generated by the 2nd frequency component, and it has 0.38 tone second active time and 0 inactive time. The 3rd on-off section: generated by the 3rd frequency component, and it has 0.38 tone second active time and 0 inactive time.
138
The 4th on-off section: only generate silence since no frequency component is specified. It has tone 0 second active time and 4 seconds inactive time.
Stutter Tone:
STUTTER, "350-18,440-18;10;.6(.1+.1);(/)" Stutter dial tone is generated from a mixture of two frequency components: 350 Hz at -18 dBm and 440 Hz at -18 dBm. The expiration time is exact 10 seconds. It has two cadence segments. The first segment: includes only one on-off sections, on 0.1 second and off 0.1 second, and on-off repeats for 0.6 second. The second segment: include one on-off section, and has infinite repeating time and infinite tone active time.
350-18,440-18;20
440-18,480-18;-1;(2+4)
139
Obihai Tone Pattern Script Reorder tone or Fastbusy Obihai Tone Pattern Script Confirmation Tone Obihai Tone Pattern Script
480-18,620-18;10;(.5+.5)
480-18,620-18;10;(.25+.25)
600-18;1;(.2+.2)
800-18;30;(.1+10)
385-18,484-18;20
350-18,440-18;20;2(.1+.1);()
480+3,620+3;10;(.125+.125)
480-16;20
140
TonePattern Conference Tone ToneName TonePattern SIT Tone 1 ToneName TonePattern SIT Tone 2 ToneName TonePattern
350-18,440-18;20;(.2+.2)
350-16;10;(.1+.1,.1+9.7)
914-16,1371-16,177716;20;(1/.274+0,2/.274+0,4/.380+0,0/0+4)
141
914-16,1371-16,177716;20;(1/.380+0,2/.380+0,4/.380+0,0/0+4)
985-16,1371-16,177716;20;(1/.380+0,2/.380+0,4/.380+0,0/0+4)
Field1 Composition:
Field-1 describes the overall ringing duration in seconds. The expression is a numeric value, and supports up to 3 decimated digits. The numeric value can negative, zero, and positive: Negative value: Ringing lasts indefinitely No value: Ringing lasts infinitely Zero value: Ringing is skipped Positive value: Normal ringing duration
Example: 30.5 The above example illustrates a ringing tone that terminates after 30.5 seconds.
t: The cadence segment duration in seconds. Negative value: Ringing indefinitely No value: Ringing indefinitely Zero value: Ringing is skipped Positive value: Normal ringing duration
142
on_0/1/2/3: The ring active time in seconds. Negative value: Not allowed No value: Infinite ring active time 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) 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.
Parameter Call Waiting Tone 1 ToneName TonePattern Call Waiting Tone 2 ToneName TonePattern
Description Distinctive Call Waiting Tone 1 Obihai Tone Pattern Script Distinctive Call Waiting Tone 2 Obihai Tone Pattern Script
143
Call Waiting Tone ToneName TonePattern Call Waiting Tone ToneName TonePattern Call Waiting Tone ToneName TonePattern Call Waiting Tone ToneName TonePattern Call Waiting Tone ToneName TonePattern Call Waiting Tone ToneName TonePattern Call Waiting Tone ToneName TonePattern Call Waiting Tone ToneName TonePattern
Obihai Tone Pattern Script Distinctive Call Waiting Tone 3 Obihai Tone Pattern Script Distinctive Call Waiting Tone 4 Obihai Tone Pattern Script
Bellcore-dr3 440-18;30;(.1+.1,.1+10) Bellcore-dr4 440-18;30;(.1+.1,.1+.1,.1+10) Bellcore-dr5 440-18;30;(.3+.1,.1+.1,.3+10) User-dr1 440-18;30;(.1+.1,.3+.2,.3+10) User-dr2 440-18;30;(.3+.1,.3+.1,.1+10) User-dr3 440-18;30;(.3+2) User-dr4 440-18;30;(.3+2) User-dr5 440-18;30;(.3+2)
5 Distinctive Call Waiting Tone 5 Obihai Tone Pattern Script 6 Distinctive Call Waiting Tone 6 Obihai Tone Pattern Script 7 Distinctive Call Waiting Tone 7 Obihai Tone Pattern Script 8 Distinctive Call Waiting Tone 8 Obihai Tone Pattern Script 9 Distinctive Call Waiting Tone9 Obihai Tone Pattern Script 10 Distinctive Call Waiting Tone 10 Obihai Tone Pattern Script
144
145
146
Bit0 (LSB) = G711u Bit1 = G711a Bit2 = G726r16 Bit3 = G726r24 Bit4 = G726r32 Bit5 = G726r40 Bit6 = G729
$LDN = last dialed number (for redial) (global; read only) $LCR = last callers number (for call return) (global; read only) $SPD[n] = number for the speed dial n (n = 1 99) (global; admissible value: literal or token representing a phone number) $CODE = the digit(s) representing the variable part of a star code (see examples below; read only) Variable names are CASE INSENSITIVE.
Actions are carried out one-by-one in the order as specified in the script. Restrictions: At most 1 coll action per code. Either 1 say or 1 call action at most per code, and it must be the last action in the script.
147
*72, Call Forward Unconditional, coll($cfan),set($cfa,1) Collects a number from the user according to the DigitMap. Then set the CallForwardUnconditionalNumber on all trunks to the collected value, and set the CallForwardUnconditionalEnable on all trunks to Yes To modify the script to enable CallForwardUnconditional on SP1 only, change it to
*67, Block Caller ID Once, set($BCI1,1) Enable masking of caller ID information once for the next call on any trunk
*74(x|xx), Set Speed Dial, coll($Spd[$code]) After user dials *74, OBi expects one or two more digits from the user which represent a speed dial slot index (1 to 99). The 1 or 2-digit variable part is stored in the variable $code. OBi device then plays a prompt tone and proceeds to collect a number from the user according to the DigitMap. Finally OBi stores the collected number in the given speed dial slot. If the slot already has a number specified, it will be overwritten quietly with the new value.
*75(x|xx), Check Speed Dial, say($Spd[$code]) After user dials *75, OBi expects one or two more digits from the user which represent a speed dial slot index (1 to 99). The 1 or 2-digit variable part is stored in the variable $code. OBi device then announces the number stores in the speed dial slot, or says not available if the slot is empty.
148
149
Code17 Code18 Code19 Code20 Code21 Code22 Code23 Code24 Code25 Code26 Code27 Code28 Code29 Code30
Default = Do Not Disturb Star Code Default = Disable Do Not Disturb Star Code Default = Repeat Dial Star Code Default = Disable Repeat Dial Star Code Default = Set Speed Dial Star Code Default = Check Speed Dial Star Code Default = Loopback Media Star Code Default = Loopback RTP Star Code Default = Force G711u Codec Star Code Default = Force G729 Codec Star Code Default = Clear Speed Dial Star Code Default = Blind Transfer Star Code Default = Barge In Star Code
*78, Do Not Disturb, set($Dnd,1) *79, Disable DND, set($Dnd,0) *66, Repeat Dial, rpdi($Ldn) *86, Disable Repeat Dial, rpdi *74(x|xx), Set Speed Dial, coll($Spd[$Code]) *75(x|xx), Check Speed Dial, say($Spd[$Code]) *03, Loopback Media, set($Lbm1,1) *04, Loopback RTP Packet, set($Lbp1,1) *4711, Use G711 Only, set($Cdm1,3) *4729, Use G729 Only, set($Cdm1,4) *76([1-9]|[1-9]x), Clear Speed Dial, set($Spd[$Code],) *98, Blind Transfer, coll($Bxrn) *96, Barge In, set($Bar1,1)
150
151
Parameter 1 2 3 To 99
Default Setting
DigitMap
(xx.<*:@>xx?x?<*:.>xx?x?<*:.>xx?x?<*:. >xx?x?|xx.<*:@>xx?x?<*:.>xx?x?<*:.>xx ?x?<*:.>xx?x?<*::>xx?x?x?x?) Note: this default value supports IPv4 dialing
User Defined Digit Map N (N = 2 10) A 2-16 characters long label to reference this digit map in other digit maps and call routing rules. It must be alphanumeric, not containing any spaces, and different from other userdefined or built-in digit map labels A valid digit map
Label
DigitMap
152
Anonymous: The admin can enable anonymous access where the user does not need to login. However the acces is limited to read-only for anonymous users.
Here is a screen short of the File Sharing Settings device web page.
153
154
155
Enable
No
FileFilter
UserID
userN
156
Password
Password is case-sensitive. It must be an alphanumeric string and must not contain any space. Maximum Password length is 64 characters. The Home Directory for anonymous level access, such that user cannot navigate the file system above this directory.
HomeDirectory
Maximum length of this field is 256 characters. Note: A blank value is same as slash (/) which allows navigation all the way to the root of the file system A list of semicolon (;) separated filename filters to limit the type of filtes this user can see. Each filter MUST be of the format: *.<file-type> Where <file-type> is a literal string (no wildcards or space), such as jpg, pdf, mp3, etc., and * is a wildcard that matches any valid filename string. For example: *.jpg; *.pdf; *.mp3; *.mov Maximum length of this field is 256 characters. By enabling write access to the file system, you allow the user to upload, copy, remove, rename, cut and paste files, or create, remove, and rename directories on the USB storage device.
/obi_share/userN
FileFilter
WriteEnable
No
File Explorer
The File Explorer web page can be launched by clicking the File Explorer link on the OBi device webpage or visit the link: http://<obi-address>/obi_share. You may be requested to login with a valid UserID and Password. To use the file exploere as an anonymous user, visit the link: http://<obi-address>/obi_share/anonymous. Below is a screen shot of a typical File Explorer web page.
157
On the left corner of the status bar is a select all checkbox for selecting all the items on the current page. To the right of the checkbox is the current directory path. On the far right of the status bar is the User ID of the current login user and the logout button, which are not shown for anonymous level login. The current directory path information is with respect to the home directory of the login user. The symbol represents the home directory which is always at the root of the path. Each level in the directory path is separated from the previous level with a slash (/). User can click any directory name in the path shown on the status bar to jump to a different level in the directory. Click the logout button to logout or login as a different user. The contents of current directory are listed below the status bar, with all the sub-directories, if any, followed by all the files in this directory. For example:
158
As shown above, each sub-directory or file is shown as a selectable item per row, with a selected for operation checkbox on the left. A sub-directory item has a directory icon ( ) and a directory name. A file item has a filename, the file size in bytes and the file type. In the current design, the file type is simply the filename suffix, or a pair of <> is shown if the filename does not have a suffix. You can select one or more items for applying an operation by clicking the corresponding checkboxes. The available operations that can be applied are shown on the bottom of the page and may depend on the kind of items or the number of items selected. In the following example, each operation is represented by a special icon on the bottom line:
Also shown on the far right of the bottom line is the currently available space in bytes on the attached USB storage device, if the option WriteEnable is true for login user. The name of each sub-directory item is a link to navigate into that sub-directory. Clicking the link of a file item on the other hand may show the contents of the file or download the file based on the file type and web browser functionality. The table below listed the available file sharing operations: Icon Operation Remarks This operation is available to the admin only. Any unpasted Cut or Copy operation will be forgotten by the OBi upon this operation. We highly recommend the admin to always perform this operation before detaching the USB device or rebooting the OBi. If the file system on the USB storage device is HPS Plus or HFP+, the admin MUST perform this operation before detaching the USB device. Failure to do so may cause the USB device to become read only and may require reformatting of the USB device You should check that the size of the file to be uploaded can fit in the available space on the USB device. If there is already a file with the same name in the same location, the OBi will pop up a prompt window to ask for confirmation before overwriting the existing file. Any intermediate directory in the given path name will be created automatically if it does not exist Available only when one or more files or subdirectories are selected. The OBi will pop up a prompt window to ask for confirmation before proceeding. Available only when one or more files or subdirectories are selected.
Eject USB Safely detach the USB storage device from the OBi.
Upload File Upload a single file from the local host to the USB storage device. Create Folder Create a new folder with the given path name if it does not exist already; an input box will pop up for entering the path name when you click this icon Delete Remove the selected files and sub-directories permanently from the USB storage device. This operation cannot be undone. Cut Cut the selected files and sub-directories to be
159
pasted elsewhere on the USB storage device with a subsequent Paste operation (in the same session). Copy Copy the selected files or sub-directories to be pasted in a different directory on the USB storage device with a subsequent Paste operation (in the same session). Paste Paste the selected files or sub-directories that are either cut with a previous Cut operation or copied with a previous Copy operation Rename Rename the selected file or directory to the given name; an input box will pop up for entering the new name when you click this icon Save Link As Download the selected file to store a copy on the local host
Available only if there is a previous Cut or Copy operation (in the same session) that has not been pasted yet. Available when one and only one file or sub-directory item is selected.
Available when one and only one file item is selected. Available only when one or more files or subdirectories are selected.
Copy Link Location Copy the links (URLs) of the selected items to the clipboard of the local host
On some web browsers a prompt window will pop up to ask for confirmation before proceeding; the user may need to press Control+C for example before the Link Locations (URLs) are copied into clipboard of the local host.
OBiTALK Service
yes
yes
yes
yes
yes
yes
yes
yes
yes
160
SP3 Service
2 3 3
yes
yes
yes
yes
yes
yes
yes yes no
Each supported service is also referred to as a trunk (a traditional telco term for a physical wire or wires that deliver phone services to homes or businesses). Each trunk is represented with 2-letter abbreviation and a 1-based instance identifier: SP1 = the SP1 Voice Service (with ITSP A, B, C , or D ) 3 3 SP2 = the SP2 Voice Service (with ITSP A, B, C , or D ) 2 3 3 SP3 = the SP3 Voice Service (with ITSP A, B, C , or D ) 2 3 3 SP4 = the SP4 Voice Service (with ITSP A, B, C , or D ) PP1 = the OBiTALK Service 1 LI1 = the PSTN Line Service on the LINE port
3 3
The instance identifier may be omitted if it is equal to 1; hence LI is equivalent LI1, PP is equivalent to PP1, etc. These shorthand notations are used heavily in configuring the OBi device, as found in call routes, call forward numbers, and speed dials parameters. Unless stated otherwise, the abbreviated trunk names are case insensitive. In addition to all the call bridging functionalities, the OBi110 has a built-in physical PHONE port for hooking up analog telephones or FAX machines. OBi110 includes a set of features to support its PHONE port to make it work also as a fullfeatured ATA device. Users can place and receive calls on the PHONE port over any of the trunks. The OBi110 also comes with an Auto Attendant for helping callers to direct their calls landed on the device. When an inbound call is received on the device, it may be routed to the AA which then offers a menu of options to the caller to direct it further. It could be directed to the PHONE port, or bridged with another call on a trunk (which the AA dials or sets up on behalf of the caller). The PHONE port and the AA are the two entities in the OBi device that calls can terminate (i.e., starts or ends there), as opposed to the trunks, which rely on the corresponding service providers to terminate the call. In this document we refer to the PHONE port and the AA as endpoints. Like the trunks, each endpoint is represented by a 2-letter abbreviation and a 1based instance identifier: PH1 = the PHONE Port (same as PHONE1 port) 6 PH2 = the PHONE2 Port AA1 = the Auto Attendant
Unless stated otherwise, abbreviated endpoint names are case insensitive. A trunk or an endpoint is also referred to as a Terminal in this document. The following matrix shows the possible call connections between the endpoints and the trunks: Supported endpoint calls on the OBi
161
Any Trunk
PHONE2 Port
AA
n/a yes
yes no
yes yes
yes yes
yes
yes
no
yes
yes
yes
yes
no
162
caller := number OR embedded-digit-map OR ? OR @ callee := number OR embedded-digit-map OR @ terminal := PHx OR AAx OR LIx(arg) OR SPx(arg) OR PPx(arg) arg := cid > target x := 1 OR 2 OR 3 cid := spoofed-caller-number OR $1 target := number-to-call OR $2 embedded-digit-map := (Mlabel) OR digit-map
Notes: Terminal-list can be empty, which means to block this call. The preceding : cannot be omitted. Up to 4 terminals may be specified in the list. The listed terminals will be called/rung by OBi simultaneously; we refer to this operation as forking the call. A terminal may be a trunk or an endpoint. Abbreviated terminal names are case-insensitive number and number-to-call are literal strings, such as 14089991234 digit-map is just any proper digit map, such as (1xxx|xx.); make sure to include the enclosing parentheses
163
spoofed-caller-number is a literal string, such as 14081112233, to be used as the caller number for making a new call on the specified trunk (Mlabel) is a named digit map, where label is the abbreviated name of any terminal that has a digit map defined: 2 2 1 SP1, SP2, SP3 , SP4 , LI , PP, PH, PH2Error! Bookmark not defined., or AA $1 is an internal variable containing the value of the caller number of this inbound call, after any digit map transformation in the matched caller object of the matched peering object in the peering-list. $2 is an internal variable containing the called number of this inbound call, after any digit map transformation in the matched callee object of the matched peering object in the peering-list.
More notes on peering-list and peering objects: Peering-list is optional in InboundCallRoute. If peering-list is empty, the succeeding : can be omitted also. An empty peering-list implies a single peering object whose caller object list matches any caller number. That is, the InboundCallRoutes listed below are all equivalent o ph o {ph} o {:ph} o {?|@>@:ph} Callee-list in a peering object can be empty. It implies the callee object @, meaning any called number. The preceding > can be omitted if callee-list is empty. Caller-list in a peering object can be empty. It implies the caller-list @|?, meaning any caller number including anonymous. The succeeding > cannot be omitted if caller-list is empty but not the callee-list
More notes on the arg, cid, and target objects: The cid object inside an arg object is optional. If omitted, it implies no caller-ID spoofing when making the call on the specified trunk. The succeeding > can be omitted is cid is omitted The target object inside an arg object is optional. If omitted, it implies the target $2, which means to call the original called number after applying any necessary digit map transformation implied by the rule. The preceding > cannot be omitted if target is omitted but cid is not arg object is optional. If omitted, it implies the arg with the target $2 and no cid. If arg is omitted, the succeeding parentheses ( ) can be omitted also.
An inbound call matches a rule if its caller-number/callee-number matches one of the peering objects of the rule. Peering objects are tested in the order left and right, and the first matched peering object will win. Rules are also checked in the order left to right, and the first matched rule will win. Therefore it is important that you place the more specific rules first in the InboundCallRoute if multiple rules can potentially match the same inbound call.
It says: Ring the PHONE port for all incoming calls. This is the default InboundCallRoute for all trunks.
2) {(14081223330|15103313456):aa},{(1800xx.|1888xx.):},{ph} It says: Ring both PHONE port and AA for calls coming from 1 408 122 3330 or 1 510 331 3456, block all 800, 888, and anonymous calls, and ring the PHONE port for all other calls
164
3) {(x.4081113333|x.4152224444):aa},{ph} It says: Ring the AA for calls coming from any number that ends with 408 111 3333 or 415 222 4444, and ring the PHONE port for all other calls. Be sure to include the enclosing parentheses in this example since x. is a digit map specific syntax.
4) {200123456:aa},{sp1(14083335678)} It says: Ring the AA for calls coming from 200123456. For all any other call, bridge it by calling 1 408 333 5678 using SP1 Service
terminal := PHx OR AAx OR LIx(arg) OR SPx(arg) OR PPx(arg) arg := cid > target x := 1 OR 2 OR 3 cid = spoofed-caller-number target = number-to-call OR $2 embedded-digit-map = (Mlabel) OR digit-map
165
Notes: A terminal may be a trunk or another endpoint. Abbreviated terminal names are case-insensitive number and number-to-call are literal strings, such as 14089991234 digit-map is just any proper digit map, such as (1xxx|xx.); make sure to include the enclosing parentheses spoofed-caller-number is a literal string, such as 14081112233, to be used as the caller number for making a new call on the specified trunk (Mlabel) is a named digit map where label is the abbreviated name of any terminal that has a digit map defined: SP1, SP2, LI, PP, PH, or AA $2 is an internal variable containing the called number of this outbound call, after any digit map transformation in the matched callee object Callee-list can be empty, which implies the single callee object @, which means any called number. The succeeding : can be omitted also when callee-list is empty
More notes on the arg, cid, and target objects: The cid object inside an arg object is optional. If omitted, it implies no caller-ID spoofing when making the call on the specified trunk. The succeeding > can be omitted if cid is omitted. The target object inside an arg object is optional. If omitted, it implies the target $2, which means to call the original called number after applying any necessary digit map transformation implied by the rule. The preceding > cannot be omitted if target is omitted but not the cid. arg object is optional. If omitted, it implies the arg with the target $2 and no cid
An outbound call matches a rule if its called number matches one of the callee objects of the rule. Callee objects are tested in the order left and right, and the first matched callee will win. Rules are also checked in the order left to right, and the first matched rule will win. Therefore it is important that you place the more specific rules first in the OutboundCallRoute if multiple rules can potentially match the same outbound call.
Note that every endpoint also has a digit map defined. The user dialed number is completely processed with the endpoints digit map first before it is passed to the OutboundCallRoute for routing decision. Therefore the number used for matching call routing rules has already incurred the transformations, if any, implied by the digit map. Remember this fact when crafting your own OutboundCallRoute.
OutboundCallRoute Examples: 1) sp1 OR {SP1} OR {:SP1} OR {@:Sp1} (all equivalent) This rule says: Make all calls using SP1 Service, without any caller-id spoofing or digit transformation
2) {(<#:>|911):li},{**0:aa},{***:aa2},{(Mpli):pli},{(<**1:>(Msp1)):sp1},{(<**2:>(Msp2)):sp2},{(<**8:>(Mli)):li},{(<**9:>( Mpp)):pp} This is the default OutboundCallRoute for the PHONE port. It says:
166
Dial # key to connect to the LINE port; OBi will take the LINE port hardware to off-hook but will not dial out any digit. The net result is that the user will hear dial tone generated by the PSTN company if a working line is connected to the LINE port. The user may then continue to dial the PSTN number directly to the phone company. Note that from the OBis point of view, the PSTN call is connected the moment it takes the LINE port to the offhook state! Use the PSTN Line to call 911 Dial **0 to invoke AA1 or AA Dial *** to invoke the local device configuration IVR (a.k.a AA2) (Mpli) and pli will be substituted with the PrimaryLines abbreviated name Use SP1 Service to call all numbers that start with **1 and subsequent digits matching SP1 Services DigitMap. Remove the **1 prefix from the resulting number before making the call Use SP2 Service to call all numbers that start with **2 and subsequent digits matching SP2 Services DigitMap. Remove the **2 prefix from the resulting number before making the call Use the LINE port to call all numbers that start with **8 and subsequent digits matching LINE ports DigitMap. Remove the **8 prefix from the resulting number before making the call Use the OBiTALK Service to call all numbers that start with **9 and subsequent digits matching OBiTALK Services DigitMap. Remove the **9 prefix from the resulting number before making the call
A digit map rule is a rule for matching a given sequence of digits. It may contain extra white spaces for readability; all spaces are removed by the OBi device during parsing. A rule may contain one or more of the following elements: literals - Any combination of 0-9,*,#,+,-,A-Z,a-z, except m, M, s, S, x, X which have special meaning in the digit map syntax. It matches digit sequences with exactly the same literals literals - Everything inside a pair of single quotes is treated as a literal except for the single quote () character. x - a wild card digit that matches any digit from 0-9. x is CASE SENSITIVE x. - matches 0 or more x [123-7] or [135] - A set of 1 or more digits surrounded by pair of [ ]. It matches any digit in the set. The syntax represents an inclusive digit range, such as 09, 37. So [1237] is equivalent to [17] or [1234567] S, S0, S1, S2, S9 - Digit timer of 0, 1, 2, ,9 seconds respectively; S is equivalent to S1; S0 is the same as blank. You can concatenate multiple S elements together if you need more than 9s timeout, such as S9S5 for a 14s timeout. S is CASE SENSITIVE. It should only be used either as the first element of a rule for hot/warm line implementation, or as the last element of a rule as a means of overriding the default interdigit timer <elements:literals> - Substitute the digit sequence matching elements with the given literals. Single quote syntax is NOT needed or allowed for the literals in this context; special characters may be used here as they do not apply in this context either . Elements can be empty, in which case the : may be omitted. This case is useful for inserting
167
some extra digits in certain part of the dialed digits. The literals part can be empty also but the : MUST NOT be omitted. This case is useful for removing part of dialed digits. Elements and literals MUST NOT be both empty. (map) An embedded digit map for matching subsequent digits. (Mlabel) A named embedded digit map for matching subsequent digits, where label is one of abbreviated terminal names. Possible choices are: o (Msp1) for SP1 Service::DigitMap o (Msp2) for SP2 Service::DigitMap 2 o (Msp3) for SP3 Service::DigitMap 2 o (Msp4) for SP4 Service::DigitMap o (Mpp) for OBiTALK Service::DigitMap 1 o (Mli) for LINE Port ::DigitMap o (Mph) for PHONE Port::DigitMap o (Mph2) for PHONE2 PortError! Bookmark not defined.::DigitMap o (Maa) for Auto Attendant::DigitMap o (MtgN) for TrunkGroupN::DigitMap, N=1,2,3,4 o (MvgN) for VoiceGatewayN::DigitMap, N=1,2,3,4,5,6,7,8
Starting with release 1.2, the following elements are added: X A wildcard digit that matches 09 or *. This is equivalent to [x*] or [0-9*x] @ A wildcard character that matchs any alphanumeric character except # x? matches 0 or 1 x @? matches 0 or 1 @ [^] matches any single alphanumeric character that is not in the set Allow alphanumweric and wildcard inside a set [ ], such as [x], [X#], [@#], [a-zA-Zx]
The last two elements imply that the OBi digit maps are recursive. Recursive digit maps allow digit maps to be reused and make their specification more compact and readable. It is important that you do not specify digit maps that lead to infinite recursion. For example, a digit map must not include a named embedded digit map that references itself. To bar users from calling numbers that match a rule, add a ! in front of that rule in the digit map. The rule is then referred to as a barring rule. Lets look at some examples. 1408xxxxxxx Matches any 11-digit number that starts with 1408 011xx. Matches any number that starts with 011 followed by one or more digits <1408>xxxxxxx Matches any 7-digit number. OBi pre-pends 1408 to the number when making the call <:1408>xxxxxxx Equivalent to the last example <+>1xxxxxxxxxx Pre-pends + to any 11-digit number that starts with 1 <**1:>1408xxxxxxx Matches any number that starts with **11408 followed by 7 digits. OBi removes the **1 prefix when making the call *74(x|xx) Matches any number that starts with *74, followed by 1 or 2 digits
168
**1(Msp1) Matches any number that starts with **1 and with the rest of digits matching the DigitMap in the SP1 Service <:1234> Matches an empty phone number and replaces with 1234. This is the syntax for a hotline to 1234 <S0:1234> Equivalent to the last example <:#> Hotline to the number # <S0:#> Equivalent to the last example <S4:1234> Call 1234 if no digits entered for 4s. This is the syntax of a warm line. xx.853 7683 Matches any number with at least 8 digits and ends with 8537683, such as 15108537683, 98537683 (x.408 223 1122) Matches any number with at least 10 digits and ends with 408 223 1122, such as 4082231122, 1408 223 1122 xx.<#> Adds a # to the end of any number with 1 or more digits !1900xxx xxxx Barring all 11-digit numbers that start with 1900 [^*]@@. Arbitrarily long alphanumeric sequence (except #) that does not start with * xx? one or two-digit number (1xxxxxxxxxxS0|xx.) Arbitrarily long digit sequence not starting with 1; otherwise it is limited to 11 digits
The DMP restarts the interdigit timer on every newly entered digit. The duration of this timer can be either long or short. The long and the short timer values are set to 10s and 2s respectively at present (and they are not configurable). Whether to use the long or short interdigit timer depends on the current rule matching states. The DMP maintains a matching state for each rule in the digit map as it processes each input digit. The following states are defined: Partially Matched (PM) The rule partially matches the accumulated input sequence. Initially all rules are in this state before any digit is entered. Rules in this state have the potential of becoming EM or IM as more digits are entered. Example: 1234 partially matches the rules xxxxxxx, 1xxxx, 1234567, <123:>xxxx. Exactly Matched (EM) The rule exactly matches the accumulated input sequence. However, any further input digit will turn this rule into the MM state. Example: 1234 exactly matches the rules xxxx, 1234, 1xxx, <123:5678>x Indefinitely Matched (IM) The rule matches the accumulated input sequence indefinitely, with a variable length such that the rule can potentially stay as IM as more matching digits are entered. Example: 011853 indefinitely matches the rules xx., 011xx., <011:>xx.
169
Mismatch (MM) The rule does not match the accumulated input sequence. This state will not change as more digits are entered. Example: 1234 mismatches the rules 123, 1xx, 12345
Rules in the EM or IM state are candidates to be selected by the DMP. After processing a new digit, the DMP returns a final decision if any of the following conditions holds: 1. 2. All rules are the MM state. DMP returns an error One or more rules are in the EM state with no rules in the IM state. DMP returns the best matched EM rule. If the best matched rule is a barring rule, DMP returns an error instead
Otherwise, DMP starts the short interdigit timer if there is at least one rule in the EM state, or else the long one. When the interdigit timer expires, DMP makes a timely decision by returning the best matched rule at that moment if one is found, or else a timeout error. Again if the best matched rule in this case is a barring rule, DMP returns an error instead. Note that the timer to wait for the first input digit is NOT governed by the interdigit timer, but the duration of dial tone being played and could be a lot lengthier than the long interdigit timer.
The best matched rule is the one that has the most specific literals matching the input digit sequence. For example, the input sequence 1234 matches the rule 123x better than 1xxx. On the other hand, an EM rule is always selected over an IM rule.
Finally, the default interdigit timer can be overridden by appending the Sn element at the end of the rule (n = 09).
Lets look at some examples. Consider this simple digit map: (<1408>xxx xxxx) As soon as 7 digit have been entered, the DMP returns a complete number by pre-pending the accumulated digits with 1408.
Consider another simple map: (xx.) After user dials one or more digits, the DMP returns the accumulated digits as a complete number when the long interdigit timer expires.
Lets combine the last two maps: (xx. | <1408>xxx xxxx) After user dials 1 or more digits but less than 7 digits, the DMP would return the accumulated digits as a complete number when the (long) interdigit timer expires. As soon as 7 digits are entered, the DMP would return 1408 followed by the th accumulated 7-digit when the (short) interdigit expires. On the 8 digit and beyond, however, the DMP will consider the first rule only and return the accumulated digits as is when the (long) interdigit timer expires.
nd
170
(xx. | <1408>xxx xxxxS4) In this case the DMP behaves exactly the same as the last, except that the short interdigit timer the DMP uses upon th th receiving the 7 digit is overridden by a 4s timer; hence the user will have up to 4s instead of 2 to dial the 8 digit.
Forcing Interdigit Timeout With A Pound(#) Key When dialing, user may force an interdigit timeout with a # key instead of waiting for the DMP to timeout its own long or short timer. This is allowed as long as the # key does not match the current element of any PM rules. Otherwise the # key will be swallowed by the DMP instead of triggering a timeout. Consider the digit map (33xx.) If the user enters 333#, the DMP will return immediately with the number 333. Now consider the digit map (33xx.|333#1234x.) If the user enters 333#, the DMP will not return but continue to wait for further input or its interdigit timer to expire. Note that the first rule 33xx. is now in the MM state since the digit # does not match x. The user may continue to enter 1234#, or 1234 and wait for a long interdigit timeout for the DMP to successfully return 333#1234.
171
By default both parameters are empty, except for User Defined Digit Map 1 (see the section below).
b) <user-id>*<a>*<b>*<c>*<d>*<port> where <user-id> is an arbitrary length numeric user-id, such as 100345, <port> is a port number in the range 065535, and each of <a>,<b>,<c>,<d> is a 1-3 digit pattern in the range 1255 that identifies one byte of an IP address. The dialed 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 123456*192*168*15*180*5061 maps to 1234@192.168.15.113 maps to 123456@192.168.15.180:5061
172
Microprocessor
Chip Vendor Width of Machine Word Instruction Set Obihai SoC 32 bit MIPS
Management Configuration
Local Access Interface Remote Access Interface Device Web Page Standard Remote Provisioning Secure Remote Provisioning Secure Remote Firmware Update Customization Call History (CDRs) LED Indications RTP Statistics IVR, Web Page Password Protected (Admin & User Level Log-in) Syslog (Multi-Level Granularity), Invokable via SIP Notify, Web, Provisioning HTTP v1.1, XML v1.0 XML via TFTP or HTTP, TR069 / TR104 SSL via HTTPS , Encrypted XML via HTTP or TFTP Dedicated User Name & Password Encrypted Binary File via TFTP or HTTP + Dedicated User Name & Password OBi-ZT: Obihai Zero-Touch Automatic Customization & Configuration ** Call Detail Records on OBi Web Page, Export to XML Power, Device Status, Upgrade Progress Status, Ethernet Actvty, PHONE Status RTP Transport Type Audio Codec Type (Tx/Rx) RTP Packetization - ms (Tx/Rx)
173
RTP Packet Count (Tx/Rx) RTP Byte Count (Tx/Rx) Peer Clock Differential Rate - PPM Packets In Jitter Buffer Packets Out-Of-Order Packets Interpolated Packets Late (Dropped) Packets Lost Packet Loss Rate % Packet Drop Rate % Jitter Buffer Length - ms Received Interarrival Jitter - ms DTMF Digits Received Jitter Buffer Underruns Jitter Buffer Overruns Sequence Number Discontinuities Skew Compensation - ms SIP Session Status OBiTALK Status Phone Port Status Dedicated Device Web Page for Quick ITSP Account Set-Up Save & Restore Configuration via XML file to / from a Local Folder
Session Information Primary SIP Service Set-Up Wizard System Settings Back-Up / Restore
Security
Local Access Interface Remote Access Interface Device Web Page Standard Secure Remote Provisioning IVR Password User Name & Password Access via HTTP, TFTP HTTPS HTTP v1.1, XMLv1.0 TFTP, HTTP, HTTPS
Data Networking
VoIP
174
VoIP Cont
G.726 (40/32/24/16) G.729ab Codec Pre-selection Code Voice Processing per SIP Service TX/RX Audio Gain, Echo Cancellation Adjustable Audio Frames per Packet Codec Name Assignment Codec Profile per SIP SP (2) & OBiTALK Service Dynamic Audio Payload Packet Loss Concealment Jitter Buffer (Adaptive) STUN ICE SUBSCRIBE / NOTIFY Framework (RFC 3265) NOTIFY Dialog, Line Status SUBSCRIBE Message Summary VoIP NAT Interworking DATE Header Support ALERT-INFO Header Support Remote-Party-ID (RPID) P-Asserted-Identity (PAID) RTP Statistics in BYE Message Media Loopback Support Configurable Contact List (Inbound Call Routing) Automatic Attendant (English) with Configurable Answer Delay PIN Access Control to AA (Up to 4 PINs) Recursive Digit Map for Call Routing (AA, Phone, Voice Gateways, Trunk Groups) AA Configurable Outbound Call Routing Rule SIP Service Configurable Inbound Call Routing Rule (2) Direct / Single-Stage Dialing (Route to Voice Gateway) Fax Pass Through (G.711) Modem Pass Through (G.711) In-Band DTMF (G.711) Out of Voice Band DTMF (RFC 2833) Out of Voice Band DTMF (INFO Method) Call Progress Tone Generation Tone Profile per SIP SP and OBiTALK service Ring Profile per SIP SP and OBiTALK service Star Code Profile per SIP SP and OBiTALK service Full Duplex Audio G.165, 168 Echo Cancelation VAD Voice Activity Detection Silence Suppression Comfort Noise Generation Three Way Conference Calling with Local Mixing Hook Flash Event Signaling Flash Hook Timer Caller ID Name & Number per Bellcore, ETSI and DTMF MWI Message Waiting Indicator Visual Message Waiting Indication (VMWI) Daylight Savings Time Support North & South Hemispheres Caller ID Enable /Disable Caller ID Number Caller ID Name (Alphanumeric) Call Waiting Maximum Session Control Call Forward - Unconditional Call Forward on Busy Call Forward on No Answer (Ring Count Configurable) Call Transfer Enable / Disable Anonymous Call Block
Telephony
175
Anonymous Call Do Not Disturb Call Return Repeat Dialing Configurable Call Progress Tone Call Progress Tone Profiles (2) Dial Tone Busy Tone Ringback Tone Reorder Tone Confirmation Tone Holding Tone Second Dial Tone Stutter Tone Howling Tone Prompt Tone Call Forwarded Tone Conference Tone SIT Tones (1-4) Ringing & Call Waiting Tone Configuration Ring Patterns (10) - Configurable Call Waiting Tone Patterns (10) - Configurable Call Waiting Tone Pattern Profiles (2) Configurable Start Codes Star Code Profiles (2) Redial Call Return Activate Block Caller ID Deactivate Block Caller ID Block Caller ID Once Unblock Caller ID Once Activate Call Forwarding (All Calls) Deactivate Call Forwarding (All Calls) Activate Call Forward on Busy Deactivate Call Forward on Busy Activate Call Forward on No Answer Deactivate Call Forward on No Answer Activate Block Anonymous Calls Deactivate Block Anonymous Calls Activate Call Waiting Deactivate Call Waiting Activate Do Not Disturb Deactivate Do Not Disturb Activate Repeat Dial Deactivate Repeat Dial
Certifications
FCC Part 15 A-Tick CE Yes Class B Yes Yes
176
Environmental
Operating Temperature Storage Temperature Operating Humidity Non-operating Humidity 0 to 45 C (32 to 113 F) -25 to 85 C (-13 to 185 F) 10% to 90% Non-condensing 10% to 90% Non-condensing
Physical Attributes
Dimensions: (width x depth x height) Unit Weight: Shipping Weight Mounting 6.5 x 9.0 x 2.2 centimetres 2.6 x 3.5 x 0.9 inches 200 grams / 7 ounces 312 grams / 12 ounces (Including Power Supply, Cable and Packaging) Desktop Mountable
Power Supply
Type Input Power Output Power Universal Switching with Fixed US, EU, UK or AU Style Plug Prongs (Model Dependent) AC Input: 100 to 240 Volts 0.3A 50-60Hz (26-34 VA) DC: +12V 1.0 Amp Max
Carton Specifications
Units Per Carton Carton Dimensions (width x depth x height) Carton Weight Cartons Per Std. 20 / 40 ft Container 20 Units 43.2 x 25.4 x 21.6 centimetres 17 x 10 x 8.5 inches 6.4 Kilograms / 14 pounds 1,170 / 2,430 Cartons Non-palletized
Miscellaneous
Active Internet Connection Analog Touch Tone Phone Access to Internet Via a Switched Ethernet Port on Home or Office Router (Optional) Active Internet Phone Service Subscription with All Required SIP Credentials to Make & Receive Calls Quick Start / Installation Guide User / Administrative Guide Implementation Guide for Service Providers ** OBi100 Voice Service Bridge and Telephone Adapter Power Adapter 1 x RJ-45 Ethernet Cable (80 inches / 203 centimeters) Quick Start / Installation Guide 1-Year Hardware (Limited) California, USA China 8517.62.00 All content subject to change. This data sheet is not a warranty. 140911.100.1
Requirements
Documentation
Package Contents Warranty Engineering & Design Location Country of Origin HST Code Data Sheet State Data Sheet Version
177
OBi110
General
Brand Manufacturer Hardware Designer Model Name Release Date Obihai Browse Obihai Devices Obihai Obihai Technology, Inc. OBi110 November 2010
Microprocessor
Chip Vendor Width of Machine Word Instruction Set Obihai SoC 32 bit MIPS
178
Caller ID Detect Method: FSK (Bell 202), FSK (V.23), DTMF (FI, SE, DK) DTMF Playback Level Ring Detection Ring Frequency Min Ring Frequency Max Ring Threshold: 40.50-49.50 Vrms, 19.35-23.65 Vrms, 13.50-16.50 Vrms Ring Validation Time: 8 Settings Ring Indication Delay Time: 8 Settings Ring Timeout: 15 Settings Ringer Impedance: High, Synthesized
Management Configuration
Local Access Interface Remote Access Interface Device Web Page Standard Remote Provisioning Secure Remote Provisioning Secure Remote Firmware Update Customization Call History (CDRs) LED Indications IVR, Web Page Password Protected (Admin & User Level Log-in) Syslog (Multi-Level Granularity), Invokable via SIP Notify, Web, Provisioning HTTP v1.1, XML v1.0 XML via TFTP or HTTP, TR069 / TR104 SSL via HTTPS , Encrypted XML via HTTP or TFTP Dedicated User Name & Password Encrypted Binary File via TFTP or HTTP + Dedicated User Name & Password OBi-ZT: Obihai Zero-Touch Automatic Customization & Configuration ** Call Detail Records on OBi Web Page, Export to XML Power, Device Status, Upgrade in Progress Status, Ethernet Activity, PHONE Port Status, LINE Port Status RTP Transport Type Audio Codec Type (Tx/Rx) RTP Packetization - ms (Tx/Rx) RTP Packet Count (Tx/Rx) RTP Byte Count (Tx/Rx) Peer Clock Differential Rate - PPM Packets In Jitter Buffer Packets Out-Of-Order Packets Interpolated Packets Late (Dropped) Packets Lost Packet Loss Rate % Packet Drop Rate % Jitter Buffer Length - ms Received Interarrival Jitter - ms DTMF Digits Received Jitter Buffer Underruns Jitter Buffer Overruns Sequence Number Discontinuities Skew Compensation - ms SIP Session Status OBiTALK Status Phone Port Status Line Port Status Dedicated Device Web Page for Quick ITSP Account Set-Up Save & Restore Configuration via XML file to / from a Local Folder
RTP Statistics
Session Information Primary SIP Service Set-Up Wizard System Settings Back-Up / Restore
Security
179
Local Access Interface Remote Access Interface Device Web Page Standard Secure Remote Provisioning
IVR Password User Name & Password Access via HTTP, TFTP HTTPS HTTP v1.1, XMLv1.0 TFTP, HTTP, HTTPS
Data Networking
VoIP
180
Telephony
Configurable Contact List (Inbound Call Routing) Automatic Attendant (English) with Configurable Answer Delay PIN Access Control to AA (Up to 4 PINs) Recursive Digit Map for Call Routing (AA, Line, Phone, Voice Gateways, Trunk Groups) AA Configurable Outbound Call Routing Rule SIP Service Configurable Inbound Call Routing Rule (2) Direct / Single-Stage Dialing (Route to Voice Gateway) Fax Pass Through (G.711) Modem Pass Through (G.711) In-Band DTMF (G.711) Out of Voice Band DTMF (RFC 2833) Out of Voice Band DTMF (INFO Method) Call Progress Tone Generation Tone Profile per SIP SP and OBiTALK service Ring Profile per SIP SP and OBiTALK service Star Code Profile per SIP SP and OBiTALK service Full Duplex Audio G.165, 168 Echo Cancelation VAD Voice Activity Detection Silence Suppression Comfort Noise Generation Three Way Conference Calling with Local Mixing Hook Flash Event Signaling Flash Hook Timer Caller ID Name & Number per Bellcore, ETSI and DTMF MWI Message Waiting Indicator Visual Message Waiting Indication (VMWI) Daylight Savings Time Support North & South Hemispheres Caller ID Enable /Disable Caller ID Number Caller ID Name (Alphanumeric) Call Waiting Maximum Session Control Call Forward - Unconditional Call Forward on Busy Call Forward on No Answer (Ring Count Configurable) Call Transfer Enable / Disable Anonymous Call Block Anonymous Call Do Not Disturb Call Return Repeat Dialing Configurable Call Progress Tone Call Progress Tone Profiles (2) Dial Tone Busy Tone Ringback Tone Reorder Tone Confirmation Tone Holding Tone Second Dial Tone Stutter Tone Howling Tone Prompt Tone Call Forwarded Tone Conference Tone SIT Tones (1-4) Ringing & Call Waiting Tone Configuration Ring Patterns (10) - Configurable Call Waiting Tone Patterns (10) - Configurable
181
Call Waiting Tone Pattern Profiles (2) Configurable Start Codes Star Code Profiles (2) Redial Call Return Activate Block Caller ID Deactivate Block Caller ID Block Caller ID Once Unblock Caller ID Once Activate Call Forwarding (All Calls) Deactivate Call Forwarding (All Calls) Activate Call Forward on Busy Deactivate Call Forward on Busy Activate Call Forward on No Answer Deactivate Call Forward on No Answer Activate Block Anonymous Calls Deactivate Block Anonymous Calls Activate Call Waiting Deactivate Call Waiting Activate Do Not Disturb Deactivate Do Not Disturb Activate Repeat Dial Deactivate Repeat Dial
Certifications
FCC Part 15 FCC Part 68 A-Tick CE ICES-003 RoHS WEEE UL/cUL Yes Class B Yes FCC ID: OBIITO.OBOBI110 Yes Yes Yes Yes Yes Yes Power Adapter
Environmental
Operating Temperature Storage Temperature Operating Humidity Non-operating Humidity 0 to 45 C (32 to 113 F) -25 to 85 C (-13 to 185 F) 10% to 90% Non-condensing 10% to 90% Non-condensing
Physical Attributes
Dimensions (width x depth x height) 11.5 x 11.0 x 3.0 centimetres 4.5 x 4.2 x 1.2 inches
182
255 grams / 9 ounces 400 grams / 14 ounces (Including Power Supply, Cables and Packaging) Desktop or Wall Mountable
Power Supply
Type Input Power Output Power Universal Switching with Fixed US, EU, UK or AU Style Plug Prongs (Model Dependent) AC Input: 100 to 240 Volts 0.3A 50-60Hz (26-34 VA) DC: +12V 1.0 Amp Max
Carton Specifications
Units Per Carton Carton Dimensions (width x depth x height) Carton Weight Cartons Per Std. 20 / 40 ft Container 20 Units 48.0 x 29.0 x 29.0 centimetres 19.0 x 11.4 x 11.4 inches 8.6 Kilograms / 19 pounds 768 / 1,613 Cartons Non-palletized
Miscellaneous
Active Internet Connection Analog Touch Tone Phone Access to Internet Via a Switched Ethernet Port on Home or Office Router (Optional) Access to an Analog Telephone (POTS) Line. (Optional) Active Internet Phone Service Subscription with All Required SIP Credentials to Make & Receive Calls Quick Start / Installation Guide User / Administrative Guide Implementation Guide for Service Providers ** OBi110 Voice Service Bridge and Telephone Adapter Power Adapter 1 x RJ-45 Ethernet Cable (80 inches / 203 centimeters) 1 x RJ-11 Telephone Cable (45 inches / 113 centimeters) Quick Start / Installation Guide 1-Year Hardware (Limited) California, USA China 8517.62.00 All content subject to change. This data sheet is not a warranty. 140911.110.1
Requirements
Documentation
Package Contents
Warranty Engineering & Design Location Country of Origin HST Code Data Sheet State Data Sheet Version
183
OBi202
General
Brand Manufacturer Hardware Designer Model Name Release Date Obihai Browse Obihai Devices Obihai Obihai Technology, Inc. OBi202 April 2012
Microprocessor
Width of Machine Word Instruction Set 32 bit ARM
Management Configuration
Local Access Interface Remote Access Interface Device Web Page Standard Remote Provisioning Secure Remote Provisioning Secure Remote Firmware Update Customization Call History (CDRs) LED Indications IVR, Web Page Password Protected (Admin & User Level Log-in) Syslog (Multi-Level Granularity), Invokable via SIP Notify, Web, Provisioning HTTP v1.1, XML v1.0 XML via TFTP or HTTP, TR069 / TR104 SSL via HTTPS , Encrypted XML via HTTP or TFTP Dedicated User Name & Password Encrypted Binary File via TFTP or HTTP + Dedicated User Name & Password OBi-ZT: Obihai Zero-Touch Automatic Customization & Configuration ** Call Detail Records on OBi Web Page, Export to XML Power, Device Status, Upgrade Progress Status, Ethernet Activity, PHONE Status RTP Transport Type Audio Codec Type (Tx/Rx) RTP Packetization - ms (Tx/Rx) RTP Packet Count (Tx/Rx) RTP Byte Count (Tx/Rx) Peer Clock Differential Rate - PPM Packets In Jitter Buffer Packets Out-Of-Order
RTP Statistics
184
Packets Interpolated Packets Late (Dropped) Packets Lost Packet Loss Rate % Packet Drop Rate % Jitter Buffer Length - ms Received Interarrival Jitter - ms DTMF Digits Received Jitter Buffer Underruns Jitter Buffer Overruns Sequence Number Discontinuities Skew Compensation - ms Session Information Primary SIP Service Set-Up Wizard System Settings Back-Up / Restore SIP Session Status OBiTALK Status Phone Port Status (Phone 1 and Phone 2) Dedicated Device Web Page for Quick ITSP Account Set-Up Save & Restore Configuration via XML file to / from a Local Folder
Security
Local Access Interface Remote Access Interface Device Web Page Standard Secure Remote Provisioning IVR Password User Name & Password Access via HTTP, TFTP HTTPS HTTP v1.1, XMLv1.0 TFTP, HTTP, HTTPS
Data Networking
185
- PPTP (Point-to-Point Tunneling Protocol) - L2TP (Layer 2 Tunneling Protocol) Four (4) Service Provider Configuration Profile Assignments (ITSP 1-4) Four (4) Service /Trunk Subscription Profile Assignments (SP 1-4) SIPv2 (RFC 3261, 3262, 3263, 3264) SIP over UDP SIP over TCP SIP over TCP with TLS 4 SIP Service Provider Service Sessions Concurrent Operation 4 XMPP (Google Voice) Sessions 2 OBiTALK Service Session SIP Proxy Redundancy Local or DNS Based SVR, Primary & Secondary Fallback List Restrict Source IP Address Maximum Number of Sessions Independent per Service Trunk Groups (4) Voice Gateway Direct Dialing (8) G.711 A-Law (64 kbps) G.711 -Law (64 kbps) G.726 (32 kbps) G.729ab (8 kbps) iLBC (13.3, 15.2 kbps) Codec Pre-selection Code Voice Processing per SIP Service TX/RX Audio Gain, Echo Cancellation Adjustable Audio Frames per Packet Codec Name Assignment Codec Profile per SIP SP (2) & OBiTALK Service Dynamic Audio Payload Packet Loss Concealment Jitter Buffer (Adaptive) STUN ICE SUBSCRIBE / NOTIFY Framework (RFC 3265) NOTIFY Dialog, Line Status SUBSCRIBE Message Summary VoIP NAT Interworking DATE Header Support Remote-Party-ID (RPID) P-Asserted-Identity (PAID) RTP Statistics in BYE Message Media Loopback Support Configurable Contact List (Inbound Call Routing) Automatic Attendant (English) with Configurable Answer Delay PIN Access Control to AA (Up to 4 PINs) Recursive Digit Map for Call Routing (AA, Phone, Voice Gateways, Trunk Groups) AA Configurable Outbound Call Routing Rule SIP Service Configurable Inbound Call Routing Rule (2) Direct / Single-Stage Dialing (Route to Voice Gateway) Fax Pass Through (G.711) T.38 Fax Relay for Real-Time Fax over IP Modem Pass Through (G.711) In-Band DTMF (G.711) Out of Voice Band DTMF (RFC 2833) Out of Voice Band DTMF (INFO Method) Call Progress Tone Generation Tone Profile per SIP SP and OBiTALK service Ring Profile per SIP SP and OBiTALK service Star Code Profile per SIP SP and OBiTALK service Full Duplex Audio G.165, 168 Echo Cancelation VAD Voice Activity Detection
VoIP
Telephony
186
Silence Suppression Comfort Noise Generation Three Way Conference Calling with Local Mixing Hook Flash Event Signaling Flash Hook Timer Caller ID Name & Number per Bellcore, ETSI and DTMF MWI Message Waiting Indicator Visual Message Waiting Indication (VMWI) Daylight Savings Time Support North & South Hemispheres Caller ID Enable /Disable Caller ID Number Caller ID Name (Alphanumeric) Call Waiting Maximum Session Control Call Forward - Unconditional Call Forward on Busy Call Forward on No Answer (Ring Count Configurable) Call Transfer Enable / Disable Anonymous Call Block Anonymous Call Do Not Disturb Call Return Repeat Dialing Configurable Call Progress Tone Call Progress Tone Profiles (2) Dial Tone Busy Tone Ringback Tone Reorder Tone Confirmation Tone Holding Tone Second Dial Tone Stutter Tone Howling Tone Prompt Tone Call Forwarded Tone Conference Tone SIT Tones (1-4) Ringing & Call Waiting Tone Configuration Ring Patterns (10) - Configurable Call Waiting Tone Patterns (10) - Configurable Call Waiting Tone Pattern Profiles (2) Configurable Start Codes Star Code Profiles (2) Redial Call Return Activate Block Caller ID Deactivate Block Caller ID Block Caller ID Once Unblock Caller ID Once Activate Call Forwarding (All Calls) Deactivate Call Forwarding (All Calls) Activate Call Forward on Busy Deactivate Call Forward on Busy Activate Call Forward on No Answer Deactivate Call Forward on No Answer Activate Block Anonymous Calls Deactivate Block Anonymous Calls Activate Call Waiting Deactivate Call Waiting
187
Activate Do Not Disturb Deactivate Do Not Disturb Activate Repeat Dial Deactivate Repeat Dial
Certifications
FCC Part 15 A-Tick CE ICES-003 RoHS WEEE UL/cUL Yes Class B Future Yes Yes Yes Yes Yes Power Adapter
Environmental
Operating Temperature Storage Temperature Operating Humidity Non-operating Humidity 0 to 45 C (32 to 113 F) -25 to 85 C (-13 to 185 F) 10% to 90% Non-condensing 10% to 90% Non-condensing
Physical Attributes
Dimensions: (width x depth x height) Unit Weight: Shipping Weight Mounting 10.5 cm x 11.4 cm x 3.0 cm 4.1 in x 4.5 in x 1.2 in 255 grams / 9 ounces 390 grams / 14 ounces (Including Power Supply, Ethernet Cable and Packaging) Wall & Desktop Mountable
Power Supply
Type Input Power Output Power Universal Switching with Fixed US, EU, UK Style Plug Prongs (Model Dependent) AC Input: 100 to 240 Volts 0.3A 50-60Hz (26-34 VA) DC: +12V 1.0 Amp Max
Carton Specifications
Units Per Carton Carton Dimensions Carton Weight Cartons Per Std. 20 / 40 ft Container 20 Units 36.0 cm x 33.0 cm x 26.8 cm 14.2 in x 13 in x 10.5 in 8.2 Kilograms / 18 pounds 896 / 1,848 Cartons Non-palletized
Miscellaneous
Requirements Active Internet Connection
188
Analog Touch Tone Phone Access to Internet Via a Switched Ethernet Port on Home or Office Router (Optional) Active Internet Phone Service Subscription with All Required SIP Credentials to Make & Receive Calls Documentation Quick Start / Installation Guide User / Administrative Guide Implementation Guide for Service Providers ** OBi202 Voice Service Bridge and Telephone Adapter Power Adapter 1 x RJ-45 Ethernet Cable (80 inches / 203 centimeters) Quick Start / Installation Guide 1-Year Hardware (Limited) California, USA 8517.62.00 All content subject to change. This data sheet is not a warranty. 100411.202.2
** For Service Providers Only
Package Contents Warranty Engineering & Design Location HST Code Data Sheet State Data Sheet Version
189