Polycom HDA50, Administrator'S Manual

Page 1: ...1 0 0 July 2019 3725 86015 001A ADMINISTRATOR GUIDE Polycom HDA50 ...

Page 2: ... In no event shall Polycom and or its respective suppliers be liable for any direct consequential incidental special punitive or other damages whatsoever including without limitation damages for loss of business profits business interruption or loss of business information even if Polycom has been advised of the possibility of such damages End User License Agreement BY USING THIS PRODUCT YOU ARE A...

Page 3: ...ter Values 6 Getting Started 8 Product Overview 8 Port Setup and Configuration 8 Configuration and Management Interfaces 9 Web Server Based Local Configuration 9 Local Device Update and Management 10 Firmware Update 10 Customized AA Prompts Backup and Restore 10 Backup Configuration 11 Restore Configuration 11 Reset Configuration Locally 12 Reset Configuration Remotely 12 Device Interface 13 Heads...

Page 4: ...ngs 21 Codec Profile Features 21 Tone and Ring Patterns 21 Tone Profile Features 21 Field 1 Composition 21 Field 2 Composition 22 Field 3 to Field 6 Composition 22 Tone Examples 23 Ring Profile A B 24 Ring Profile Features 25 Field 1 Composition 25 Field 2 to Field 5 Composition 25 Call Routing 27 Inbound Call Route Configuration 27 Outbound Call Route Configuration 29 Trunks Endpoints and Termina...

Page 5: ...Proxy for a SIP IP Phone 39 Automated Attendant 40 Customizing AA Prompt Lists 40 Trunk Groups 41 Parameter Reference Guide 42 Troubleshooting 106 Phone Port Setup and Configuration 106 Possible Error Messages on Firmware Update Failure 107 ...

Page 6: ...ry information Polycom HDA50 Deployment Guide Includes information about configuration device settings initial configuration setup and a provisioning parameter reference guide Getting Help For more information about installing configuring and administering Polycom products see Documents Software at Polycom Support Polycom and Partner Resources In addition to this guide the following documents and ...

Page 7: ...heir appearances are different The canonical fashion simplifies locating parameters on the device s native web portal or on OBiTALK at https www1 obitalk com The literal fashion is required when provisioning or writing OBIPhoneXML apps Canonical Fashion This example shows the format of the canonical fashion Parameter Group Name ParameterName Parameter Value replace with actual value The Parameter ...

Page 8: ...uired and will be removed when your script or app is processed Boolean Values You can identify parameters that take a Boolean value on your device s configuration web pages by a check box next to the parameter name Throughout the document we may loosely refer to a Boolean value as enable disable or yes no but the only valid Boolean parameter values to use in a device configuration file is either t...

Page 9: ...e You Begin Polycom Inc 7 If a parameter value can include white spaces such as X_DisplayLabel use just a single space and no extra space before and after the value For example X_DisplayLabel My New Service ...

Page 10: ... of SIP services Automatic Attendant AA for simplified call routing High quality voice encoding using G 711 G 7 22 G 726 G 729 Opus and iLBC algorithms Recursive digit maps and associated call routing outbound and inbound Port Setup and Configuration Make the following connections to use your device For details see the HDA50 Setup Sheet Power Connection Connect the supplied 12 volt power adapter t...

Page 11: ...ns and status information organized into a number of web pages If the device is already bootstrapped into your assigned PDMS SP account follow the procedure below to find the device s IP address Procedure 1 Log in to PDMS SP 2 Go to the Manage Device page and select the device by OBi number MAC Address or Serial Number 3 Go to the Configuration tab and select Local Configuration 4 You can find the...

Page 12: ... browser window select the firmware file 3 Click the Update button to start the upgrade process The process takes about 30 seconds to complete To perform a multiple device upgrade refer to the PDMS SP procedure at https documents polycom com bundle pdms sp ag current page t2733076 html For step 3 use the HDA50 firmware link http fw obihai com HDA50 x x x xxxx fw Customized AA Prompts Backup and Re...

Page 13: ...a previous backup copy you need to specify the backup file you want to restore to All the existing prompts in the device are removed first when applying the backup file This process cannot be undone Different web browsers 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 operatio...

Page 14: ...ware reset button located via an opening on the underside of the device resets all settings You can change reset behavior via configuration Reset Configuration Remotely You can reset the device configuration to its factory default condition remotely Procedure 1 Enter the following parameter into an XML configuration file ParameterList X_Reset All 2 In the PDMS SP interface use base profiles to pus...

Page 15: ...ages The device Phone port supports input signaling and control messages comprising On Hook Off Hook Hook Flash DTMF tones The device Phone port supports output signaling and control messages comprising Caller ID CWCID MWI DTMF Tone Ring Polarity Reversal CPC Power Denial The device Phone port has a Maximum Sessions capacity of two This isn t configurable The device Phone port replies BUSY to a ne...

Page 16: ... system to allow the device to automatically answer incoming calls but not accept calls waiting Procedure Connect the device Phone port to an external PA system using an RJ11 to line out connector and enable the UseForPagingOnly parameter Available Features The HDA50 supports many IP routing and LAN features IP Routing and LAN Switching Features The HDA50 has two Ethernet ports labeled as the Inte...

Page 17: ... forward the packet to the corresponding LAN IP address The router updates the NAT binding table If the receiving port and protocol match a reserved pair to support an internal process queue the packet for local processing If the receiving port and protocol match 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...

Page 18: ...nteed 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 See the QoS Parameter Guide 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 p...

Page 19: ...mode using the parameter WAN Settings Internet Settings 802_1XMode Depending on the selected mode you have to configure the additional authentication parameters listed in the following table 802_1X Authentication Parameter Description EAP MD5 EAP TLS1 0 TTLS MSCHAPv2 802_1XIdentity A user name If the value isn t needed set the value as an empty string Required Required Required 802_1XPassword A pa...

Page 20: ...me with the last reboot reason code in parentheses The following table defines the reboot reason codes Reboot Reason Codes Reason Code Description 0 Reboot on power cycle 1 Operating system reboot 2 Reboot after Firmware Update Via provisioning or phone 6 3 Reboot after new profile invoked 4 Reboot after parameter value change or firmware has changed and invoked via device web page 5 Reboot after ...

Page 21: ...ng normally Backing Off The service is currently down and the device is taking a short pause before retrying the connection CallState can be one of the following values N Active Calls where N 0 1 as many as the maximum number of calls allowed in the configuration LAN Status This page is available when the HDA50 is in router mode and shows the status of devices currently on the LAN There are two se...

Page 22: ...ll Record This button is available for calls involving the Phone port only Pressing this button allows you to record the current conversation in an audio au file Call History The Call History page shows the last 400 calls made with the device Detailed call information is available including terminals involved the name if available of the Peer endpoints making the call and the direction path the ca...

Page 23: ...odecs in the chosen profile and ordered according to the assigned priorities in the profile For more information on codec profile parameters see the Codec Profile Parameter Guide table in the Parameter Reference Guide section Tone and Ring Patterns Your device enables you to create customized tone patterns and ringtones Tone Profile Features The general format for tone profiles is field 1 field 2 ...

Page 24: ...yback duration No value tone plays indefinitely Example 30 234 This example means Tone playback terminates after 30 234 seconds Field 3 to Field 6 Composition Field 3 4 5 6 share the same definition and each field describes one single cadence segment Together the four fields form a macro segment which is repeated until tone playback expires The expression is a string of numeric values with the spe...

Page 25: ...3 decimated digits Example 4 1 3 2 34 3 2 1 5 This example means Use the first frequency to generate a tone for 0 3 seconds Follow this tone with 2 34 seconds of silence Use a combination of the first and second frequencies to generate a tone for 2 seconds Follow this tone with 1 5 seconds of silence The cadence operates repeatedly for 4 seconds Tone Examples These examples show the interpretation...

Page 26: ...inactive time The third on off section generated by the third frequency component and it has 0 38 tone second active time and 0 inactive time The fourth 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 20 2 1 1 Stutter dial tone is generated from a mixture of two frequency ...

Page 27: ...eld 5 Composition Fields 2 3 4 5 share the same definition and each field describes one single cadence segment Together the four fields form a macro segment which is repeated until ringing expires The expression is a string of numeric values with the special notation and It has the format as per the following construct t on_0 off_0 on_1 off_1 on_2 off_2 on_3 off_3 t The cadence segment duration in...

Page 28: ...ctive for 0 3 seconds followed by 2 34 seconds of silence then ringing for 2 seconds and followed by 1 5 seconds of silence This cadence operates repeatedly for 4 seconds For more information on call waiting parameters see the Call Waiting Parameter Guide table in the Parameter Reference Guide section For more information on ring profile parameters see the Ring Profile Parameter Guide table in the...

Page 29: ...figuration It is a comma separated list of rules where each rule is also surrounded by a pair of curly braces No extra white spaces are allowed These rules tell the device how to handle an inbound call such as sending it to the Phone port and ringing the attached phone s sending it to the Auto Attendant for further routing interactively with the caller or making another call on a specific trunk to...

Page 30: ...d 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 InboundCallRou...

Page 31: ...so checked in the order left to right and the first matched rule wins 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 Outbound Call Route Configuration Every endpoint has an OutboundCallRoute parameter in the device configuration It tells the device where to send the call when the endpoint ...

Page 32: ...necessary digit map transformation implied by the rule The preceding can t 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 wins Rules ar...

Page 33: ...trunks The device also comes with an Auto Attendant AA for helping callers to direct their calls landed on the device When an inbound call is received on the device it can be routed to the AA which then offers a menu of options to the caller to direct it further It could be directed to ring an available Phone port or bridged with another call on a trunk which the AA dials or sets up on behalf of t...

Page 34: ...Call Routing Polycom Inc 32 Supported Endpoint Calls on the Device Any Trunk Phone Port AA Any Trunk n a yes Yes Phone Port PHONE1 Port yes no Yes AA yes yes No ...

Page 35: ... web page and documentation and the OBiTALK portal the term ITSP describes the entity providing the SIP Trunk service to the device When the device is used in conjunction with an IP PBX the IP PBX takes the place of the ITSP if it is the entity providing the SIP Trunk account credential and connectivity to the device Each ITSP configuration is grouped together as an ITSP Profile referred to as ITS...

Page 36: ...an be set in the OutboundProxyTransport parameters If OutboundProxyTransport is TCP or TLS your device initiates a TCP or TLS connection only with the OutboundProxy All subsequent messages exchanged between your device and the servers MUST use the same connection If for any reason the connection is closed your device attempts to re establish the connection with the OutboundProxy following an expon...

Page 37: ... address in all outbound SIP requests instead of its local contact address if one is discovered by either method discovered above SIP Proxy Server Redundancy and Dual REGISTRATION Server Redundancy specifically refers to the device s capability to a look for a working server to REGISTER with from among a list of candidates and b switch to another server once the server that it currently registers ...

Page 38: ...ly becomes the primary server when the current primary server fails The device then starts searching for a new secondary server if the candidate set is not empty The candidate list can change be lengthened shortened priority changed etc on every DNS renewal based on the entry s TTL The device rearranges the primary and secondary servers and fallback lists accordingly If the server redundancy featu...

Page 39: ...ddress and port from the binding response and uses 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 goes on without using external address in the SDP Standard RTP requires the use of an even numbered port in the m line If the external port is not an even number the device changes the local RTP...

Page 40: ...Ring tone names are not case sensitive If a match is found the device plays the corresponding ring or call waiting tone Otherwise the device plays the default ring RTP Statistics the X RTP Stat Header When ending an established call the device can include a summary of the RTP statistics collected during the call in the SIP BYE request or the 200 response to the SIP BYE request sent by the peer dev...

Page 41: ...ameter Guide table in the Parameter Reference Guide section For more information on ITSP SIP settings parameters see the ITSP SIP Settings Parameter Guide table in the Parameter Reference Guide section For more information on ITSP RTP settings parameters see the ITSP RTP Settings Parameter Guide table in the Parameter Reference Guide section Using SPn as a Proxy for a SIP IP Phone An SP service ca...

Page 42: ...rompt list this can be followed by a r start end parameter that specifies the range to play for that prompt where start starting time mark in milliseconds 0 is the default if start is omitted end ending time mark in milliseconds the end of the prompt is the default if end is omitted If the r parameter is omitted the full range of the prompt is played Examples User1 r 1000 means play the User1 prom...

Page 43: ...git maps and call routing rules so that calls can 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 A TG can include another TG that is TG can be recursive However you must make sure this does not result in infinite recursion For more information on trunk group parameters see the Trunk Group Parameter Guide...

Page 44: ... 255 255 255 0 DefaultGateway Gateway to use when using static IP addressing 192 168 15 1 DNSServer1 URL for domain name server 1 when using static IP addressing 8 4 4 4 DNSServer2 URL for domain name server 2 when using static IP addressing 4 2 2 2 MACAddress MAC address installed on the phone 9CADEF90004E LLDP MEDStatus Enables LLDP media endpoint discovery for improved network connections Enabl...

Page 45: ...ference between this phone and the peer in ppm parts per million Packets in Jitter Buffer Number of packets in the Jitter Buffer Packets Out of Order Number of received RTP packets that are out of order Packets 10ms Interpolated Number of frames interpolated Packets Lost Number of incoming RTP packets assumed lost Packet Loss Rate Amount of incoming RTP packets assumed lost rate in percent Packet ...

Page 46: ...s as defined in RFC3611 MOS LQ The estimated mean opinion score for listening quality MOS SQ The estimated mean opinion score for conversational quality SP Services Settings Parameter Description Default Setting Reset Statistics n 1 6 ResetStatistics Check this option and press Submit to reset the statistics for this SP Service NA RTP Statistics n 1 6 PacketsSent Total RTP packets sent on this lin...

Page 47: ...e Parameter Description Default Setting ResetStatistics ResetStatistics Resets the statistics for this voice service N A RTP Statistics PacketsSent Total RTP packets sent on this line N A PacketsReceived Total RTP packets received on this line N A BytesSent RTP payload bytes sent for this line N A BytesReceived RTP payload bytes received for this line N A PacketsLost Number of RTP packets lost on ...

Page 48: ...dressingType is set to Static DNSServer1 IP address of the first DNS server to use in addition to the ones obtained from the DHCP server when DHCP is also enabled If AddressingType is set to Static the device only uses DNSServer1 and DNSServer2 for DNS lookup It tries as many as five DNS servers when attempting to resolve a domain name DNSServer1and DNSServer2 are tried first whichever is specifie...

Page 49: ...antic Time GMT 03 30 Newfoundland GMT 03 00 Buenos Aires Greenland GMT 02 00 Mid Atlantic GMT 01 00 GMT 00 00 London Lisbon GMT 01 00 Rome Paris Madrid GMT 02 00 Athens Cairo GMT 03 00 Moscow Baghdad GMT 04 00 Abu Dhabi GMT 04 30 Kabul GMT 05 00 Islamabad Karachi GMT 05 30 New Delhi GMT 05 45 Kathmandu GMT 06 00 GMT 07 00 Bangkok Jakarta GMT 08 00 Beijing HK Singapore GMT 09 00 Tokyo Seoul GMT 10 ...

Page 50: ... time during Daylight Saving Time Format hh mm ss ss can be omitted if it is 0 mm ss can be omitted if both are 0 1 DNS Control DNSQueryOrder When more than one DNS servers are available the unit attempts to resolve a domain name by querying each server sequentially until a successful result is received The parameter controls the order in querying the servers Choose from DNS Server1 DNS Server2 DH...

Page 51: ...mplete host name 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 If not specified the default is 1 pri is optional only if wt is not specified 1 is the default if not specified port is optional The default to use is based on the protocol...

Page 52: ...ic the device only uses DNSServer1 and DNSServer2 for DNS lookup It tries as many as five DNS servers when attempting to resolve a domain name DNSServer1and DNSServer2 are tried first whichever is specified and then the addresses obtained from the DHCP Server if available DNSServer2 IP address of the second DNS server to use in addition to the ones obtained from the DHCP server when DHCP is also e...

Page 53: ...for EAP MD5 EAP TTLS Private key and EAP TTLS MSCHAPv2 modes None 802_1XAnonymousID Anonymous ID If empty an anonymous ID is used in authentication None 802_1XTLSSecurityProfile Security profile for 802 1x authentication Choices are 1 or 2 1 Local Time CurrentLocalTime Current local date and time of the device read only Time Service Settings NTPServer1 Host name or IP address of the first NTP serv...

Page 54: ...rta GMT 08 00 Beijing HK Singapore GMT 09 00 Tokyo Seoul GMT 10 00 Sydney Guam GMT 11 00 Solomon Is GMT 12 00 Fiji Auckland GMT 08 00 Pacific Time DaylightSavingTimeEnabl e Enables daylight saving time on the unit Yes DaylightSavingTimeStart Daylight Saving Time Start Date Format month day weekday hh mm ss where month 1 12 day 1 31 weekday 0 1 7 0 special 1 Monday 7 Sunday hh 0 23 mm 0 59 ss 0 59 ...

Page 55: ...entially until a successful result is received The parameter controls the order in querying the servers Choose from DNS Server1 DNS Server2 DHCP Offered DNS Servers DHCP Offered DNS Servers DNS Server1 DNS Server2 DNS Server1 DNS Server2 DHCP Offered DNS Servers DNSQueryDelay When more than one DNS servers are available the unit attempts to resolve a domain name by querying each server sequentiall...

Page 56: ...complete host name 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 If not specified the default is 1 pri is optional only if wt is not specified 1 is the default if not specified port is optional The default to use is based on the protoc...

Page 57: ...erver Settings Enable Enables the DHCP Server on the LAN side Yes ClientAddressRangeStart Together with the CurrentRouterIPAddress and SubnetMask parameters this parameter determines the starting IP address to assign to DHCP clients The value of this parameter is the starting value of the lower bits of the 32 bit starting IP address not masked by the SubnetMask and it MUST fit within the unmasked ...

Page 58: ... known as NAT Loopback or Hairpin This setting takes effect only if the firewall is enabled Otherwise this feature is disabled No DRDOSAttackProtection Enables protection against Distributed Reflection Denial of Service This setting takes effect only if the firewall is enabled Otherwise this feature is disabled No VPNPassThrough Allows VPN L2TP PPTP and IPSEC traffic to pass through if enabled oth...

Page 59: ...e total upstream bandwidth in kbps 2048 RestrictedBandwidth The guaranteed bandwidth for Restricted class traffic in kbps 512 Priority Class Bandwidth Allocation High The guaranteed uplink bandwidth allocation weight for High Priority class traffic It must be a value between 1 and 10 5 Medium The guaranteed uplink bandwidth allocation weight for Medium Priority class traffic It must be a value bet...

Page 60: ...e URL must include scheme Supported schemes are http and tftp DnsLookupType Controls what type of DNS record to lookup Choose from A Record Only SRV Record Only Try Both A Record Only DnsSrvPrefix Controls whether to add a standard prefix to the domain name when looking up a SRV Record For HTTP and HTTPS the prefix to add is _http _tcp For TFTP the prefix to add is _tfto _udp Choose from No Prefix...

Page 61: ...PRM0 to TPRM3 Temporary variables used in scripts for ConfigURL Please refer to device provisioning guide for examples on how to these variables OBiTALK Provisioning Method Current operational method of Provisioning Choose from 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 periodi...

Page 62: ... Value The value can be any plain text or a valid canonical parameter name preceded by a sign For example X_DeviceManagement WebServer Port You must not enclose the parameter name following the sign with braces or parentheses ExpandIn This is a comma separated list of canonical parameter names where the macro expansion can be used As many as three parameter names can be specified Specify ANY to al...

Page 63: ... OBN Device OBi number such as 200123456 ANY DSN Device S N such as 88B01NA00000 ANY GPRMn n 0 7 Value Auto Provisioning GPRMn Auto Provisioning ConfigURL Auto Firmware Update FirmwareURL TPRMn n 0 3 Value of Auto Provisioning TPRMn Auto Provisioning ConfigURL Auto Firmware Update FirmwareURL UDMn n 0 3 Value of User Defined Macro n Value The value of User Defined Macro n ExpandIn Device Administr...

Page 64: ...ASIC or DIGEST to web proxy service ProxyAuthPassword The password corresponding to AuthUserName for authentication BypassProxyServerFor LocalAddress Enables device to bypass the web proxy for services residing in the same network subnet as the device BypassProxySubnetList A list of network subnets where the software bypasses the configured web proxy The device sends requests directly to the IP ad...

Page 65: ...e encryption algorithms to support in establishing a TLS connection according to the TLS profile specification configured on the phone None CACertList The CA Certificate List to use in a TLS profile Choice of Default Default P1 Default P2 All Platform1 Platform2 Platform1 2 Default DeviceCert The Device Certificate List to use in a TLS profile Choice of Polycom Custom1 Custom2 Polycom ITSP Profile...

Page 66: ... syntaxes Maximum length is 511 characters 1xxxxxxxxxx 1 2 9 xxxxxxxxx 011xx xx STUNEnable Enables device to send a STUN binding request for its RTP port prior to every call No STUNServer IP address of domain name of the STUN Server to use X_STUNServerPort UDP listen port of the STUN Server 3478 X_ICEEnable Enables device to use ICE algorithm to find the best peer RTP address to forward RTP traffi...

Page 67: ...main CPE domain string If empty device uses ProxyServer as its own domain to form its AOR Address Of Record or Public Address when constructing SIP messages for example in the FROM header of outbound SIP Requests If SPn Service URI is specified additional rules applied in forming the AOR See the description of the URI parameter for more details and examples UserAgentTransport Transport protocol fo...

Page 68: ...imer T4 in ms 5000 TimerA Value of SIP timer A in ms 500 TimerB Value of SIP timer B in ms 32000 TimerD Value of SIP timer D in ms 32000 TimerE Value of SIP timer E in ms 500 TimerF Value of SIP timer F in ms 32000 TimerG Value of SIP timer G in ms 500 TimerH Value of SIP timer H in ms 32000 TimerI Value of SIP timer I in ms 5000 TimerJ Value of SIP timer J in ms 32000 TimerK Value of SIP timer K ...

Page 69: ...led the target s Contact is used instead Yes X_Use302ToCallForward Enables using the 302 response to INVITE for call forward If disabled device bridges the call legs instead when forwarding a call and consumes some resources on the device Yes X_UserAgentName 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...

Page 70: ...GISTER If the URI contains it is used in the TO and FROM header as well as the Request URI as is The device forms the Request URI of SUBSCRIBE the same way as the TO header with an additional port number X_MWISubscribeExpires Periodic interval to renew SUBSCRIBE 3600 X_RegSubscribe Enables subscription to the reg event package No X_RegSubscribeExpires Expires value for subscription to the reg even...

Page 71: ...cation in an 18x response to the calling peer if this is a call waiting situation No X_Support100rel Enables support for RFC3262 reliable provisional SIP responses If enabled the device announces this support in a SIP Supported header and requires a caller to use this option if the caller also supports this feature No X_DiscoverPublicAddress Enables letting the device use the public IP address and...

Page 72: ...P 16600 LocalPortMax Top of port range for tx rx RTP with this SP 16798 KeepAliveInterval Interval in seconds between sending keep alive packet on an RTP channel that is currently in idle due to call hold for instance RTP keepalive is disabled if the value of this parameter is set to 0 0 DSCPMark Diffserv code for outgoing RTP packets with this SP 0 RTCP Enable Enables RTCP No TxRepeatInterval RTC...

Page 73: ...rovider according to the settings in the ITSP Profile Otherwise device does not send any SIP REGISTER for the service Yes X_NoRegNoCall Enables blocking making or receiving calls on this service unless registration with the SIP server is successful No X_KeepAliveEnable Enables sending keep alive message If set to YES device sends periodic keep alive messages to the destination specified in X_KeepA...

Page 74: ...rn 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 istaken from the selected Ring Profile Choose from 1 through 10 1 X_CallOnHoldRing 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...

Page 75: ...oxy mode operation on this SP service If enabled the SP accepts SIP Registration from one client device from the LAN side which must be using the same user id and password as this SP s AuthUserName and AuthPassword parameters for authentication The client device known as the local_client may send SIP INVITE to the device at this SP to make calls This SP s InboundCallRoute must be set up with the p...

Page 76: ... button to be configured with the attributes that follow Valid values are 1 2 as many as the maximum number of programmable function buttons on that phone model A bn attribute is followed by one or more of the fn va and la attributes The end of a bn section is marked by another bn attribute You must insert a bn 0 attribute after the last button fn Required A code that represents the function serve...

Page 77: ...or example USER Park Night It should be no longer than 7 characters due to space limitation This attribute does not apply for a sidecar button Other than Ext 1 and the generic Speed Dial function all the other button functions are only applicable if the service installed on this SP is from an OBiPLUS system This parameter is useful only if the X_Proxy parameter is enabled In that case the device p...

Page 78: ...y 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 Examples Let ProxyServer sip myitsp com AuthUserName 4089991123 URI empty UserAgentDomain empty then AOR 4089991123 sip myitsp com Change UserAgentDomain to users myitsp com then AOR 40899...

Page 79: ... Phone port or PHONE1 port No X_VMWIEnable2 Enables Visual Message Waiting Indication for this service for the PHONE2 port No MessageWaiting This state parameter indicates if there are any new messages for this subscriber on the service provider s voicemail system No X_BridgedOutboundCallMax Duration Limit on the call duration in seconds for all outbound calls that are bridged from the same or ano...

Page 80: ...ph See the Trunks Endpoints and Terminals section for a description of the syntaxes for specifying this parameter Ph RingProfile Selects a Ring Profile to ring the Phone port with when an incoming call is routed to the Phone port Choose from A or B A CodecProfile Selects a Codec Profile to be used for all calls on this service Choose from A or B A DefaultRing Default ring pattern number to ring th...

Page 81: ... calls that can be established on this service 2 OBiTALK Inbound Direct Dialing Authentication Parameter Guide Parameter Description Default Setting AuthMethod The OBiTALK protocol allows incoming calls to indicate a target number that is different from this device s OBi number The device in that case attempts to establish and bridge the call to the target number according to the rules configured ...

Page 82: ...his call Ring the device 2 Press 2 to make a new call If UsePIN authentication is enabled and the user enters a matching PIN the device attendant immediately prompts the user to enter a PIN followed by the pound key If the entered PIN is not a match the attendant gives the user two additional attempts to enter the PIN If the third attempt does not match the attendant announces a thank you message ...

Page 83: ...lected by the user Bye Thank you for choosing Obihai Technology Goodbye When user presses or key to leave the AA User Prompts Parameter Guide Parameter Description Default Setting User N Description N 1 10 A text string that describes the contents of this user prompt User N Length N 1 10 This is a read only status parameter It shows the space occupied by this prompt in number of milliseconds Space...

Page 84: ...t e 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 the service with which to make this call See the Trunks Endpoints and Terminals section for a description of the syntaxes to specify this parameter Forking to multiple numbers in an AA outbound call is supported on the OBi202...

Page 85: ... call must be all digits Maximum length 15 digits PIN2 PIN code to make a call must be all digits Maximum length 15 digits PIN3 PIN code to make a call must be all digits Maximum length 15 digits PIN4 PIN code to make a call must be all digits Maximum length 15 digits Auto Attendant Prompt Parameter Guide Parameter Description Default Setting Welcome Prompt List to replace the system s Welcome mes...

Page 86: ...is VG It can be referenced as Mvgn x x AuthUserID A user ID to authenticate with the gateway AuthPassword A password to authenticate with the gateway Trunk Group Parameter Guide Parameter Description Default Setting Trunk Group n n 1 4 Enable Enables this trunk group Yes Name An arbitrary user friendly name to identify this trunk group optional TrunkList A comma separated list of names of trunks t...

Page 87: ...eptable according to the DigitMap the device uses this outbound call routing rule to determine that service to make this call with If no appropriate call route is found the device plays a SIT tone followed by a short error message to let the caller know that there is no call route to place the call See the Trunks Endpoints and Terminals section for a description of the syntaxes to specify this par...

Page 88: ...82 to apply to the Phone port when ringing 70 RingWaveform Ringer waveform to apply to the Phone port when ringing Choose from Sinusoidal Trapezoidal Sinusoidal InterleavedRing When both Phone ports are ringing enabling this option causes the device to interleave the ring signal applied to each port to reduce the chance of overloading the power supply No Port Settings OnHookTipRingVoltage Tip Ring...

Page 89: ...ethod Caller ID delivery standard Choose from FSK Bell202 FSK V 23 DTMF Finland Sweden DTMF Denmark FSK Bell202 CallerIDTrigger Triggering event for on hook Caller ID signal generation Choose from After First Ring After Polarity Reversal Before First Ring After First Ring ChannelTxGain Transmit gain in dB 12 to 12 to apply to signal sent from the device to the attached phone s 0 ChannelRxGain Rece...

Page 90: ...l in connected state while there is a second call on hold or ringing Choose from N America uses hook switch events only Nordic Regions R1 R2 where R hook flash or the R button R0 Reject the second incoming call applicable only if the second call is ringing R1 End current call resume answer the second call R2 Hold current call resume answer the second call R3 Conference the two calls R4 Transfer se...

Page 91: ...shake tones objectionable especially if their phones do not support CWCID Set this option to No if you don t want the CWCID feature or don t have phones that can display CWCID Yes MWIEnable Enables MWI Signal stutter dial tone generation If enabled any SP voice service enabled on the device that has MWI Service enabled triggers the generation of stutter dial tone if there are new voicemails for th...

Page 92: ... audio mixing Conference Call if enabled is initiated by the user by hook flashing the phone in one of the following scenarios One call on hold while a second outgoing call ringing Case 1 One call on hold while a second outgoing call connected Case 2 Case 1 is an early conference where the second conferencee is still ringing The other two parties may converse while hearing ringback tone in the bac...

Page 93: ...lay Delay in milliseconds before the device answers an incoming media loopback call 0 MediaLoopbackMaxDuration Maximum duration in seconds to allow for an inbound media loopback call Set the value to blank or 0 to make it unlimited 0 RepeatDialInterval Interval in seconds between retry in a repeat dial operation 30 RepeatDialExpires Duration of time in seconds when a repeat dial operation remains ...

Page 94: ... holding if this parameter is not specified The valid number should be a complete number with trunk information such as SP1 14083334567 EndHoldingCallWhenHangUp If enabled when a user hangs up while a call is still on hold the device ends that call instead of alerting the same to the user with a short ring No MOHServiceNumber The number to call to get music streamed to the remote party when the re...

Page 95: ...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 100 CPCDelayTime A short delay in milliseconds before the device generates a CPC signal to the Phone port after the far end has hung up during a call 2000 CPCDuration The device generates CPC Cal...

Page 96: ... Reverse By using a different polarity for an Idle and a Connected line the device effectively generates a polarity reversal signal to the Phone port which signals the attached phone equipment that the call is either connected or ended Forward USB Port Parameter Guide Parameter Description Default Setting USB Headset Settings AutoAnswerEnable Enables auto answer Yes IncomingNotification Sets the n...

Page 97: ...te Bit rate in bits sec Informational only not configurable 64000 Enable Enables this codec Yes SilenceSuppression Enables silence suppression for this codec No PacketizationPeriod Packet size in ms 20 Priority Priority assigned to this codec 1 is the highest 2 PayloadType Standard payload type for G711 alaw Informational only not configurable 8 G729 Codec Codec Codec name G729 BitRate Bit rate in...

Page 98: ...d list of event IDs to indicate such as CED CNG 32 Telephone Event Codec Codec Name This codec is for relaying DTMF events using RTP telephone ev ent Enable Enables this codec Yes PayloadType Dynamic Payload type to be used for RFC2833 telephone DTMF events Valid range is 96 127 101 Encap RTP Codec Codec Name This codec is used to encapsulate RTP packets during a packet loopback call encaprtp Payl...

Page 99: ...11A G711U Tone Profile A B Parameter Guide Parameter Description Default Setting Dial Tone ToneName Dial Tone TonePattern Obihai Tone Pattern Script 350 18 440 18 20 Ringback Tone ToneName Ringback Tone TonePattern Obihai Tone Pattern Script 440 18 480 18 1 2 4 Busy Tone ToneName Busy Tone TonePattern Obihai Tone Pattern Script 480 18 620 18 10 5 5 Reorder Tone ToneName Reorder tone or Fast busy T...

Page 100: ...Tone ToneName Prompt Tone to prompt user to enter a number for configuration such as speed dial TonePattern Obihai Tone Pattern Script 480 16 20 Call Forwarded Dial Tone ToneName Call Forwarded Dial Tone A special dial tone to indicate call forward all is active Not configurable TonePattern Obihai Tone Pattern Script 350 18 440 18 20 2 2 DND Dial Tone ToneName DND Dial Tone A special dial tone to ...

Page 101: ...ion Tone 4 Not configurable TonePattern Obihai Tone Pattern Script 985 16 1371 16 1777 16 20 1 380 0 2 380 0 4 380 0 0 0 4 Outside Dial Tone ToneName Outside Dial Tone Not configurable TonePattern Obihai Tone Pattern Script 385 16 10 R Command Tone ToneName R Command Tone Not configurable TonePattern Obihai Tone Pattern Script 400 16 5 Paging Tone ToneName Paging Tone Not configurable TonePattern ...

Page 102: ...attern Script 440 18 30 1 1 1 1 1 10 Call Waiting Tone 5 ToneName Distinctive Call Waiting Tone 5 An incoming SIP INVITE may include the same name in an Alert Info header to choose this ring Bellcore dr5 TonePattern Obihai Tone Pattern Script 440 18 30 3 1 1 1 3 10 Call Waiting Tone 6 ToneName Distinctive Call Waiting Tone 6 An incoming SIP INVITE may include the same name in an Alert Info header ...

Page 103: ...f the ring An incoming SIP INVITE may include the same name in an Alert Info header to choose this ring Bellcore dr1 RingPattern Obihai tone cadence script 60 2 4 Ring Pattern 2 RingName Name of the ring An incoming SIP INVITE may include the same name in an Alert Info header to choose this ring Bellcore dr2 RingPattern Obihai tone cadence script 60 3 2 1 2 3 4 Ring Pattern 3 RingName Name of the ...

Page 104: ...rt Info header to choose this ring User dr2 RingPattern Obihai tone cadence script 60 4 2 4 2 4 4 Ring Pattern 8 RingName Name of the ring An incoming SIP INVITE may include the same name in an Alert Info header to choose this ring User dr3 RingPattern Obihai tone cadence script 60 25 9 75 Ring Pattern 9 RingName Name of the ring An incoming SIP INVITE may include the same name in an Alert Info he...

Page 105: ...ps and call routing rules It must be alphanumeric not contain any spaces and be different from other user defined or built in digit map labels ipd DigitMap A valid digit map xx xx x xx x xx x xx x xx xx x xx x xx x xx x xx x x x This default value supports IPv4 dialing User Defined Digit Map N N 2 to 10 Label A 2 to 16 character long label to reference this digit map in other digit maps and call r...

Page 106: ... or Password in this case No HomeDirectory The Home Directory for anonymous level access such that user can t navigate the file system above this directory Maximum length of this field is 256 characters A blank value is the same as slash which allows navigation all the way to the root of the file system obi_share anon ymous FileFilter A list of semicolon separated filename filters to limit the typ...

Page 107: ...filters to limit the types of filters 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 and so forth and is a wildcard that matches any valid filename string For example jpg pdf mp3 mov Maximum length of this field is 256 characters WriteEnable By enabling write access to the file system you enable the user t...

Page 108: ...1 Connect an analog telephone to the device Phone port 2 From a phone attached to the device dial to access the device Config Attendant 3 Select 1 to hear the IP address of the device read back to you Write this down Access Device Web Portal Each HDA50 device has its own built in portal site at http ip address where ip address is the IP address of the device The native web portal offers configurab...

Page 109: ...uggested Solution Firmware Package Checksum Error A corrupted firmware package file was used for the update Check the file and or redownload the firmware package and try again System Is Busy The device is busy because one of the phone services is in an active call or device provisioning is in progress Try to update again later Firmware Is Not Modified The device is already running the same firmwar...