Administrator’s Guide for the Polycom® SoundPoint® IP/SoundStation® IP Family SIP 3.1.2B March, 2009 Edition 1725-11530-310 Rev. C SIP 3.1.
Trademark Information © 2009 Polycom, Inc. Polycom®, the Polycom "Triangles" logo and the names and marks associated with Polycom's products are trademarks and/or service marks of Polycom, Inc. and are registered and/or common law marks in the United States and various other countries. All other trademarks are property of their respective owners.
About This Guide The Administrator’s Guide for the SoundPoint IP / SoundStation IP family is for administrators who need to configure, customize, manage, and troubleshoot SoundPoint IP / SoundStation IP phone systems. This guide covers the SoundPoint IP 301, 320, 330, 430, 501, 550, 560, 600, 601, 650, and 670 desktop phones, and the SoundStation IP 4000 , 6000, and 7000 conference phones.
Administrator’s Guide SoundPoint IP / SoundStation IP iv
Contents About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii 1 Introducing the SoundPoint IP / SoundStation IP Family . . . 1–1 SoundPoint IP Desktop Phones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1 SoundStation IP Conference Phones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4 Key Features of Your SoundPoint IP / SoundStation IP Phones . . . . . . . 1–6 2 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Administrator’s Guide SoundPoint IP / SoundStation IP Call Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–3 Call Waiting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–3 Called Party Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–4 Calling Party Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–4 Missed Call Notification .
Contents Instant Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–30 Multilingual User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–30 Downloadable Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–31 Synthesized Call Progress Tones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–32 Microbrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Administrator’s Guide SoundPoint IP / SoundStation IP Custom Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–81 Incoming Signaling Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–82 Secure Real-Time Transport Protocol . . . . . . . . . . . . . . . . . . . . . . . . . 4–82 Configuration File Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–82 Configuring SoundPoint IP / SoundStation IP Phones Locally . . . .
Contents Directory
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–68 Presence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–72 Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–72 Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–75 Backgrounds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Administrator’s Guide SoundPoint IP / SoundStation IP Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B–9 Third Party Call Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B–9 SIP for Instant Messaging and Presence Leveraging Extensions . . B–10 Shared Call Appearance Signaling . . . . . . . . . . . . . . . . . . . . . . . . . . . B–10 Bridged Line Appearance Signaling . . . . . . . . . . . . . . . . . . . . . .
1 Introducing the SoundPoint IP / SoundStation IP Family This chapter introduces the SoundPoint IP / SoundStation IP family, which is supported by the software described in this guide. The SoundPoint IP / SoundStation IP family provides a powerful, yet flexible IP communications solution for Ethernet TCP/IP networks, delivering excellent voice quality. The high-resolution graphic display supplies content for call information, multiple languages, directory access, and system status.
Administrator’s Guide SoundPoint IP / SoundStation IP The currently supported desktop phones are: 1-2 • SoundPoint IP 301 • SoundPoint IP 320/330 • SoundPoint IP 430
Introducing the SoundPoint IP / SoundStation IP Family • SoundPoint IP 501 • SoundPoint IP 550/560 • SoundPoint IP 600/601 1-3
Administrator’s Guide SoundPoint IP / SoundStation IP • SoundPoint IP 650 • SoundPoint IP 670 SoundStation IP Conference Phones This section describes the current SoundPoint IP conference phones. For individual guides, refer to the product literature available at http://www.polycom.com/support/voice/. Additional options are also available. For more information, contact your Polycom distributor.
Introducing the SoundPoint IP / SoundStation IP Family The currently supported conference phones are: • SoundStation IP 4000 • SoundStation IP 6000 • SoundStation IP 7000 1-5
Administrator’s Guide SoundPoint IP / SoundStation IP Key Features of Your SoundPoint IP / SoundStation IP Phones The key features of the SoundPoint IP / SoundStation IP phones are: • Award winning sound quality and full-duplex speakerphone or conference phone — Permits natural, high-quality, two-way conversations (one-way, monitor speaker in the SoundPoint IP 301) — Uses Polycom’s industry leading Acoustic Clarity Technology • Easy-to-use — An easy transition from traditional PBX systems into the world
Introducing the SoundPoint IP / SoundStation IP Family • Dual auto-sensing 10/100/1000baseT Ethernet ports — Leverages existing infrastructure investment — No re-wiring with existing CAT 5 cabling — Simplifies installation • Power over Ethernet (PoE) port — Unused pairs on Ethernet port pairs are used to deliver power to the phone via a wall adapter allowing fewer wires to desktop — Optional accessory cable for CiscoR Inline Powering and IEEE 802.
Administrator’s Guide SoundPoint IP / SoundStation IP 1-8
2 Overview This chapter provides an overview of the Session Initiation Protocol (SIP) application and how the phones fit into the network configuration. SIP is the Internet Engineering Task Force (IETF) standard for multimedia conferencing over IP. It is an ASCII-based, application-layer control protocol (defined in RFC 3261) that can be used to establish, maintain, and terminate calls between two or more endpoints.
Administrator’s Guide SoundPoint IP / SoundStation IP System on page 4-1. To troubleshoot any problems with your SoundPoint IP / SoundStation IP phones on the network, refer to Troubleshooting Your SoundPoint IP / SoundStation IP Phones on page 5-1. Where SoundPoint IP / SoundStation IP Phones Fit The phones connect physically to a standard office twisted-pair (IEEE 802.3) 10/100 megabytes per second Ethernet LAN and send and receive all data using the same packet-based technology.
Overview Session Initiation Protocol Application Architecture The software architecture of SIP application is made of 4 basic components: • BootROM—loads first when the phone is powered on • Application—software that makes the device a phone • Configuration—configuration parameters stored in separate files • Resource Files—optional, needed by some of the advanced features Configuration Resource Files bootROM Application BootROM The bootROM is a small application that resides in the flash memory o
Administrator’s Guide SoundPoint IP / SoundStation IP 5. Download the master configuration file. This file is either called .cfg or 000000000000.cfg . This file is used by the both the bootROM and the application for a list of other files that are needed for the operation of the phone. 6. Examine the master configuration file for the name of the application file, and then look for this file on the boot server.
Overview 2. Controls all aspects of the phone after it has restarted. 3. Uploads log files. BootROM and Application Wrapper Both the bootROM and the application run on multiple platforms (meaning all previously released versions of hardware that are still supported). The file stored on the boot server is a wrapper, with multiple hardware specific images contained within.
Administrator’s Guide SoundPoint IP / SoundStation IP Application Configuration Files Typically, the files are arranged in the following manner although parameters may be moved around within the files and the filenames themselves can be changed as needed. These files dictate the behavior of the phone once it is running the executable specified in the master configuration file.
Overview The following figure shows one possible layout of the central provisioning method. Manual Configuration When the manual configuration method is employed, any changes made are stored in a configuration override file. This file is stored on the phone, but a copy will also be uploaded to the central boot server if one is being used.
Administrator’s Guide SoundPoint IP / SoundStation IP • Ring tones • Synthesized tones • Contact directories Available Features This section provides information the features available on the SoundPoint IP / SoundStation IP phones: • Basic User Features — Automatic Off-Hook Call Placement—Supports an optional automatic off-hook call placement feature for each registration. — Call Forward—Provides a flexible call forwarding feature to forward calls to another destination.
Overview — Customizable Audio Sound Effects—Audio sound effects used for incoming call alerting and other indications are customizable. — Directed Call Pick-Up and Group Call Pick-Up—Calls to another phone can be picked up by dialing the extension of the other phone. Calls to another phone within a pre-defined group can be picked up without dialing the extension of the other phone. — Distinctive Call Waiting—Calls can be mapped to distinct call waiting types.
Administrator’s Guide SoundPoint IP / SoundStation IP — Missed Call Notification—The phone can display the number of calls missed since the user last looked at the Missed Calls list. — Soft Key Activated User Interface—The user interface makes extensive use of intuitive, context-sensitive soft key menus. — Speed Dial—The speed dial system allows calls to be placed quickly from dedicated keys as well as from a speed dial menu.
Overview — Multiple Call Appearances—The phone supports multiple concurrent calls. The hold feature can be used to pause activity on one call and switch to another call. — Multiple Line Keys per Registration—More than one line key can be allocated to a single. — Multiple Registrations—SoundPoint IP desktop phones support multiple registrations per phone. However, SoundStation IP conference phones support a single registration.
Administrator’s Guide SoundPoint IP / SoundStation IP — Automatic Gain Control—Designed for hands-free operation, boosts the transmit gain of the local user in certain circumstances. — Background Noise Suppression—Designed primarily for hands-free operation, reduces background noise to enhance communication in noisy environments. — Comfort Noise Fill—Designed to help provide a consistent noise level to the remote user of a hands-free call.
Overview — Secure Real-Time Transport Protocol—Encrypting audio streams to avoid interception and eavesdropping. For more information on each feature and its associated configuration parameters, see the appropriate section in Configuring Your System on page 4-1. New Features in SIP 3.1 Note The SoundPoint IP 300 and 500 phones will be supported on the latest maintenance patch release of the SIP 2.1 software stream—currently SIP 2.1.3. Any new features introduced after SIP 2.1.3 are not supported.
Administrator’s Guide SoundPoint IP / SoundStation IP • Microbrowser—An XML API allows for the creation of more advanced applications. • Multilingual User Interface—Polish and Slovenian are now available as languages choices. Documentation of the newly released SoundPoint IP 560 and 670 desktop phones and SoundStation IP 6000 and 7000 conference phones has also been added.
3 Setting up Your System Your SoundPoint IP / SoundStation IP SIP phone is designed to be used like a regular phone on a public switched telephone network (PSTN). This chapter provides basic instructions for setting up your SoundPoint IP / SoundStation IP phones.
Administrator’s Guide SoundPoint IP / SoundStation IP Setting Up the Network Regardless of whether or not you will be installing a centrally provisioned system, you must perform basic TCP/IP network setup, such as IP address and subnet mask configuration, to get your organization’s phones up and running. The bootROM application uses the network to query the boot server for upgrades, which is an optional process that will happen automatically when properly deployed.
Setting up Your System Parameter DHCP Option DHCP Alternate DHCP Configuration File (application only) Local FLASH Refer to DHCP Menu on page 3-7 • • - • boot server address 151 • - - • SIP server address Note: This value is configurable.
Administrator’s Guide SoundPoint IP / SoundStation IP Supported Provisioning Protocols The bootROM performs the provisioning functions of downloading configuration files, uploading and downloading the configuration override file and user directory, and downloading the dictionary and uploading log files. The protocol that will be used to transfer files from the boot server depends on several factors including the phone model and whether the bootROM or SIP application stage of provisioning is in progress.
Setting up Your System Note Setting Option 66 to tftp://192.168.9.10 has the effect of forcing a TFTP download. Using a TFTP URL (for example, tftp://provserver.polycom.com) has the same effect. For downloading the bootROM and application images to the phone, the secure HTTPS protocol is not available. To guarantee software integrity, the bootROM will only download cryptographically signed bootROM or application images.
Administrator’s Guide SoundPoint IP / SoundStation IP Main Menu The following configuration parameters can be modified on the main setup menu: Name Possible Values Description DHCP Client Enabled, Disabled If enabled, DHCP will be used to obtain the parameters discussed in DHCP or Manual TCP/IP Setup on page 3-2. DHCP Menu Refer to DHCP Menu on page 3-7. Note: Disabled when DHCP client is disabled. Phone IP Address dotted-decimal IP address Phone’s IP address.
Setting up Your System Note A parameter value of “???” indicates that the parameter has not yet been set and saved in the phone’s configuration. Any such parameter should have its value set before continuing. The EM Power parameter is only available on SoundPoint IP 601 and 650 phones. Note To switch the text entry mode on the SoundPoint IP 330/320, press the #. You may want to use URL or IP address modes when entering server addresses.
Administrator’s Guide SoundPoint IP / SoundStation IP Name Possible Values Boot Server (continued) 1=Custom Description The phone will look for the option number specified by the Boot Server Option parameter (below), and the type specified by the Boot Server Option Type parameter (below) in the response received from the DHCP server. If the DHCP server sends nothing, the following scenarios are possible: • If a boot server value is stored in flash memory and the value is not “0.0.0.
Setting up Your System Possible Values Name VLAN Discovery VLAN ID Option Description 0=Disabled (default) No VLAN discovery through DHCP. 1=Fixed Use predefined DHCP vendor-specific option values of 128, 144, 157 and 191. If this is used, the VLAN ID Option field will be ignored 2=Custom Use the number specified in the VLAN ID Option field as the DHCP private option value.
Administrator’s Guide SoundPoint IP / SoundStation IP Name Possible Values Description Server Address dotted-decimal IP address OR domain name string OR URL The boot server to use if the DHCP client is disabled, the DHCP server does not send a boot server option, or the Boot Server parameter is set to Static. The phone can contact multiple IP addresses per DNS name. These redundant boot servers must all use the same protocol. If a URL is used it can include a user name and password.
Setting up Your System Ethernet Menu The following Ethernet configuration parameters can be modified on the Ethernet menu: Name Possible Values Description CDP Compatibility Enabled, Disabled If enabled, the phone will use a CDP compatibility method. It also reports PoE power usage to the switch. The default value is Enabled. VLAN ID Null, 0 through 4094 Phone’s 802.1Q VLAN identifier. The default value is Null.
Administrator’s Guide SoundPoint IP / SoundStation IP The syslog protocol is a very simplistic protocol: the syslog sender sends a small textual message (less than 1024 bytes) to the syslog receiver. The receiver is commonly called “syslogd”, “syslog daemon” or “syslog server”. Syslog messages can be sent through UDP, TCP, or TLS. The data is sent in cleartext. Syslog is supported by a wide variety of devices and receivers.
Setting up Your System All of the boot servers must be reachable by the same protocol and the content available on them must be identical. The parameters described in section Server Menu on page 3-9 can be used to configure the number of times each server will be tried for a file transfer and also how long to wait between each attempt. The maximum number of servers to be tried is configurable. For more information, contact your Certified Polycom Reseller.
Administrator’s Guide SoundPoint IP / SoundStation IP 3. Copy all files from the distribution zip file to the phone home directory. Maintain the same folder hierarchy. The distribution zip file contains: — sip.ld (including a separate one for every supported model) — sip.cfg — phone1.cfg — 000000000000.cfg — 000000000000-directory~.xml — SoundPointIP-dictionary.xml (one of each supported language) — SoundPointIPWelcome.
Setting up Your System Multiple boot servers can be configured by having the boot server DNS name map to multiple IP addresses. The default number of boot servers is one and the maximum number is eight. HTTPS, HTTP, and FTP are supported for redundant boot servers. For all SoundPoint IP and SoundStation IP phones, follow the normal provisioning process in the next section, Provisioning Phones.
Administrator’s Guide SoundPoint IP / SoundStation IP 2. (Optional) Create new configuration file(s) in the style of sip.cfg by performing the following steps: Note For more information on why to create another configuration file, refer to the “Configuration File Management on SoundPoint IP Phones” whitepaper at www.polycom.com/support/voice/ . For more information, especially on the SIP server address, refer to SIP on page A-10. For more information on the sip.
Setting up Your System c Edit the CONFIG_FILES attribute of the .cfg files so that it references the appropriate sipXXXX.cfg file. For example, replace the reference to sip.cfg with sip650.cfg. d Edit the LOG_FILE_DIRECTORY attribute of the .cfg files so that it points to the log file directory. e Edit the CONTACT_DIRECTORY attribute of the .cfg files so that it points to the organization’s contact directory. 4.
Administrator’s Guide SoundPoint IP / SoundStation IP Provisioning SoundStation IP 7000 Phones Using CLink Normally the SoundStation IP family conference phone is provisioned over the Ethernet by the boot server. However, when two SoundStation IP family phones are daisy-chained together, the one that is not directly connected to the Ethernet can still be provisioned (known as the secondary).
Setting up Your System Upgrading SIP Application You can upgrade the SIP application that is running on the SoundPoint IP and SoundStation IP phones in your organization. The exact steps that you perform are dependent on the version of the SIP application that is currently running on the phones and the version that want to upgrade to. The bootROM, application executable, and configuration files can be updated automatically through the centralized provisioning model. These files are read-only by default.
Administrator’s Guide SoundPoint IP / SoundStation IP Warning The configuration files listed in CONFIG_FILES attribute of the master configuration file must be updated when the software is updated. Any new configuration files must be added to the CONFIG_FILES attribute in the appropriate order. Mandatory changes must be made or the software may not behave as expected. For more information, refer to the “Configuration File Management on SoundPoint IP Phones” whitepaper at www.polycom.com/support/voice/ .
Setting up Your System To upgrade your SIP application: 1. Do one of the following steps: a Place the bootrom.ld file corresponding to BootROM revision 4.0.0 (or later) onto the boot server. b Ensure that all phones are running BootROM 4.0.0 or later code. 2. Copy sip.ld, sip.cfg and phone1.cfg from the SIP2.2.0 or later release distribution onto the boot server. These are the relevant files for all phones except the SoundPoint IP 300 and 500 phones. 3. Rename sip.ld, sip.cfg, and phone1.
Administrator’s Guide SoundPoint IP / SoundStation IP For more information, refer to “Technical Bulletin 35311: Supporting SoundPoint IP 300 and IP 500 Phones with SIP 2.2 and Later Releases“ at http://www.polycom.com/usa/en/support/voice/soundpoint_ip/VoIP_T echnical_Bulletins_pub.html .
4 Configuring Your System After you set up your SoundPoint IP / SoundStation IP phones on the network, you can allow users to place and answer calls using the default configuration, however, you may be require some basic changes to optimize your system for best results.
Administrator’s Guide SoundPoint IP / SoundStation IP • Connected Party Identification • Context Sensitive Volume Control • Customizable Audio Sound Effects • Message Waiting Indication • Distinctive Incoming Call Treatment • Distinctive Ringing • Distinctive Call Waiting • Do Not Disturb • Handset, Headset, and Speakerphone • Local Contact Directory • Local Digit Map • Microphone Mute • Soft Key Activated User Interface • Speed Dial • Time and Date Display • Idle Display Ani
Configuring Your System Call Log The phone maintains a call log. The log contains call information such as remote party identification, time and date, and call duration. It can be used to redial previous outgoing calls, return incoming calls, and save contact information from call log entries to the contact directory. The call log is stored in volatile memory and is maintained automatically by the phone in three separate lists: Missed Calls, Received Calls and Placed Calls.
Administrator’s Guide SoundPoint IP / SoundStation IP Called Party Identification The phone displays and logs the identity of the remote party specified for outgoing calls. This is the party that the user intends to connect with. There are no related configuration changes. Calling Party Identification The phone displays the caller identity, derived from the network signalling, when an incoming call is presented, if the information is provided by the call server.
Configuring Your System Configuration changes can performed centrally at the boot server: Central Configuration file: Turn this feature on or off. (boot server) sip.cfg • Configuration file: phone1.cfg Specify per-registration whether all missed-call events or only remote/server-generated missed-call events will be displayed. • For more information, refer to Feature on page A-92. For more information, refer to Missed Call Configuration on page A-112.
Administrator’s Guide SoundPoint IP / SoundStation IP Note L16/16000 is not supported on SoundPoint IP 301 and SoundStation IP 4000 phones. L16/32000 and L16/48000 are only supported on SoundPoint IP 7000 phones. Note The alternate sampled audio sound effect files must be present on the boot server or the Internet for downloading at boot time. Configuration changes can performed centrally at the boot server or locally: Central (boot server) Configuration File: sip.
Configuring Your System Distinctive Ringing There are three options for distinctive ringing: 1. The user can select the ring type for each line. This option has the lowest priority. 2. The ring type for specific callers can be assigned in the contact directory. For more information, refer to Distinctive Incoming Call Treatment, the previous section. This option has a higher priority than option 1 and a lower priority than option 3. 3. The voIpProt.SIP.alertInfo.x.value and voIpProt.SIP.alertInfo.x.
Administrator’s Guide SoundPoint IP / SoundStation IP Do Not Disturb A Do Not Disturb (DND) feature is available to temporarily stop all incoming call alerting. Calls can optionally be treated as though the phone is busy while DND is enabled. DND can be configured as a per-registration feature. Incoming calls received while DND is enabled are logged as missed. For more information on forwarding calls while DND is enabled, refer to Call Forward on page 4-20.
Configuring Your System IP 4000, 6000, and 7000 conference phones are full-duplex speakerphones. The SoundPoint IP 301 phones is a listen-only speakerphone. The SoundPoint IP phones provide dedicated keys for convenient selection of either the speakerphone or headset. Only the SoundPoint IP 320, 330, 430, 550, 560, 650, and 670 desktop phones can be configured to use the electronic hookswitch.
Administrator’s Guide SoundPoint IP / SoundStation IP Note If a user makes a change to the local contact directory, there is a five second timeout before it is uploaded to the boot server as -directory.cfg. Configuration changes can performed centrally at the boot server or locally: Central (boot server) Configuration file: sip.cfg Set whether the directory uses volatile storage on the phone (required on the SoundPoint IP 500 platform for directories greater than 25 entries).
Configuring Your System 1001 1 0 0 0 0 ... -
Dr
Smith Bill 1003 3 0 0 0 0 Element Permitted Values Interpretation lb UTF-8 encoded string of up to 40 bytes label Note: In some cases, this will be less than 40 characters due to UTF-8’s variable length encoding.
Administrator’s Guide SoundPoint IP / SoundStation IP Element Permitted Values Interpretation sd Null, 1 to 9999 speed-dial index Associates a particular entry with a speed dial bin for one-touch dialing or dialing from the speed dial menu. Note: On the SoundPoint IP 330/320 and the SoundStation IP 6000 and 7000, the maximum speed-dial index is 99.
Configuring Your System Configuration changes can performed centrally at the boot server or locally: Central (boot server) Configuration file: sip.cfg Specify impossible match behavior, trailing # behavior, digit map matching strings, and time out value. • Configuration file: phone1.cfg Specify per-registration impossible match behavior, trailing # behavior, digit map matching strings, and time out values that override those in sip.cfg.
Administrator’s Guide SoundPoint IP / SoundStation IP Configuration changes can performed centrally at the boot server or locally: Central XML file: (boot server) -directory. xml The x element in the -directory.xml file links a directory entry to a speed dial resource within the phone.
Configuring Your System Local Web Server Set the basic SNTP and daylight savings settings. (if enabled) Navigate to: http:///coreConf.htm#ti Changes are saved to local flash and backed up to -phone.cfg on the boot server. Changes will permanently override global settings unless deleted through the Reset Local Config menu selection and the -phone.cfg is removed from the boot server.
Administrator’s Guide SoundPoint IP / SoundStation IP AC power adapter or can be line-powered (power supplied through the signaling or idle pairs of the LAN Ethernet cable). Line powering typically requires that the phone plugs directly into a dedicated LAN jack. Devices that do not require LAN power can then plug into the SoundPoint IP PC Ethernet port. To disabled the PC Ethernet port, refer to Disabling PC Ethernet Port on page C-27.
Configuring Your System c For the solid backgrounds, set the name and RGB values. For example: bg.hiRes.gray.pat.solid.3.name=”Gray” bg.hiRes.gray.pat.solid.3.red=”128” bg.hiRes.gray.pat.solid.3.green=”128” bg.hiRes.gray.pat.solid.3.blue=”128” d For images, select a filename. For example: bg.hiRes.gray.bm.3.name=”polycom.jpg” bg.hiRes.gray.bm.3.em.name=”polycomEM.jpg” bg.hiRes.gray.bm.3.adj=”0” The default size for images on a phone is 320 x 160.
Administrator’s Guide SoundPoint IP / SoundStation IP Configuration changes can performed centrally at the boot server or locally: Central (boot server) Configuration file: sip.cfg Specify whether RFC 2543 (c=0.0.0.0) or RFC 3264 (a=sendonly or a=inactive) outgoing hold signaling is used. • For more information, refer to SIP on page A-10. Specify local hold reminder options. • For more information, refer to Hold, Local Reminder on page A-67.
Configuring Your System Configuration changes can performed centrally at the boot server: Central (boot server) Configuration file: sip.cfg Specify whether to allow a transfer during the proceeding state of a consultation call. • For more information, refer to SIP on page A-10. Specify whether a transfer is blind or not. • For more information, refer to Call Handling Configuration on page A-64.
Administrator’s Guide SoundPoint IP / SoundStation IP The individual parties within a conference can be managed. New parties can be added and information about the conference participants can be viewed (for example, names, phone numbers, send/receive status or media flow, receive and transmit codecs, and hold status). Configuration changes can be performed centrally at the boot server: Central Configuration file: sip.cfg (boot server) Turn this feature on or off.
Configuring Your System The Diversion field with a SIP header is often used by the call server to inform the phone of a call’s history. For example, when a phone has been set to enable call forwarding, the Diversion header allows the receiving phone to indicate who the call was from, and from which phone number it was forwarded. (For more information, refer to Header Support on page B-4.) .
Administrator’s Guide SoundPoint IP / SoundStation IP Group Call Pick-Up Calls to another phone within a pre-defined group can be picked up without dialing the extension of the other phone. This feature depends on support from a SIP server. Configuration changes can performed centrally at the boot server: Central (boot server) Configuration file: sip.cfg Turn this feature on or off. • For more information, refer to Feature on page A-92.
Configuring Your System • Bridged Line Appearance • Busy Lamp Field • Customizable Fonts and Indicators • Instant Messaging • Multilingual User Interface • Downloadable Fonts • Synthesized Call Progress Tones • Microbrowser • Real-Time Transport Protocol Ports • Network Address Translation • Corporate Directory • Recording and Playback of Audio Calls • Daisy-Chaining Phones • Provisioning Phones Over CLink • Enhanced Feature Keys • Configurable Soft Keys This section also pr
Administrator’s Guide SoundPoint IP / SoundStation IP Configurable Feature Keys All key functions can be changed from the factory defaults. The scrolling timeout for specific keys can be configured. Note No feature keys on the SoundStation IP 4000, 6000, or 7000 can be remapped. Since there is no Redial key on the SoundPoint IP 330/320 phone, the redial function cannot be remapped.
Configuring Your System Multiple Line Keys per Registration More than one Line Key can be allocated to a single registration (phone number or line) on SoundPoint IP phones. The number of Line Keys allocated per registration is configurable. Configuration changes can performed centrally at the boot server or locally: Central Specify the number of line keys to assign per registration. (boot server) Configuration file: phone1.
Administrator’s Guide SoundPoint IP / SoundStation IP Local Web Server (if enabled) Specify the default number of calls that can be active or on hold per line key and the number of calls per registration that can be active or on hold per line key assigned to that registration. Navigate to http:///appConf.htm#ls and http:///reg.htm Changes are saved to local flash and backed up to -phone.cfg on the boot server.
Configuring Your System Configuration changes can performed centrally at the boot server or locally: Central (boot server) Configuration file: sip.cfg Specify whether diversion should be disabled on shared lines. • For more information, refer to Shared Calls on page A-67. Specify line-seize subscription period. • For more information, refer to Server on page A-7. Specify standard or non-standard behavior for processing line-seize subscription for mutual exclusion feature.
Administrator’s Guide SoundPoint IP / SoundStation IP simultaneously. This feature is dependent on support from a SIP server that binds the appearances together logically and looks after the necessary state notifications and performs an access control function. For more information, refer to Bridged Line Appearance Signaling on page B-10. Note In the configuration files, bridged lines are configured by “shared line” parameters.
Configuring Your System The Busy Lamp Field (BLF) feature enhances support for a phone-based attendant console. It allows monitoring the hook status and remote party information of users through the busy lamp fields and displays on an attendant console phone. In the SIP 3.
Administrator’s Guide SoundPoint IP / SoundStation IP Configuration changes can performed centrally at the boot server: Central (boot server) Configuration File: sip.cfg Specify fonts to overwrite existing ones or specify new fonts. • For more information, refer to Fonts on page A-72. Specify which bitmaps to use. • For more information, refer to Bitmaps on page A-80. Specify how to create animations and LED indicator patterns.
Configuring Your System The SoundPoint IP and SoundStation IP user interface is available in the following languages by default: Chinese (if displayable), Danish, Dutch, English, French, German, Italian, Japanese (if displayable), Korean (if displayable), Norwegian, Polish, Portuguese, Russian, Slovenian, Spanish, and Swedish. Note Slovenian is not supported on the SoundStation IP 4000. Note The multilingual feature relies on dictionary files resident on the boot server.
Administrator’s Guide SoundPoint IP / SoundStation IP Synthesized Call Progress Tones In order to emulate the familiar and efficient audible call progress feedback generated by the PSTN and traditional PBX equipment, call progress tones are synthesized during the life cycle of a call. These call progress tones are easily configurable for compatibility with worldwide telephony standards or local preferences. Configuration changes can performed centrally at the boot server: Central Configuration file: sip.
Configuring Your System Configuration changes can performed centrally at the boot server or locally: Central (boot server) Configuration file: sip.cfg Specify the Application browser home page, a proxy to use, and size limits. • For more information, refer to Microbrowser on page A-95. Specify the telephone notification and state polling events to be recorded and location of the push server. • Local For more information, refer to Applications on page A-98.
Administrator’s Guide SoundPoint IP / SoundStation IP Configuration changes can performed centrally at the boot server or locally: Central (boot server) Configuration file: sip.cfg Specify whether to filter incoming RTP packets by IP address, whether to require symmetric port usage, whether to jam the destination port and specify the local RTP port range start. • Local Web Server (if enabled) For more information, refer to RTP on page A-57.
Configuring Your System The SoundPoint IP phones can be configured to interface with a corporate directory server that supports the Lightweight Directory Access Protocol (LDAP) version 3. (Microsoft’s Active Directory is included.) Both corporate directories that support server-side sorting and those that do not are supported. In the latter case, the sorting is performed on the phone. Polycom recommends using corporate directories that have server-side sorting.
Administrator’s Guide SoundPoint IP / SoundStation IP This section contains the following information: • Corporate Directory LDAP Attributes • Browsing the Corporate Directory • Configuration File Example Corporate Directory LDAP Attributes The entry attributes in the corporate directory are mapped through sip.
Configuring Your System Configuration File Example The following excerpt from the sip.cfg configuration file shows an example where downloaded entries are limited to any where the phone number is in the 604 area code: dir.corp.address=” dir.corp.port=”389” dir.corp.transport=”TCP” dir.corp.baseDN=”cn=Users,dc=yourcompany,dc=local dir.corp.user=”ldapadmin” dir.corp.password=”12345678” dir.corp.filterPrefix=”(objectclass=person)” dir.corp.scope=”sub” dir.corp.attribute.1.name=”sn” dir.corp.attribute.1.
Administrator’s Guide SoundPoint IP / SoundStation IP Note Notify your users that they may be required by federal, state, and/or local laws to notify some or all called parties when they are recording. Playback of recorded files can occur on the phone as well as on other devices, such as a Windows® or Apple® based computer using an application like Windows Media Player® or iTunes®. The user controls which calls are recorded and played back.
Configuring Your System Instructions for daisy-chaining SoundStation IP family conference phones are available in the SoundStation IP 7000 User Guide. Provisioning Phones Over CLink Normally the SoundStation IP family conference phone is provisioned over the Ethernet by the boot server. However, when two SoundStation IP family phones are daisy-chained together, the one that is not directly connected to the Ethernet can still be provisioned (known as the secondary).
Administrator’s Guide SoundPoint IP / SoundStation IP Enhanced Feature Keys Note The Enhanced Feature Key feature from SIP 3.0 is compatible with Enhanced Feature Key feature from SIP 3.1 . However, improvements have been made, and Polycom recommends that existing configuration files be reviewed and updated. Customers replacing legacy telephony PBX or key system would like to get equivalent functionality from their new VoIP telephony system. With SIP 3.
Configuring Your System This element indicates the start of enhanced feature key definition section. The efk element has the following format: ... This element describes behavior of enhanced feature key. The different blocks of the enhanced feature key definitions are uniquely identified by number following efk.efklist prefix (for example, efk.efklist.1.). Note In SIP 3.
Administrator’s Guide SoundPoint IP / SoundStation IP Name Interpretation type The SIP method to be performed once the macro starts executing. This parameter has the following values: • If set to “invite “, the action required is performed using the SIP INVITE method. Note: This parameter is included for backwards compatability only. Do not use if at all possible. If the action.string contains types, this parameter is ignored. If this parameter is omitted, the default is INVITE. action.
Configuring Your System Name Interpretation userfeedback This parameter specifies the user input feedback method. It has the following values: • If set to “visible”, the text appears as clear text. • If set to “masked”, the text appears as “*” characters. For example, if a password is entered. If this parameter is omitted, the value “visible” is used. If this parameter has an invalid value (including Null), this prompt is invalid and all parameters depending on this prompt are invalid.
Administrator’s Guide SoundPoint IP / SoundStation IP Macro names and action strings cannot contain these characters. If they do, unpredictable results may occur. Macro Definition The action.string in the efklist element can be defined by either: • Macro Action • Prompt Macro Substitution • Expanded Macros Macro Action The action string is executed in the order it appears. User input is collected before any action is taken.
Configuring Your System Name Interpretation $T$ The embedded action type. Multiple actions can be defined. Supported action types include: • invite • dtmf • refer Note: Polycom recommends that you always define this field. If it is not defined, the supplied digits will be dialed using INVITE (if no active call) or DTMF (if an active call). The use of refer method is call server dependentand may require the addition of star codes. $M$ The embedded macro.
Administrator’s Guide SoundPoint IP / SoundStation IP The macros provide a generic and easy to manage way to define the prompt to be displayed to the user, the maximum number of characters that the user can input, and action that the phone performs once all user input has been collected. The macros are case sensitive. If a macro attempts to use a prompt that is disabled, the macro execution fails. A prompt is not required for every macro.
Configuring Your System • If two macros have the same name, the first one will be used and the subsequent ones will be ignored. • “'!” and “^” macro prefixes cannot be mixed in the same macro line. • A sequence of characters prefixed with “!” are parsed as a macro name. The exception is the speed dial reference, which starts with “!” and contains digits only. • A sequence of characters prefixed with “^” is the action string.
Administrator’s Guide SoundPoint IP / SoundStation IP Configuration File Changes You must make the the following changes to the parameter that is defined in the sip.cfg configuration file: Action String Example The action string “$Changup$*444*$P1N4$$Tinvite$$Cwaitconnect$$P2N3$$Cpause2$$Tdt mf$$Changup$” is executed as follows: 1. The user is prompted for 4 digits. For example, “1234”. 2.
Configuring Your System efk.efkprompt.1.userfeedback="visible" efk.efkprompt.1.type="numeric" efk.efkprompt.1.digitmatching="style1" ... /> ...
Administrator’s Guide SoundPoint IP / SoundStation IP To use the Call Park key during an active call: 1. When there is an active call on line 2233: a Select the Call Park soft key. The Call Park screen appears. b Enter the number where you want to park the active call, then select the Next soft key. The Call Park * code (*68) is prepended to the number you entered and the call is parked at that location by the call server. The active call is put on hold during this operation.
Configuring Your System • Directly into an Enhanced Feature Key macro • Directly into a URL • A chained list of actions It is possible to disable the display of specific standard keys—the soft keys that are displayed on SoundStation IP and SoundStation IP phones—to make room for other soft keys that your organization wants displayed. To ensure that the usability of features is not compromised, the disabling of certain soft keys in certain circumstances may be restricted.
Administrator’s Guide SoundPoint IP / SoundStation IP Custom soft keys can be configured to precede the standard soft keys that are still displayed. The order of the custom soft keys follows the configuration order. The standard soft keys are shifted to the right and any empty spaces are removed. If the custom soft keys are configured to not precede the standard soft keys, then the standard soft keys do not move.
Configuring Your System To map a chained list of actions to a soft key: 1. Configure speed dial index 2 in contact directory with a regular phone number. For example, enter “2900” in the contact field. 2. Configure speed dial index 1 in contact directory with “!2” in contact field. 3. Update the sip.cfg configuration as follows: softkey.1.label = ChainAct softkey.1.action = $S1$$Tinvite$ softkey.1.use.idle = 1 4. Reboot the phone.
Administrator’s Guide SoundPoint IP / SoundStation IP Voice Mail Integration The phone is compatible with voice mail servers. The subscribe contact and callback mode can be configured per user/registration on the phone. The phone can be configured with a SIP URL to be called automatically by the phone when the user elects to retrieve messages.
Configuring Your System Multiple Registrations The SoundPoint IP 301, 320, 330, and 430 support a maximum of two registrations, the SoundPoint IP 501 supports three, the SoundPoint IP 550 and 560 supports four, and the SoundPoint IP 600, 601, and 650 support 6. Up to three SoundPoint IP Expansion Modules can be added to a single host SoundPoint IP 601 and 650 phone increasing the total number of buttons to 12 registrations on the SoundPoint IP 601 and 34 registrations on the SoundPoint IP 650 and 670.
Administrator’s Guide SoundPoint IP / SoundStation IP Local (continued) Local Phone User Interface Use the SIP Configuration menu to specify the local SIP signaling port, a default SIP server to register to and registration information for up to twelve registrations (depending on the phone model). The SIP Configuration menu contains a sub-set of all the parameters available in the configuration files.
Configuring Your System Two types of redundancy are possible: • Fail-over: In this mode, the full phone system functionality is preserved by having a second equivalent capability call server take over from the one that has gone down/off-line. This mode of operation should be done using DNS mechanisms or “IP Address Moving” from the primary to the back-up server.
Administrator’s Guide SoundPoint IP / SoundStation IP SRV records will be tried, before falling back on A records if NAPTR and SRV records return no results. If no port is given, and none is found through DNS, 5060 will be used. Refer to http://www.ietf.org/rfc/rfc3263.txt for an example. Note Failure to resolve a DNS name is treated as signalling failure that will cause a failover.
Configuring Your System Hosted VoIP Service Provider Call Server 1B Call Server 1A Internet DNS Server VoIP SMB Customer Premise SIP Capable Router Server2 ` ` PSTN PSTN Gateway ` ` Phone Configuration The phones at the customer site are configured as follows: • Server 1 (the primary server) will be configured with the address of the service provider call server. The IP address of the server(s) to be used will be provided by the DNS server. For example: reg.1.server.1.address="voipserver.
Administrator’s Guide SoundPoint IP / SoundStation IP until the registration is successful (for example, when the Internet link is once again operational). While the primary server registration is unavailable, the next highest priority server in the list will serve as the working server. As soon as the primary server registration succeeds, it will return to being the working server. Note If reg.x.server.y.register is set to 0, then phone will not register to that server.
Configuring Your System The presence feature works differently when Microsoft Live Communications Server 2005 is used as the call server. For more information, refer to the next section, Microsoft Live Communications Server 2005 Integration. Configuration changes can performed centrally at the boot server: Central (boot server) XML file: -directory. xml The 0 (buddy watching) and 0 (buddy blocking) elements in the -directory.
Administrator’s Guide SoundPoint IP / SoundStation IP Configuration changes can performed centrally at the boot server: Central (boot server) Configuration file: sip.cfg Specify that support for Microsoft Live Communications Server 2005 is enabled. • For more information, refer to SIP on page A-10. Specify the line/registration number used to send SUBSCRIBE for presence. • For more information, refer to Presence on page A-72. Turn the presence and messaging features on or off.
Configuring Your System e Locate the voIpProt parameter. Set the voIpProt.server.x.transport attribute to TCPpreferred or TLS. Your selection depends on the LCS configuration. Note The TLS protocol is not supported on SoundPoint IP 300 and 500 phones. f Set the voIpProt.server.x.address to the LCS address. For example, voIpProt.server.1.address = "lcs2005.local" g Set the voIpProt.SIP.lcs attribute to 1. h (Optional) If SIP forking is desired, set voIpProt.SIP.ms-forking attribute to 1.
Administrator’s Guide SoundPoint IP / SoundStation IP To set up a dual registration with Microsoft Live Communications Server 2005 as the presence server: 1. (Optional) Modify the sip.cfg configuration file as follows: a Open sip.cfg in an XML editor. b Locate the feature parameter. c For the feature.1.name = presence attribute, set feature.1.enabled to 1. d For the feature.2.name = messaging attribute, set feature.2.enabled to 1. e Locate the voIpProt parameter.
Configuring Your System l Set the roaming_privacy.reg element to the number corresponding to the LCS registration. For example, roaming_privacy.reg = 2 Refer to Roaming Privacy on page A-123. m Save the modified phone1.cfg configuration file. Access URL in SIP Message Introduced in SIP 2.2, this feature that allows information contained in incoming SIP signaling to refer to XHTML web content that can be rendered by the SoundPoint IP phone’s Microbrowser.
Administrator’s Guide SoundPoint IP / SoundStation IP User Interface There are three user interface aspects to this feature: • Web content status indication • Web content retrieval (spontaneous and on-demand) • Settings menu item to control active versus passive behaviour Web Content Status Indication When valid web content (validity is determined through a SIP header parameter) is available for a SIP call, it is indicated by an icon that appears after the call appearance status text, regardless of t
Configuring Your System appropriate URL upon arrival of the appropriate SIP signaling, subject to some conditions described below. Since new web content URLs can be received at any time—as the first URL for a call or a replacement URL—rules are needed to match displayed web content with automatic phone behaviour, which are valid actions from within the Microbrowser context.
Administrator’s Guide SoundPoint IP / SoundStation IP • An expires parameter is defined to indicate the lifespan of the URL itself, or, assuming that the URL is permanent, the time span for which the content is expected to have relevance to the call with which it is associated. If the parameter is absent or invalid, this will be interpreted to mean that the content or the URL itself will be persistent in nature.
Configuring Your System When a phone is configured with a DNS server, it will behave as follows by default: • An initial attempt to resolve a hostname that is within the static DNS cache, for example to register with its SIP registrar, results in a query to the DNS. • If the initial DNS query returns no results for the hostname or cannot be contacted, then the values in the static cache are used for their configured time interval.
Administrator’s Guide SoundPoint IP / SoundStation IP reg.1.server.1.transport="UDPOnly" reg.1.server.2.address="172.23.0.150" reg.1.server.2.port="5075" reg.1.server.2.transport="UDPOnly" When the static DNS cache is used, the sip.cfg configuration would look as follows: reg.1.address="1001" reg.1.server.1.address="sipserver.example.com" reg.1.server.1.port="5075" reg.1.server.1.transport="UDPOnly" reg.1.server.2.address="" reg.1.server.2.port="" reg.1.server.2.transport="" dns.cache.A.1.name="sipserver.
Configuring Your System reg.1.server.2.address="" reg.1.server.2.port="" reg.1.server.2.transport="" dns.cache.SRV.1.name="_sip._udp.sipserver.example.com " dns.cache.SRV.1.ttl= "3600" dns.cache.SRV.1.priority="1" dns.cache.SRV.1.weight="1" dns.cache.SRV.1.port="5075" dns.cache.SRV.1.target="primary.sipserver.example.com" dns.cache.SRV.2.name="_sip._udp.sipserver.example.com " dns.cache.SRV.2.ttl= "3600" dns.cache.SRV.2.priority="2" dns.cache.SRV.2.weight="1" dns.cache.SRV.2.port="5075" dns.cache.SRV.2.
Administrator’s Guide SoundPoint IP / SoundStation IP dns.cache.NAPTR.1.preference="1" dns.cache.NAPTR.1.flag="s" dns.cache.NAPTR.1.service=" SIP+D2U" dns.cache.NAPTR.1.regexp="" dns.cache.NAPTR.1.replacement="_sip._udp.sipserver.example.com" dns.cache.SRV.1.name="_sip._udp.sipserver.example.com " dns.cache.SRV.1.ttl= "3600" dns.cache.SRV.1.priority="1" dns.cache.SRV.1.weight="1" dns.cache.SRV.1.port="5075" dns.cache.SRV.1.target="primary.sipserver.example.com" dns.cache.SRV.2.name="_sip._udp.sipserver.
Configuring Your System For example, if a user parks a call, the following message appears on their phone: Configuration changes can be performed centrally at the boot server: Central (boot server) Configuration file: sip.cfg Turn this feature on or off and specify which warnings are displayable. • For more information, refer to SIP on page A-10. Setting Up Audio Features Proprietary state-of-the-art digital signal processing (DSP) technology is used to provide an excellent audio experience.
Administrator’s Guide SoundPoint IP / SoundStation IP • Dynamic Noise Reduction • Treble/Bass Controls Low-Delay Audio Packet Transmission The phone is designed to minimize latency for audio packet transmission. There are no related configuration changes.
Configuring Your System packets (also known as Silence Insertion Descriptor (SID) frames) and also decodes CN packets, efficiently regenerating a facsimile of the background noise at the remote end. Configuration changes can performed centrally at the boot server: Central (boot server) Configuration file: sip.cfg Enable or disable VAD and set the detection threshold. • For more information, refer to Voice Activity Detection on page A-52.
Administrator’s Guide SoundPoint IP / SoundStation IP When using the handset on any SoundPoint IP phones, AEC is not normally required. In certain situations, where echo is experienced by the far-end party, when the user is on the handset, AEC may be enabled to reduce/avoid this echo. To achieve this, make the following changes in the sip.cfg configuration file (default settings for these parameters are disabled): voice.aec.hs.enable = 1 voice.aes.hs.enable = 1 voice.ns.hs.enable = 1 voice.ns.hs.
Configuring Your System Sample Rate Frame Size Effective audio bandwidth Algorithm MIME Type Ref. Bit Rate Siren14 SIREN14/ 16000 SIREN14 24 Kbps 32 Kbps 48 Kbps 32 Ksps 20ms - 80ms 14 KHz Siren22 SIREN22/ 48000 SIREN22 32 Kbps 48 Kbps 64 Kbps 32 Ksps 20ms - 80ms 14 KHz RFC 2833 phone-event RFC 2833 N/A N/A N/A N/A Note The network bandwidth necessary to send the encoded voice is typically 5-10% higher than the encoded bit rate due to packetization overhead. For example, a G.
Administrator’s Guide SoundPoint IP / SoundStation IP systems. This feature uses noise synthesis techniques to smooth out the noise level in the direction toward the remote user, providing a more natural call experience. There are no related configuration changes. Automatic Gain Control Automatic Gain Control (AGC) is applicable to hands-free operation and is used to boost the transmit gain of the local talker in certain circumstances.
Configuring Your System Configuration changes can performed centrally at the boot server or locally: Central Specify default and protocol-specific 802.1p/Q settings. (boot server) Configuration file: sip.cfg Local Web Server Specify 802.1p/Q settings. (if enabled) Navigate to http:///netConf.htm#qo Local Phone User Interface Specify whether CDP is to be used or manually set the VLAN ID or configure DHCP VLAN Discovery. • For more information, refer to Ethernet IEEE 802.
Administrator’s Guide SoundPoint IP / SoundStation IP A wide range of performance metrics are generated. Some are based on current values, such as jitter buffer nominal delay and round trip delay, while others cover the time period from the beginning of the call until the report is sent, such as network packet loss. Some metrics are computed using other metrics as input, such as listening Mean Opinion Score (MOS), conversational MOS, listening R-factor, and conversational R-factor.
Configuring Your System • Secure Real-Time Transport Protocol • Configuration File Encryption Local User and Administrator Privilege Levels Several local settings menus are protected with two privilege levels, user and administrator, each with its own password. The phone will prompt for either the user or administrator password before granting access to the various menu options. When the user password is requested, the administrator password will also work.
Administrator’s Guide SoundPoint IP / SoundStation IP Configuration changes can performed locally: Local Local Phone User Interface The custom certificate can be specified and the type of certificate to trust can be set under the Settings menu.
Configuring Your System For more information on encrypting configuration files including determining whether an encrypted file is the same as an unencrypted file and using the SDK to facilitate key generation, refer to Encrypting Configuration Files on page C-4. Configuration changes can performed centrally at the boot server: Central (boot server) Configuration File: sip.cfg Specify the phone-specific contact directory and the phone-specific configuration override file. • Configuration file: .
Administrator’s Guide SoundPoint IP / SoundStation IP Passwords: Administrator password required. Network Configuration SIP Configuration SSL Security settings Reset to Default - local configuration, device settings, and file system format User password required. Reboot Phone Changes made through the web server or local user interface are stored internally as overrides. These overrides take precedence over settings contained in the configuration obtained from the boot server.
5 Troubleshooting Your SoundPoint IP / SoundStation IP Phones This chapter provides you with some tools and techniques for troubleshooting SoundPoint IP / SoundStation IP phones and installations. The phone can provide feedback in the form of on-screen error messages, status indicators, and log files for troubleshooting issues.
Administrator’s Guide SoundPoint IP / SoundStation IP If your problems is not listed in this chapter nor described in the latest Release Notes, contact your Certified Polycom Reseller for support. Error Messages There are several different error messages that can be displayed on the phone when it is booting.
Troubleshooting Your SoundPoint IP / SoundStation IP Phones Error, application is not present! There is no application stored in flash memory and the phone cannot boot. A compatible SIP application must be downloaded into the phone using one of the supported provisioning protocols. You need to resolve the issue of connecting to the boot server. This error is typically a result one of the above errors. This error is fatal.
Administrator’s Guide SoundPoint IP / SoundStation IP Status When the phone is unable to register with the call control server, the icon is shown (outline). Once the phone is registered, the icon shown (solid). On the SoundStation IP 7000, the icons are is and . Blinking Time If the phone has not been able to contact the SNTP server or if one has not been configured, the date/time display will flash until this is fixed.
Troubleshooting Your SoundPoint IP / SoundStation IP Phones Log Files SoundPoint IP and SoundStation IP phones will log various events to files stored in the flash file system and will periodically upload these log files to the boot server. The files are stored in the phone’s home directory or a user-configurable directory. There is one log file for the bootROM and one for the application.
Administrator’s Guide SoundPoint IP / SoundStation IP There are other logging parameters that you may wish to modify. Changing these parameters does not have the same impact as changing the logging levels, but you should still understand how your changes will affect the phone and the network. • log.render.level—Sets the lowest level that can be logged (default=1) • log.render.file.size—Maximum size before log file is uploaded (default=16 kb) • log.render.file.upload.
Troubleshooting Your SoundPoint IP / SoundStation IP Phones The following figure shows an example of a configuration file and the resulting log file. Manual Log Upload If you want to look at the log files without having to wait for the phone to upload them (which could take as long as 24 hours or more), initiate an upload by pressing correct combination of keys on the phone. For more information, refer to Multiple Key Combinations on page C-10.
Administrator’s Guide SoundPoint IP / SoundStation IP Reading a Boot Log The following figure shows a portion of a boot log file: Boot Failure Messages The following figure shows an example of “Application sip.
Troubleshooting Your SoundPoint IP / SoundStation IP Phones Reading an Application Log The following figure shows a portion of an application log file: Testing Phone Hardware To obtain more detailed troubleshooting information, you can access certain menus on the SoundPoint IP and SoundStation IP phone that test the phone hardware.
Administrator’s Guide SoundPoint IP / SoundStation IP Power and Startup Symptom Problem Corrective Action There are power issues. The SoundPoint IP / SoundStation IP family SIP phone has no power. Do one of the following: 5 - 10 • Verify that no lights appear on the unit when it is powered up. • Check if the phone is properly plugged into a functional AC outlet. • Make sure that the phone isn't plugged into a plug controlled by a light switch that is off.
Troubleshooting Your SoundPoint IP / SoundStation IP Phones Controls Symptom Problem Corrective Action The dial pad does not work. The dial pad on the SoundPoint IP / SoundStation IP family SIP phone does not respond. Do one of the following: • Check for a response from other feature keys or from the dial pad. • Place a call to the phone from a known working telephone. Check for display updates.
Administrator’s Guide SoundPoint IP / SoundStation IP Access to Screens and Systems Symptom Problem Corrective Action There is no response from feature key presses. The SoundPoint IP / SoundStation IP family SIP phone is not in active state. Do one of the following: The display shows “Network Link is Down”. 5 - 12 The LAN cable is not properly connected. • Press the keys more slowly. • Check to see whether or not the key has been mapped to a different function or disabled.
Troubleshooting Your SoundPoint IP / SoundStation IP Phones Calling Symptom Problem Corrective Action There is no dial tone. Power is not correctly applied to the SoundPoint IP family SIP phone. Do one of the following: Dial tone is not present on one of audio paths. The phone is not registered. The phone does not ring. Ring setting or volume is low. Outbound or inbound calling is unsuccessful. The line icon shows an unregistered line icon. The phone line is unregistered.
Administrator’s Guide SoundPoint IP / SoundStation IP Displays Symptom Problem Corrective Action There is no display. Power is not correctly applied to the SoundPoint IP family SIP phone. Do one of the following: The display is incorrect. The display has bad contrast. The contrast needs adjustment. Outbound or inbound calling is unsuccessful. The display is flickering. 5 - 14 Certain type of older fluorescent lighting causes the display to appear to flicker.
Troubleshooting Your SoundPoint IP / SoundStation IP Phones Audio Symptom Problem Corrective Action There is no audio on the headset. The connections are not correct. Do one of the following: There are audio and echo issues on the headset. Possible issues include: • Echo on external calls through a gateway. • Internal calls (no gateway), handsfree echo. • Internal calls (no gateway), handset to handset echo.
Administrator’s Guide SoundPoint IP / SoundStation IP 5 - 16
A Configuration Files This appendix provides detailed descriptions of certain configuration files used by the Session Initiation Protocol (SIP) application. It is a reference for all parameters that are configurable when using the centralized provisioning installation model. This appendix contains information on: • Master Configuration Files (MAC-address.cfg or 000000000000.cfg) • Application Configuration (sip.cfg) • Per-Phone Configuration (phone1.
Administrator’s Guide SoundPoint IP / SoundStation IP Master Configuration Files The master configuration files can be one of: • Specified master configuration file—The master configuration file can be explicitly specified in the boot server address, for example, http://usr:pwd@server/dir/example1.cfg. The filename must end with .cfg and be at least five characters long. If this file cannot be downloaded, the phone will search for the per-phone master configuration file (described next).
Configuration Files Note Warning • CONFIG_FILES—A comma-separated list of configuration files. Each file name has a maximum length of 255 characters and the list of file names has a maximum length of 2047 characters, including commas and white space. Each configuration file can be specified as a URL with its own protocol, user name and password, for example ftp://usr:pwd@server/dir/phone2034.cfg. • MISC_FILES—A comma-separated list of other required files.
Administrator’s Guide SoundPoint IP / SoundStation IP CONFIG_FILES=”phone1[MACADDRESS].cfg, sip.cfg” MISC_FILES=”” LOG FILE DIRECTORY=”” OVERRIDES_DIRECTORY=”” CONTACTS_DIRECTORY=”” LICENSE_DIRECTORY=””/> If you have a requirement for separate application loads on different phones on the same boot server, you can modify the application that is loaded when each phone reboots. An example is below:
Configuration Files server interface or local menu settings on the phone. These settings include the local port used for SIP signaling, the address and ports of a cluster of SIP application servers, voice codecs, gains, and tones, and other parameters.
Administrator’s Guide SoundPoint IP / SoundStation IP • Microbrowser • Applications • Peer Networking • DNS Cache • Soft Keys Polycom recommends that you create another file with your organization’s modifications. If you must change any Polycom templates, back them up first. For more information, refer to the “Configuration File Management on SoundPoint IP Phones” whitepaper at www.polycom.com/support/voice/.
Configuration Files Server This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation voIpProt.server.dhcp.available 0, 1 0 If set to 1, check with the DHCP server for SIP server IP address. If set to 0, do not check with DHCP server. voIpProt.server.dhcp.option 128 to 255 Null Option to request from the DHCP server if voIpProt.server.dhcp.available = 1. There is no default value for this parameter, it must be filled in with a valid value.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute voIpProt.server.x.transport Permitted Values DNSnaptr or TCPpreferre d or UDPOnly or TLS or TCPOnly Default Interpretation DNSnapt r If set to Null or DNSnaptr: If voIpProt.server.x.address is a hostname and voIpProt.server.x.port is 0 or Null, do NAPTR then SRV look-ups to try to discover the transport, ports and servers, as per RFC 3263. If voIpProt.server.x.address is an IP address, or a port is given, then UDP is used.
Configuration Files Permitted Values Attribute Default Interpretation voIpProt.server.x.retryMaxCount Null or non-negativ e integer 3 If set to 0 or Null, 3 is used. retryMaxCount retries will be attempted before moving on to the next available server. voIpProt.server.x.expires.lineSeize positive integer, minimum 10 30 Requested line-seize subscription period. voIpProt.server.x.lcs 0, 1 0 This attribute overrides the voIpProt.SIP.lcs .
Administrator’s Guide SoundPoint IP / SoundStation IP SIP This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation voIpProt.SIP.useContactInReferTo 0, 1 0 If set to 0, the “To URI” is used in the REFER. If set to 1, the “Contact URI” is used in the REFER. voIpProt.SIP.useRFC2543hold 0, 1 0 If set to 1, use the obsolete c=0.0.0.
Configuration Files Permitted Values Default Interpretation voIpProt.SIP.connectionReuse. useAlias 0, 1 0 If set to 0, this is the old behavior. voIpProt.SIP.sendCompactHdrs 0, 1 Attribute If set to 1, phone uses the connection reuse draft which introduces "alias". 0 If set to 0, SIP header names generated by the phone use the long form, for example ‘From’. If set to 1, SIP header names generated by the phone use the short form, for example ‘f’. voIpProt.SIP.keepalive.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Permitted Values Default Interpretation voIpProt.SIP.authOptimizedInFailover 0,1 0 If set to 1, when failover occurs, the first new SIP request is sent to the server that sent the proxy authentication request. If set to 0, when failover occurs, the first new SIP request is sent to the server with the highest priority in the server list. If reg.x.auth.optimizedInFailover set to Null, this attribute is checked. If voIpProt.SIP.
Configuration Files Attribute Permitted Values Default Interpretation voIpProt.SIP.header.list.useFirst 0, 1 1 If set to 1 or Null, the first diversion header is displayed. If set to 0, the last diversion header is displayed. voIpProt.SIP.header.warning.codes. accept comma separated list Null A list of accepted warning codes. If set to Null, all codes are accepted. Only codes between 300 and 399 are supported. For example, if you want to accept only codes 325 to 330: voIpProt.SIP.header.warning.
Administrator’s Guide SoundPoint IP / SoundStation IP Outbound Proxy This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation IP address or host name and port of a SIP server to which the phone shall send all requests. voIpProt.SIP.outboundProxy.address dotted-deci mal IP address or host name Null voIpProt.SIP.outboundProxy.port 1 to 65535 5060 voIpProt.SIP.outboundProxy.
Configuration Files Alert Information This configuration attribute is defined as follows: Permitted Values Attribute Default Interpretation Alert-Info fields from INVITE requests will be compared against as many of these parameters as are specified (x=1, 2, ..., N) and if a match is found, the behavior described in the corresponding ring class (refer to Ring type on page A-36) will be applied. voIpProt.SIP.alertInfo.x.
Administrator’s Guide SoundPoint IP / SoundStation IP Permitted Values Default Interpretation voIpProt.SIP.requestValidation.x. request.y.event A valid string Null Determines which events specified with the Event header should be validated; only applicable when voIpProt.SIP.requestValidation.x.re quest is set to “SUBSCRIBE” or “NOTIFY”. If set to Null, all events will be validated. voIpProt.SIP.requestValidation. digest.realm A valid string Polycom SPIP Determines string used for Realm.
Configuration Files Music on Hold This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation voIpProt.SIP.musicOnHold.uri string Null A URI that provides the media stream to play for the remote party on hold. If reg.x.musicOnHold is set to Null, this attribute is checked. Note: The SIP URI parameter transport is supported when configured with the values of UDP, TCP, or TLS.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Permitted Values Default Interpretation dialplan.applyToUserSend 0, 1 1 This attribute covers the case when the user presses the Send soft key to send the dialed number. Value interpretation is the same as for dialplan.applyToCallListDial. dialplan.impossibleMatchHandling 0, 1 or 2 0 If set to 0, the digits entered up to and including the point where an impossible match occurred are sent to the server immediately.
Configuration Files — For example, if a customer dials 16092345678, a call is placed to 16002345678. • 911xxx.T— A period (".") which matches an arbitrary number, including zero, of occurrences of the preceding construct — For example: 91112 with waiting time to comply with T is a match 911123 with waiting time to comply with T is a match 9111234 with waiting time to comply with T is a match and the number can grow indefinitely given that pressing the next digit takes less than T.
Administrator’s Guide SoundPoint IP / SoundStation IP This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation dialplan.digitmap string compatible with the digit map feature of MGCP described in 2.1.5 of RFC 3435. String is limited to 768 bytes and 30 segments; a comma is also allowed; when reached in the digit map, a comma will turn dial tone back on;’+’ is allowed as a valid digit; extension letter ‘R’ is used as defined above.
Configuration Files Server This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation dialplan.routing.server.x. address dotted-decimal IP address or host name Null dialplan.routing.server.x.port 1 to 65535 5060 IP address or host name and port of a SIP server that will be used for routing calls. Multiple servers can be listed starting with x=1, 2, ... for fault tolerance.
Administrator’s Guide SoundPoint IP / SoundStation IP Multilingual The multilingual feature is based on string dictionary files downloaded from the boot server. These files are encoded in standalone XML format. Several western European and Asian languages are included with the distribution. Attribute Permitted Values Interpretation lcl.ml.lang Null If Null, the default internal language (US English) will be used, otherwise, the language to be used may be specified in the format language-region.
Configuration Files Attribute Permitted Values Interpretation lcl.ml.lang.clock.x.longFormat 0, 1 If attribute present, overrides lcl.datetime.date.longFormat. If 1, display the day and month in long format (Friday/November), otherwise use abbreviations (Fri/Nov). lcl.ml.lang.clock.x.dateTop 0, 1 If attribute present, overrides lcl.datetime.date.dateTop. If 1, display date above time, otherwise display time above date. lcl.ml.lang.y.
Administrator’s Guide SoundPoint IP / SoundStation IP 4. Add a lcl.ml.lang.clock.menu.x attribute to the configuration file. 5. Add lcl.ml.lang.clock.x.24HourClock, lcl.ml.lang.clock.x.format, lcl.ml.lang.clock.x.longFormat and lcl.ml.lang.clock.x.dateTop attributes and set them according to the regional preferences. 6. (Optional) Set lcl.ml.lang to be the new language_region string.
Configuration Files Date and Time This configuration attribute is defined as follows: Attribute Permitted Values lcl.datetime.time.24HourClock 0,1 If set to 1, display time in 24-hour clock mode rather than a.m./p.m. lcl.datetime.date.format string which includes ‘D’, ‘d’ and ‘M’ and two optional commas Controls format of date string. D = day of week d = day M = month Interpretation Up to two commas may be included.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute up.welcomeSoundOnWarmBootE nabled Permitted Values Default Interpretation 0, 1 0 If set to 1, play welcome sound effect on warm as well as cold boots. If set to 0, only a cold boot will trigger the welcome sound effect. up.localClockEnabled 0, 1 1 If set to 1, display the date and time on the idle display. up.backlight.
Configuration Files Permitted Values Attribute up.mwiVisible 0 - Disabled 1 - Enabled Default Interpretation 0 If set to 0 or Null, there is no MWI for registration x (SIP 2.1.0 and 2.1.1 behavior). If set to 1, msg.mwi.x.callBackMode is set to disabled. MWI notification will be displayed for registration x (Pre-SIP 2.1.0 behavior). up.handsfreeMode 0 - Disabled 1 - Enabled 1 If set to 1 or Null, hands-free speakerphone is enabled. If set to 0, hands-free speakerphone is disabled. up.
Administrator’s Guide SoundPoint IP / SoundStation IP Dual Tone Multi-Frequency This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation tone.dtmf.level -33 to -3 -15 Level of the high frequency component of the DTMF digit measured in dBm0; the low frequency tone will be two dB lower. tone.dtmf.
Configuration Files Attribute Permitted Values Default Interpretation tone.dtmf.viaRtp 0, 1 1 If set to 1, encode DTMF in the active RTP stream, otherwise, DTMF may be encoded within the signaling protocol only when the protocol offers the option. Note: tone.dtmf.chassis.masking should be enabled when tone.dtmf.viaRtp is disabled. tone.dtmf.
Administrator’s Guide SoundPoint IP / SoundStation IP In the following table, x is the chord-set number and cat is one of callProg, ringer, or misc. Attribute Permitted Values tone.chord.cat.x.freq.y 0-1600 Frequency for this component in Hertz; up to four chord-set components can be specified (y=1, 2, 3, 4). tone.chord.cat.x.level.y -57 to 3 Level of this component in dBm0. tone.chord.cat.x.onDur positive On duration in milliseconds, 0=infinite. Interpretation integer tone.chord.cat.x.
Configuration Files In the following table, x is the sampled audio file number. Attribute Permitted Values Interpretation saf.x Null OR valid path name OR an RFC 1738-compliant URL to a HTTP, FTP, or TFTP wave file resource. If Null, the phone will use a built-in file. Note: Refer to the above wave file format restrictions. If set to a path name, the phone will attempt to download this file at boot time from the boot server.
Administrator’s Guide SoundPoint IP / SoundStation IP This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation se.stutterOnVoiceMail 0, 1 1 If set to 1, stuttered dial tone is used in place of normal dial tone to indicate that one or more messages (voice mail) are waiting at the message center. se.appLocalEnabled 0, 1 1 If set to 1, local user interface sound effects such as confirmation/error tones, will be enabled.
Configuration Files Currently, patterns that use the sampled instruction are limited to the following format: sampled followed by optional silence and optional branch back to the beginning. Note In the following table, x is the pattern number, y is the instruction number. Both x and y need to be sequential. There are three categories of sound effect patterns: callProg (Call Progress Patterns), ringer (Ringer Patterns) and misc (Miscellaneous Patterns). Permitted Values Attribute Interpretation se.pat.
Administrator’s Guide SoundPoint IP / SoundStation IP Call progress pattern number Use within phone 7 alternate call waiting tone (distinctive) 8 confirmation tone 9 howler tone (off-hook warning) 10 record warning 11 message waiting tone 12 alerting 13 intercom announcement tone 14 barge-in tone 15 secondary dial tone Ringer Patterns The following table maps ringer pattern numbers to their default descriptions.
Configuration Files Ringer pattern number Default description 18 Sampled audio file 7 19 Sampled audio file 8 20 Sampled audio file 9 21 Sampled audio file 10 22 Sampled audio file 11 Silent Ring will only provide a visual indication of an incoming call, but no audio indication. Note Sampled audio files 1-21 all use the same built-in file unless that file has been replaced with a downloaded file. For more information, refer to Sampled Audio for Sound Effects on page A-30.
Administrator’s Guide SoundPoint IP / SoundStation IP Ring type Ring type is used to define a simple class of ring to be applied based on some credentials that are usually carried within the network protocol. The ring class includes attributes such as call-waiting and ringer index, if appropriate. The ring class can use one of four types of ring that are defined as follows: ring Play a specified ring pattern or call waiting indication.
Configuration Files Note Modification of se.rt.modification.enabled and se.rt.x.name parameters through the user interface will be implemented in a future release. Voice Settings This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation voice.txPacketFilter 0, 1 Null Flag to determine whether or not narrowband Tx high-pass filtering should be enabled. If set to 1, narrowband Tx high-pass filter is enabled.
Administrator’s Guide SoundPoint IP / SoundStation IP Voice Coding Algorithms The following voice codecs are supported: Algorithm MIME Type Label Bit Rate Sample Rate Frame Size Effective Audio Bandwidth G.711μ-law PMCU G711mu 64 Kbps 8 Ksps 10ms - 80ms 3.5 KHz G.711a-law PCMA G711A 64 Kbps 8 Ksps 10ms - 80ms 3.5 KHz G.722 G722/8000 G722 64 Kbps 16 Ksps 10ms - 80ms 7 KHz G.722.1 G7221/16000 G7221 16 Kbps, 24 Kbps, 32 Kbps 16 Ksps 20ms - 80ms 7 KHz G.722.
Configuration Files Attribute Permitted Values Default Interpretation voice.codecPref.IP_300.G711Mu Null, 1-3 1 Specifies the codec preferences for SoundPoint IP 301 models. Interpretation as above. voice.codecPref.IP_300.G711A 2 voice.codecPref.IP_300.G729AB 3 voice.codecPref.IP_650.G711Mu Null, 1-4 2 voice.codecPref.IP_650.G711A 3 voice.codecPref.IP_650.G729AB 4 voice.codecPref.IP_650.G722 1 voice.codecPref.IP_4000.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Permitted Values Default Interpretation voice.codecPref.IP_7000.G711Mu Null, 1-16 6 Specifies the codec preferences for the SoundStation IP 7000 platform. Interpretation as above. voice.codecPref.IP_7000.G711A 7 voice.codecPref.IP_7000.G722 4 voice.codecPref.IP_7000.G7221.16kbps Null voice.codecPref.IP_7000.G7221.24kbps Null voice.codecPref.IP_7000.G7221.32kbps 5 voice.codecPref.IP_7000.G7221C. 24kbps Null voice.codecPref.
Configuration Files Codec Profiles The following profile attributes can be adjusted for each of the five supported codecs. In the table, x=G711Mu, G711A, G722, G7221, G7221C, and G729AB, Lin16, Siren14, and Siren22. Attribute Permitted Values voice.audioProfile.x.payloadSize 10, 20, 30, ...80 Interpretation Preferred Tx payload size in milliseconds to be provided in SDP offers and used in the absence of ptime negotiations. This is also the range of supported Rx payload sizes.
Administrator’s Guide SoundPoint IP / SoundStation IP Volume Persistence The user’s selection of the receive volume during a call can be remembered between calls. This can be configured per termination (handset, headset and hands-free/chassis). In some countries regulations exist which dictate that receive volume should be reset to nominal at the start of each call on handset and headset. Attribute Permitted Values Default Interpretation voice.volume.persist.handset 0, 1 0 voice.volume.
Configuration Files Attribute Default voice.gain.rx.analog.ringer.IP_430 0 voice.gain.rx.analog.ringer.IP_601 6 voice.gain.rx.analog.ringer.IP_650 0 voice.gain.rx.analog.ringer.IP_6000 0 voice.gain.rx.analog.ringer.IP_7000 0 voice.gain.rx.digital.handset -15 voice.gain.rx.digital.headset -21 voice.gain.rx.digital.chassis 0 voice.gain.rx.digital.chassis.IP_330 6 voice.gain.rx.digital.chassis.IP_430 6 voice.gain.rx.digital.chassis.IP_4000 0 voice.gain.rx.digital.chassis.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Default voice.gain.tx.analog.chassis.IP_430 36 voice.gain.tx.analog.chassis.IP_601 0 voice.gain.tx.analog.chassis.IP_650 36 voice.gain.tx.analog.chassis.IP_6000 0 voice.gain.tx.analog.chassis.IP_7000 0 voice.gain.tx.digital.handset 0 voice.gain.tx.digital.handset.IP_330 10 voice.gain.tx.digital.handset.IP_430 10 voice.gain.tx.digital.handset.IP_650 6 voice.gain.tx.digital.headset 0 voice.gain.tx.digital.headset.
Configuration Files Attribute Default voice.handset.txag.adjust.IP_650 18 voice.handset.sidetone.adjust.IP_330 3 voice.handset.sidetone.adjust.IP_430 3 voice.handset.sidetone.adjust.IP_650 0 voice.headset.rxag.adjust.IP_330 4 voice.headset.rxag.adjust.IP_430 1 voice.headset.rxag.adjust.IP_650 1 voice.headset.txag.adjust.IP_330 21 voice.headset.txag.adjust.IP_430 39 voice.headset.txag.adjust.IP_650 21 voice.headset.sidetone.adjust.IP_330 -3 voice.headset.sidetone.adjust.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Default voice.aec.hd.lowFreqCutOff 100 voice.aec.hd.highFreqCutOff 7000 voice.aec.hd.erlTab_0_300 -24 voice.aec.hd.erlTab_300_600 -24 voice.aec.hd.erlTab_600_1500 -24 voice.aec.hd.erlTab_1500_3500 -24 voice.aec.hd.erlTab_3500_7000 -24 voice.aec.hf.enable 1 voice.aec.hf.lowFreqCutOff 100 voice.aec.hf.highFreqCutOff 7000 voice.aec.hf.erlTab_0_300 -6 voice.aec.hf.erlTab_300_600 -6 voice.aec.hf.erlTab_600_1500 -6 voice.
Configuration Files Attribute Default voice.aes.hf.duplexBalance.2 6 voice.aes.hf.duplexBalance.3 6 voice.aes.hf.duplexBalance.4 5 voice.aes.hf.duplexBalance.5 4 voice.aes.hf.duplexBalance.6 4 voice.aes.hf.duplexBalance.7 3 voice.aes.hf.duplexBalance.8 2 voice.aes.hf.duplexBalance.IP_4000.0 10 voice.aes.hf.duplexBalance.IP_4000.1 9 voice.aes.hf.duplexBalance.IP_4000.2 8 voice.aes.hf.duplexBalance.IP_4000.3 7 voice.aes.hf.duplexBalance.IP_4000.4 6 voice.aes.hf.duplexBalance.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Default voice.ns.hf.enable 1 voice.ns.hf.signalAttn -6 voice.ns.hf.silenceAttn -9 voice.ns.hf.IP_4000.enable 1 voice.ns.hf.IP_4000.signalAttn -6 voice.ns.hf.IP_4000.silenceAttn -9 Automatic Gain Control These settings control the performance of the transmit automatic gain control feature. Note Automatic Gain Control will be implemented in a future release. Polycom recommends that you do not change these values.
Configuration Files Receive Equalization These settings control the performance of the receive equalization feature. Polycom recommends that you do not change these values. Attribute Default voice.rxEq.hs.IP_330.preFilter.enable 1 voice.rxEq.hs.IP_430.preFilter.enable 1 voice.rxEq.hs.IP_500.preFilter.enable 1 voice.rxEq.hs.IP_600.preFilter.enable 1 voice.rxEq.hs.IP_601.preFilter.enable 1 voice.rxEq.hs.IP_650.preFilter.enable 1 voice.rxEq.hs.IP_330.postFilter.enable 0 voice.rxEq.hs.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Default voice.rxEq.hf.IP_330.preFilter.enable 1 voice.rxEq.hf.IP_430.preFilter.enable 1 voice.rxEq.hf.IP_500.preFilter.enable 1 voice.rxEq.hf.IP_600.preFilter.enable 1 voice.rxEq.hf.IP_601.preFilter.enable 1 voice.rxEq.hf.IP_650.preFilter.enable 1 voice.rxEq.hf.IP_4000.preFilter.enable 0 voice.rxEq.hf.IP_6000.preFilter.enable 0 voice.rxEq.hf.IP_7000.preFilter.enable 0 voice.rxEq.hf.IP_330.postFilter.enable 0 voice.rxEq.
Configuration Files Attribute Default voice.txEq.hs.IP_601.preFilter.enable 0 voice.txEq.hs.IP_650.preFilter.enable 1 voice.txEq.hs.IP_330.postFilter.enable 1 voice.txEq.hs.IP_430.postFilter.enable 1 voice.txEq.hs.IP_500.postFilter.enable 1 voice.txEq.hs.IP_600.postFilter.enable 1 voice.txEq.hs.IP_601.postFilter.enable 1 voice.txEq.hs.IP_650.postFilter.enable 1 voice.txEq.hd.IP_330.preFilter.enable 0 voice.txEq.hd.IP_430.preFilter.enable 0 voice.txEq.hd.IP_500.preFilter.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Default voice.txEq.hf.IP_430.postFilter.enable 1 voice.txEq.hf.IP_500.postFilter.enable 1 voice.txEq.hf.IP_600.postFilter.enable 1 voice.txEq.hf.IP_601.postFilter.enable 1 voice.txEq.hf.IP_650.postFilter.enable 1 voice.txEq.hf.IP_4000.postFilter.enable 0 voice.txEq.hf.IP_6000.postFilter.enable 0 voice.txEq.hf.IP_7000.postFilter.
Configuration Files • Server • RTCP-XR Central Report Collector This configuration attribute is defined as follows: Permitted Values Default Interpretation voice.qualityMonitoring.collector.enable. periodic 0, 1 0 Enables generation of periodic quality reports throughout a call. voice.qualityMonitoring.collector.enable. session 0, 1 0 Enables generation of a quality report at the end of each call. voice.qualityMonitoring.collector.enable.
Administrator’s Guide SoundPoint IP / SoundStation IP Alert Reports This configuration attribute is defined as follows: Attribute voice.qualityMonitoring.collector. alert.moslq.threshold.warning Permitted Values Default Interpretation Null, 15 to 40 Null Threshold value of listening MOS score (MOS-LQ) that causes phone to send a warning alert quality report. Configure the desired MOS value multiplied by 10. If set to Null, warning alerts are not generated due to MOS-LQ.
Configuration Files Server This configuration attribute is defined as follows: Permitted Values Attribute Default Interpretation voice.qualityMonitoring.collector.server.x. address Dotted-decima l IP address or host name Null IP address or host name and port of a SIP server (report collector) that accepts voice quality reports contained in SIP PUBLISH messages. Set x to 1as only one report collector is supported at this time. voice.qualityMonitoring.collector.server.x.
Administrator’s Guide SoundPoint IP / SoundStation IP RTP These parameters apply to RTP packets. Attribute Permitted Values Default Interpretation qos.ethernet.rtp.user_priority 0-7 5 User-priority used for RTP packets. Call Control These parameters apply to call control packets, such as the network protocol signaling. Attribute Permitted Values Default Interpretation qos.ethernet.callControl.user_priority 0-7 5 User-priority used for call control packets.
Configuration Files RTP These parameters apply to RTP packets. Attribute Permitted Values Default Interpretation qos.ip.rtp.dscp 0 to 63 or EF or any of AF11,AF12, AF13,AF21, AF22,AF23, AF31,AF32, AF33,AF41, AF42,AF43 Null This parameter allows the DSCP of packets to be specified. If set to a value, this will override the other qos.ip.rtp… parameters. Default of Null which means the other qos.ip.rtp… parameters will be used. qos.ip.rtp.
Administrator’s Guide SoundPoint IP / SoundStation IP Call Control These parameters apply to call control packets, such as the network protocol signaling. Permitted Values Attribute Default Interpretation qos.ip.callControl.dscp 0 to 63 or EF or any of AF11,AF12, AF13,AF21, AF22,AF23, AF31,AF32, AF33,AF41, AF42,AF43 Null This parameter allows the DSCP of packets to be specified. If set to a value this will override the other qos.ip.callControl… parameters.
Configuration Files Network Monitoring Polycom recommends that you do not change these values. This configuration attribute is defined as follows: Attribute Permitted Values Default tcpIpApp.netMon.enabled 0, 1 1 tcpIpApp.netMon.period 1 to 86400 30 Time Synchronization The following table describes the parameters used to set up time synchronization and daylight savings time. The defaults shown will enable daylight savings time (DST) for North America.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Permitted Values Default Interpretation tcpIpApp.sntp.address.overrideDHCP 0, 1 0 These parameters determine whether configuration file parameters override DHCP parameters for the SNTP server address and Greenwich Mean Time (GMT) offset. If set to 0, DHCP values will override configuration file parameters. If set to 1, the configuration file parameters will override DHCP values. tcpIpApp.sntp.
Configuration Files Attribute Permitted Values Default Interpretation tcpIpApp.sntp.daylightSavings.start.date 1-31 8 If fixedDayEnable is set to 1, use as day of the month to start DST. If fixedDayEnable is set to 0, us the mapping: 1 = the first occurrence of a given day-of-the-week in a month, 8 = the second occurrence of a given day-of-the-week in a month, 15 = the third occurrence of a given day-of-the-week in a month, 22 = the fourth occurrence of a given day-of-the-week in a month tcpIpApp.
Administrator’s Guide SoundPoint IP / SoundStation IP Port This attribute includes: • RTP RTP This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation tcpIpApp.port.rtp.filterByIp 0, 1 1 If set to 1, reject RTP packets arriving from (sent from) a non-negotiated (through SDP) IP address. tcpIpApp.port.rtp.filterByPort 0, 1 0 If set to 1, reject RTP packets arriving from (sent from) a non-negotiated (through SDP) port.
Configuration Files Keep-Alive Allowing for the configuration of TCP keep-alive on SIP TLS connections, the phone can detect a failures quickly (in minutes) and attempt to re-register with the SIP call server (or its redundant pair). This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation tcpIpApp.keepalive.tcp.idleTransmitInterval 10 to 7200 Null After idle x seconds, the keep-alive message is sent to the call server.
Administrator’s Guide SoundPoint IP / SoundStation IP This attribute also includes: Configuration Configuration This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation httpd.cfg.enabled 0, 1 1 If set to 1, the HTTP server configuration interface will be enabled. httpd.cfg.port 1-65535 80 Port is 80 for HTTP servers. Care should be taken when choosing an alternate port.
Configuration Files Attribute call.dialtoneTimeOut Permitted Values Null, positive integer Default Interpretation 60 Time in seconds to allow the dialtone to be played before dropping the call. If set to 0, the call is not dropped. If set to Null, call dropped after 60 seconds. call.lastCallReturnString string of maximum length 32 *69 The string sent to the server when the user selects the “last call return” action. call.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Permitted Values Default Interpretation call.singleKeyPressConference 0,1 0 If set to 1, the conference will be setup after a user presses the Conference soft key or Conference key the first time. Also, all sound effects (dial tone, DTMF tone while dialing and ringing back) are heard by all existing participants in the conference. If set to 0 or Null, sound effects are only heard by conference initiator (old behavior).
Configuration Files Shared Calls This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation call.shared.disableDivert 0, 1 1 If set to 1, disable diversion feature for shared lines. Note: This feature is disabled on most call servers. call.shared.seizeFailReorder 0, 1 1 If set to 1, play re-order tone locally on shared line seize failure. call.shared.
Administrator’s Guide SoundPoint IP / SoundStation IP Directory
This attribute includes: • Local Directory • Corporate Directory Local Directory The local directory is stored in either flash memory or RAM on the phone. The local directory size is limited based on the amount of flash memory in the phone. (Different phone models have variable flash memory.Configuration Files Attribute Permitted Values Default Interpretation dir.local.nonVolatile.maxSize.8meg 1 to 100 100 Attribute applies only to platforms with 8 Mbytes or more of flash memory. This is the maximum size of non-volatile storage that the directory will be permitted to consume. dir.local.readonly 0, 1 1 Specifies whether or not local contact directory is read only. If set to 0 or Null, the local contact directory is editable. If set to 1, the local contact directory is read only.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Permitted Values Default Interpretation dir.corp.baseDN UTF-8 encoded string Null The base domain name is the starting point for making queries on the LDAP server. dir.corp.user UTF-8 encoded string Null The username used to authenticate to the LDAP server. dir.corp.password UTF-8 encoded string Null The password used to authenticate to the LDAP server. dir.corp.
Configuration Files Attribute Permitted Values Default Interpretation dir.corp.attribute.x.sticky 0, 1 Null If set to 0 or Null, the filter criteria for this attribute is reset after a reboot. If set to 1, the filter criteria for this attribute is retained through a reboot. Such attributes are denoted with a “*” before the label when displayed on the phone. dir.corp.attribute.x.filter UTF-8 encoded string Null The filter string for this attribute, which is edited when searching. dir.corp.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Permitted Values Default Interpretation dir.corp.cacheSize 8 to 256 64 The maximum number of entries that can be cached locally on the phone. dir.corp.pageSize 8 to 64 16 The maximum number of entries requested from the corporate directory server with each query. Presence The parameter pres.reg is the line number used to send SUBSCRIBE. If this parameter is missing, the phone will use the primary line to send SUBSCRIBE.
Configuration Files • is a free string of characters that typically carries the meaning of the font. Examples are “fontFixedSize” for a fixed-size font, or “fontProportionalSize” for a proportional size font. • describes the font height in number of screen pixels. • describes the Unicode range covered by this font. Since .fnt or .fon are 256 characters based blocks, the is Uxx00_UxxFF (.fnt file) or Uxx00_UyyFF (.fon file).
Administrator’s Guide SoundPoint IP / SoundStation IP to include support for a large number of font ranges at once; otherwise, if simply adding or changing a few fonts currently in use, multiple .fnt files are recommended since they are easier to work with individually. This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation font.delimiter string up to 256 ASCII characters Null Delimiter required to retrieve different grouped .fnt blocks.
Configuration Files IP_500 font This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation font.IP_500.x.name fontName_height_Uxx00_U yyFF.fon OR fontName_height_Uxx00_U xxFF.fnt Null Defines the font file that will be loaded from boot server during boot up. Note: When several font.IP_500.x.name are defined, the index x must follow consecutive increasing order.
Administrator’s Guide SoundPoint IP / SoundStation IP Polycom does not recommend the remapping for keys. In the following table, x=IP_300, IP_330, IP 430, IP_500, IP_550, IP_600, IP_650, and IP_4000, and IP_7000 and y is the key number.
Configuration Files Backgrounds The backgrounds used by the SoundPoint IP 550, 560, 650, and 670 phones are defined in this section. In the following table, w=1 to 3, x=1 to 6. This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation bg.hiRes.color.selection w,x 1,1 Specify which type of background (w) and index for that type (x) is selected on reboot where w=1 to 3, x=1 to 6. bg.hiRes.color.pat.solid.x. name any string bg.hiRes.color.pat.solid.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute button.color.selection.x.y. modify Permitted Values Default any string Interpretation The label color for soft keys and line key labels associated with the defined backgrounds. These values can be modified locally by the user. The format is: “rgbHILo, ”. For example: “rbgHiLo, 51, 255, 68, 255, 0, 119” is the default button color associated with the built-in background. bg.gray.selection w,x bg.hiRes.gray.pr.x.adj bg.
Configuration Files Attribute Permitted Values bg.hiRes.gray.bm.x.name any string bg.hiRes.gray.bm.x.em.name any string Graphic files for display on the phone and Expansion Module and also the brightness adjustment to the graphic. bg.hiRes.gray.bm.x.adj integer For x=1: Default Interpretation • name is “Leaf.jpg” name is “LeafEM.jpg” adjustment is “0” For x=2: • name is “Sailboat.jpg” name is “SailboatEM.jpg” adjustment is “-3” For x=3: • name is “Beach.jpg” name is “BeachEM.
Administrator’s Guide SoundPoint IP / SoundStation IP Bitmaps The bitmaps used by each phone model are defined in this section. Platform , , , , , , and In the following table, x=IP_300, IP_330, IP_400, IP_500, IP_600, IP_4000, or IP_7000 and y is the bitmap number.
Configuration Files This configuration attribute is defined as follows: Permitted Values Attribute ind.idleDisplay.mode ind.idleDisplay.enabled 1 (default), 2, 3 0, 1 Default Interpretation Null The idle display animation screen layouts. For example, for the SoundPoint IP 330/320: 0 • If set to 1 or Null, the idle display animation size is 87 x 11 pixels. • If set to 2, the idle display animation size is 87 x 22 pixels. • If set to 3, the idle display animation size is 102 x 22 pixels.
Administrator’s Guide SoundPoint IP / SoundStation IP Patterns This section defines patterns for the LED indicators. In the following table, x is the pattern number, y is the step in the pattern. Attribute Permitted Values Interpretation ind.pattern.x.step.y.state On or Off Turn LED on or off for this step. ind.pattern.x.step.y.duration positive integer Duration in milliseconds for this step. 0=infinite ind.pattern.x.step.y.
Configuration Files LEDs In the following table, x is the LED number. Attribute Permitted Values ind.led.x.index ind.led.x.class Interpretation This is for internal usage only and should not be changed (this is the logical index). positive integer ind.led.x.physNum Assigns the class (defined in Classes on page A-82) for this indicator. This maps the logical index to a specific physical LED.
Administrator’s Guide SoundPoint IP / SoundStation IP Permitted Values Attribute ind.gi.x.y.physY IP 300: 0-3 IP 330: 0-19 IP 400: 0-45 Interpretation For Graphic Icon type indicators, this is the y-axis location of the upper left corner of the indicator measured in pixels from top to bottom. IP 500: 0-79 IP 600: 0-159 IP 4000: 0-67 IP 7000: 0-127 ind.gi.x.y.physW IP 300: n/a IP 330: 1-87 For Graphic Icon type indicators, this is the width of the indicator measured in pixels.
Configuration Files Each event in the log contains the following fields separated by the | character: • time or time/date stamp • 1-5 character component identifier (such as “so”) • event class • cumulative log events missed due to excessive CPU load • free form text - the event description Example: 011511.006|so |2|00|soCoreAudioTermChg: chassis -> idle time stamp ID event class missed events text Three formats are available for the event timestamp: Type Example 0 - seconds.
Administrator’s Guide SoundPoint IP / SoundStation IP Basic Logging and This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation log.level.change.xxx 0-5 4 Control the logging detail level for individual components. These are the input filters into the internal memory-based log system.
Configuration Files Permitted Values Attribute Default Interpretation log.render.file.size positive integer, 1 to 179.5 16 Maximum local application log file size in Kbytes. When this size is exceeded, the file is uploaded to the boot server and the local copy is erased. log.render.file.upload.period positive integer 172800 Time in seconds between log file uploads to the boot server. Note: The log file will not be uploaded if no new events have been logged since the last upload. log.render.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Permitted Values Interpretation log.sched.x.startMode abs, rel Start at absolute time or relative to boot. log.sched.x.startTime positive integer OR hh:mm Seconds since boot when startMode is rel or the start time in 24-hour clock format when startMode is abs. log.sched.x.startDay 1-7 When startMode is abs, specifies the day of the week to start command execution. 1=Sun, 2=Mon, ...
Configuration Files Encryption This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation sec.encryption.upload.dir 0, 1 0 If set to 0, the phone-specific contact directory is uploaded to the server unencrypted regardless of how it was downloaded. This will replace whatever phone-specific contact directory is on the server even if it is encrypted.
Administrator’s Guide SoundPoint IP / SoundStation IP Provisioning This attribute’s settings control aspects of the phone’s boot server provisioning system. Attribute Permitted Values Default Interpretation prov.fileSystem.rfs0.minFreeSpace 5-512 5 Minimum free space in Kbytes to reserve in the file system when downloading files from the boot server. prov.fileSystem.ffs0.4meg.minFreeSpace 420 prov.fileSystem.ffs0.2meg.minFreeSpace 48 prov.fileSystem.ffs0.8meg.
Configuration Files This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation ramdisk.enable 0, 1 1 If set to 1, RAM disk will be available. The RAM disk is used to cache downloaded wave files, and other resources for the user interface. ramdisk.bytesPerBlock 0, 32, 33, ..., 1024 0 These four parameters use internal defaults when value is set to 0. ramdisk.blocksPerTrack 0, 1, 2, ..., 65536 0 ramdisk.nBlocks 0, 1, 2, ..., 65536 4096 ramdisk.
Administrator’s Guide SoundPoint IP / SoundStation IP Feature These settings control the activation or deactivation of a feature at run time. In the table below, x is the feature number. Attribute Permitted Values Interpretation feature.x.
Configuration Files Attribute Permitted Values Interpretation feature.x.enabled 0 or 1 (default) except for x=9 If set to 0, the feature will be disabled. If set to 1, the feature will be enabled and usable by the local user. Note: The "url-dialing" feature must be disabled by setting feature.9.enabled to 0 in order to prevent unknown callers from being identified on the display by an IP address.
Administrator’s Guide SoundPoint IP / SoundStation IP Finder This configuration attribute is defined as follows: Attribute res.finder.sizeLimit Permitted Values positive integer Default Interpretation 300 If a resource that is being downloaded to the phone is larger than this value * 1024 bytes (= the maximum size), the resource will be automatically truncated to the maximum size defined.
Configuration Files Attribute Permitted Values res.quotas.x.value positive integer Interpretation When a particular resource (one of category “font”, “bitmap”, or “font”) is downloaded to the phone, a quota equal to this value * 1024 bytes of compound data size is applied for that category. If downloading a resource would exceed the quota for that category, the resource will not be downloaded and a predefined default will be used instead. For res.quotas.x.
Administrator’s Guide SoundPoint IP / SoundStation IP Idle Display The Microbrowser can be used to create a display that will be part of the phone’s idle display. These settings control the home page and the refresh rate. Attribute Permitted Values Default Interpretation mb.idleDisplay.home Null or any fully formed valid HTTP URL. Length up to 255 characters. Null URL used for Microbrowser idle display home page. For example: http://www.example.com/xhtml/frontpage.cgi?pa ge=home.
Configuration Files Main Browser This setting controls the home page used by the Microbrowser when that function is selected. Attribute Permitted Values Default Interpretation mb.main.home Any fully formed valid HTTP URL. Length up to 255 characters. Null URL used for Microbrowser home page. If blank, the browser will notify the user that a blank home-page was used. For example: http://www.example.com/xhtml/frontpage.cgi?pa ge=home. mb.main.
Administrator’s Guide SoundPoint IP / SoundStation IP Browser Limits These settings limit the size of object which the Microbrowser will display by limiting the amount of memory available for the Microbrowser. Attribute Permitted Values Default Interpretation mb.limits.nodes positive integer 256 Limits the number of tags that the XML parser will handle. This limits the amount of memory used by complicated pages. A maximum total of 500 (256 each) is recommended.
Configuration Files Attribute Permitted Values Default Interpretation apps.statePolling.URL URL Null The URL to which the phone sends call processing state/device/network information. The protocol used can be either HTTP or HTTPS. Note: To enable state polling, the attributes apps.statePolling.URL, apps.statePolling.username, and apps.statePolling.password must be set to non-Null values. apps.statePolling. username string Null The user name to access the state polling URL. apps.statePolling.
Administrator’s Guide SoundPoint IP / SoundStation IP Peer Networking Peer networking manages communications between Polycom devices. For the SoundStation IP 7000 conference phone, it manages daisy-chaining and video integation with the HDX video systems. This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation pnet.role “auto” Null The role of the SoundStation IP 7000 when communicating with other Polycom devices.
Configuration Files NAPTR This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation dns.cache.NAPTR.x. name domain name string Null The domain name to which this resource record refers. dns.cache.NAPTR.x.ttl 300 to 65535 300 Specifies the time interval (in seconds) that the resource record may be cached before the source of the information should again be consulted. dns.cache.NAPTR.x.
Administrator’s Guide SoundPoint IP / SoundStation IP SRV This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation dns.cache.SRV.x.name domain name string Null The domain name string with SRV prefix. dns.cache.SRV.x.ttl 0 to 65535, seconds 300 Specifies the time interval that the resource record may be cached before the source of the information should again be consulted. dns.cache.SRV.x.
Configuration Files Soft Keys This configuration attribute is defined as follows (where x =1 to maximum number of defined soft keys): Attribute Permitted Values Default Interpretation softkey.x.label string Null This is the text displayed with the soft key. If set to Null, the label to display is determined as follows: softkey.x.action string Null softkey.x.enable 0 (default) 1 Null 0 (default) 1 Null softkey.x.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute softkey.x.use.alerting Permitted Values 0 (default) 1 Default Interpretation Null If set to 0 or Null, the soft key is not displayed in the alerting state. If set to 1, the soft key is displayed in the alerting state. softkey.x.use.dialtone 0 (default) 1 Null If set to 0 or Null, the soft key is not displayed in the dialtone state. If set to 1, the soft key is displayed in the dialtone state. softkey.x.use.
Configuration Files Attribute softkey.feature.directories Permitted Values 0 1 Null (default) Default Interpretation Null If set to Null, the Dir soft key is displayed on the SoundPoint IP 320/330 phone, but not on any other phone. If set to 0, the Dir soft key is not displayed on any phone. If set to 1, the Dir soft key is displayed on all phones as follows: softkey.feature.callers 0 1 Null (default) Null • In the idle state, it is displayed after the New Call and Callers soft keys.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Permitted Values Default Interpretation softkey.feature.buddies 0 or 1 1 If set to 0, the Buddies soft key is not displayed. If set to 1 or Null, the Buddies soft key is displayed. Note: pres.idleSoftKeys must be set to 1 for this soft key to be displayed. softkey.feature. basicCallManagement.
Configuration Files • User Preferences Registration SoundPoint IP 301, 320, 330, and 430 support a maximum of two unique registrations, SoundPoint IP 501 supports three, the SoundPoint IP 550 and 560 supports four, and SoundPoint IP 600, 601, 650, and 670 support six.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Permitted Values Default Interpretation reg.x.auth.userId string Null User ID to be used for authentication challenges for this registration. If non-Null, will override the “Reg User x” parameter entered into the Authentication submenu off of the Settings menu on the phone. reg.x.auth.password string Null Password to be used for authentication challenges for this registration.
Configuration Files Attribute Permitted Values Default Interpretation reg.x.lineKeys 1 to max 1 max = the number of line keys on the phone. max = 1 on SoundStation IP 4000, 6000, 7000, max = 2 on IP 301, 320, 330, 430, max = 3 on IP 501, max = 4 on IP 550, 560, max = 6 on IP 600, max = 48 on IP 601, 650, 670 (without any Expansion Modules attached, only 6 line keys are available) The number of line keys on the phone to be associated with registration ‘x’. reg.x.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute reg.x.outboundProxy.transport Permitted Values DNSnaptr or TCPpreferred or UDPOnly or TLS or TCPOnly Default Interpretation DNSnap tr If set to Null or DNSnaptr: If reg.x.outboundProxy.address is a hostname and reg.x.outboundProxy.port is 0 or Null, do NAPTR then SRV look-ups to try to discover the transport, ports and servers, as per RFC 3263. If reg.x.outboundProxy.address is an IP address, or a port is given, then UDP is used.
Configuration Files Attribute Permitted Values Default Interpretation reg.x.auth.optimizedInFailover 0, 1 0 If set to 1, when failover occurs, the first new SIP request is sent to the server that sent the proxy authentication request. If set to 0, when failover occurs, the first new SIP request is sent to the server with the highest priority in the server list. If this parameter is Null, voIpProt.SIP.authOptimizedInFailover is checked. If both parameters are set, this parameter takes precedence.
Administrator’s Guide SoundPoint IP / SoundStation IP Do Not Disturb This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation call.donotdisturb.perReg 0, 1 0 If set to 1, the DND feature will allow selection of DND on a per-registration basis. NOTE: If voIpProt.SIP.serverFeatureControl.dnd is set to 1 (enabled), this parameter is ignored. For more information, refer to SIP on page A-10.
Configuration Files Missed Call Tracking You can enable/disable missed call tracking on a per-line basis. In the following table, x is the registration number. IP 301, 320, 330, 430: x=1-2; IP 501: x=1-3; IP 550, 560: x=1-4; IP 600: x=1-6; IP 601: x=1-12; IP 650, 670: x=1-34; IP 4000: x=1; IP 6000: x=1; IP 7000: x=1. Attribute Permitted Values Default Interpretation call.missedCallTracking.x.enabled 0, 1 1 If set to 1 or Null, missed call tracking is enabled. If call.
Administrator’s Guide SoundPoint IP / SoundStation IP Diversion The phone has a flexible call forward/diversion feature for each registration. In all cases, a call will only be diverted if a non-Null contact has been configured. In the following tables, x is the registration number. IP 301, 320, 330, 430: x=1-2; IP 501: x=1-3; IP 550, 560: x=1-4; IP 600: x=1-6; IP 601: x=1-12; IP 650, 670: x=1-34; IP 4000: x=1; IP 6000: x=1; IP 7000: x=1.
Configuration Files Busy Calls can be automatically diverted when the phone is busy. Attribute Permitted Values Default Interpretation divert.busy.x.enabled 0, 1 1 If set to 1, calls will be forwarded on busy to the contact specified below. Note: If server-based call forwarding is enabled, this parameter is disabled. divert.busy.x.timeout positive integer 60 Time in seconds to allow altering before initiating the diversion. divert.busy.x.
Administrator’s Guide SoundPoint IP / SoundStation IP Do Not Disturb The phone can automatically divert calls when Do Not Disturb (DND) is enabled. Attribute Permitted Values Default Interpretation divert.dnd.x.enabled 0, 1 0 If set to 1, calls will be forwarded on DND to the contact specified below. Note: If server-based DND or server-base call forwarding is enabled, this parameter is disabled. divert.dnd.x.
Configuration Files Attribute Permitted Values Default Interpretation dialplan.x.applyToUserDial 0, 1 1 When present, and if dialplan.x.digitmap is not Null, this attribute overrides the global dial plan defined in the sip.cfg configuration file. For interpretation, refer to Dial Plan on page A-17. dialplan.x.applyToUserSend 0, 1 1 When present, and if dialplan.x.digitmap is not Null, this attribute overrides the global dial plan defined in the sip.cfg configuration file.
Administrator’s Guide SoundPoint IP / SoundStation IP This configuration attribute is defined as follows: Permitted Values Attribute dialplan.x.digitmap dialplan.x.digitmap.timeOut Default Interpretation A string compatible with the digit map feature of MGCP described in 2.1.
Configuration Files Emergency In the following attributes, y is the index of the emergency entry description and z is the index of the server associated with the emergency entry y. For each emergency entry (index y), one or more server entry (indexes (y,z)) can be configured. y and z must both follow single step increasing numbering starting at 1. This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation dialplan.x.routing.emergency. y.
Administrator’s Guide SoundPoint IP / SoundStation IP Message Waiting Indicator In the following table, x is the registration number. IP 301, 320, 330, 430: x=1-2; IP 501: x=1-3; IP 550, 560: x=1-4; IP 600: x=1-6; IP 601: x=1-12; IP 650, 670: x=1-34; IP 4000: x=1; IP 6000: x=1; IP 7000: x=1. This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation msg.mwi.x.
Configuration Files This configuration attribute is defined as follows: Permitted Values Attribute Default Interpretation nat.ip dotted-decima l IP address Null IP address to advertise within SIP signaling - should match the external IP address used by the NAT device. nat.signalPort 1024 to 65535 Null If non-Null, this port will be used by the phone for SIP signaling, overriding the value set for voIpProt.local.signalPort in sip.cfg. nat.
Administrator’s Guide SoundPoint IP / SoundStation IP This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation attendant.uri string Null For attendant console / busy lamp field (BLF) feature. This specifies the list SIP URI on the server. If this is just a user part, the URI is constructed with the server host name/IP. attendant.reg positive integer 1 For attendant console / BLF feature.
Configuration Files Roaming Privacy Note This attribute is used in conjunction with Microsoft Live Communications Server 2005 only. This configuration attribute is defined as follows: Attribute roaming_privacy.reg Permitted Values positive integer Default Interpretation Null Specifies the line/registration number which has roaming privacy support enabled. If Null, roaming privacy is disabled. If value < 1, then value is replaced with 1.
Administrator’s Guide SoundPoint IP / SoundStation IP Flash Parameter Configuration Any field in the bootROM setup menu and the application SIP Configuration menu can be set through a configuration file. A DHCP server can be configured to point the phones to a boot server that has the required configuration files. The new settings will be downloaded by the phones and used to configure them. This removes the need for manual interaction with phones to configure basic settings.
Configuration Files This flash attributes are defined as follows: Name Possible Values Description device.set 0 or 1 default = 0 If set to 0, do not use any device.xxx.yyy fields to set any parameters. Set this to 0 after the initial installation. If set to 1, use the device.xxx.yyy fields that have device.xxx.yyy.set = 1. Set this to 1 for the initial installation only. device.xxx.yyy.set 0 or 1 default = 0 If set to 0, do not use the device.xxx.yyy value. If set to 1, use the device.xxx.
Administrator’s Guide SoundPoint IP / SoundStation IP Name Possible Values Description device.prov.serverName any string For descriptions, refer to Server Menu on page 3-9. device.prov.serverType 0 to 4 device.prov.user any string device.prov.password any string device.prov.appProvType 0 or 1 device.prov.appProvString any string device.prov. redunAttemptLimit 10, Null device.prov. redunInterAttemptDelay 300, Null device.sntp.
Configuration Files Name Possible Values Description device.syslog.facility 0 to 23 A description of what generated the log message. For more information, refer to section 4.1.1 of RFC 3165. The default value is 16, which maps to “local 0”. device.syslog.renderLevel 0 to 6 Specifies the lowest class of event that will be rendered to syslog. It is based on log.render.level and can be a lower value. Refer to Basic Logging and on page A-86. device.syslog.
Administrator’s Guide SoundPoint IP / SoundStation IP A - 128
B Session Initiation Protocol (SIP) This chapter provides a description of the basic Session Initiation Protocol (SIP) and the protocol extensions that are supported by the current SIP application. To find the applicable Request For Comments (RFC) document, go to http://www.ietf.org/rfc.html and enter the RFC number. This chapter contains information on: • Basic Protocols—All the basic calling functionality described in the SIP specification is supported. Transfer is included in the basic SIP support.
Administrator’s Guide SoundPoint IP / SoundStation IP RFC and Internet Draft Support The following RFC’s and Internet drafts are supported: B-2 • RFC 1321—The MD5 Message-Digest Algorithm • RFC 2327—SDP: Session Description Protocol • RFC 2387—The MIME Multipart / Related Content-type • RFC 2976—The SIP INFO Method • RFC 3261—SIP: Session Initiation Protocol (replacement for RFC 2543) • RFC 3262—Reliability of Provisional Responses in the Session Initiation Protocol (SIP) • RFC 3263—Session
Session Initiation Protocol (SIP) • RFC 3969—The Internet Assigned Number Authority (IANA) Uniform Resource Identifier (URI) Parameter Registry for the Session Initiation Protocol (SIP) • RFC 4028—Session Timers in the Session Initiation Protocol (SIP) • RFC 4235—An INVITE-Initiated Dialog Event Package for the Session Initiation Protocol (SIP) • RFC 4662—Session Initiation Protocol (SIP) Event Notification Extension for Resource Lists • draft-levy-sip-diversion-08.
Administrator’s Guide SoundPoint IP / SoundStation IP Method Supported Notes INFO Yes RFC 2976, the phone does not generate INFO requests, but will issue a final response upon receipt. No INFO message bodies are parsed. MESSAGE Yes Final response is sent upon receipt. Message bodies of type text/plain are sent and received.
Session Initiation Protocol (SIP) Header Supported Diversion Yes Error-Info No Event Yes Expires Yes From Yes In-Reply-To No Max-Forwards Yes Min-Expires No Min-SE Yes MIME-Version No Organization No P-Asserted-Identity Yes P-Preferred-Identity Yes Priority No Proxy-Authenticate Yes Proxy-Authorization Yes Proxy-Require No RAck Yes Record-Route Yes Refer-To Yes Referred-By Yes Remote-Party-ID Yes Replaces Yes Reply-To No Require Yes Retry-After No Route
Administrator’s Guide SoundPoint IP / SoundStation IP Header Supported Subject No Subscription-State Yes Supported Yes Timestamp No To Yes Unsupported No User-Agent Yes Via Yes Warning Yes WWW-Authenticate Yes Notes Only warning codes 300 to 399 Response Support The following SIP responses are supported: Note In the following table, a “Yes” in the Supported column means the header is sent and properly parsed. The phone may not actually generate the response.
Session Initiation Protocol (SIP) 3xx Responses - Redirection Response Supported 300 Multiple Choices Yes 301 Moved Permanently Yes 302 Moved Temporarily Yes 305 Use Proxy No 380 Alternative Service No Notes 4xx Responses - Request Failure Note All 4xx responses for which the phone does not provide specific support will be treated the same as 400 Bad Request.
Administrator’s Guide SoundPoint IP / SoundStation IP Response Supported 481 Call/Transaction Does Not Exist Yes 482 Loop Detected Yes 483 Too Many Hops No 484 Address Incomplete Yes 485 Ambiguous No 486 Busy Here Yes 487 Request Terminated Yes 488 Not Acceptable Here Yes 491 Request Pending No 493 Undecipherable No 5xx Responses - Server Failure Response Supported 500 Server Internal Error Yes 501 Not Implemented Yes 502 Bad Gateway No 503 Service Unavailable No 504 Server
Session Initiation Protocol (SIP) Hold Implementation The phone supports both currently accepted means of signaling hold. The first method, no longer recommended due in part to the RTCP problems associated with it, is to set the “c” destination addresses for the media streams in the SDP to zero, for example, c=0.0.0.0. The second, and preferred, method is to signal the media directions with the “a” SDP media attributes sendonly, recvonly, inactive, or sendrecv.
Administrator’s Guide SoundPoint IP / SoundStation IP SIP for Instant Messaging and Presence Leveraging Extensions The phone is compatible with the Presence and Instant Messaging features of Microsoft Windows Messenger 5.1.
C Miscellaneous Administrative Tasks This appendix provides information required by varied aspects of the Session Initiation Protocol (SIP) application.
Administrator’s Guide SoundPoint IP / SoundStation IP C-2 • Deutsche Telekom AG Root CA • Digital Signature Trust Co. Global CA 1 • Digital Signature Trust Co. Global CA 2 • Digital Signature Trust Co. Global CA 3 • Digital Signature Trust Co. Global CA 4 • Entrust Worldwide by DST • Entrust.net Premium 2048 Secure Server CA • Entrust.net Secure Personal CA • Entrust.
Miscellaneous Administrative Tasks • TC TrustCenter, Germany, Class 1 CA • TC TrustCenter, Germany, Class 2 CA • TC TrustCenter, Germany, Class 3 CA • TC TrustCenter, Germany, Class 4 CA • Thawte Personal Basic CA • Thawte Personal Freemail CA • Thawte Personal Premium CA • Thawte Premium Server CA • Thawte Server CA • Thawte Universal CA Root • UPS Document Exchange by DST • ValiCert Class 1 VA • ValiCert Class 2 VA • ValiCert Class 3 VA • VeriSign Class 4 Primary CA • Veris
Administrator’s Guide SoundPoint IP / SoundStation IP Polycom endeavors to maintain a built-in list of the most commonly used CA Certificates. Due to memory contraints, we cannot keep as thorough a list as some other applications (for example, browsers). If you are using a certificate from a commercial Certificate Authority not in the list above, you may submit a Feature Request for Polycom to add your CA to the trusted list by visiting https://jira.polycom.com:8443//secure/CreateIssue!default.
Miscellaneous Administrative Tasks You can check whether an encrypted file is the same as an unencrypted file by: 1. Run the configFileEncrypt utility on the unencrypted file with the "-d" option. This shows the "digest" field. 2. Look at the encrypted file using WordPad and check the first line that shows a "Digest=…." field. If the two fields are the same, then the encrypted and unencrypted file are the same.
Administrator’s Guide SoundPoint IP / SoundStation IP 2. Manually reboot the phone so that it will download the new key. The phone will automatically reboot a second time to use the new key. At this point, the phone expects all encrypted configuration files on the boot server to use the new key and it will continue to reboot until this is the case. The files on the server must be updated to the new key or they must be made available in unencrypted format.
Miscellaneous Administrative Tasks The SoundPoint IP 501/600/601 phones only support the four colors black, dark gray, light gray, and white. Any other colors will be approximated. Color RGB Values (Decimal) RGB Values (Hexadecimal) Black 0,0,0 00,00,00 Dark Gray 96,96,96 60,60,60 Light Gray 160,160,160 A0,A0,A0 White 255,255,255 FF,FF,FF The SoundPoint IP 550/560/650 phones support a 4-bit grayscale, which is a smooth gradient from black (0, 0, 0) to white (FF, FF, FF).
Administrator’s Guide SoundPoint IP / SoundStation IP Next, enable the idle display feature and modify the idle display “animation” for each model to point to your bitmap (again without the .bmp extension):
Miscellaneous Administrative Tasks … BootROM/SIP Application Dependencies Not withstanding the hardware backward compatibility mandate, there have been times throughout the life of the SoundPoint IP / SoundStation IP phones where certain dependencies on specific bootROM and application versions have been necessitated. This table summarizes some the major dependences that you are likely to encounter: Model BootROM SIP Application IP 301/501 2.6.1 or later 1.4.2, 1.5.4, 1.6.
Administrator’s Guide SoundPoint IP / SoundStation IP There is always a way to move forward with bootROM releases, although it may be a two or three step procedure sometimes, but there are cases where it is impossible to move backward. Make special note of these cases before upgrading. Note that: • 1.x cannot be upgraded to any 2.x automatically • 2.0 and 2.1 can not upgrade past 2.4 • Only 2.6 can upgrade to 3.0 • 3.
Miscellaneous Administrative Tasks Note As of SIP 3.1, users can restart their phones by pressing the Menu key, and then selecting Settings > Basic > Restart Phone. Any new bootROM and SIP applications will be downloaded to the phone as a result of this restart.
Administrator’s Guide SoundPoint IP / SoundStation IP Default Feature Key Layouts The following figures and tables show the default SIP key layouts for the SoundPoint IP 301, 320, 330, 430, 501, 550, 560, 600, 601, 650, and 670 and SoundStation IP 4000, 6000, and 7000 models.
Miscellaneous Administrative Tasks SoundPoint IP 320/330 31 7 13 14 Menu Dial 15 32 9 33 34 Line 1 8 Line 2 10 16 ABC DEF JKL MNO 19 TUV WXYZ 20 1 6 2 1 325 GHI 4 5 PQRS Hold 5 2 6 26 7 4 8 3 9 27 30 21 OPER 29 0 28 24 22 23 Key ID Key ID Function Key ID Function Key ID Function Key ID Function 1 Dialpad2 12 n/a 23 VolUp 34 Menu 2 Dialpad5 13 SoftKey2 24 VolDown 35 n/a 3 Dialpad8 14 ArrowUp 25 Dialpad3 36 n/a 4 Dialpad7 15 Select 26 Di
Administrator’s Guide SoundPoint IP / SoundStation IP SoundPoint IP 430 Key ID Function Key ID Function Key ID Function Key ID Function 1 Line1 12 DialpadPound 23 Messages 34 Softkey3 2 Line2 13 Dialpad9 24 n/a 35 Handsfree 3 n/a 14 Dialpad8 25 SoftKey4 36 n/a 4 ArrowUp 15 Dialpad7 26 Headset 37 n/a 5 Hold 16 Dialpad4 27 SoftKey2 38 n/a 6 n/a 17 Dialpad5 28 SoftKey1 39 n/a 7 Redial 18 Dialpad6 29 ArrowDown 40 n/a 8 VolUp 19 Dialpad3 30 S
Miscellaneous Administrative Tasks SoundPoint IP 501 1 35 40 2 34 Sel 4 3 39 5 33 Del 38 Conference Directories 6 32 Services 31 28 27 26 25 Menu 7 Call Lists 30 Conference 29 Transfer 37 Redial 1 2 3 24 23 22 ABC ABC Messages 8 DEF Do Not Disturb 4 5 6 19 20 21 GHI JKL MNO GHI JKL MNO 77 TUV 88 WXYZ PQRS 36 DEF PQRS18 * 15 9 99 Hold TUV 17 WXYZ16 10 0 # 13 14 OPER OPER 12 11 Key ID Key ID Function Key ID Function Key ID Function Key ID Functio
Administrator’s Guide SoundPoint IP / SoundStation IP SoundPoint IP 550/560/600/601/650/670 34 1 33 Sel 35 2 41 4 5 42 3 31 Del 6 Menu Directories 30 28 27 26 7 25 Messages Services 29 Conference 32 Transfer 37 1 24 2 23 3 ABC DEF ABC DEF 36 Hold 40 9 4 19 5 20 6 GHI JKL GHI JKL 77 TUV PQRS MNO MNO 21 10 88 99 16 17 PQRS Redial 8 Do Not Disturb 22 18 TUV * 15 WXYZ Hold 39 WXYZ 38 0 # 14 13 OPER OPER 12 11 Key ID Note The SoundPoint IP 550 and 560
Miscellaneous Administrative Tasks SoundStation IP 4000 6 25 12 18 26 27 5 22 28 29 1 2 3 7 8 9 13 14 15 19 20 21 4 10 16 Key ID Function Key ID Function Key ID Function Key ID Function 1 Dialpad1 12 Select 23 n/a 34 n/a 2 Dialpad2 13 Dialpad7 24 n/a 35 n/a 3 Dialpad3 14 Dialpad8 25 Menu 36 n/a 4 VolUp 15 Dialpad9 26 Exit 37 n/a 5 Handsfree 16 MicMute 27 SoftKey1 38 n/a 6 ArrowUp 17 n/a 28 SoftKey2 39 n/a 7 Dialpad4 18 ArrowDo
Administrator’s Guide SoundPoint IP / SoundStation IP SoundStation IP 6000 27 17 23 11 26 5 22 28 29 25 1 2 3 7 8 9 13 14 15 19 20 21 4 10 16 Key ID Key ID Function Key ID Function Key ID Function Key ID Function 1 Dialpad1 12 n/a 23 Select 34 n/a 2 Dialpad2 13 Dialpad7 24 n/a 35 n/a 3 Dialpad3 14 Dialpad8 25 SoftKey3 36 n/a 4 VolUp 15 Dialpad9 26 Exit 37 n/a 5 Handsfree 16 MicMute 27 Menu 38 n/a 6 n/a 17 ArrowUp 28 SoftKey1 39 n
Miscellaneous Administrative Tasks SoundStation IP 7000 7 1 19 13 2 6 14 26 20 30 8 3 4 5 9 15 21 10 16 22 11 17 23 12 18 24 27 28 29 Key ID Key ID Function Key ID Function Key ID Function Key ID Function 1 SoftKey1 12 DialpadStar 23 Dialpad9 34 n/a 2 ArrowUp 13 SoftKey3 24 DialpadPound 35 n/a 3 Menu 14 ArrowLeft 25 n/a 36 n/a 4 Conference 15 Dialpad2 26 Select 37 n/a 5 Redial 16 Dialpad5 27 VolUp 38 n/a 6 Handsfree 17 Dialpad8 2
Administrator’s Guide SoundPoint IP / SoundStation IP • On the SoundPoint IP 320/330 phone, CallPickup and ParkedPickup refer to the same function. On other phones, CallPickup refers to the soft key function that provides the menu with separate soft keys for parked pickup, directed pickup, and group pickup. • Some functions depend on the feature being enabled. For example, BuddyStatus and MyStatus require the presence feature to be enabled.
Miscellaneous Administrative Tasks Label Function Dialpad3 Dialpad3 Dialpad4 Dialpad4 Dialpad5 Dialpad5 Dialpad6 Dialpad6 Dialpad7 Dialpad7 Dialpad8 Dialpad8 Dialpad9 Dialpad9 DialpadPound DialpadPound DialpadStar DialpadStar DialpadURL Dialname Call screen only DirectedPiclup DirectedPickup Call screen only Directories Directories Divert Forward DoNotDisturb Do Not Disturb menu Exit Exist existing menu GroupPickup GroupPickup Handsfree Handsfree Hold Toggle Hold Joi
Administrator’s Guide SoundPoint IP / SoundStation IP Label Function MyStatus MyStatus NewCall NewCall Null Do nothing Offline Offline for presence EnterRecord enterCallRecord Call screen only Redial Redial Call screen only Release EndCall or Cancel hot dial SoundStation IP 7000 only ParkedPickup ParkedPickup Call screen only Select Select Setup Settings menu Silence RingerSilence SoftKey1 SoftKey1 SoftKey2 SoftKey2 SoftKey3 SoftKey3 SoftKey4 SoftKey4 SpeedDial SpeedDia
Miscellaneous Administrative Tasks Assigning a VLAN ID Using DHCP To assign a VLAN ID to a phone using DHCP: >> In the DHCP menu of the Main setup menu, set VLAN Discovery to “Fixed” or “Custom”. When set to “Fixed”, the phone will examine DHCP options 128,144, 157 and 191 (in that order) for a valid DVD string. When set to "Custom", the value set in "VLAN ID Option" will be examined for a valid DVD string.
Administrator’s Guide SoundPoint IP / SoundStation IP The following figure shows the phone’s processing to determine if the VLAN ID is valid: Parsing Vendor ID Information After the phone boot, it sends a DHCP Discover packet to the DHCP server. This is found in the Bootstrap Protocol/option “Vendor Class Identifier” section of the packet and includes the phone’s part number and the bootROM version.
Miscellaneous Administrative Tasks IANA Private Enterprise number to determine which vendor's format should be used to decode the remaining data. The private enterprise number assigned to Polycom is 13885 (0x0000363D). This vendor ID information is not a character string, but an array of binary data. The steps for parsing are as follows: 1. Check for the Polycom signature at the start of the option: 4 octet: 00 00 36 3d 2. Get the length of the entire list of sub-options: 1 octet 3.
Administrator’s Guide SoundPoint IP / SoundStation IP Product, Model, and Part Number Mapping In SIP 2.1.2, enhancements to the master configuration file were made to allow you to direct phone upgrades to a software image and configuration files based on phone model number, firmware part number, or MAC address. The part number specific version has precedence over the model number version, which has precedence over the original version. For example, CONFIG_FILES_2345-11605-001=”phone1_2345-11605-001.
Miscellaneous Administrative Tasks Disabling PC Ethernet Port Certain SoundPoint IP phones have a PC Ethernet port. If it is unused, it can be disabled. The PC Ethernet port can be disabled on the SoundPoint IP 330, 430, 450, 550, 560, 601, 650, and 670 and 850. The port cannot be disabled on the SoundPoint IP 301, 501, and 600 due to a lack of hardware support for the feature. To disable the Ethernet port on a supported SoundPoint IP phone: 1. Press . 2.
Administrator’s Guide SoundPoint IP / SoundStation IP C - 28
D Third Party Software This appendix provides the copyright statements for third party software products that are part of the Session Initiation Protocol (SIP) application. Ares Copyright 1998 by the Massachusetts Institute of Technology.
Administrator’s Guide SoundPoint IP / SoundStation IP Each revision is distinguished by a version number. You may use this Software under terms of this license revision or under the terms of any subsequent revision of the license. THIS SOFTWARE IS PROVIDED BY THE OPENLDAP FOUNDATION AND ITS CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
Third Party Software endorse or promote products derived from this software without prior written permission. For written permission, please contact openssl-core@openssl.org. 5. Products derived from this software may not be called "OpenSSL" nor may "OpenSSL" appear in their names without prior written permission of the OpenSSL Project. 6.
Administrator’s Guide SoundPoint IP / SoundStation IP 3. All advertising materials mentioning features or use of this software must display the following acknowledgement: "This product includes cryptographic software written by Eric Young (eay@cryptsoft.com)" The word 'cryptographic' can be left out if the routines from the library being used are not cryptographic related. 4.
Third Party Software Expat: Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd and Clark Cooper Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, su
Administrator’s Guide SoundPoint IP / SoundStation IP D-6
Index Numerics 802.1Q VLAN header 4–78 A access URL 4–65 ACD. See also automatic call distribution acoustic echo cancellation 4–75 acoustic echo cancellation A–45 acoustic echo suppression A–46 AEC. See also acoustic echo cancellation AGC.
Administrator’s Guide SoundPoint IP / SoundStation IP sampled audio for sound effects A–30 SDP A–9 security A–88 shared calls A–67 SIP A–10 soft keys A–103 sound effect patterns A–32 sound effects A–31 tones A–27 transmit equalization A–50 user preferences A–25 voice activity detection A–52 voice coding algorithms voice coding algorithms A–38 voice settings A–37 volume persistence A–42 web server A–63 application configuration file A–4 application error messages 5–3 application files overview 2–6
Index configuration file example 4–62 connected party identification 4–5 consultative transfers 4–18 context sensitive volume control 4–5 corporate directory 4–35, A–69, A–92 custom certificates 4–81 customizable audio sound effects 4–5 customizable fonts and indicators 4–29 D daisy-chaining phones 4–38 date and time A–25 default feature key layouts C–12 default password 3–5, 4–83, C–11, C–27 deploying phones from the boot server 3–14 device A–124 DHCP secondary server 3–3 DHCP INFORM 3
Administrator’s Guide SoundPoint IP / SoundStation IP IP_500 font A–75 IP_600 font A–75 J jitter buffer 4–74 K keep-alive A–63 key features 1–6 keys A–75 L language support 1–7 languages, adding new A–23 languages, supported 4–31 last call return 4–22 LEDs A–83 length A–89 local / centralized conferencing 4–19 local A–6 local contact directory 4–9 local contact directory file format 4–10 local digit map 4–12 local reminder A–67 local user and administrator
Index missed call configuration A–112 Network Address Translation A–120 no answer A–115 quotas A–94 registration A–107 roaming buddies A–122 roaming privacy A–123 routing A–118 routing server A–118 per-phone configuration file A–106 phone diagnostics 5–9 phone1.
Administrator’s Guide SoundPoint IP / SoundStation IP SIP basic protocols, header support B–4 SIP header diversion A–12 warning A–13 SIP headers, warnings 4–72 SIP. See also Session Initiation Protocol sip.
POLYCOM, INC. APPLICATION PROGRAMMING INTERFACE LICENSE (“API”) FOR SOUNDPOINT IP AND SOUNDSTATION IP PRODUCTS (“Product” or “Products”). 1. Agreement. You understand and agree that by using the API you will be bound by the terms of the End User License and Warranty Terms included with the Product(s) and this document (together, the “Agreement”). In the event of any conflicts between the End User License and Warranty Terms and this document, this document shall govern with respect to the API. 2. Parties.
By downloading the following Sample Applications, you agree to the below end user license agreement. LICENSE AGREEMENT FOR DEVELOPMENT PURPOSES This License Agreement for Development Purposes (the "Agreement") is a legal agreement between you and Polycom, Inc., a Delaware corporation ("Polycom"). The software you are about to download (the "Software") comprises sample code that may be useful in the development of applications designed to operate on or in conjunction with Polycom Products.
2.3. Reservation. Polycom reserves all rights in the Software not expressly granted to you in this Agreement. 3. SUPPORT SERVICES. 3.1. No Support Services. Polycom provides no support services for the Software. 4. TERMINATION. 4.1. Termination. Without prejudice to any other rights, Polycom may terminate this Agreement if you fail to comply with any of the terms and conditions of this Agreement. In such event, you must destroy all copies of the Software and all of its component parts.
for certain products supplied to consumers or the limitation of liability for personal injury, so the above limitations and exclusions may be limited in their application to you. 8. EXPORT CONTROLS. 8.1. Export Controls. The Software may not be downloaded or otherwise exported or reexported (i) into (or to a national or resident of) Cuba, Iraq, Libya, North Korea, Yugoslavia, Iran, Syria, Republic of Serbia, or any other country to which the U.S. has embargoed goods; or (ii) to anyone on the U.
agreement shall be construed to limit either party's right to independently develop or distribute software that is functionally similar to the other party's products, so long as proprietary information of the other party is not included in such software. 9.5. Entire Agreement. This Agreement represents the complete agreement concerning this license and may be amended only by a writing executed by both parties.
Addendum to SIP 3.1 Administrator’s Guide This addendum addresses changes to the SoundPoint IP / SoundStation IP SIP 3.1 Administrator’s Guide specific to the release of the SoundPoint IP 450 desktop phone. The SoundPoint IP 450 desktop phone hardware behaves in a similar manner to the SoundPoint IP 430 except for: • The SoundPoint IP 450 phone has a 4-bit grayscale or monochrome LCD display. It has a resolution of 256 by 116 pixels. • The SoundPoint IP 450 phone has an additional line key.
Administrator’s Guide Addendum for the SoundPoint IP 450 For more information on the SoundPoint IP 450 desktop phone, refer to the User Guide at http://www.polycom.com/support/voip/ . Note New or Changed Features Distribution Zip File As well as the sip.ld file in the archive, there is a separate file for the SoundPoint IP 450 phone called 2345-12450-001.sip.ld . Electronic Hookswitch The SoundPoint IP 450 phone can be configured to use the electronic hookswitch.
Administrator’s Guide Addendum for the SoundPoint IP 450 Backlight Intensity Like the SoundPoint IP 550, 560, 650, and 670, the backlight intensity on the SoundPoint IP 450 phone has two modes: • Backlight On • Backlight Idle You can modify the Backlight On intensity and the Backlight Idle intensity separately. You can select high, medium, low, and off levels for both. You can also modify the maximum backlight intensity.
Administrator’s Guide Addendum for the SoundPoint IP 450 Gains The default gain settings have been carefully adjusted to comply with the TIA-810-A digital telephony standard. Polycom recommends that you do not change these values. Attribute Default voice.gain.rx.analog.chassis.IP_450 0 voice.gain.rx.analog.ringer.IP_450 0 voice.gain.rx.digital.chassis.IP_450 5 voice.gain.rx.digital.ringer.IP_450 -12 voice.gain.tx.analog.chassis.IP_450 36 voice.gain.tx.digital.handset.IP_450 6 voice.
Administrator’s Guide Addendum for the SoundPoint IP 450 Receive Equalization These settings control the performance of the receive equalization feature. Polycom recommends that you do not change these values. Attribute Default voice.rxEq.hs.IP_450.preFilter.enable 1 voice.rxEq.hs.IP_450.postFilter.enable 0 voice.rxEq.hd.IP_450.preFilter.enable 0 voice.rxEq.hd.IP_450.postFilter.enable 0 voice.rxEq.hf.IP_450.preFilter.enable 1 voice.rxEq.hf.IP_450.postFilter.
Administrator’s Guide Addendum for the SoundPoint IP 450 Background This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation bg.gray.selection w,x 2,1 Specifiy which type of background (w) and index (x) for that type is selected on reboot. -3 Specify the brightness adjustment to the graphic. White Solid pattern name. bg.medRes.gray.pr.x.adj bg.medRes.gray.pat.solid.x. name any string bg.medRes.gray.pat.solid.x.red 0 to 255 bg.medRes.gray.
Administrator’s Guide Addendum for the SoundPoint IP 450 Attribute Permitted Values bg.medRes.gray.bm.x.name any string bg.medRes.gray.bm.x.em. name any string bg.medRes.gray.bm.x.adj integer Default Interpretation Graphic files for display on the phone and Expansion Module and also the brightness adjustment to the graphic. For x=1: • name is “Leaf256x116.jpg” adjustment is “0” For x=2: • name is “Sailboat256x116.jpg” adjustment is “-3” For x=3: • name is “Beach256x116.
Administrator’s Guide Addendum for the SoundPoint IP 450 Bitmaps The IP_450 parameters affect the SoundStation IP 450 desktop phone. Indicators The IP_450 parameters affect the SoundStation IP 450 desktop phone. Animations The IP_450 parameters affect the SoundStation IP 450 desktop phone. Graphic Icons The IP_450 parameters affect the SoundStation IP 450 desktop phone.
Administrator’s Guide Addendum for the SoundPoint IP 450 The SoundPoint IP 450 desktop phone default key layout is as follows: 1 2 3 4 28 27 5 25 34 31 22 29 35 26 30 32 21 20 19 16 17 18 15 14 13 10 11 12 23 7 33 9 8 Key ID Key ID Function Key ID Function Key ID Function Key ID Function 1 Line1 12 DialpadPound 23 Messages 34 SoftKey3 2 Line2 13 Dialpad9 24 n/a 35 Handsfree 3 Line3 14 Dialpad8 25 Softkey4 36 n/a 4 ArrowUp 15 Dialpad7 26 Headset
Administrator’s Guide Addendum for the SoundPoint IP 450 1 - 10
Addendum to SIP 3.1 Administrator’s Guide This addendum addresses changes to the SoundPoint IP / SoundStation IP SIP 3.1 Administrator’s Guide specific to the release of the Polycom® VVX™ 1500 Business Media phone. The Polycom VVX 1500 is a Business Media phone that combines advanced business telephony, one-touch video, real-time presence and integrated business applications into one seamless, lifelike communications experience.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone • Recording and Playback of Audio Calls • Video Transmission • Voice Quality Monitoring • Multiple Registrations • Video Codecs • Audio Codecs • Digital Picture Frame • Application Launch Pad • LCD Power Saving Configuration file changes are described in Configuration File Changes on page 1-8.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Configuration changes can performed centrally at the boot server: Central (boot server) Local Configuration file: sip.cfg Specify which background will be displayed. Local Phone User Interface The user can save one of the images as the background by selecting Save as Background on the touch screen. • For more information, refer to Background on page 1-9.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Configuration changes can be performed centrally at the boot server: Central (boot server) Configuration file: sip.cfg Turn video transmission off at the near end when calls start and transmit still image if video not available. • For more information, refer to Video on page 1-9. Specify camera parameters. • For more information, refer to Camera Controls on page 1-11.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Video Codecs The following table summarizes the Polycom VVX 1500 phone’s video codec support: Effective video bandwidth Algorithm MIME Type Bit Rate Frame Rate H.263 H263/90000, H263-1998/90000 64 kbps to 768 kbps 5 fps to 30 fps Tx Frame size:CIF, QCIF Rx Frame Size:CIF, QCIF, SQCIF, QVGA, SIF Refer to Bit Rate column. H.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Frame Size Effective audio bandwidth Algorithm MIME Type Ref. Bit Rate Sample Rate G.729AB G729 RFC 1890 8 Kbps 8 Ksps 10ms - 80ms 3.5KHz Lin16 L16/8000 L16/16000 L16/32000 L16/44100 L16/48000 RFC 1890 128 Kbps 256 Kbps 512 Kbps 705.6 Kbps 768 Kbps 8 Ksps 16 Ksps 32 Ksps 44.1 Ksps 48 Ksps 10ms 4 KHz 8 KHz 16 KHz 22.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Application Launch Pad You can configure a page (similar to the Menu page) where users can launch any applications that run on phone. Currently, the only applications are the Digital Picture Frame and the “My Info Portal”. There are four additional entries that you can configure for any of your company’s applications.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Users can change the default values through the phone’s menu to accomodate their individual schedules. For example, a user may normally start work at 10am and work 8 hours a day from Monday to Saturday. Configuration changes can be performed centrally at the boot server: Central (boot server) Configuration file: sip.cfg Turn this feature on or off and configure how it works.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Application Configuration File Changes Background This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation bg.VVX_1500.color.selection w,x 1,1 Specifiy which type of background (w) and index for that type (x) is selected on reboot where w=1 to 3, x=1 to 6. The type of backgrounds are built-in (w=1), solids (w=2), and bitmaps (w=3).
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Attribute video.screenMode Permitted Values “normal”, “full”, “crop” Default Interpretation Null Applies to the video window shown in the normal mode. If set to “normal” or Null, all pixels are displayed, black bars appear on the top, bottom, or sides of the window, if necessary, to maintain the correct aspect ratio.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone • Video Coding Algorithms Camera Controls These settings control the performance of the camera. These configuration attributes are defined as follows: Attribute video.camera. flickerAvoidance Permitted Values Default Interpretation 0 to 2 Null Set flicker avoidance. If set to 0 or Null, flicker avoidance is automatic. If set to 1, 50hz AC power frequency flicker avoidance (Europe/Asia).
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Local Camera View These settings control how the local camera is viewed on the screen. These configuration attributes are defined as follows: Attribute video.localCameraView. fullscreen.enabled Permitted Values Default Interpretation 0=Disable, Null Determines whether the local camera view is shown in the full screen layout . 1=Enable If set to 0, the local camera view is not shown.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Codec Profiles The profile attributes can be adjusted for each of the new supported video codecs. Attribute Permitted Values Interpretation video.profile.H264.jitterBufferMax (video.profil e.H264.jitter BufferMin + 500ms) to 2500ms, default 2000ms The largest jitter buffer depth to be supported (in milliseconds). Jitter above this size will always cause lost packets.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Attribute Permitted Values Interpretation video.profile.H263.jitterBufferMin 33ms to 1000ms, default 150ms The smallest jitter buffer depth (in milliseconds) that must be achieved before play out begins for the first time. Once this depth has been achieved initially, the depth may fall below this point and play out will still continue.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Attribute Permitted Values Interpretation video.profile.H2631998.jitterBufferShrink 33ms to 1000ms, default 70ms The absolute minimum duration time (in milliseconds) of RTP packet Rx with no packet loss between jitter buffer size shrinks. Use smaller values (33 ms) to minimize the delay on known good networks. Use larger values (1000ms) to minimize packet loss on networks with large jitter (3000 ms). video.profile.H2631998.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Permitted Values Attribute Interpretation video.profile.H2631998.annexK 0, 1 (default), 2, 3, 4 This value is H263-1998/90000 format parameter ANNEXK used to signal Polycom VVX 1500 receiving capability in the SDP. video.profile.H2631998.annexN 0, 1 (default), 2, 3, 4 This value is H263-1998/90000 format parameter ANNEXN used to signal Polycom VVX 1500 receiving capability in the SDP.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Codec Preferences Attribute Permitted Values Default Interpretation voice.codecPref.VVX_1500.G711Mu Null, 1-16 4 Specifies the audio codec preferences for the Polycom VVX 1500 phone. Interpretation as above. voice.codecPref.VVX_1500.G711A 5 voice.codecPref.VVX_1500.G722 3 voice.codecPref.VVX_1500.G7221.16kbps Null voice.codecPref.VVX_1500.G7221.24kbps Null voice.codecPref.VVX_1500.G7221.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Codec Profiles The profile attributes can be adjusted for each of the supported codecs, namely, x= G711A, G711Mu, G722, G7221, G7221C, G729AB, Lin16, and Siren14. Attribute Permitted Values voice.audioProfile.x.payloadSize 10, 20, 30, ...80 Interpretation Preferred Tx payload size in milliseconds to be provided in SDP offers and used in the absence of ptime negotiations.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Gains The default gain settings have been carefully adjusted to comply with the TIA-810-A digital telephony standard for the Polycom VVX 1500 phone. Polycom recommends that you do not change these values. Attribute Default voice.gain.rx.analog.handset.VVX_1500 -2 voice.gain.rx.analog.handset.sidetone.VVX_1500 -15 voice.gain.rx.analog.headset.VVX_1500 -2 voice.gain.rx.analog.headset.sidetone.VVX_1500 -31 voice.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Receive Equalization These new settings control the performance of the receive equalization feature on the Polycom VVX 1500 phone. Polycom recommends that you do not change these values. Attribute Default voice.rxEq.hs.VVX_1500.preFilter.enable 1 voice.rxEq.hs.VVX_1500.postFilter.enable 0 voice.rxEq.hd.VVX_1500.preFilter.enable 0 voice.rxEq.hd.VVX_1500.postFilter.enable 0 voice.rxEq.hf.VVX_1500.preFilter.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Quality of Service These new configuration attributes are defined as follows: • This parameter apply to Video RTP packets. This parameter controls the 802.1p/Q user_priority field. Attribute Permitted Values Default Interpretation qos.ethernet.rtp.video.user_priority 0-7 5 User-priority used for Video RTP packets. • Attribute These parameters apply to RTP packets.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Feature This new configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation feature.20.enabled 0 or 1 1 If set to 1, the picture frame feature is enabled. If set to 0 or Null, the picture frame feature is disabled.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone This attribute also includes changes to the Main Browser attribute: Attribute Permitted Values Default Interpretation mb.main.x.url string Null The internal/external URI, icon, and associated text for at most six applications (for x= 1 to 6). mb.main.x.icon Null mb.main.x.text Null The default values for x=1 is: mb.main.1.url=”PicFrame://” mb.main.1.icon=”http://127.0.0.1/launc hpad/geticonPicFrame” mb.main.1.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone Attribute powerSaving.officeHours. duration.xxx Permitted Values Default Interpretation 0 to 12 10 or 0 The duration of the day’s office hours, where xxx is one of “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday”, and “sunday” . If set to Null, the default value for the week days is 10 (hours) and the default value for Saturday and Sunday is 0 (hours). powerSaving.idleTimeout.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone These new configuration attributes are defined as follows: Attribute Permitted Values Default Interpretation up.pictureFrame.folder string Null The path name for images. The maximum length is 40 characters. If set to Null, images stored in the root folder on the USB flash drive are displayed. For example, if the images are stored in the “/images/phone” folder on the USB flash drive, set up.pictureFrame.
Administrator’s Guide Addendum for the Polycom VVX 1500 Business Media Phone • Restoring Factory Defaults—Press and hold the 4, 6, 8, and * dial pad keys simultaneously during the countdown process in the bootROM until the password prompt appears. Enter the administrator password to initiate the reset. Resetting to factory defaults will also reset the administrator password (factory default password is 456).
