SIP 3.1.2B
Copyright Notice
Disclaimer
About This Guide
Administrator’s Guide SoundPoint IP / SoundStation IP
Contents
Administrator’s Guide SoundPoint IP / SoundStation IP
Contents
Troubleshooting Your SoundPoint IP / SoundStation IP Phones
Contents
Administrator’s Guide SoundPoint IP / SoundStation IP
SoundPoint IP Desktop Phones
Introducing the SoundPoint IP / SoundStation IP Family
Administrator’s Guide SoundPoint IP / SoundStation IP
SoundPoint IP SoundPoint IP 550/560 SoundPoint IP 600/601
SoundStation IP Conference Phones
Currently supported conference phones are SoundStation IP
Key Features of Your SoundPoint IP / SoundStation IP Phones
SoundPoint IP 600
Administrator’s Guide SoundPoint IP / SoundStation IP
Overview
SoundPoint IP / SoundStation IP Phones on
Where SoundPoint IP / SoundStation IP Phones Fit
Session Initiation Protocol Application Architecture
BootROM
Application
Master Configuration Files Application Configuration Files
Configuration
Application Configuration Files
Resource Files
Ring tones Synthesized tones Contact directories
Available Features
Overview
Microsoft Live Communications Server
Overview
Administrator’s Guide SoundPoint IP / SoundStation IP
New Features in SIP
Administrator’s Guide SoundPoint IP / SoundStation IP
Setting up Your System
Dhcp or Manual TCP/IP Setup
Setting Up the Network
For more information on Dhcp options, go to
FTP Tftp Http Https
Supported Provisioning Protocols
Main Menu Dhcp Menu Server Menu Ethernet Menu Syslog Menu
Modifying the Network Configuration
Certificate Authority List on page C-1
Name Possible Values Description Dhcp Client
EM Power
Dhcp Menu
Phone IP Address
Section, Server Menu
Menu
Possible Name Values Description
Menu
Server Menu
Name Possible Values Description
Dhcp on page C-23
Server. Refer to Supported Provisioning Protocols on
Or later. Passive FTP is still supported
Using the method specified in RFC
Password these characters if they are correctly escaped
Password, this will be ignored
This will be ignored
Ethernet menu
Setting
Setting unless you want to disable the PC port
Refer to Basic Logging level/change/ and render
Setting Up the Boot Server
Create account and home directory
Information, contact your Certified Polycom Reseller
Each phone may open multiple connections to the server
These permissions, but will not be able to upload files
You must decide on a boot server security policy
Deploying Phones From the Boot Server
Sip.cfg Phone1.cfg 000000000000.cfg Directory~.xml
SoundPointIP-dictionary.xmlone of each supported language
Provisioning Phones
Configuration Files on page C-4
PhoneMACaddress.cfg
Configuration on page A-4
SIP/ on page A-10
5EL@
Provisioning SoundStation IP 7000 Phones Using CLink
Supporting SoundPoint IP and SoundStation IP Phones
Upgrading SIP Application
Supporting SoundPoint IP 300 and 500 Phones
To upgrade your SIP application
Administrator’s Guide SoundPoint IP / SoundStation IP
This chapter also provides instructions on
Setting Up Basic Features
Configuring SoundPoint IP / SoundStation IP Phones Locally
Administrator’s Guide SoundPoint IP / SoundStation IP
Call Waiting
Call Timer
Call Log
Missed Call Notification
Called Party Identification
Calling Party Identification
Central boot server
Context Sensitive Volume Control
Connected Party Identification
Customizable Audio Sound Effects
Distinctive Incoming Call Treatment
Message Waiting Indication
Messages and voice messages are waiting
Saf/ on page A-30 or Sound Effects se/ on page A-31
Distinctive Call Waiting
Distinctive Ringing
Address-directory
Xml Local
116
Do Not Disturb
Handset, Headset, and Speakerphone
Userpreferences/on page A-107
Local Contact Directory
Ory.xml
Direct
Xml
?xml version=1.0 encoding=UTF-8 standalone=yes ? directory
Element Permitted Values Interpretation
Directory
UTF-8’s variable length encoding
Space is added between first and last names
Auto-reject
Local Digit Map
7000, the maximum speed-dial index is
Speed Dial
Microphone Mute
Soft Key Activated User Interface
Time and Date Display
Boot server Ethernet
Idle Display Animation
Ethernet Switch
Your choice
Graphic Display Backgrounds
Their phone
Call Hold
Automatic Off-Hook Call Placement
For images, select a filename. For example
AutoOffHook/ on page A-112
Hold/localReminder/ on page A-67
Call Transfer
Manage Conferences
Local / Centralized Conferencing
Call Forward
Directed Call Pick-Up
Group Call Pick-Up
Setting Up Advanced Features
Call Park/Retrieve
Last Call Return
Configuring Your System
Feature Key Layouts on page C-12
Configurable Feature Keys
Multiple Call Appearances
Multiple Line Keys per Registration
Shared Call Appearances
Bridged Line Appearance
Busy Lamp Field
EchnicalBulletinspub.html
Customizable Fonts and Indicators
Live Communications Server 2005 Integration on
Attendant.uri
Instant Messaging
Central boot
Multilingual User Interface
Server Sip.cfg
Fonts, refer to Fonts font/ on page A-72
Swedish
Microbrowser
Synthesized Call Progress Tones
Saf/ on page A-30
Call Progress Patterns on page A-33
Real-Time Transport Protocol Ports
Nat/ on page A-120
Network Address Translation
Corporate Directory
Settings Basic Preferences Corporate Directory View
This section contains the following information
Display
Recording and Playback of Audio Calls
670 have a functioning USB port
Daisy-Chaining Phones
Provisioning Phones Over CLink
Efk Efklist Efkprompt Version Special Characters
Enhanced Feature Keys
Efk
This element describes behavior of enhanced feature key
Efklist
This element contains the following parameters
This element describes the behavior of the user prompts
Efkprompt
Version efk.version=2
Version
Special Characters
Macro Action
Macro Action Prompt Macro Substitution Expanded Macros
Prompt Macro Substitution
Using Invite if no active call or Dtmf if an active
Call. The use of refer method is call server
Dependentand may require the addition of star codes
Prompt is not required for every macro
Collected. The macros are case sensitive
Expanded Macros
Contact Directory File Format on
Examples
Enhanced Feature Key XML Files
Configuration File Changes
Action String Example
Action string
Well as others mapped to Park Return and Call Pickup
Using Call Park Key
Contact Directory Changes
Configurable Soft Keys
MyStatus and Buddies Hold, Transfer, and Conference
New Call End Call Split Join Forward
103
Update the sip.cfg configuration as follows
Softkey.feature.newcall =
Update sip.cfg as follows
Voice Mail Integration
Server server/ on page A-7
Multiple Registrations
Server/ on page A-7, and Registration reg/ on page A-107
Automatic Call Distribution
Server Redundancy
DNS SIP Server Name Resolution
For Outgoing Calls Invite Fallback
Phone Operation for Registration
Phone Configuration
Configured
Presence
Microsoft Live Communications Server 2005 Integration
Boot server Address-directory
Immediately with business contacts
Examples on
Roamingprivacy/ on page A-123
Roamingbuddies/ on page A-122
Refer to Roaming Privacy roamingprivacy/ on page A-123
Refer to Roaming Buddies roamingbuddies/ on page A-122
Locate the roamingprivacy attribute
Set reg.x.auth.password to the LCS password
Set the reg.x.server.y.address to the LCS server name
Web Content Examples User Interface Signaling Changes
Access URL in SIP Message
Web Content Status Indication
Settings Menu
Static DNS Cache
Example
Dns.cache.A.1 , dns.cache.A.2 , and so on
Set to null to force SRV lookups
Display of Warnings from SIP Headers
Setting Up Audio Features
Jitter Buffer and Packet Error Concealment
Low-Delay Audio Packet Transmission
Voice Activity Detection
Dynamic Noise Reduction Treble/Bass Controls
Dtmf Tone Generation
Acoustic Echo Cancellation
Dtmf Event RTP Payload
DTMF/ on page A-28
Effective
Audio Codecs
Following table summarizes the phone’s audio codec support
On page A-38 and Codec Profiles audioProfile/ on page A-41
Background Noise Suppression
Comfort Noise Fill
Ieee 802.1p/Q
IP Type-of-Service
Automatic Gain Control
Periodic-Generated during a call at a configurable period
Three types of quality reports can be enabled
Voice Quality Monitoring
Threshold
Dynamic Noise Reduction
Setting Up Security Features
Treble/Bass Controls
Monitoring/ on page A-52
Custom Certificates
Local User and Administrator Privilege Levels
Pwd/length/ on page A-89
Tinspub.html
Configuration File Encryption
Incoming Signaling Validation
Configuration changes can performed locally
Secure Real-Time Transport Protocol
Device.cfg
Configuring SoundPoint IP / SoundStation IP Phones Locally
Configuration on page A-124
Passwords
Troubleshooting Your SoundPoint IP / SoundStation IP Phones
BootROM Error Messages
Error Messages
Application Error Messages
Status Menu
Log Files
Scheduled Logging
Manual Log Upload
Following figure shows a portion of a boot log file
Reading a Boot Log
Following figure shows a portion of an application log file
Testing Phone Hardware
Reading an Application Log
Symptom Problem Corrective Action
Power and Startup
Controls
To Rebooting the Phone on
Access to Screens and Systems
Calling
Phone on page C-10
Displays
Upgrading
Audio
Oice/soundpointip/VoIPTechnicalBullet
Inspub.html
Administrator’s Guide SoundPoint IP / SoundStation IP
Configuration Files
Master Configuration Files
One will cause a reboot loop
CONFIGFILES=phone1MACADDRESS.cfg, sip.cfg MISCFILES=
Application Configuration
Configuration Files
Attribute Permitted Default Interpretation Values
This configuration attribute is defined as follows
Protocol voIpProt
This attribute includes
If voIpProt.server.x.address is a
Permitted Attribute Values Default Interpretation
VoIpProt.server.x.transport is set to
If voIpProt.server.x.transport is set to
VoIpProt.server.x.address is an IP
VoIpProt.SIP.lcs
To 1 default is
Parameter if set to 1 when the parameter
Permitted Attribute Values Default Interpretation
Reg.x.auth.optimizedInFailover takes
Lcl.ml.lang.tags.x in Multilingual ml
This attribute also includes
Ept = 325,326,327,328,329,330
Outbound Proxy outboundProxy
Alert Information alertInfo
Due to the additional signaling required
Request Validation requestValidation
May have a negative performance impact
Special Events specialEvent
Conference Setup conference
Dial Plan dialplan
Supported when configured with the values
UDP, TCP, or TLS
Dialplan.applyToCallListDial
Digit Map digitmap Routing routing
This attributes also includes
Configuration Files
Server server Emergency emergency
Attribute Permitted Values Default Interpretation
Server server
Localization lcl
Emergency emergency
Multilingual ml Date and Time datetime
Lcl.ml.lang.menu.1
Attribute Permitted Values Interpretation
Lcl.ml.lang.menu.2
Lcl.ml.lang.menu.3
Lcl.datetime.date.dateTop
Lcl.datetime.date.longFormat
Lcl.ml.lang.tags.1 =
Zh-cn,zhq=0.9,enq=0.8
Optional Set lcl.ml.lang to be the new languageregion string
Permitted Attribute Values Interpretation
User Preferences up
OnIntensity value
OnIntensity, it will be replaced with
Dual Tone Multi-Frequency Dtmf Chord-Sets chord
Tones tones
Disabled
Only be enabled when tone.dtmf.viaRtp is
Be enabled when tone.dtmf.viaRtp is
Sampled Audio for Sound Effects saf
To SoundPointIPWelcome.wav
Sound Effects se
Following table, x is the sampled audio file number
Instruction Meaning Example
Patterns pat Ring type rt
Call progress Use within phone Pattern number
Miscellaneous Patterns
Call Progress Patterns
Call progress Pattern number Use within phone
Ringer pattern number Default description
Ringer Patterns
Miscellaneous Pattern number Use within phone
Miscellaneous Patterns
Defined in Call Progress Patterns on page A-33
Sequential
Patterns on page A-34
Voice Settings voice
These codecs include
Following voice codecs are supported
Codec Preferences codecPref Codec Profiles audioProfile
Codec Preferences codecPref
Permitted Attribute Values Default Interpretation
Voice.codecPref.IP7000.G722
Codec Profiles audioProfile
Attribute Default
Attribute Default
Attribute Default
Acoustic Echo Cancellation aec
Acoustic Echo Suppression aes
Background Noise Suppression ns
Feature
Receive Equalization rxEq
Transmit Equalization txEq
Attribute Default
Central Report Collector collector Alert Reports alert
Voice.vadEnable parameter
If voice.vadEnable is set to 0, add attribute line
Nable.periodic is set 1, since
Server server RTCP-XR rtcpxr
Central Report Collector collector
Alert Reports alert
Following settings control the 802.1p/Q userpriority field
Quality of Service QOS
RTCP-XR rtcpxr
Ethernet Ieee 802.1p/Q ethernet IP TOS IP
Call Control callControl
These parameters apply to RTP packets
Other other
RTP rtp Call Control callControl
RTP rtp
Qos.ip.callControl…
Basic TCP/IP Tcpip
Attribute Permitted Default Values
Permitted Attribute Values Default Interpretation
Start.dayOfWeek
If fixedDayEnable is set to
Start.date is ignored
Stop.dayOfWeek
RTP rtp
Must be enabled for this to work
TcpIpApp.port.rtp.filterByIp
TcpIpApp.port.rtp.filterByPort
Value that is out of range,
Default value is used
Web Server httpd
Configuration cfg
Call Handling Configuration call
If call.stickyAutoLineSeize is set to 1, this
Reg.x.callsPerLineKey. Refer to Registration
SoundPoint IP 330/320 only
Shared Calls shared Hold, Local Reminder hold/localReminder
BroadWorks calls server only. You must change
Value if your organization uses a different call
IP 4000, 6000, and 7000 phones. For other
Servers
Phones a quick press and release of the line
Key will resume a call whereas pressing
Local Directory local Corporate Directory corp
Directory dir
Dir.local.volatile.4meg
Dir.local.volatile.8meg, this
Read only, speed dial entry on
SoundPoint IP 320/330 is disabled
Enter the speed dial index followed
By #
Used for display purposes only
600, and 601 legacy phones, use
Dir.corp.viewPersistence
Leg tagged parameter. This
Prevents slow behavior after exiting
Fonts font
Presence pres
SoundPoint IP 550, 560, 600, 601, 650,
SoundPoint IP 320, 330, 430, 500
IP330 font IP330
Keys key
This configuration attribute is defined as follows
Functions
Following table lists the functions that are available
Backgrounds bg
Built-in default solid pattern is displayed
Same to display correctly on grayscale
Darkens the graphic during preview
Individual phone when the user lightens or
Bitmaps bitmap
Indicators ind
Following indicators are used by the phone
IP7000/ on page A-80
Platform IP300/, IP 330/, IP400
IP500/, IP600/, IP4000/,
IP4000/, and IP7000/ tag above
Attribute Permitted Interpretation Values
IP300/, IP330/, IP400/, IP500/, IP600
Following table, x is the LED number
LEDs led
Level Interpretation
Event Logging log
Type Example
Three formats are available for the event timestamp
Two types of logging are supported
You do not change this value
Log.render.level maps to
Syslog Menu on
Support append mode unless
Set starting with log.sched.x where x identifies the task
Server is set up for this
Uploaded if no new events have
Security sec
Encryption encryption Password Lengths pwd/length
License license
RAM Disk ramdisk
Provisioning prov
Value
Delay delay
Request request
Feature feature
Finder finder Quotas quotas
Resource res
Phones, this value is internally replaced by 4X
Phones, this value is internally replaced by 2X
Value. For the SoundStation IP 6000
SoundStation IP 4000, 6000, and 7000 phones
Microbrowser mb
This value is internally replaced by 2X the value. For
Replaced by 4X the value
SoundPoint IP 430, 501, 550, 560, 600
Miscellaneous XML errors can occur on
650, and 670 and SoundStation IP 4000
7000 phones
Used. Refer to User Preferences up/ on
If mb.main.idleTimeout
Function is selected
Detrimental effect on performance of the phone
Applications apps
Values
Apps.push.password must be set to non-Null
Non-Null values
Naptr NAPTR/ attribute SRV SRV
Peer Networking pnet
DNS Cache dns
Http//tools.ietf.org/html/rfc2915
Http//tools.ietf.org/html/rfc2782
Macro Definition on
Soft Keys softkey
Permitted Attribute Values Default Interpretation
For this soft key to be displayed
New Call and Callers soft keys
Parameters include
Per-Phone Configuration
User Preferences userpreferences
Registration reg
Parameters will override the parameters
Is non-Null, all of the reg.x.server.y.xxx
Specified in sip.cfg in Server server/ on
A-7
Sharing that registration
Refer to Call Handling Configuration call
Shared line counts as a call for every phone
If reg.x.serverFeatureControl.cf is not
VoIpProt.SIP.strictLineSeize is
Calls call
Sylantro call server only
Set to 1 enabled, this parameter is ignored. For
More information, refer to SIP SIP/ on
If call.missedCallTracking.x.enabled is
Diversion divert
Forwarding is enabled, this
Parameter is enabled
Divert.x.contact will be
Calls can be automatically diverted when the phone is busy
Server-base call forwarding is
Enabled, this parameter is
Dialplan.x.digitmap is not
Plan dialplan/ on page A-17
Dialplan.x.applyToUserDial When present, and if
Digit Map digitmap/ on
Messaging msg
Message Waiting Indicator mwi
Server/ on page A-118
Chosen. Refer to Voice Mail Integration on
Network Address Translation nat
Attendant attendant
VoIpProt.local.signalPort in sip.cfg
Communications Server
Roaming Buddies roamingbuddies
Value 0 if the call server is Microsoft Live
User Preferences userpreferences
Roaming Privacy roamingprivacy
VoIpProt.SIP.strictLineSeize
VoIPProt.SIP.lineSeize.retries,
Flash Parameter Configuration
Setup on
Enabled
This flash attributes are defined as follows
For example, if device.net.ipAddress.set =
Server address is preserved
Menu on
Refer to Basic Logging level/change/
Render/ on page A-86
Administrator’s Guide SoundPoint IP / SoundStation IP
Session Initiation Protocol SIP
RFC and Internet Draft Support
Method Supported
Request Support
Following SIP request messages are supported
Header Supported
Header Support
Following SIP request headers are supported
Header Supported
Response Supported
Response Support
Following SIP responses are supported
3xx Responses Redirection
5xx Responses Server Failure
Reliability of Provisional Responses
Hold Implementation
Transfer
Third Party Call Control
Bridged Line Appearance Signaling
Shared Call Appearance Signaling
Trusted Certificate Authority List
Miscellaneous Administrative Tasks
Administrator’s Guide SoundPoint IP / SoundStation IP
Miscellaneous Administrative Tasks
Encrypting Configuration Files
Option. This shows the digest field
Changing the Key on the Phone
Encrypted and unencrypted file are the same
Encryption/ on page A-89
Model Width Height Color Depth
Adding a Background Logo
Model Associate Parameter
RGB Values
Color RGB Values Decimal Hexadecimal
IP300 IP300 IP330
Bitmaps
IP330 IP400
IP500 IP500
Animations Indicators
BootROM/SIP Application Dependencies
Model BootROM SIP Application
Migration Dependencies
Multiple Key Combinations
IP 4000 and 6000 6, 8 and * dial pad keys
BootROM until the password prompt appears
About three seconds
IP 301 The two Line keys and the Up and Down arrow keys
SoundStation IP 4000, 6000, and 7000 models
Default Feature Key Layouts
SoundPoint IP
Key ID Function
SoundPoint IP 320/330
SoundPoint IP
OPER0 14 # 12 11OPER Key ID
SoundPoint IP 550/560/600/601/650/670
SoundStation IP
Key ID
Internal Key Functions
Label Function
LCR
Label Function
VLAN-A=10 VLAN-A=0x0a VLAN-A=012
Assigning a Vlan ID Using Dhcp
Parsing Vendor ID Information
Miscellaneous Administrative Tasks
Product Name Model Name Product Part Number
Product, Model, and Part Number Mapping
Press
Select Save Config
Disabling PC Ethernet Port
Administrator’s Guide SoundPoint IP / SoundStation IP
Third Party Software
OpenSSL
Third Party Software
Zlib
Copyright and Permission Notice
Administrator’s Guide SoundPoint IP / SoundStation IP
Numerics
Index
Administrator’s Guide SoundPoint IP / SoundStation IP
IP TOS call control callControl A-58 IP400 font A-74
Dhcp
Administrator’s Guide SoundPoint IP / SoundStation IP
SDP SDP A-9
Sipsip A-10
POLYCOM, INC Application Programming Interface License API
License Agreement for Development Purposes
Support Services
Export Controls
Page
Addendum to SIP 3.1 Administrator’s Guide
Distribution Zip File
New or Changed Features
Electronic Hookswitch Graphic Display Backgrounds
Metrics for listening and conversational quality
Configuration File Changes
Backlight Intensity
Gains gain
Transmit Equalization txEq
Receive Equalization rxEq
Background bg
Administrator’s Guide Addendum for the SoundPoint IP
Multiple Key Combinations and Default Key Layout
Key ID
Administrator’s Guide Addendum for the SoundPoint IP
Graphic Display Backgrounds Multilingual User Interface
Frame feature refer to Digital Picture Frame on
Picture is displayed when the phone starts up the first time
Video Transmission
Through Settings Basic Video Camera Settings
Settings Basic Video Video Call Settings, Video Screen
LocalCameraView/ on
Mode, and Local Camera View
CodecPref/on page 1-12 and Codec Profiles codecPref/ on
Video Codecs
On page 1-17 and Codec Profiles audioProfile/ on
Digital Picture Frame
Polycom VVX 1500 phone or through a computer using
LCD Power Saving
Application Launch Pad
Developer’s Guide, which can be found at
Configuration File Changes
Bg.VVX1500.color.bm.1.name to
Application Configuration File Changes
These configuration attributes are defined as follows
Camera Controls camera Local Camera View localCameraView
These attributes also include
Camera Controls camera
Codec Preferences codecPref Codec Profiles codecPref
Video.profil
Codec Profiles codecPref
H264.jitter
BufferMin +
TterBufferMin
H2631998.ji
SDP
Codec Preferences codecPref Codec Profiles audioProfile
Codec Preferences codecPref
Codec Profiles audioProfile
Gains gain
Receive Equalization rxEq
Other qos.ip.rtp.video…
Qos.ip.rtp.video… parameters
Polycom VVX 1500 only
This new configuration attribute is defined as follows
Hpad/geticonPicFrame
Mb.main.1.url=PicFrame
Mb.main.1.text=Picture Frame
Polycom.com
Per-Phone Configuration File Changes
Set up.pictureFrame.folder to
These new configuration attributes are defined as follows
Images/phone
Flash drive up.pictureFrame.folder
3725