Obihai OBi1062 Administration Manual Download Page 140

Page: 140 / 220

140

Audio Codec Profiles

There are two Codec Profiles available on OBi devices and they are selectable per trunk (OBiTALK, SP

= 1 – 6 ). To

select a codec as the preferred codec in this profile, set the priority of that codec to be highest among all the enabled

codecs in the profile. Each of the SP and OBiTALK services can be assigned a codec profile in its corresponding

configuration. The codec list to use when setting up a call on the underlying service is formed from the list of enabled

codecs in the chosen profile and ordered according to the assigned priorities in the profile. For codecs with the same

priority setting, the codec appears first on the codec profile web page will be considered as higher priority.

Summary of Contents for OBi1062

Page 1: ...IPPhoneAdministrationGuide Models OBi1062 OBi1032 OBi1022 April 2015 Copyright Obihai Technology Inc 2015 All Rights Reserved Copyright material Do not make copies Do not distribute All contents subje...

Page 2: ...IGURATION AND MANAGEMENT INTERFACES 19 DEVICE LOCAL CONFIGURATION 19 To access the OBi IP Phone Device Management Web Page 19 Web Page Conventions and Icons Buttons 20 Local Configuration Web Page Lay...

Page 3: ...Keys 47 Speed Dial Keys 47 BLF Keys 47 Presence Monitor 47 Group Page Keys 47 VOICE SERVICES 48 ITSP PROFILES 48 OVERVIEW OF COMMON TRUNK CONFIGURATION 48 Service Enable 48 Service Account Credentials...

Page 4: ...ok Dialing 65 Outbound Call Routes 65 Primary Line 65 Explicitly Selecting a Line to make call 66 Dialing Speed Dials 99 Numbers 66 Dialing Star Codes 66 Called Party Caller ID Display 66 Handling Inc...

Page 5: ...Pickup 79 BLF Operation Resume 79 BLF Configuration 79 Floating BLF Key Assignment 80 SIP for BLF 81 Call Park and Call Pickup 82 Call Park Methods 82 Call Park Monitor and Call Pickup Methods 83 Sha...

Page 6: ...KEY 99 Calls App Behavior 99 SOFT KEY SET CUSTOMIZATION 100 Soft Key Set Parameter Syntax 100 Soft Key Specification 100 Assignable Soft Keys 101 Soft Key Set Parameters 103 LINE KEY WINDOW CUSTOMIZA...

Page 7: ...BACK SERVICE 129 USER RECORDED PROMPTS 130 CUSTOMIZING AA PROMPT LISTS 130 VOICE GATEWAYS AND TRUNK GROUPS 132 VOICE GATEWAY 132 TRUNK GROUPS 132 LDAP 133 LDAP SERVICE SETUP 133 Client Authentication...

Page 8: ...The Hash Pound Key 165 INVOKE SECOND DIAL TONE IN DIGIT MAP 165 CHANGE INTERDIGIT LONG TIMER DYNAMICALLY AFTER PARTIAL MATCH 166 USER DEFINED DIGIT MAPS 166 A USER DEFINED DIGIT MAP FOR IPV4 DIALING 1...

Page 9: ...X A B C D E F 182 ITSP Profile X SIP Web Page X A B C D E F 183 ITSP Profile X RTP Web Page X A B C D E F 189 VOICE SERVICES 189 SPn Service Web Page n 1 2 3 4 5 6 189 OBiTALK Service Configuration 1...

Page 10: ...ck on your device and at the next page you ll see a link to enter the expert configuration page Within this page you can then click another link to bring up the device s complete set of configuration...

Page 11: ...s the literal value to assign to the named parameter and may contain spaces Group Name or its top level headings may be omitted when the context is clear For example SP1 Service AuthUserName 408222431...

Page 12: ...aracteristics of each OBi IP Phone The following table provides a specification summary for each model while figures 1 through 4 show the front and back of each OBi IP Phone as well as the phone with...

Page 13: ...hai Technology Inc 13 Figure 1 Front of the OBi1032 IP Phone Figure 2 Front of the OBi1062 IP Phone Line Keys LK1 LK3 Programmable Keys PK1 PK8 Headset Jack 3 5mm MWI Lamp Soft Keys SK1 SK4 Handset HD...

Page 14: ...ight 2010 2015 Obihai Technology Inc 14 Figure 3 Rear of the OBi1032 and OBi1062 IP Phones Figure 4 OBi1062 with an attached OBi1000e Sidecar Option Not Available on OBI1022 Sidecar 1 Sidecar Keys SK1...

Page 15: ...P Phone Figure 6 Rear of the OBi1022 IP Phone Ethernet Switch Port Supports PoE USB Port Ethernet Passthrough Port Power Socket 12V DC Handset Port Wall Mounting Points Stand Mouting Points Programmab...

Page 16: ...k in order to obtain phone service In most cases your network will require an internet connection and your service provider will set out requirements for the required capacity of your connection to su...

Page 17: ...phone SIP Support for Voice Over IP OBiTALK Managed VoIP Network for OBi Endpoint Devices Applications High Quality Voice Encoding Using G 711 G 726 G 729 G 722 iLBC and OPUS Algorithms Recursive Digi...

Page 18: ...portal for device management allowing members to add people and associated OBi endpoints to circles of trust such that additional functionality can be shared amongst authorized users OBiON for iPhone...

Page 19: ...ect value instead When you access the OBi device management web page you may be prompted to enter a user name and password There are two levels of access to the OBi web page User Level and Admin Level...

Page 20: ...n check the Default box This will open the parameter field for access and modification If there is a non default setting in a parameter field and you want to revert that parameter back to its default...

Page 21: ...ach web page is divided into three frames A top frame with the Obihai banner which can be customized by the administrator a left frame that lists the links to the available pages and a main frame that...

Page 22: ...Auto Attendant Gateways and Trunk Groups OBiBluetooth IP Phone Phone Settings Line Keys Programmable Keys Side Car 1 Side Car 2 Soft Keys LED Settings LDAP Feature Key Customization Codec Profiles Co...

Page 23: ...tion closely follows TR 104 For a full description of the configuration file and parameter names please refer to the OBi Device Provisioning Guide Similar to the way parameters are grouped under diffe...

Page 24: ...r the phone You can find the object name corresponding to each configuration web page section listed at the end of this document About ZT Zero Touch Device Customization at Obihai s Factory When produ...

Page 25: ...at may be applied to many units When a base profile is changed all units using this base profile will be automatically updated with any changes that have been made Telephone IVR Based Local Configurat...

Page 26: ...to change the value Press 1 to enter a new value Press 2 to set the default value Press 0 to repeat the information 4 IP Address Current Value Your current value will be read back to you and you will...

Page 27: ...eat the information Press to enter another configuration selection 2 IVR Password The current value of the IVR password will be read back Press 1 to enter a new value Press 2 to set the default value...

Page 28: ...tion Press to enter another configuration selection 24 DNS Server Primary The current value of the primary DNS server will be read back Press 1 to enter a new value Press 2 to set the default value Pr...

Page 29: ...mber Press 1 to enter a new value Press 2 to set the default value Press 0 to repeat the information Press to enter another configuration selection 174 SP1 Call Forward on Busy Enable Disable Press 1...

Page 30: ...ess 2 to set the default value Press 0 to repeat the information Press to enter another configuration selection 268 SP2 Block Anonymous Call Enable Press 1 to enter a new value Press 2 to set the defa...

Page 31: ...ration selection 901 Registration State of OBiTALK The current value will be read back Press 0 to repeat the information Press to enter another configuration selection 967 OBiTALK Block Caller ID Enab...

Page 32: ...t the default value Press 0 to repeat the information Press to enter another configuration selection Auto Attendant Configuration Options Selection Always Press After Entering Selection Announcement W...

Page 33: ...nearest number of seconds A total of 122 seconds 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 Furthe...

Page 34: ...able o OBiWiFi Setup Mode o SSID o Status o Security o Signal Strength o MAC Address Bluetooth o Enable o Status o Pairing Mode o Discoverable OBiLine Settings not available on OBi1022 o Enable o Stat...

Page 35: ...col ProxyServer ProxyServerPort ProxyServerTransport OutboundProxy OutboundProxyPort RegistrationPeriod ProxyRequire DnsSrvAutoPrefix DiscoverPublicAddress Speed Dials 99 Device Administration o Web S...

Page 36: ...Block Anonymous Call Anonymous Call Auto Answer Page Join Page Group 1 Joint page Group 2 Ringer Volume Speakerphone Volume Speakerphone Mic Gain Handset Volume Handset Mic Gain RJ9 Headset Volume RJ...

Page 37: ...iance with 802 1p q If WAN Settings Internet Settings VLANEnable is enabled outbound traffic will be tagged according to the parameters VLANID and VLANPriority The phone will ignore inbound traffic th...

Page 38: ...Client Settings ExtraOptions Note that the phone will not recognize any option numbers other than the supported ones listed above You can use the macros DHCPOPT66 DHCPOPT150 DHCPOPT159 DHCPOPT160 and...

Page 39: ...s interpolated by the phone using its own local clock in between NTP refreshes Daylight saving time can be enabled by enabling the option DaylightSavingTimeEnable Daylight saving time is automatically...

Page 40: ...The VLKW Virtual Line Key Window shows nothing but the idle phone icon shown on the right column when no active call is assigned to the key Otherwise the icon changes to reflect the current call state...

Page 41: ...least one incoming call Holding at least one call holding Busy at least one active call Idle no calls Call parked against the monitored extension VLKW shows the bound service name and the monitored e...

Page 42: ...ise it is applied system wide to all incoming call regardless which service the calls are coming from If this feature is enabled the phone rejects all incoming calls with Caller ID name number hidden...

Page 43: ...e Add to Conference Add all calls that are in the Holding State to the current conversation VLKW shows how many calls are in the Holding State The LED turns red is there is at least one call in the Ho...

Page 44: ...sing the guest phone for his own extension temporarily until he logs out or the server logs him out remotely This function must be bound to a specific voice service that supports this feature Paramete...

Page 45: ...on OBi1032 and 10 on OBi1022 are available per phone The VLK tabs are numbered 1 4 1 2 on the OBi1022 where one and only one VLK tab is visible on the screen at any time the 4 Tab icons 2 on the OBi1...

Page 46: ...the status of the monitored entity is changed Highlights of Feature Key Functions This section highlights the most commonly used feature key functions to introduce some definitions that are used frequ...

Page 47: ...BLF key is used to monitor the call status of another extension This feature operates in the context of an SP service In many cases the BLF key also acts as a speed dial key to call or transfer a cal...

Page 48: ...document ITSP Profiles The configuration of an SP service is divided into two parts A Service Provider part and a Service Subscriber Part The Service Provider part comprises of parameters that are co...

Page 49: ...listening at the standard port 5060 Note that since Google Voice and OBiTALK servers are already known by the phone there is no need to configure the server domains for these services For other SIP SP...

Page 50: ...o call it will make the call if the trunk is enabled and up and it has not yet reached full capacity Otherwise the trunk will fail the outgoing call attempt It should be noted that although there is a...

Page 51: ...xyServer or the RegistrarServer by enabling the parameter SPn Service X_RegisterEnable ProxyServer and RegistrarServer could be different although they are rarely so in practice ProxyServer is a requi...

Page 52: ...Credentials X_ShareLineUserID Registration Period The nominal registration Expires header value implemented as a Contact header parameter value used by the phone in REGISTER requests is configured in...

Page 53: ...ResponseCodes on the actual error code The format of this parameter is the same as a digit map Let s consider the default value of this parameter 40 17 w120 40 34 w120 99 01 w120 200 4 9 xx Each rule...

Page 54: ...e server port is taken from the configured value or 5060 will be used if no value is specified We recommend setting the ProxyServerPort to 0 i e the unspecified value if DNS SRV lookup is intended for...

Page 55: ...ne 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 c...

Page 56: ...oon 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 Si...

Page 57: ...uest right before making or answering a call on SPx If the request is successful the device decodes the mapped external address and port from the binding response and uses them in the m and c lines of...

Page 58: ...ice can include a summary of the RTP statistics collected during the call in the SIP BYE request or the 200 response to the SIP BYE request sent by the peer device The summary is carried in an X RTP S...

Page 59: ...pback call the 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...

Page 60: ...can be setup to automatically do that for you when you pick up the phone To enable this feature on the device set the SPn Service CallingFeatures X_SkipCallScreening parameter to true false is the def...

Page 61: ...e 9 digit OBi number For your convenience Obihai maintains an Echo Server at the reserved OBi Number 222 222 222 Users can call this number to do a quick Echo Test after listening to a short announcem...

Page 62: ...otherwise the phone considers the service disabled With that the Bluetooth connected mobile phone becomes a mobile service gateway for the phone to access the mobile service on the mobile phone Like o...

Page 63: ...State Description Available Operations Icon LED Pattern Dialtone Dial tone played to prompt the user to enter the target number to call End Steady green Dialing The user is entering a target number to...

Page 64: ...default value is 2 for all lines The number should be set to equal to or less than what the underlying service provider can support Complex Operations Between Multiple Diverse Voice Services The OBi10...

Page 65: ...hooks the phone before dialing the number The phone plays the dial tone when it is off hook and starts collecting any digits entered by the user and processes these digits according to the phone digi...

Page 66: ...d dial numbers are unrelated to the speed dial feature keys These numbers can be associated with phones or devices reachable via an Internet or landline service or the OBiTALK network Be careful with...

Page 67: ...end the call simply by hanging up i e on hooking the phone Holding Calls While a call is connected the user may place the call on hold using one of the following methods Pressing the Hold soft key thi...

Page 68: ...waits for B s Phone to ring but before B answers to complete the call transfer The OBi user presses the Transfer Now soft key to complete the call transfer 3 Unattended or Blind Call Transfer In this...

Page 69: ...ote also that if the transfer operation eventually fails after completion from the OBi user s perspective the original call with the transferee cannot be restored Transfer Signaling As transferor if t...

Page 70: ...onferees to access the bridge for this conference call On that the phone maintains the call with the bridge in the Connected State and sends a REFER to both conferees to refer them to the Contact as r...

Page 71: ...The phone inserts info alert autoanswer delay 0 parameters in an Alert Info header in the INVITE request The method to use is controlled by the parameter ITSP Profile X SIP X_AutoAnswerMethod Regardle...

Page 72: ...ALK only Block Caller ID or Anonymous Call allows you when making an outgoing call to prevent your name and number information from appearing on the called phone This is a feature to can be enabled fo...

Page 73: ...ock from the phone attached to the OBi dial 77 To cancel Anonymous Call Block from the phone attached to the OBi dial 87 Feature Key with the function Block Anonymous Call This feature has both Phone...

Page 74: ...rward on Busy dial 61 A confirmation tone will be heard Call forward on No Answer When you use Call Forward on No Answer all calls are forwarded to the number you indicate only when you do not answer...

Page 75: ...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 fr...

Page 76: ...ironments so usually all that is required is for the feature to be enabled and a feature key mapped to each phone for the service Push to talk can also be enabled for Page Groups this can be configure...

Page 77: ...s of other users from their phone BLF is a feature of the monitoring phone The monitored extension usually does not do anything special to be monitored The detection and notification of events occurri...

Page 78: ...t the call to apply the desired operation on the call using the available soft keys Note that the level of details for each call event may not be the same for all soft switches Some implementations ma...

Page 79: ...is enabled in the phone configuration This operation requires the specification of a barge in feature code that can be configured under the ITSP Profile of the SP service that is bound to the BLF key...

Page 80: ...ure Configuration X A F X_BLFSubscribeExpires BLF implementation relies on the SIP subscription to the dialog event package of the monitored resource This value specifies in seconds the expires value...

Page 81: ...e any combination of line keys side car keys and programmable keys SIP for BLF For each BLF extension that does not belong to any group the OBi1000 subscribes to the dialog event package for each exte...

Page 82: ...such as 001 1234 88912 etc While a user is talking to someone on the phone they can choose to park the call at an unoccupied slot and later they or someone else can pick up the call from the same slo...

Page 83: ...call with a single key press The Call Park Monitor feature key is described in the next section Note that the Park soft key will not be seen unless the parameter SPn Service Network Provided Services...

Page 84: ...hared Line and Shared Call Appearances SCA SIP SP only A Shared Line is a service account or extension that is installed on a group of phones such that if a sharing phone is using that extension other...

Page 85: ...at SCA Barge In to monitor the conversation only or to fully participate in the conversation Steady red Held A sharing phone is on a call with that SCA and has placed the call on hold Resume and take...

Page 86: ...ion is required If the SP service is a SIP service the following additional parameters are required Parameter Group Parameter Description SPn Service SIP Credentials X_XmppDomain The XMPP server domai...

Page 87: ...he user has the option to set their own presence and status as seen by other users of the same XMPP service The user sets their own presence by pressing the MyPresence soft key the default value is on...

Page 88: ...is just a matter of convenience so that you can have all your contacts consolidated in one list with or without presence information A Buddy List may be divided into groups such as Friends Co workers...

Page 89: ...ding has been turned off Rec Start on Recording has been turned on Rec Stop Rec Pause paused Recording has been turned on but paused at the moment Rec Resume na Feature is not enabled The soft key opt...

Page 90: ...le when the call is in the Connected State After pressing the key the agent has a chance to enter a specific supervisor s extension or skip that to use the default supervisor s extension To use this f...

Page 91: ...ency numbers by adding the prefix EM to those numbers using the Phone Settings DigitMap and a corresponding rule in Phone Settings OutboundCallRoute to route those calls to a specific voice service to...

Page 92: ...is feature if enabled will let the soft switch forward all calls to the configured forwarding number unconditionally The functionality provided by this feature is similar to that of the CallForwardUnc...

Page 93: ...rom the GUI the setting is submitted to the server with a subscribe request and stored on the server ACD Agent State ACD stands for Automated Call Distribution and is the primary way a call center dis...

Page 94: ...list of Executives currently associated with the assistant turn on off the call filtering feature for any of the executives Enable Disable the Divert option and set modify the Phone Number to divert...

Page 95: ...t enable the option SPn Service Network Provided Services Directory The user can invoke the Network Directory service of a specific SP service from the phone by launching the Net Dir app from the Main...

Page 96: ...lowing settings of this feature from the phone GUI Enable Disable this feature Change the Remote Phone Number note there is a limitation at present where the number cannot be removed via XSI To make t...

Page 97: ...d set this feature on the server the setting is stored on the server Call Forward No Answer To make this function available on the phone you must enable the option SPn Service Network Provided Service...

Page 98: ...s app the following methods of access are available Feature Key Define a feature key with the function Do Not Disturb Set the Service parameter of the key to the SP service that provides this feature...

Page 99: ...ne Key Tabs By default the line keys area to the right of the screen are overloaded with 4 tabs of VLKs such that only one tab is visible at anytime This feature can be disabled by disabling the optio...

Page 100: ...ow when the given soft key is hidden A soft key is hidden when its hidden condition is matched The hidden condition for each soft key is defined internally For example missed lines specifies that the...

Page 101: ...eference Do Not Disturb Do Not Disturb Do Not Disturb any dnr User Preference Do Not Ring Do Not Ring Do Not Ring any lcr Last Call Return Call Return any ldap LDAP directory search LDAP any ldn Last...

Page 102: ...ld Hold the selected call privately when the call appearance is a SCA Private Hold CallConnected resume Resume the selected call This key is mutually exclusive with the Hold key Resume CallHolding con...

Page 103: ...parked Pickup CallParked Soft Key Set Parameters Parameter Group Parameter Description IP Phone Soft Keys Soft Key Sets Home The soft key set shown on the Home Screen The default is redial cfa dnd mi...

Page 104: ...this window is divided into three non overlapping regions Text Line 1 Text Line 2 and Icon The information shown in the window depends on the function assigned to the corresponding line key which is a...

Page 105: ...igured for the feature key number The Number field as configured for the feature key service The default name of the service specified in the Service field for the feature key SP1 SP6 OBiTALK OBiBluet...

Page 106: ...X500 500 ms red followed by 500 ms off G50 X50 G50 X1000 50 ms green 50 ms off 50 ms green 1s off LED Settings Parameters Parameter Group Parameter Description Call State For a bounded or unbounded C...

Page 107: ...ion Line Monitor The LED pattern reflects the state of the bounding voice service IP Phone LED Settings Service State Idle IP Phone LED Settings Service State InUse IP Phone LED Settings Service State...

Page 108: ...the function Call Forward This is the LED pattern when the feature is enabled IP Phone LED Settings Feature Key State CallForwardDisabled For feature key assigned the function Call Forward This is the...

Page 109: ...LED pattern when the service providing this feature is down IP Phone LED Settings Feature Key State NewMessagesWaitingYes For feature key assigned the function Message Status This is the LED pattern...

Page 110: ...rencesMenu1 For example language Language timeFormat Time Format dateFormat Date Format IP Phone Phone Settings GUI Menus PreferencesMenu2 IP Phone Phone Settings GUI Menus PreferencesMenu3 IP Phone P...

Page 111: ...le Block Caller ID a k a Anonymous Call Feature aans Enable Disable Auto Answering incoming page pg1 Join Page Group 1 pg2 Join Page Group 2 ringerVol Ringer Volume speakerVol Speakerphone Audio Volum...

Page 112: ...e used for various items shown on the phone screen dict Text Fonts The true type font files for rendering text to display on the screen fonts Ring Tones Ring tone wave files It must be in 16 bit monon...

Page 113: ...just a string and should match one of the font names not file names listed in font map Below is the default contents of font map which lists all the factory installed fonts that come with the phone fo...

Page 114: ...banksia bold droidsans droidsans bold libre caslon libre caslon italic libre caslon bold opensans opensans italic opensans bold opensans bold italic quattrocento quattrocento bold terminal dosis termi...

Page 115: ...of the root element dictionary and is also the name shown to the user in the Perference for language selection Each dictionary item has a key value pair a mode attribute and a namespace When applying...

Page 116: ...mode i item key Do Not Disturb value No Molestar mode i item key Do Not Ring value No Suena mode i item key Call Forward value Desv o de Llamadas mode i item key Call Waiting value Llamada en Espera...

Page 117: ...nown value Desconocido mode i item key offline value Fuera de Linea mode i item key online value En Linea mode i item key away value Fuera de Oficina mode i item key xa value Fuera de Oficina Extendid...

Page 118: ...ice value Dispositivo mode i item key File System Type value Tipo de Sistema de Archivo mode i item key Capacity value Capacidad mode i item key Internal value Interno mode i item key USB storage 1 va...

Page 119: ...evo mode i item key Clear value Limpiar mode i item key Sort value Ordenar mode i item key New Entry value Nueva Entrada mode i item key Group Filter value Filtrar Grupo mode i item key Import value I...

Page 120: ...brando mode i ns cs item key OBiTALK value OBiTALK mode i item key Auto value mode i item key Auto value mode i item key OBiTALK value OBiTALK mode i item key Not Available value No Disponible mode i...

Page 121: ...producto Bluetooth conectado mode i item key No connected Bluetooth devices value No hay ning n dispositivo Bluetooth conectado mode i item key Contact Access Denied value Acceso a contacto neg mode i...

Page 122: ...ara continuar mode i item key Removing value Removiendo mode i item key Removing folder value Carpeta borrado mode i item key Removing file value Archivo borrado mode i item key Copying value Copiando...

Page 123: ...data tar zcvf obiphone data tar gz Note that the tar command must be issued inside of the working directory obiphone data as OBi Phone will NOT strip the first level in the tar file In addition you ca...

Page 124: ...abcd com phone cfg datapkg tar The full syntax is a script similar to what can be specified in the FirmwareURL parameter for firmware update Refer to the OBi Device Provisioning Guide for a descripti...

Page 125: ...ers on the right When there is a conflict the user version has the highest priority then the ITSP version then the OBi version On each bootup the folders are scanned to create a list of available lang...

Page 126: ...on for users to select to assign to a contact The data filenames must on of the following extensions png jpg jpeg gif or bmp obi people scratch itsp people scratch phone people User Preferences Defaul...

Page 127: ...method supported by the phone for pulling is HTTP HTTPS GET The method supported by the phone for pushing is SIP Notify with the Event obixml and Content Type application obixml Action URLs Pull Model...

Page 128: ...Copyright 2010 2015 Obihai Technology Inc 128 XML App Development Please refer to the document OBiPhone XML Application Development Guide for details on OBiPhone XML syntaxes and and app samples...

Page 129: ...f the caller hangs up before the AA answers the AA calls the number represented by 1 which is a macro that is expanded into the caller number after processing by the digit map on the left side of the...

Page 130: ...ist of prompt elements known as a Prompt List A prompt element can be a user prompt with optional parameters or a control element A user prompt is referred as User N where N 1 10 In a prompt list this...

Page 131: ...to enter a callback number A couple of times after MenuTitle PleaseWait Please wait while your call is being connected Once after user enters a phone number to call EnterNumber Enter number followed...

Page 132: ...e 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...

Page 133: ...e to the server The BindDN value is usually derived from a username that typically looks like an email address such as admin ldap example com In which case the corresponding BindDN would be CN admin O...

Page 134: ...enldap org Client Authentication LDAP v2 supports ldap and ldaps with Simple Authentication only LDAP v3 adds support for TLS and SASL Authentication Simple authentication involves sending the LDAP se...

Page 135: ...he ldap soft key to any of the configurable soft key sets For example configure the following value for the Home soft key set with the LDAP soft key in the 4 th position redial cfwd dnd ldap Search Fi...

Page 137: ...xplicitly selected line and no line selection prefix i e line access code has been dialed For example when going off hook to get Dialtone the phone will try to allocate a call key that is bound to the...

Page 138: ...ditional parameter the Call Forward option under User Preferences should control note that this is the same setting the Call Forward soft key in the Home Screen controls There is the Phone version and...

Page 140: ...ong all the enabled codecs in the profile Each of the SP and OBiTALK services can be assigned a codec profile in its corresponding configuration The codec list to use when setting up a call on the und...

Page 141: ...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 frequen...

Page 142: ...e 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 tim...

Page 143: ...m 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...

Page 144: ...y Inc 144 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 repeatin...

Page 145: ...ds Field 2 to Field 5 Composition Field 2 3 4 5 share the same definition and each field describes one single cadence segment Together the four 4 fields form a macro segment which will be repeated unt...

Page 146: ...ove 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...

Page 147: ...abbreviated name of a trunk SP1 SP6 BT or PP If TK is not specified for a trunk specific variable it implies all the applicable trunks in the system Note that SPn is the SPn Service where n 1 6 BT the...

Page 148: ...pplied when making the call but not the DigitMap rpdi token repeat dial the number represented by token coll VAR collect a number from the user and store it as the value of the parameter s represented...

Page 149: ...its 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 fro...

Page 150: ...all Waiting 78 Do Not Disturb Turn On 79 Do Not Disturb Disable 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 i e request call...

Page 151: ...y also include explicit trunk information with the general format TK number where TK SPn n 1 6 BT or PP For example PP ob200112233 SP2 14089991123 BT2 4280913 etc If trunk information is not specified...

Page 152: ...e OBiBluetooth Service with built in Bluetooth or via an OBiBT dongle connected to USB Port 2 The instance identifier may be omitted if it is equal to 1 hence BT is equivalent BT1 PP is equivalent to...

Page 153: ...call routing rule syntaxes for inbound calls and outbound calls are slightly different and we shall explain them separately below Call Routing Rule configuration relies heavily on digit maps If you ar...

Page 154: ...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 num...

Page 155: ...4081223330 15103313456 ph aa 1800xx 1888xx ph It says Ring the phone and AA for calls coming from 1 408 122 3330 or 1 510 331 3456 block all 800 888 and anonymous calls and ring just the phone for all...

Page 156: ...t 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 Th...

Page 157: ...igitMap 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 Service s DigitMap Remove the 2 pr...

Page 158: ...The digit map rule serves to match numbers based on the characteristics of the form and content the entered number or alphanumeric string for example when entering a SIP URI on the OBi IP Phone A rule...

Page 159: ...land country code 64 but don t want to define all the possibilities of the NZ number plan within our digit map in this case we can write one of the following rules 011 64 xx Using US international dia...

Page 160: ...and elements are separated from literals using a colon Usage Notes Single quote syntax is NOT needed or allowed for the literals in this context special characters may be used here as they do not appl...

Page 161: ...ompact 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 map Em...

Page 162: ...ic character except Example To match any arbitrarily long alphanumeric sequence except that does not start with we would write our matching rule as follows Matching Function The question mark matching...

Page 163: ...ts within 4 seconds S4 1234 Match any number with at least 8 digits that ends with 8537683 such as 1 510 853 7683 9 853 7683 xx 853 7683 Match any number with at least 10 digits that ends in 408 890 6...

Page 164: ...es 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...

Page 165: ...n 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 consumed by the DMP instead of triggering a timeout Consider the d...

Page 166: ...User Defined Digit Map 1 to 10 Each user defined digit map is specified with 2 parameters Label An arbitrary string for referencing this digit map in other digit map specification The value should be...

Page 167: ...nclude detail SIP messages on an SP service in the syslog use the parameter SPn Service X_SipDebugOption with one of the options Disable Log All Messages or Log All Except REGISTER Messages SPn Servic...

Page 168: ...e first level of the tarball tar zcvf itsp20141001 tar gz Example Linux command to generate the MD5 checksum md5sum itsp20141001 tar gz Auto Update Operation Similar to Auto Firmware Update feature Cu...

Page 169: ...ackage MD5Checksum Standard MD5 checksum hexadecimal string of the Customization Data Package Incremental When enable the customization Data package will be installed incrementally e g without erasing...

Page 170: ...ice 192 168 15 165 SubnetMask 255 255 255 0 DefaultGateway 192 168 15 1 DNSServer1 4 2 2 2 DNSServer2 MACAddress MAC address installed on the device 9CADEF90004E WiFi Status DeviceInfo Network Status...

Page 171: ...t after Firmware Update via provisioning or phone 6 3 Reboot after New Profile Invoked 4 Reboot after Parameter Value Change or Firmware has changed and invoked via device web page 5 Reboot after Fact...

Page 172: ...l Jitter Average measured network jitter in the received direction in milliseconds Max Interarrival Jitter Maximum measured network jitter in the received direction in milliseconds Jitter Buffer Under...

Page 173: ...o use in addition to the ones received from DHCP DNSServer2 An additional DNS Server to use in addition to the ones received from DHCP Access Point n DeviceInfo WiFi AP n n 1 2 20 SSID SSID of the acc...

Page 174: ...essingType is set to Static DefaultGateway The default gateway IP address to assign to the device when AddressingType is set to Static DNSServer1 IP address of the first DNS server to use in addition...

Page 175: ...LLDP MED Enable LLDP MED discovery false LLDP MEDExclusivePeriod Number of seconds for LLDP MED discovering Network Policy exclusively before the IP is established according to AddressType 0 LLDP MED...

Page 176: ...ingTimeDiff Amount of time to add to current time during Daylight Saving Time Format hh mm ss ss may be omitted if it is 0 mm ss may be omitted if both are 0 1 DHCP Client Settings X_DHCPC Hostname De...

Page 177: ...om abc obihai com 192 168 15 118 192 168 15 108 Note If the A record of a given hostname cannot be found in any of the Local DNS Records the device will attempt to resolve it using external DNS querie...

Page 178: ...tional Username for authentication if URL scheme is http Password Optional Password for authentication if URL scheme is http ITSP Provisioning X_DeviceManagement ITSPProvisioning and OBiTALK Provision...

Page 179: ...Defined Macro n X_DeviceManagement X_UserDefinedMacro n n 0 1 2 3 UDM0 UDM3 Value Any plain text or reference to another parameter s full TR 104 name prepended by a ExpandIn A comma separated list of...

Page 180: ...ovisioning OBi ZT or Zero Touch provisioning is a system level approach to deploying and maintaining thousands or millions of OBi devices with high security and control at the device level down to the...

Page 181: ...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...

Page 182: ...ately from the Call History web page Reset Configuration to Factory Default The OBi device may be reset to factory default condition Call history and various statistical information will be removed at...

Page 183: ...nable device to send a STUN binding request for its RTP port prior to every call false STUNServer IP address of domain name of the STUN Server to use X_STUNServerPort UDP listen port of the STUN Serve...

Page 184: ...ion port to be used in connecting to the outbound proxy 5060 X_OutboundProxyTransport A different SIP transport may be used by the OutboundProxy The available choices are UDP TCP TLS Follow ProxyServe...

Page 185: ...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 thi...

Page 186: ...the call true X_MWISubscribe 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...

Page 187: ...provided separated by a comma the first one applies to REGISTER and the second to INVITE 5 9 xx X_ProxyRequire If this parameter is not blank OBi will include a Proxy Require header stating the value...

Page 188: ...included in an x md5 hash SDP attribute false X_EchoServer A server that can echo back SIP messages to the device X_EchoServerPort The echo server listening port 5060 X_EnableRFC2543CallHold Enable th...

Page 189: ...uses account userid local ip address as the local CNAME X_RTCPMux Enable RTCP Mux operation send and receive RTCP on the same local port as the corresponding RTP false Jitter Buffer VoiceService 1 Vo...

Page 190: ...e is the ASCII string keep alive r n false X_KeepAliveExpires Keep alive period in seconds 15 X_KeepAliveServer Hostname or IP address of keep alive server X_KeepAliveServerPort UDP port of the keep a...

Page 191: ...e selected Ring Profile Valid choices are NO Ring or 1 10 8 X_RepeatDialRing The ring pattern number to use to ring the PHONE port when a repeat dial operation on this trunk is successful as the calle...

Page 192: ...UAS with a 401 or 407 Response URI 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 t...

Page 193: ...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 false CallForwardUnconditionalNumber Directory number to forward all incom...

Page 194: ...bit mask such that bit 0 for Phone 1 bit 1 for phone 2 etc 255 MessageWaiting This is a state rather than a configuration parameter that indicates if there are any new messages for this subscriber on...

Page 195: ...y true X_SRTP 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 t...

Page 196: ...scriber for the purpose of displaying a Caller ID Name on the recipient s device DigitMap Digit map to restrict numbers that can be dialed or called with this service See OBi Call Routing and Digit Ma...

Page 197: ...itionalEnable 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...

Page 198: ...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 false AnonymousCallEnable Enable masking of Caller ID information for all...

Page 199: ...ameters are available on this web page Parameter Description Default Setting User Prompts VoiceService 1 X_UserPrompt User N Description N 1 10 A text string that describes the contents of this user p...

Page 200: ...g1 Trunk Group 2 code tg2 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 SP1 Service An...

Page 201: ...rameter to play it from the web browser Gateways and Trunk Groups Web Page Parameter Description Default Setting Voice Gateway n VoiceService 1 X_VoiceGateway n n 1 8 Enable Enable this voice gateway...

Page 202: ...OnHoldRing The ring pattern to use to ring a phone port to remind holding call on this service 8 DirectoryNumber Informational only The PSTN number associated with this service Calling Features VoiceS...

Page 203: ...Msp1 sp1 2 Msp2 sp2 3 Msp3 sp3 4 Msp4 sp4 8 Mbt bt 9 Mpp pp Mpli pli CallReturnDigitMaps Call Return is the service where the user can call the last caller by dialing a star code 69 by default OBi de...

Page 204: ...re new voicemails for the subscriber on the service provider s voicemail system true VMWIEnable Enable VMWI Signal generation If enabled any SP voice service enabled on the device that has VMWI Servic...

Page 205: ...ting a conference call false CallWaitingEnable 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 connec...

Page 206: ...l and bridge to get some audio played when the phone user holds the call PlaySITOnCallFailureCodes Specify which INVITE failure response codes will trigger the OBi to play SIT tone to alert the phone...

Page 207: ...alk Line Keys Parameter Description Default Setting Line Key n VoiceService 1 Phone LineKey n n 1 24 12 for OBi1032 Function Service Number Name Group Programmable Keys Parameter Description Default S...

Page 208: ...tate VoiceService 1 Phone LED Service Idle G InUse G500 X500 Ringing R50 X50 Holding R500 X500 ServiceDown O1000 G1000 SCA VoiceService 1 Phone LED SCA Seized R150 X150 Trying R PeerRinging R Connecte...

Page 209: ...dEnabled R CallForwardDisabled X CallForwardServiceDown O CallParkedYes R CallParkedNo X CallParkMonitorSErviceDown O CallWaitingEnabled X CallWaitingDisabled R DoNotDisturbEnabled R DoNotDisturbDisab...

Page 210: ...e backspac e CallConnecting end newcall CallConnected end hold conf transfer privhol d park dispcode escalate trace rec start rec stop rec pause rec resume tomobile CallHolding end resume add2conf con...

Page 211: ...3 n 1 2 for X A B respectively Codec Codec Name G729 BitRate Bit rate in bits sec Note Informational only not configurable 8000 Enable Enable this codec true SilenceSuppression Enable silence suppres...

Page 212: ...amic Payload type for this codec Valid range is 96 127 105 iLBC Codec VoiceService 1 VoiceProfile 1 Line n Codec List 8 n 1 2 for X A B respectively Codec Codec Name G726 40 BitRate Bit rate in bits s...

Page 213: ...scription 2 n 1 2 for X A B respectively ToneName Ringback Tone TonePattern Obihai Tone Pattern Script 440 18 480 18 1 2 4 Busy Tone VoiceService 1 VoiceProfile n Tone Description 3 n 1 2 for X A B re...

Page 214: ...1 VoiceService 1 VoiceProfile n Tone Description 13 n 1 2 for X A B respectively ToneName Special Information Tone 1 TonePattern Obihai Tone Pattern Script 985 16 1428 16 1777 16 20 1 380 0 2 380 0 4...

Page 215: ...rvice 1 VoiceProfile n Tone Description 21 n 1 2 for X A B respectively ToneName Distinctive Call Waiting Tone 6 User dr1 TonePattern Obihai Tone Pattern Script 440 18 30 1 1 3 2 3 10 Call Waiting Ton...

Page 216: ...ern 60 25 9 75 Ring Pattern 11 VoiceService 1 VoiceProfile 1 Line n Ringer Description 11 n 1 2 for X A B respectively RingName User dr5 RingPattern 60 25 9 75 Star Code Profiles Star Code Profile X W...

Page 217: ...back RTP Packet set Lbp1 1 Code25 Default Force G711u Codec Star Code 4711 Use G711 Only set Cdm1 3 Code26 Default Force G729 Codec Star Code 4729 Use G729 Only set Cdm1 4 Code27 Default Clear Speed D...

Page 218: ...ptions in a popup window when user presses the More softkey whern there are more than 4 options Otherwise show softkey options in a circular list when user presses the More softkey true PackCallsOnDis...

Page 219: ...Dialer Enable enhanced dialer where a list of recently dialed number that partially match the currently entered digits is displayed below the dialer input box user can highlight an entry in the list t...

Page 220: ...e For an explanation of this feature please refer to the section User Defined Digit Maps under Digit Map Configuration Parameter Description Default Setting User Defined Digit Map 1 Label A 2 16 chara...

Search results

Summary of Contents for OBi1062

Reviews:

Related manuals for OBi1062

Brands by name

Popular brands

Obihai OBi1062, Administration Manual

Search results

Summary of Contents for OBi1062

Reviews:

Related manuals for OBi1062

Brands by name

Popular brands