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