Administrator’s Guide for the SoundPoint® IP/SoundStation® IP Family SIP 2.2.0 August, 2007 Edition 1725-11530-220 Rev. A SIP 2.2.
Trademark Information Polycom®, the Polycom logo design, SoundPoint® IP, SoundStation®, SoundStation VTX 1000®, ViaVideo®, ViewStation®, and Vortex® are registered trademarks of Polycom, Inc. Conference Composer™, Global Management System™, ImageShare™, Instructor RP™, iPower™, MGC™, PathNavigator™, People+Content™, PowerCam™, Pro-Motion™, QSX™, ReadiManager™, Siren™, StereoSurround™, V2IU™, Visual Concert™, VS4000™, VSX™, and the industrial design of SoundStation are trademarks of Polycom, Inc.
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, 600, 601, and 650 desktop phones, and the SoundStation IP 4000 conference phone.
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–2 SoundStation IP Conference Phone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4 Key Features of Your SoundPoint IP / SoundStation IP Phones . . . . . . . 1–5 2 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Administrator’s Guide SoundPoint IP / SoundStation IP Call Waiting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–3 Called Party Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–4 Calling Party Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–4 Missed Call Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–4 Connected Party Identification . . .
Contents Downloadable Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–28 Synthesized Call Progress Tones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–28 Microbrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–28 Real-Time Transport Protocol Ports . . . . . . . . . . . . . . . . . . . . . . . . . . 4–29 Network Address Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Administrator’s Guide SoundPoint IP / SoundStation IP Power and Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–9 Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–10 Access to Screens and Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–11 Calling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Per-Phone Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–82 Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–83 Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–87 Diversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–90 Dial Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Administrator’s Guide SoundPoint IP / SoundStation IP D Third Party Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D–1 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
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 SoundPoint IP Desktop Phones This section describes the current SoundPoint IP desktop 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 • SoundPoint IP 430 • SoundPoint IP 501 • SoundPoint IP 550 1-3
Administrator’s Guide SoundPoint IP / SoundStation IP • SoundPoint IP 600/601 • SoundPoint IP 650 SoundStation IP Conference Phone This section describes the current SoundPoint IP conference phone. 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 phone is: • SoundStation IP 4000 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-
Administrator’s Guide SoundPoint IP / SoundStation IP — Application flexibility for call management and new telephony applications • Large LCD — Easy-to-use, easily readable and intuitive interface — Support of rich application content, including multiple call appearances, presence and instant messaging, and XML services — 4 line x 20 character monochrome LCD for the SoundPoint IP 301 — 102 x 23 pixel graphical LCD for the SoundPoint IP 320/330 — 160 x 80 pixel graphical grayscale LCD for the SoundPoint I
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 Note Any new features introduced after SIP 2.1.2 are not supported on the SoundPoint IP 300 and 500. This section provides information the features available on the SoundPoint IP / SoundStation IP phones: • Basic Features — Automatic Off-Hook Call Placement—Supports an optional automatic off-hook call placement feature for each .
Overview — Context Sensitive Volume Control—The volume of user interface sound effects, such as the ringer, and the receive volume of call audio is adjustable. — 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.
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 Registrations—SoundPoint IP phones support multiple s per phone. (SoundStation IP 4000 supports a single .) — Network Address Translation—The phones can work with certain types of network address translation (NAT). — Presence—Allows the phone to monitor the status of other users/devices and allows other users to monitor it. Requires call server support.
Administrator’s Guide SoundPoint IP / SoundStation IP — IP Type-of-Service—Allows for the setting of TOS settings. — Jitter Buffer and Packet Error Concealment—Employs a high-performance jitter buffer and packet error concealment system designed to mitigate packet inter-arrival jitter and out-of-order or lost (lost or excessively delayed by the network) packets. — Low-Delay Audio Packet Transmission—Designed to minimize latency for audio packet transmission.
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.
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 Note The Server User and Server Password parameters should be changed from the default values. Note that for insecure protocols the user chosen should have very few privileges on the server. Ethernet Menu The following Ethernet configuration parameters can be modified on the Ethernet menu: Name Possible Values Description CDP Enabled, Disabled If enabled, the phone will use CDP. It also reports PoE power usage to the switch. The default value is Enabled.
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 — SoundPointIPWelcome.wav Refer to the Release Notes for a detailed description of each file in the distribution.
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. To deploy phones from the boot server: Note For more information on encrypting configuration files, refer to Encrypting Configuration Files on page C-3. 1.
Administrator’s Guide SoundPoint IP / SoundStation IP local conditions. Changing the default daylight savings parameters will likely be necessary outside of North American locations. a (Optional) Disable the local web (HTTP) server or change its signalling port if local security policy dictates. b Change the default location settings for user interface language and time and date format. 3.
Setting up Your System 5. Monitor the boot server event log and the uploaded event log files (if permitted). Ensure that the configuration process completed correctly. All configuration files used by the boot server are logged. You can now instruct your users to start making calls. Upgrading SIP Application You can upgrade the SIP application that is running on the SoundPoint IP and SoundStation IP phones in your organization.
Administrator’s Guide SoundPoint IP / SoundStation IP 2. Customize new configuration files or apply new or changed parameters to the old configuration files. Differences between old and new versions of configuration files are explained in the Release Notes that accompany the software. Both mandatory and optional changes may present. Changes to site-wide configuration files such as sip.cfg can be done manually, but a scripting tool is useful to change per-phone configuration files.
Setting up Your System The following procedure must be used for upgrading to SIP 2.2.0 or later for installations that have SoundPoint IP 300 and 500 phones deployed. It is also recommended that this same approach be followed even if SoundPoint IP 300 and 500 phones are not part of the deployment as it will simplify management of phone systems with future software releases. To upgrade your SIP application: 1. Do one of the following steps: a Place the bootrom.ld file corresponding to BootROM revision 4.0.
Administrator’s Guide SoundPoint IP / SoundStation IP Note This approach takes advantage of an enhancement that was added in SIP2.0.1/BootROM 3.2.1 that allows for the substitution of the phone specific [MACADDRESS] inside configuration files. This avoids the need to create unique .cfg files for each phone such that the default 000000000000.cfg file can be used for all phones in a deployment. If this approach is not used, then changes will need to be made to all the .
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-77. For more information, refer to Missed Call Configuration on page A-89.
Administrator’s Guide SoundPoint IP / SoundStation IP Note L16/16000 is not supported on SoundPoint IP 301 and SoundStation IP 4000 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.cfg Specify patterns used for sound effects and the individual tones or sampled audio files used within them.
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-18.
Configuring Your System Handset, Headset, and Speakerphone SoundPoint IP phones come standard with a handset and a dedicated connector is provided for a headset (not supplied). The SoundPoint IP 320, 330, 430, 500, 501, 550, 600, 601, and 650 desktop phones and SoundStation IP 4000 conference phone 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.
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 Set whether the directory uses volatile storage on the phone (required on the SoundPoint IP 500 platform for directories greater than 25 entries). • XML file: 000000000000-direct ory.xml For more information, refer to Directory
on page A-58. A sample file named 000000000000-directory~.Configuring Your System ...
Administrator’s Guide SoundPoint IP / SoundStation IP Element Permitted Values Interpretation ad 0,1 auto divert If set to 1, automatically diverts callers that match the directory entry to the address specified in divertcontact. Note: If auto-divert is enabled, it has precedence over auto-reject. ar 0,1 auto-reject If set to 1, automatically rejects callers that match the directory entry. Note: If auto-divert is also enabled, it has precedence over auto-reject.
Configuring Your System Microphone Mute A microphone mute feature is provided. When activated, visual feedback is provided. This is a local function and cannot be overridden by the network. There are no related configuration changes. Soft Key Activated User Interface The user interface makes extensive use of intuitive, context-sensitive soft key menus. The soft key function is shown above the key on the graphic display. There are no related configuration changes.
Administrator’s Guide SoundPoint IP / SoundStation IP Network Time Protocol (SNTP) timeserver. The time and date displayed on the phone will flash continuously until a successful SNTP response is received to indicate that they are not accurate. The time and date display can use one of several different formats and can be turned off. Configuration changes can performed centrally at the boot server or locally: Central (boot server) Configuration file: sip.cfg Turn time and date display on or off.
Configuring Your System Configuration changes can performed centrally at the boot server: Central (boot server) Configuration file: sip.cfg To turn idle display animation on or off. • For more information, refer to Indicators on page A-65. To replace the animation used for the idle display. • For more information, refer to Animations , , , , , on page A-66. To change the position of the idle display animation.
Administrator’s Guide SoundPoint IP / SoundStation IP Automatic Off-Hook Call Placement The phone supports an optional automatic off-hook call placement feature for each registration. Configuration changes can performed centrally at the boot server: Central (boot server) Configuration file: phone1.cfg Specify which registrations have the feature and what contact to call when going off hook. • For more information, refer to Automatic Off-Hook Call Placement on page A-89.
Configuring Your System Call Transfer Call transfer enables the user (party A) to move an existing call (party B) into a new call between party B and another user (party C) selected by party A. The phone offers three types of transfers: • Blind transfers—The call is transferred immediately to party C after party A has finished dialing party C’s number. Party A does not hear ring-back.
Administrator’s Guide SoundPoint IP / SoundStation IP Configuration changes can performed centrally at the boot server: Central (boot server) Configuration file: sip.cfg Specify the conference hold behavior (all parties on hold or only host is on hold). • For more information, refer to Call Handling Configuration on page A-55. Specify whether or not all parties hear sound effects while setting up a conference. • For more information, refer to Call Handling Configuration on page A-55.
Configuring Your System Server-based call forwarding is disabled if Shared Call Appearance or Bridged Line Appearance is enabled. Note Configuration changes can performed centrally at the boot server or locally: Central (boot server) Configuration file: sip.cfg Enable or disable server-based call forwarding. Configuration file: phone1.cfg Enable or disable server-based call forwarding as a per-registration feature.
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-77.
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 This section also provides information for making configuration changes for the following advanced call server features: • Voice Mail Integration • Multiple Registrations • Automatic Call Distrib
Administrator’s Guide SoundPoint IP / SoundStation IP • The phone keys without removable key caps cannot be remapped. These include: — Any keys on the dial pad — Volume control — Handsfree, Mute, Headset — Hold — Navigation Cluster Configuration changes can performed centrally at the boot server: Central (boot server) Configuration File: sip.cfg Set the key scrolling timeout, key functions, and sub-pointers for each key (usually not necessary).
Configuring Your System 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. The number of concurrent calls per line key is configurable. Each registration can have more than one line key assigned to it (refer to the previous section, Multiple Line Keys per Registration). Configuration changes can performed centrally at the boot server or locally: Central (boot server) Configuration file: sip.
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 diversion should be disabled on shared lines. • For more information, refer to Shared Calls on page A-57. Specify line-seize subscription period. • For more information, refer to Server on page A-7.
Configuring Your System 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. Configuration changes can performed centrally at the boot server or locally: Central (boot server) Configuration file: sip.
Administrator’s Guide SoundPoint IP / SoundStation IP Polycom recommends that the BLF not be used in conjunction with the Microsoft Live Communications Server 2005 feature. For more information, refer to Microsoft Live Communications Server 2005 Integration on page 4-38. Note Use this feature with TCPpreferred transport (refer to Server on page A-7). Configuration changes can performed centrally at the boot server: Central (boot server) Configuration file: phone1.
Configuring Your System message or by initiating a new dialog. The destination for new dialog messages can be entered manually or selected from the contact directory, the preferred method. There are no related configuration changes. Multilingual User Interface Note This feature is not available on SoundPoint IP 301 phones. The system administrator or the user can select the language. Support for major western European languages is included and additional languages can be easily added.
Administrator’s Guide SoundPoint IP / SoundStation IP Downloadable Fonts New fonts can be loaded onto the phone. For guidelines on downloading fonts, refer to Fonts on page A-60. 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.
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. • Local For more information, refer to Microbrowser on page A-79. Web Server Specify the Applications browser home page and proxy to use. (if enabled) Navigate to http:///coreConf.
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-49.
Configuring Your System the SoundPoint IP 430, 500, 501, 550, 600, 601, and 650). A message-waiting signal from a voice mail server will trigger the message-waiting indicator to flash. Configuration changes can performed centrally at the boot server or locally: Central (boot server) Configuration file: sip.cfg For one-touch voice mail access, enable the “one-touch voice mail” user preference. • Configuration file: phone1.cfg For more information, refer to User Preferences on page A-23.
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 the local SIP signaling port and an array of SIP servers to register to. For each server specify the registration period and the signaling failure behavior. • Configuration file: phone1.
Configuring Your System 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.
Administrator’s Guide SoundPoint IP / SoundStation IP Server Redundancy Server redundancy is often required in VoIP deployments to ensure continuity of phone service for events where the call server needs to be taken offline for maintenance, the server fails, or the connection from the phone to the server fails.
Configuring Your System DNS SIP Server Name Resolution If a DNS name is given for a proxy/registrar address, the IP address(es) associated with that name will be discovered as specified in RFC 3263. If a port is given, the only lookup will be an A record. If no port is given, NAPTR and 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.
Administrator’s Guide SoundPoint IP / SoundStation IP Warning If DNS is used to resolve the address for Servers, the DNS server is unavailable, and the TTL for the DNS records has expired, the phone will attempt to contact the DNS server to resolve the address of all servers in its list before initiating a call. These attempts will timeout, but the timeout mechanism can cause long delays (for example, two minutes) before the phone call proceeds “using the working server”.
Configuring Your System Phone Operation for Registration After the phone has booted up, it will register to all the servers that are configured. Server 1 is the primary server and supports greater SIP functionality than any of servers. For example, SUBSCRIBE/NOTIFY services (used for features such as shared lines, presence, and BLF) will only be established with Server 1. Upon registration timer expiry of each server registration, the phone will attempt to re-register.
Administrator’s Guide SoundPoint IP / SoundStation IP monitored status occurs. Phone status changes are broadcast automatically to monitoring phones when the user engages in calls or invokes do-not-disturb. The user can also manually specify a state to convey, overriding, and perhaps masking, the automatic behavior. Note Notification when a change in monitored status occurs will be available in a subsequent release.
Configuring Your System 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-60. Turn the presence and messaging features on or off. • Configuration file: phone1.
Administrator’s Guide SoundPoint IP / SoundStation IP 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.
Configuring Your System 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. f If SIP forking is desired, set voIpProt.SIP.
Administrator’s Guide SoundPoint IP / SoundStation IP 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-99. m Save the modified phone1.cfg configuration file. Setting Up Audio Features Proprietary state-of-the-art digital signal processing (DSP) technology is used to provide an excellent audio experience.
Configuring Your System jitter buffer is adaptive and configurable for different network environments. When packets are lost, a concealment algorithm minimizes the resulting negative audio consequences. Configuration changes can performed centrally at the boot server or locally: Central (boot server) Configuration file: sip.cfg Set the jitter buffer tuning parameters including minimum and maximum size and shrink aggression.
Administrator’s Guide SoundPoint IP / SoundStation IP DTMF tones using the active voice codec or using RFC 2833 compatible encoding. The coding format decision is based on the capabilities of the remote end point. Configuration changes can performed centrally at the boot server: Central (boot server) Configuration file: sip.cfg Set the DTMF tone levels, autodialing on and off times, and other parameters. • For more information, refer to Dual Tone Multi-Frequency on page A-25.
Configuring Your System For the SoundPoint IP 501 and 601, utilizing acoustic echo cancellation will introduce a small delay increase into the audio path which might cause a lower voice quality. Note AEC on the SoundPoint IP 301 handset is not supported. Audio Codecs The following table summarizes the phone’s audio codec support: Frame Size Effective audio bandwidth Algorithm MIME Type Ref. Bit Rate Sample Rate G.711μ-law PMCU RFC 1890 64 Kbps 8 Ksps 10ms - 80ms 3.5KHz G.
Administrator’s Guide SoundPoint IP / SoundStation IP Background Noise Suppression Background noise suppression (BNS) is designed primarily for hands-free operation and reduces background noise to enhance communication in noisy environments. There are no related configuration changes. Comfort Noise Fill Comfort noise fill is designed to help provide a consistent noise level to the remote user of a hands-free call.
Configuring Your System IEEE 802.1p/Q The phone will tag all Ethernet packets it transmits with an 802.1Q VLAN header for one of the following reasons: • When it has a valid VLAN ID set in its network configuration • When it is instructed to tag packets through Cisco Discovery Protocol (CDP) running on a connected Ethernet switch • When a VLAN ID is obtained from DHCP (refer to DHCP Menu on page 3-7) The 802.1p/Q user_priority field can be set to a value from 0 to 7.
Administrator’s Guide SoundPoint IP / SoundStation IP 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.
Configuring Your System Incoming Signaling Validation The three optional levels of security for validating incoming network signaling are: • Source IP address validation • Digest authentication • Source IP address validation and digest authentication Configuration changes can performed centrally at the boot server: Central (boot server) Configuration File: sip.cfg Specify the type of validation to perform on a request-by-request basis, appropriate to specific event types in some cases.
Administrator’s Guide SoundPoint IP / SoundStation IP Configuring SoundPoint IP / SoundStation IP Phones Locally A local phone-based configuration web server is available, unless it is disabled through sip.cfg. It can be used as the only method of modifying phone configuration or as a distributed method of augmenting a centralized provisioning model. For more information, refer to Web Server on page A-54.
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 Error Messages There are several different error messages that can be displayed on the phone when it is booting. Some of these errors are fatal, meaning that the phone will not able to boot until this issue has been resolved, and some are recoverable, meaning the phone will continue booting after the error, but the configuration of the phone may not be what you were expecting.
Troubleshooting Your SoundPoint IP / SoundStation IP Phones Not all configuration files were present on the server Similarly, a message about configuration files not being present, means that the phone was able to reach the boot server, but that it was not able to find all the necessary files. So long as the files exist in flash memory, the phone can boot following this error. Note This error does not occur with the current BootROM.
Administrator’s Guide SoundPoint IP / SoundStation IP 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. If an SNTP is not available, the data/time display can be turned off so that the flashing display is not a distraction. Status Menu Debugging of single phone may be possible through an examination of the phone’s status menu. Press Menu, select Status, and then press the Select soft key.
Troubleshooting Your SoundPoint IP / SoundStation IP Phones MAC address 00f4f200360b. The bootROM log file is uploaded to the boot server after every reboot. The application log file is uploaded periodically or when the local copy reaches a predetermined size. Both log files can be uploaded on demand using a multiple key combination described in Multiple Key Combinations on page C-9. The phone uploads four files, namely, mac-boot.log, app-boot.log, mac-now-boot.log, and mac-now-app.log.
Administrator’s Guide SoundPoint IP / SoundStation IP • log.render.file.upload.append.sizeLimit—Controls the maximum size of log files on the boot server (default=512 kb) • log.render.file.upload.append.limitMode—Controls action to take when server log reaches max size, actions are stop and delete Scheduled Logging Scheduled logging is a powerful tool for anyone who is trying to troubleshoot an issue with the phone that only occurs after some time in operation.
Troubleshooting Your SoundPoint IP / SoundStation IP Phones For more information, refer to Multiple Key Combinations on page C-9. When the log files are manually uploaded, the word “now” is inserted into the name of the file, for example, 0004f200360b-now-boot.log . 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.
Administrator’s Guide SoundPoint IP / SoundStation IP Reading an Application Log The following figure shows a portion of an application log file: 5-8
Troubleshooting Your SoundPoint IP / SoundStation IP Phones 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: • 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.
Administrator’s Guide SoundPoint IP / SoundStation IP 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: 5 - 10 • 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.
Troubleshooting Your SoundPoint IP / SoundStation IP Phones 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”. 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.
Administrator’s Guide SoundPoint IP / SoundStation IP 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. 5 - 12 The phone line is unregistered.
Troubleshooting Your SoundPoint IP / SoundStation IP Phones 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. Certain type of older fluorescent lighting causes the display to appear to flicker.
Administrator’s Guide SoundPoint IP / SoundStation IP 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. • Ensure the headset is plugged into the jack marked Headset at the rear of the phone.
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.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 • USB Port 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.useAli as 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.serverFeatureControl.cf 0, 1 0 If set to 1, server-based call forwarding is enabled. The call server has control of call forwarding. If set to 0, server-based call forwarding is not enabled. This is the old behavior. voIpProt.SIP.serverFeatureControl.dn d 0, 1 0 If set to 1, server-based DND is enabled. The call server has control of DND.
Configuration Files 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.
Administrator’s Guide SoundPoint IP / SoundStation IP 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-33) will be applied. volpProt.SIP.alertInfo.x.
Configuration Files Permitted Values Default Interpretation voIpProt.SIP.requestValidation.x.req uest.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.dige st.realm A valid string Polycom SPIP Determines string used for Realm.
Administrator’s Guide SoundPoint IP / SoundStation IP Dial Plan Note The dial plan is not applied against Placed Call List, VoiceMail, last call return, and remote control dialed numbers. This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation dialplan.applyToCallListDial 0, 1 0 This attribute covers dialing from Received Call List and Missed Call List including dialing from Edit or Info sub- menus.
Configuration Files This attributes also includes: • Digit Map • Routing Digit Map A digit map is defined either by a “string” or by a list of strings. Each string in the list is an alternative numbering scheme, specified either as a set of digits or timers, or as an expression over which the gateway will attempt to find a shortest possible match. Digit map extension letter “R” indicates that certain matched strings are replaced.
Administrator’s Guide SoundPoint IP / SoundStation IP • There is no limitation on the number of R triplet sets in a digit map. However, a digit map that contains less than full number of triplet sets (for example, a total of 2Rs or 5Rs) is considered an invalid digit map. • Using T in the left part of RRR syntax is not recommended. For example, R0TR322R should be avoided. This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation dialplan.
Configuration Files Server This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation dialplan.routing.server.x.addre ss 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 Extended character support available on SoundPoint IP 600 and SoundStation IP 4000 and 7000 platforms includes the following Unicode character ranges Name Range CJK Symbols and Punctuation U+3000 - U+303F Hiragana U+3040 - U+309F Katakana U+30A0 - U+30FF Bopomofo U+3100 - U+312F Hangul Compatibility Jamo U+3130 - U+318F Bopomofo Extended U+31A0 - U+31BF Enclosed CJK Letters and Months U+3200 - U+327F CJK Compatibility U+3300 - U+33FF C
Configuration Files Date and Time This configuration attribute is defined as follows: Attribute Permitted Values lcl.datetime.time.24HourClock 0,1 If 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 Permitted Values Default Interpretation up.welcomeSoundOnWarmBootE nabled 0, 1 0 If set to 1, play welcome sound effect on warm as well as cold boots, otherwise 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 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.
Administrator’s Guide SoundPoint IP / SoundStation IP 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.
Configuration Files 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. positive On duration in milliseconds, 0=infinite. tone.chord.cat.x.onDur Interpretation integer tone.chord.cat.x.
Administrator’s Guide SoundPoint IP / SoundStation IP 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.
Configuration Files 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.
Administrator’s Guide SoundPoint IP / SoundStation IP 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).
Configuration Files 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.
Administrator’s Guide SoundPoint IP / SoundStation IP 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.
Configuration Files 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.
Administrator’s Guide SoundPoint IP / SoundStation IP 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.
Configuration Files Algorithm MIME Type Label Bit Rate Sample Rate Frame Size Effective Audio Bandwidth G.722 G722/8000 G722 64 Kbps 16 Ksps 10ms - 80ms 7 KHz G.722.1 G722/16000 G7221 16 Kbps, 24 Kbps, 32 Kbps 16 Ksps 20ms - 80ms 7 KHz G.729AB G729 G729AB 8 Kbps 8 Ksps 10ms - 80ms 3.5 KHz These codecs include: • Codec Preferences • Codec Profiles Codec Preferences Attribute Permitted Values Default Interpretation voice.
Administrator’s Guide SoundPoint IP / SoundStation IP Codec Profiles The following profile attributes can be adjusted for each of the three supported codecs. In the table, x=G711Mu, G711A, G722, G7221, and G729AB. Attribute Permitted Values voice.audioProfile.x.payloadSize 10, 20, 30, ...80 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. voice.audioProfile.x.
Configuration Files 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.persist.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Default voice.gain.rx.analog.ringer.IP_650 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.IP_601 0 voice.gain.rx.digital.chassis.IP_650 6 voice.gain.rx.digital.ringer -21 voice.gain.rx.digital.ringer.IP_330 -12 voice.
Configuration Files Attribute Default voice.gain.tx.digital.chassis.IP_330 12 voice.gain.tx.digital.chassis.IP_430 12 voice.gain.tx.digital.chassis.IP_4000 0 voice.gain.tx.digital.chassis.IP_601 6 voice.gain.tx.digital.chassis.IP_650 12 voice.gain.tx.analog.preamp.handset 14 voice.gain.tx.analog.preamp.headset 23 voice.gain.tx.analog.preamp.chassis 32 voice.gain.tx.analog.preamp.chassis.IP_601 32 voice.gain.tx.analog.handset.wideband 3 voice.handset.rxag.adjust.IP_330 1 voice.
Administrator’s Guide SoundPoint IP / SoundStation IP Acoustic Echo Cancellation These settings control the performance of the speakerphone acoustic echo canceller. Polycom recommends that you do not change these values. . Attribute Default voice.aec.hs.enable 0 voice.aec.hs.lowFreqCutOff 100 voice.aec.hs.highFreqCutOff 7000 voice.aec.hs.erlTab_0_300 -24 voice.aec.hs.erlTab_300_600 -24 voice.aec.hs.erlTab_600_1500 -24 voice.aec.hs.erlTab_1500_3500 -24 voice.aec.hs.
Configuration Files Acoustic Echo Suppression These settings control the performance of the speakerphone acoustic echo suppressor. Polycom recommends that you do not change these values. Attribute Default voice.aes.hs.enable 0 voice.aes.hs.duplexBalance 7 voice.aes.hd.enable 0 voice.aes.hd.duplexBalance 0 voice.aes.hf.enable 1 voice.aes.hf.duplexBalance.0 7 voice.aes.hf.duplexBalance.1 7 voice.aes.hf.duplexBalance.2 6 voice.aes.hf.duplexBalance.3 6 voice.aes.hf.duplexBalance.
Administrator’s Guide SoundPoint IP / SoundStation IP Background Noise Suppression These settings control the performance of the transmit background noise suppression feature. Polycom recommends that you do not change these values. Attribute Default voice.ns.hs.enable 0 voice.ns.hs.signalAttn -6 voice.ns.hs.silenceAttn -9 voice.ns.hd.enable 0 voice.ns.hd.signalAttn 0 voice.ns.hd.silenceAttn 0 voice.ns.hf.enable 1 voice.ns.hf.signalAttn -6 voice.ns.hf.silenceAttn -9 voice.ns.hf.
Configuration Files 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. Attribute Default voice.agc.hs.enable 0 voice.agc.hd.enable 0 voice.agc.hf.enable 0 Receive Equalization These settings control the performance of the receive equalization feature.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Default voice.rxEq.hs.IP_650.postFilter.enable 0 voice.rxEq.hd.IP_330.preFilter.enable 0 voice.rxEq.hd.IP_430.preFilter.enable 0 voice.rxEq.hd.IP_500.preFilter.enable 0 voice.rxEq.hd.IP_600.preFilter.enable 0 voice.rxEq.hd.IP_601.preFilter.enable 0 voice.rxEq.hd.IP_650.preFilter.enable 1 voice.rxEq.hd.IP_330.postFilter.enable 0 voice.rxEq.hd.IP_430.postFilter.enable 0 voice.rxEq.hd.IP_500.postFilter.enable 0 voice.rxEq.
Configuration Files Transmit Equalization These settings control the performance of the hands-free transmit equalization feature. Polycom recommends that you do not change these values. . Attribute Default voice.txEq.hs.IP_330.preFilter.enable 0 voice.txEq.hs.IP_430.preFilter.enable 0 voice.txEq.hs.IP_500.preFilter.enable 0 voice.txEq.hs.IP_600.preFilter.enable 0 voice.txEq.hs.IP_601.preFilter.enable 0 voice.txEq.hs.IP_650.preFilter.enable 1 voice.txEq.hs.IP_330.postFilter.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Default voice.txEq.hf.IP_330.preFilter.enable 0 voice.txEq.hf.IP_430.preFilter.enable 0 voice.txEq.hf.IP_500.preFilter.enable 0 voice.txEq.hf.IP_600.preFilter.enable 0 voice.txEq.hf.IP_601.preFilter.enable 0 voice.txEq.hf.IP_650.preFilter.enable 1 voice.txEq.hf.IP_4000.preFilter.enable 0 voice.txEq.hf.IP_330.postFilter.enable 1 voice.txEq.hf.IP_430.postFilter.enable 1 voice.txEq.hf.IP_500.postFilter.enable 1 voice.txEq.
Configuration Files Voice Activity Detection These settings control the performance of the voice activity detection (silence suppression) feature. Attribute Permitted Values Default Interpretation voice.vadEnable 0, 1 0 If set to 1, enable VAD. voice.vadThresh integer from 0 to 30 15 The threshold for determining what is active voice and what is background noise in dB. This does not apply to G.729AB codec operation which has its own built-in VAD function. voice.vad.
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 This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation httpd.enabled 0, 1 1 If set to 1, the HTTP server will be enabled. 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.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute call.offeringTimeOut Permitted Values positive integer Default Interpretation 60 Time in seconds to allow an incoming call to ring before dropping the call, 0=infinite. Note: The call diversion, no answer feature will take precedence over this feature if enabled. For more information, refer to No Answer on page A-91. call.
Configuration Files Attribute call.stickyAutoLineSeize.onHook Dialing Permitted Values Default Interpretation Null, 0, 1 Null If call.stickyAutoLineSeize is set to 1, this parameter has no effect. The regular stickyAutoLineSeize behavior is followed. If call.stickyAutoLineSeize is set to 0 or Null and this parameter is set to 1, this overrides the stickyAutoLineSeize behavior for hot dial only. (Any new call scenario seizes the next available line.) If call.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Permitted Values Default Interpretation call.shared.oneTouchResume 0, 1 0 If set to 1, when a shared line has a call on hold the remote user can press that line and resume the call. If more than one call is on hold on the line then the first one will be selected and resumed automatically.
Configuration Files When the volatile storage option is enabled, ensure that a properly configured boot server that allows uploads is available to store a back-up copy of the directory or its contents will be lost when the phone reboots or loses power. Attribute Permitted Values Default Interpretation dir.local.volatile.2meg 0, 1 0 Attribute applies to platforms with 2 Mbytes of flash memory. If set to 1, use volatile storage for phone-resident copy of the directory to allow for larger size. dir.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Permitted Values Default Interpretation dir.local.nonVolatile.maxSize.8meg 1 to 100 100 Attribute applies only to platforms with 8 Mbytes of flash memory. This is the maximum size of non-volatile storage that the directory will be permitted to consume. dir.search.field 0, 1 Null Specifies how to search the contact directory. If set to 1, search by contact’s first name. If set to 0, search by contact’s last name.
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, IP_4000, and IP_7000 and y is the key number.
Configuration Files Bitmaps The bitmaps used by each phone model are defined in this section. Platform , , , , , In the following table, x=IP_300, IP_330, IP_400, IP_500, IP_600, IP_4000 and y is the bitmap number.
Administrator’s Guide SoundPoint IP / SoundStation IP This configuration attribute is defined as follows: Attribute ind.idleDisplay.mode ind.idleDisplay.enabled Permitted Values 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.
Configuration Files 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.colour Red or Green (default is Red if not specified) For bi-color LEDs, specify color.
Administrator’s Guide SoundPoint IP / SoundStation IP 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-67) for this indicator. This maps the logical index to a specific physical LED.
Configuration Files 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 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. IP 400: 1-102 IP 500: 1-160 IP 600: 1-320 IP 4000: 1-248 ind.gi.x.y.
Administrator’s Guide SoundPoint IP / SoundStation IP 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.
Configuration Files 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.
Administrator’s Guide SoundPoint IP / SoundStation IP 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.
Configuration Files 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, ...
Administrator’s Guide SoundPoint IP / SoundStation IP 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.
Configuration Files 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.
Administrator’s Guide SoundPoint IP / SoundStation IP RAM Disk This attribute’s settings control the phone’s internal RAM disk feature. Polycom recommends that you do not change these values. 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, ...
Configuration Files Delay These settings control the phone’s behavior when a request for restart or reconfiguration is received. Attribute request.delay.type Permitted Values Null, “audio”, or “call” Default Interpretation call Defines the strategy to adopt before a request gets executed. If set to “audio”, a request can be executed as soon as there is no active audio on the phone, independently of any call state.
Administrator’s Guide SoundPoint IP / SoundStation IP 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.
Configuration Files Quotas This configuration attribute is defined as follows: Attribute res.quotas.x.name Permitted Values Interpretation “tone”=1, “bitmap”, or “font” The name of the sub-application for which the particular quota will apply: “tone” relates to all downloaded tones and sound effects “bitmap” relates to all downloaded bitmaps “font” relates to all downloaded fonts 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 USB Port This attribute’s settings control the USB port. This configuration attribute is defined as follows: Attribute Permitted Values Default Interpretation usb.enable 0, 1 Null This parameter enables or disables the USB port on the phone. This attribute also includes: • Bulk Drive Bulk Drive These settings control the bulk drive or memory stick. Attribute Permitted Values Default Interpretation usb.
Configuration Files • Messaging • Network Address Translation • Attendant • Roaming Buddies • Roaming Privacy Registration SoundPoint IP 301, 320, 330, and 430 support a maximum of two unique registrations, SoundPoint IP 501 supports three, the SoundPoint IP 550 supports four, and SoundPoint IP 600, 601, and 650 support six.
Administrator’s Guide SoundPoint IP / SoundStation IP Attribute Permitted Values Default Interpretation reg.x.thirdPartyName string in the same format as reg.x.address Null This field must match the reg.x.address value of the other registration which makes up the bridged line appearance (BLA). It must be Null in all other cases. reg.x.auth.userId string Null User ID to be used for authentication challenges for this registration.
Configuration Files Attribute Permitted Values Default Interpretation reg.x.ringType 1 to 22 2 The ringer to be used for calls received by this registration. Default is the first non-silent ringer. reg.x.lineKeys 1 to max 1 max = the number of line keys on the phone.
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.serverFeatureControl.cf 0, 1 0 If set to 1, server-based call forwarding is enabled. The call server has control of call forwarding. If set to 0, server-based call forwarding is not enabled. This is the old behavior. If reg.x.serverFeatureControl.cf is not Null, this attribute overrides the global server-based call forwarding flag in the sip.cfg configuration file. reg.x.serverFeatureControl.
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. Automatic Off-Hook Call Placement An optional per-registration feature is supported which allows automatic call placement when the phone goes off-hook.
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: x=1-4; IP 600: x=1-6; IP 601: x=1-12; IP 650: x=1-34; IP 4000: 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.missedCallTracking.x.
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: x=1-4; IP 600: x=1-6; IP 601: x=1-12; IP 650: x=1-34; IP 4000: x=1. Attribute Permitted Values Default Interpretation divert.x.
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-16. 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: x=1-4; IP 600: x=1-6; IP 601: x=1-12; IP 650: x=1-34; IP 4000: 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 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.
Administrator’s Guide SoundPoint IP / SoundStation IP 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.
Configuration Files 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.redunAttemptLi mit 10, Null device.prov.redunInterAtte mptDelay 300, Null device.sntp.serverName any string Can be dotted-decimal IP address or domain name string.
Administrator’s Guide SoundPoint IP / SoundStation IP 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 1 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-71.
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-04.
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 No WWW-Authenticate Yes Notes 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 Shared Call Appearance Signaling A shared line is an address of record managed by a call server. The server allows multiple end points to register locations against the address of record. The phone supports shared call appearances (SCA) using the SUBSCRIBE-NOTIFY method in the “SIP Specific Event Notification” framework (RFC 3265).
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 • 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 • 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 • Verisign Class 1 Public Primary Certification Authority • Verisign Class 1 Public Primary Certification Authority - G2 • Verisign Class 1 Public Primary Certification Authority - G3 • Verisign Class 2 Public Primary Certification Authority • Verisign Class 2 Public Primary Cert
Administrator’s Guide SoundPoint IP / SoundStation IP A key is generated by the utility and must be downloaded to the phone so that it can decrypt the files that were encrypted on the server. The device.sec.configEncryption.key configuration file parameter is used to set the key on the phone. The utility generates a random key and the encryption is Advanced Encryption Standard (AES) 128 in Cipher Block Chaining (CBC) mode.
Miscellaneous Administrative Tasks The following configuration file changes are required to modify this feature: Central Configuration File: sip.cfg (boot server) Specify the phone-specific contact directory and the phone-specific configuration override file. For more information, refer to Encryption on page A-74. Configuration file: .cfg Change the encryption key. For more information, refer to Flash Parameter Configuration on page A-100.
Administrator’s Guide SoundPoint IP / SoundStation IP Model Width Height Color Depth IP 301 n/a n/a n/a IP 320/330 225 75 monochrome IP 430 94 23 monochrome IP 501 114 51 4-bit grayscale or monochrome IP 550/600/601 209 109 4-bit grayscale or monochrome IP 650 209 109 16-bit grayscale or monochrome IP 4000 150 33 monochrome Logos smaller than described in the table above are acceptable, but larger logos may be truncated or interfere with other areas of the user interface.
Miscellaneous Administrative Tasks 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): … … … …
Administrator’s Guide SoundPoint IP / SoundStation IP Model BootROM SIP Application IP 301/501 2.6.1 or later 1.4.2, 1.5.4, 1.6.1 or later IP 320/330 3.2.3 B or later 2.1.1 or later IP 430 3.1.3 C or later 1.6.6 or later IP 550 3.2.2 B or later 2.1 or later IP 600 2.0 or later 1.0 or later IP 601/EM 3.1 or later 1.6 or later IP 650/EM 3.2.2 B or later 2.0.3 B or later IP 4000 2.6 or later 1.
Miscellaneous Administrative Tasks Multiple Key Combinations On SoundPoint IP and SoundStation IP phones, certain multiple key combinations can be used to reboot the phone and restore factory defaults. For other methods for resetting and rebooting your SoundPoint IP or SoundStation IP phones, refer to “Quick Tip 18298: Resetting and Rebooting SoundPoint IP Phones” at http://www.polycom.com/support/voice/.
Administrator’s Guide SoundPoint IP / SoundStation IP Default Feature Key Layouts The following figures and table show the default SIP key layouts for SoundPoint IP 301, 320, 330, 430, 501, 550, 600, 601, and 650 and SoundStation IP 4000 models.
Miscellaneous Administrative Tasks SoundPoint IP 430 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 C - 11
Administrator’s Guide SoundPoint IP / SoundStation IP SoundPoint IP 550/600/601/650 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 1 24 2 23 3 Conference 32 ABC DEF ABC DEF 8 Do Not Disturb 22 9 4 19 5 20 6 GHI Transfer 37 JKL GHI JKL 77 TUV 36 PQRS Hold 18 TUV 10 WXYZ Hold 39 WXYZ 38 0 # 14 13 OPER * 15 40 MNO 21 88 99 16 17 PQRS Redial MNO OPER 11 12 Key ID The SoundPoint IP 550 has only the top
Miscellaneous Administrative Tasks Key ID IP 301 Function IP 320 & 330 Function IP 430 Function IP 501 Function IP 550, 600, 601, & 650 Function IP 4000 Function 6 n/a Dialpad1 n/a Delete Delete ArrowUp 7 Redial SoftKey3 Redial Menu Menu Dialpad4 8 VolUp Line1 VolUp Messages Messages Dialpad5 9 VolDown ArrowRight VolDown DoNotDisturb DoNotDisturb Dialpad6 10 DialpadStar Line2 DialpadStar Hold MicMute VolDown 11 Dialpad0 n/a Dialpad0 VolUp VolUp n/a 12 Dialp
Administrator’s Guide SoundPoint IP / SoundStation IP Key ID IP 301 Function IP 320 & 330 Function IP 430 Function IP 501 Function IP 550, 600, 601, & 650 Function IP 4000 Function 37 n/a n/a n/a Transfer Transfer n/a 38 n/a n/a n/a Headset Headset n/a 39 n/a n/a n/a MicMute Handsfree n/a 40 n/a n/a n/a Handsfree Hold n/a 41 n/a n/a n/a n/a Line4 n/a 42 n/a n/a n/a n/a Line5 n/a Note The SoundPoint IP 550 has only the top four lines keys.
Miscellaneous Administrative Tasks — VLAN IDs may be decimal, hex, or octal For example: The following DVD strings will result in the phone using VLAN 10: VLAN-A=10; VLAN-A=0x0a; VLAN-A=012; Note If a VLAN tag is assigned by CDP, DHCP VLAN tags will be ignored.
Administrator’s Guide SoundPoint IP / SoundStation IP 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. The format of this option's data is not specified in RFC 2132, but is left to each vendor to define its own format.
Miscellaneous Administrative Tasks - end of sub-options For the BootROM, sub-option 4 and sub-option 5 will contain the same string.
Administrator’s Guide SoundPoint IP / SoundStation IP C - 18
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 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 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.
Third Party Software and/or other materials provided with the distribution. 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.
Administrator’s Guide SoundPoint IP / SoundStation IP 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 S
Third Party Software D-5
Administrator’s Guide SoundPoint IP / SoundStation IP D-6
Index A ACD. See also automatic call distribution acoustic echo cancellation 4–44 acoustic echo cancellation A–40 acoustic echo suppression A–41 AEC. See also acoustic echo cancellation AGC.
Administrator’s Guide SoundPoint IP / SoundStation IP application configuration file A–4 application error messages 5–3 application files overview 2–6 Applications key 4–28 attendant A–97 attended transfers 4–17 audio codecs 4–45 automatic call distribution 4–33 automatic gain control 4–46 automatic gain control A–43 automatic off-hook call placement 4–16 automatic off-hook call placement A–88 B background logo adding C–5 configuration file changes C–6 background noise suppr
Index DHCP menu 3–7 DHCP or manual TCP/IP setup 3–2 dial plan A–16 digit map default A–18 examples A–17 match and replace A–17 digit map A–94 directed call pick-up 4–19 directory A–58 distinctive call waiting 4–7 distinctive incoming call treatment 4–6 distinctive ringing 4–7 diversion A–90 DND.
Administrator’s Guide SoundPoint IP / SoundStation IP M MAC address definition A–2 substitution 3–15, 3–20, A–3 main browser A–82 main menu 3–6 manual configuration, overview 2–7 manual log upload 5–6 master configuration file model number version A–4 part number substitution A–4 master configuration files details A–2 overview 2–5 message waiting indication 4–6 message waiting indicator A–96 messaging A–95 Microbrowser 4–28 Microbrowser A–79 microphone mute 4–13 Microsoft Live Commu
Index resource files, overview 2–7 restarting phones 3–16, 3–18 RFC support B–2 ring type
Administrator’s Guide SoundPoint IP / SoundStation IP Network link is down 5–3 Not all configuration files were present 5–3 power and startup issues 5–9 reading a boot log 5–7 reading an application log 5–8 registration status 5–3 scheduled logging 5–6 screens and systems access issues 5–11 trusted certificate authority list C–1 U upgrading SIP application 3–17 USB port A–82 user interface, soft key activated 4–13 user preferences A–23 V VAD.