Manuals / Linksys / Communications / Telephone

Linksys SPA942, SPA962, SPA932, SPA922 SIP Parameter Notes, Setting SIP Parameters, Description

Models: SPA942

1 196

Download 196 pages 29.34 Kb

Page 53

SIP Parameter Notes

Setting SIP Parameters

SIP Parameters

SIP Parameter Notes

The following table describes all SIP parameters.

Parameter	Description

Max Forward	SIP Max Forward value, which can range from 1 to 255.
	Defaults to 70.

Max Redirection	Number of times an invite can be redirected to avoid an infinite loop.
	Defaults to 5.

Max Auth	Maximum number of times a request can be challenged. Ranges from 0-
	255.
	Defaults to 2.

SIP User Agent Name	Used in outbound REGISTER requests. If empty, the header is not included.
	Macro expansion of $A to $D corresponding to GPP_A to GPP_D allowed.
	Defaults to $VERSION.

SIP Server Name	Server header used in responses to inbound responses.
	Defaults to $VERSION.

SIP Reg User Agent	User-Agent name used in a REGISTER request. If not specified, the SIP User
Name	Agent Name is also used for the REGISTER request.
	Defaults to blank.

SIP Accept Language	Accept-Language header used. If empty, the header is not included.
	Defaults to blank.

DTMF Relay MIME	MIME Type used in a SIP INFO message to signal a DTMF event. This
Type	parameter must match that of the service provider.
	Defaults to application/dtmf-relay.

Remove Last Reg	If set to yes, removes the last registration before re-registering (if the value
	is different).
	Defaults to no.

Use Compact Header	If set to yes, the SPA9x2 uses compact SIP headers in outbound SIP
	messages. If inbound SIP requests contain normal (non-compact)
	headers, the phone substitutes incoming headers with compact headers.
	If set to no, the SPA9x2 uses normal SIP headers. If inbound SIP requests
	contain compact headers, the phone reuses the same compact headers
	when generating the response, regardless of this setting.
	Defaults to no.

Escape Display Name	Setting this parameter to yes encloses the configured Display Name string
	(see ”Subscriber Information Parameters” section on page 102) in a
	pair of double quotes for outbound SIP messages.
	Any occurrences of or \ in the string is escaped with \ and \\ inside the pair
	of double quotes.
	Defaults to yes.

Linksys SPA9x2 Phone Administration Guide

46

Image 53

Linksys SPA942, SPA962, SPA932, SPA922 manual SIP Parameter Notes, Setting SIP Parameters, Description

Contents

ADMINISTRATION GUIDE Linksys SPA9x2 Phone Administration GuideInterim version released June 2008 to be updated August BUSINESS SERIESChapter 2 Getting Started Table of ContentsChapter 1 Introducing Linksys SPA9x2 Phones Chapter 4 Setting SIP Parameters Chapter 3 Setting System FeaturesChapter 5 Provisioning Basics Table of ContentsTable of Contents Chapter 6 Setting Regional ParametersChapter 7 Customizing SPA9x2 Phones Chapter 8 Customizing SPA9x2 Extensions Chapter 10 Using the SPA932 SidecarChapter 9 Customizing Users Table of ContentsTable of Contents Chapter 11 SPA9x2 Phone Field ReferenceAppendix A Creating an LED Script Appendix B Configuring a Dial PlanAppendix C Contacts Table of ContentsRead Me First Introducing Linksys SPA9x2 PhonesIntroducing Linksys SPA9x2 Phones Finding Text in a PDF6. Click Search Related DocumentationIntroducing Linksys SPA9x2 Phones Read Me First”Basic Phone Features” section on page Basic Phone Features”Additional Phone Features” section on page ”SPA9x2 Phone Configuration Scenarios” section on pageAdditional Phone Features Additional Phone FeaturesSPS932 Sidecar Attendant for the SPA962 Introducing Linksys SPA9x2 PhonesIntroducing Linksys SPA9x2 Phones Features Requring SIP SupportAdditional Phone Features Introducing Linksys SPA9x2 Phones SPA9x2 Phone Configuration ScenariosSPA9x2 Phone Configuration Scenarios Introducing Linksys SPA9x2 Phones SPA9000 IP PBX SystemSPA9000 IP PBX System PSTN switch UserD 1 to 4 DID lines Linksys SPA9x2 Phone Administration GuideSIP-PSTN UserBGateway Switch Internet WAN Interface Introducing Linksys SPA9x2 PhonesSIP Over TCP Session Initiation Protocol and SPA9x2 PhonesSession Initiation Protocol and SPA9x2 Phones Introducing Linksys SPA9x2 PhonesUsing SPA9x2 Phones with a Firewall or Router Using SPA9x2 Phones with a Firewall or RouterSIP Proxy Redundancy Introducing Linksys SPA9x2 PhonesNetwork Address Translation and SPA9x2 Phones ”Routers and Service Provider Support of NAT” section on pageNetwork Address Translation and SPA9x2 Phones Introducing Linksys SPA9x2 PhonesSTUN Server Enable see ”NAT Support Parameters” section on page Routers and Service Provider Support of NATSession Border Controllers ”Session Border Controllers” section on pageSIP-NAT Interoperation Simple Traversal of UDP Through NATs STUNSimple Traversal of UDP Through NATs STUN Introducing Linksys SPA9x2 PhonesUsing SPA9x2 Phones in a VLAN Using SPA9x2 Phones in a VLAN3. Click Admin Login advanced Determining the Type of NAT Used on Your RouterShows information about the interfaces your router uses Using SPA9x2 Phones in a VLANIntroducing Linksys SPA9x2 Phones ”Using the LCD Screen” section on page ”Using the Phone Display and Buttons” section on page”Using the Web User Interface” section on page ”Using the Personal Directory” section on pageUpgrading SPA9x2 Firmware Downloading the FirmwareDownloading the Firmware Getting StartedGetting Started Using the Phone Display and ButtonsUsing the Phone Display and Buttons Using the Phone Display and Buttons see Appendix A Creating an LED ScriptPhone Feature Getting StartedGetting Started Using the LCD ScreenUsing the Web User Interface Getting Started Administrator and User ViewsUsing the Web User Interface Admin Login Web Pages Administrator Privilegeshttp//phone.ip.address/admin Using the Web User InterfaceUser Login Web Pages Using the Personal DirectoryUsing the Personal Directory Basic and Advanced ViewsSetup 3 Call History Web Admin TabsViewing Call History Caller and Called Name MatchingRoadmap to Web UI Features Roadmap to Web UI FeaturesSee Chapter 3, Setting System FeaturesSee Chapter 5, Provisioning See Chapter 6, Setting RegionalSee Chapter 7, Customizing SPA9x2 PhonesObtaining Phone Information Info Tab Obtaining Phone Information Info TabSidecar See ”System and ProductProduct Information Notes System and Product InformationSystem and Product Information ”Line and Call Status Information”Understanding Lines, Calls, and Shared Call Appearances Phone Status InformationPhone Status Notes Phone Status InformationShared Line or Call Appearances Understanding ExtensionsUnderstanding Lines, Calls, and Shared Call Appearances Getting StartedLine Key LEDs Extension Status InformationExtension Status Information Getting StartedExtension Status Notes Line and Call Status InformationLine and Call Status Notes Line and Call Status InformationWhat’s Next? Downloaded Ring TonesRing Tone Notes Downloaded Ring TonesGetting Started What’s Next?Setting Security Features Setting System FeaturesSetting System Features Setting Security Features4. Click Submt All Changes SRTP and Securing CallsSetting System Features Setting Security FeaturesSupported Codecs Ensuring Voice QualitySecure Call Indication Tone Ensuring Voice QualityEnsuring Voice Quality Bandwidth RequirementsSetting System Features Ensuring Voice Quality Factors Affecting Voice QualitySetting System Features Setting System Features Setting System Features”Setting a Static IP Address on the IP Phone” section on page Setting System FeaturesSystem Configuration Notes Setting System Configuration InformationSetting System Configuration Information Setting System FeaturesSetting a Static IP Address on the IP Phone Setting Internet, IP and PPPoE InformationSetting Internet, IP and PPPoE Information DHCP and PPPoE NotesOptional Network Configuration Notes Setting Optional Network ParametersSetting Optional Network Parameters Setting System FeaturesVLAN Settings Notes Configuring VLAN SettingsConfiguring VLAN Settings Setting System FeaturesSetting SIP Parameters Setting SIP Parameters”SIP Parameters” section on page ”SIP Timer Values” section on page SIP ParametersSetting SIP Parameters SIP Parameter NotesSIP Parameters Parametersee Chapter 10, Using the SPA932 Sidecar Setting SIP ParametersSIP Parameters ParameterSIP Timer Notes SIP Timer ValuesSIP Timer Values Setting SIP ParametersSIP Timer Values Setting SIP ParametersParameter DescriptionREGISTER after a failure. RegRetryLongRandomDelay added to the short timerMinimum and maximum random delay to be added to the long Long Intvl when retrying REGISTER after a failureResponse Status Notes RTP ParametersRTP Notes RTP ParametersNAT Support Parameters SDP Payload TypesSDP Payload Parameters SDP Payload TypesNAT Support Parameter Notes Linksys Key System ParametersLinksys Key System Notes Linksys Key System Parameters”Configuration Access Control” section on page ”Upgrading, Resyncing, and Rebooting Phones” section on page”Using HTTPS” section on page ”Firmware Upgrade Parameters” section on pageProvisioning Configuration from Phone Keypad SPA9x2 Configuration ProfilesSPA9x2 Configuration Profiles Provisioning BasicsUpgrading, Resyncing, and Rebooting Phones Upgrading, Resyncing, and Rebooting PhonesSPA9x2 web UI Provisioning Firmware Upgrade Upgrade Enable yes Upgrading Firmware on a PhoneResyncing a Phone Rebooting a PhoneUpgrading, Resyncing, and Rebooting Phones Provisioning BasicsRetail Provisioning Redundant Provisioning Servershttps//prov.supervoip.com/linksys-init Redundant Provisioning ServersUsing HTTPS Configuration Access ControlAutomatic In-House Preprovisioning Automatic In-House PreprovisioningUsing HTTPS Firmware Upgrade ParametersHow HTTPS Works Server CertificatesProfileRule. Defines upgrade conditions and associated firmware URLs Using HTTPSProvisioning Basics ParameterSample Configuration File Sample Configuration FileGeneral Purpose Parameters Provisioning BasicsSetting Regional Parameters Setting Regional Parameters”Control Timer Values sec” section on page ”Vertical Service Activation Codes Star Codes” section on pageSetting Regional Parameters Advanced Scripting for Cadences, Call Progress Tones, and Ring TonesExample 1 Normal Ring Example 2 Distinctive Ring short,short,short,longAdvanced Scripting for Cadences, Call Progress Tones, and Ring Tones Setting Regional Parameters1 = A classic phone with mechanical bell 2 = Typical phone ring Setting Regional ParametersAdvanced Scripting for Cadences, Call Progress Tones, and Ring Tones Call Progress Tones Notes Call Progress TonesCall Progress Tones Setting Regional ParametersControl Timer Value Notes Control Timer Values secDistinctive Ring Patterns Ring Pattern NotesVertical Service Activation Codes Star Codes Vertical Service Activation Codes Star CodesSetting Regional Parameters FieldVertical Service Activation Codes Star Codes Vertical Service Activation Code NotesSetting Regional Parameters Referral Services Codes One or more * code can b* codee configured into this parameter, such as *98, or *97*98*123, and so on. The maximum total length is 79 characters Setting Regional ParametersVertical Service Activation Codes Star Codes Vertical Service Activation Codes Star Codes Using Star Codes to Activate/Deactivate ServicesSetting Regional Parameters Disabling/Deactivating Services Vertical Service Announcement CodesVertical Service Announcement Codes Setting Regional ParametersVertical Service Announcement Codes Vertical Service Announcement NotesSetting Regional Parameters Vertical Service Announcement Codes Setting Regional Parameters10 Do Not Disturb DDT DND enabled DDF DND disabled WDF CWCID disabled 13 Block Anonymous callMiscellaneous Parameters Configuring Daylight Savings Time” Daylight Saving Time Examples”Outbound Call Codec Selection Codes Outbound Call Codec Selection NotesMiscellaneous Parameters DTMF NotesSetting Regional Parameters Managing the Time and Date Localizing Your SPA9x2 PhoneLocalizing Your SPA9x2 Phone Setting Regional ParametersLocalizing Your SPA9x2 Phone Configuring Daylight Savings TimeSetting Regional Parameters Daylight Saving Time Examples Selecting a LanguageSelecting a Language Setting Regional ParametersSelecting a Language Creating a Dictionary Server ScriptSetting Regional Parameters Linksys SPA9x2 Phone Administration Guide Setting Regional ParametersSelecting a Language For example DictionaryServerScript ua=na”Supplementary Services Parameters” section on page ”Using the Photo Album Feature on the SPA962” section on page”Using Call Parking” section on page ”Using Call Pick Up and Group Call Pick Up” section on pageadvantages of hosted voicemail include service provider often hosts a voice mail service. TheCustomizing SPA9x2 Phones General Phone InformationChanging the Display Background SPA942/962 Using the Photo Album Feature on the SPA9626. Click Submit All Changes Customizing SPA9x2 PhonesLine Key Information Configuring Shared Line Extension on SPA9x2 PhonesLine Key Notes Line Key InformationLine Key LED Pattern Notes Miscellaneous Line Key Settings NotesCustomizing SPA9x2 Phones Line Key InformationLine Key Information Customizing SPA9x2 Phones“c” indicates “color” the color of the LED “r” indicates “red” a red-colored LEDSupplementary Services Notes Supplementary Services ParametersSupplementary Services Parameters Customizing SPA9x2 PhonesEnables/Disables Supplementary Services Parameterseavesdrop on the conversation. To enable this feature the Call pick up feature see ”Using Call Pick Up and Group CallUsing Call Parking Using Group PagingUsing Call Pick Up and Group Call Pick Up Supplementary Services ParametersCustomizing SPA9x2 Phones Ring Tone ParametersRing Tone Parameters Ring Tone Parameters Managing Ring TonesCustomizing SPA9x2 Phones Using Extension Mobility Audio Input Gain dB and Extension Mobility SettingsAudio Input Gain dB and Extension Mobility Settings Extension Mobility NotesGeneral, Shared Line Appearance, and NAT Settings General, Shared Line Appearance, and NAT Settings”General, Shared Line Appearance, and NAT Settings” section on page ”Network Settings and SIP Settings” section on pageGeneral, Shared Line Appearance, and NAT Settings NAT Settings NotesCustomizing SPA9x2 Extensions ParameterNetwork Settings Notes Network Settings and SIP SettingsSIP Settings Notes Network Settings and SIP SettingsDefaults to no If this feature is enabled, the IP telephony ignores furtherWhen enabled, authorization is required for initial incoming StickyCall Feature Notes Call Feature SettingsCall Feature Settings Customizing SPA9x2 ExtensionsCustomizing SPA9x2 Extensions Proxy and Registration ParametersProxy and Registration Parameters Configuring a SIP Proxy Server Configuring a SIP Proxy Server1. Select Admin Advanced Customizing SPA9x2 ExtensionsSubscriber Information Parameters Audio Configuration ParametersSubscriber Information Notes Subscriber Information ParametersCustomizing SPA9x2 Extensions Audio Configuration ParametersAudio Configuration Parameters Audio Configuration NotesCustomizing SPA9x2 Extensions ParameterDial Plan Parameters Defaults to yesDial Plan Parameters in outbound SDPSee Appendix B Configuring a Dial Plan for more detailed Dial Plan NotesCustomizing SPA9x2 Extensions Dial Plan ParametersDial Plan Parameters Customizing SPA9x2 ExtensionsParameter Description”Setting RSS Newsfeeds on the SPA962 Phone” section on page ”Supplementary Services” section on page”Web Information Service Settings SPA962 Only” section on page ”Audio Volume Settings” section on pageSupplementary Services Supplementary ServicesSupplementary Services Notes Customizing UsersWeb Information Service Settings SPA962 Only Setting RSS Newsfeeds on the SPA962 PhoneSetting RSS Newsfeeds on the SPA962 Phone Customizing UsersWeb Information Service Notes Audio Volume SettingsTraffic Information Settings Audio Volume NotesPhone GUI Color Settings SPA962 Only Phone GUI Color Settings SPA962 OnlyPhone LCD Notes Customizing UsersUsing the SPA932 Sidecar Using the SPA932 Sidecar”Configuring the SPA9000 for the SPA932” section on page ”Configuring the Broadsoft Server for the SPA932” section on pageSetting Up the SPA932 Sidecar Setting Up the SPA932 SidecarUsing the SPA932 Sidecar Configuring the Broadsoft Server for the SPA932 Configuring the SPA9000 for the SPA932Using the SPA932 Sidecar Setting Up the SPA932 SidecarSetting Up the SPA932 Sidecar Configuring the Asterisk Server for the SPA932Using the SPA932 Sidecar Setting Up the SPA932 Sidecar Configuring the SPA932Using the SPA932 Sidecar 10. Click Submit All Changes Unit/Key Configuration ScriptsUsing the SPA932 Sidecar Setting Up the SPA932 SidecarBroadsoft syntax SPA9000 SyntaxUsing the SPA932 Sidecar Setting Up the SPA932 SidecarAsterisk syntax SPA932 Parameter NotesUsing the SPA932 Sidecar Setting Up the SPA932 SidecarSPA932 Unit Monitoring Notes Monitoring the SPA932Monitoring the SPA932 Using the SPA932 SidecarLine Station Subscribe Using the SPA932 SidecarMonitoring the SPA932 Info Tab SPA9x2 Phone Field ReferenceSPA9x2 Phone Field Reference System InformationPhone Status Product InformationIndicates any additional licenses that you have installed SPA9x2 Phone Field ReferenceSPA9x2 Phone Field Reference Ext StatusInfo Tab Total number of RTP packets sent including redundantInfo Tab Line /Call StatusSPA9x2 Phone Field Reference System Configuration, page System ConfigurationInternet Connection Type and Static IP Settings, page Optional Network Configuration, page VLAN Settings, pagePPPoE Settings Internet Connection Type and Static IP SettingsLets you enable or disable local access to the web UIweb SPA9x2 Phone Field ReferenceThe debug server name and port. This feature specifies Optional Network ConfigurationSPA9x2 Phone Field Reference System TabSIP Parameters, page SIP Timer Values sec, page VLAN SettingsSIP Tab SIP ParametersSIP Tab SPA9x2 Phone Field ReferenceNumber of times an invite can be redirected to avoid an this is not specified, the SIP User Agent Name is alsoenables a user to answer or resume a call by clicking a Enables support for the Broadsoft Talk Package, whichEnables support for the Broadsoft Hold Package, which which enables a user to start a conference by clicking aSPA9x2 Phone Field Reference SIP Timer Values secSIP Tab INVITE final response, time-out value, which can rangeDefaults to blank, which disables the exponential back Response Status Code HandlingSPA9x2 Phone Field Reference SIP TabSPA9x2 Phone Field Reference RTP ParametersSIP Tab reception. RTP Port Min and RTP Port Max shouldSPA9x2 Phone Field Reference attempts to compute the round trip delay and show it asSIP Tab connection. It can range from 0 to 255 seconds. DuringSPA9x2 Phone Field Reference SDP Payload TypesSIP Tab RTP-Start-Loopback DynamicG711u Codec Name SPA9x2 Phone Field ReferenceSIP Tab SIP Tab NAT Support ParametersSPA9x2 Phone Field Reference SIP Tab Linksys Key System ParametersSPA9x2 Phone Field Reference Vertical Service Activation Codes, page Control Timer Values sec, pageProvisioning Tab Regional TabPlayed when a 486 RSC is received for an outbound call Regional TabPlayed when a call is waiting. Defaults to 440@-1030.3 SPA9x2 Phone Field ReferenceRSC to trigger this tone is configurable on the SIP screen an error occurs as a caller makes an outbound call. ThePlayed instead of the Dial Tone when there are unheard Played to all parties when a three-way conference call isDefaults to 600.25/9.75 Defaults to60.2/.4,.2/.4,.2/4Distinctive Ring Patterns SPA9x2 Phone Field ReferenceVertical Service Activation Codes Control Timer Values secLong timeout between entering digits when dialing. The The InterdigitLongTimer is used after any one digit, ifSPA9x2 Phone Field Reference Starts a callback when the last outbound call is not busyRegional Tab Forwards busy calls to the extension specified after theCW Per Call Act Code SPA9x2 Phone Field ReferenceRegional Tab Secure One Call Deact Code SPA9x2 Phone Field ReferenceRegional Tab Regional Tab Referral Services CodesSPA9x2 Phone Field Reference Regional Tab Feature Dial Services CodesSPA9x2 Phone Field Reference SPA9x2 Phone Field Reference Vertical Service Announcement CodesOutbound Call Codec Selection Codes Regional TabRegional Tab SPA9x2 Phone Field ReferenceRegional Tab MiscellaneousSPA9x2 Phone Field Reference Regional Tab Daylight Savings Time EnableSPA9x2 Phone Field Reference Phone Tab Phone TabGeneral, page SPA9x2 Phone Field ReferenceLine Key LED Pattern, page Supplementary Services, page Line Key, page Miscellaneous Line Key Settings, pageGeneral Ring Tone, page Auto Input Gain dB, pagePhone Tab Line KeySPA9x2 Phone Field Reference Line Key LED Pattern Miscellaneous Line Key SettingsSPA9x2 Phone Field Reference Phone TabLED pattern during the Local Ringing state, when the call LED pattern when the Call Appearance is disabled notLED pattern during the Remote Ringing state, where the LED pattern during the Local Active state, where the callLED Pattern when the corresponding extension is trying Supplementary ServicesSPA9x2 Phone Field Reference Phone Tabcenters. Typically enabled with the SIP-B parameter Ring ToneSPA9x2 Phone Field Reference Phone TabPhone Tab Auto Input Gain dBSPA9x2 Phone Field Reference Network Settings, page SIP Settings, page Call Feature Settings, page General, page Share Line Appearance, page NAT Settings, pageExt Tab Extension MobilityShare Line Appearance Audio Configuration, page Dial Plan, pageSPA9x2 Phone Field Reference GeneralNetwork Settings NAT SettingsSPA9x2 Phone Field Reference Ext TabControls how the jitter buffer should be adjusted. Select SIP SettingsSPA9x2 Phone Field Reference Ext TabExt Tab settings Referor, Refer Target, Referee, and Refer-ToSPA9x2 Phone Field Reference If this feature is enabled, the IP telephony ignores further listen port. This feature controls which SIP messages toresponse for an outbound INVITE. To enable this feature SPA9x2 Phone Field Referenceserver. When only a user ID is specified, the current or Call Feature Settingsoutbound proxy is contacted. Music-on-hold is disabled Defaults to imusic when used with a SPA9000 IP PBXSpecifies whether to enable a SIP-B feature regarding the Defaults toSPA9x2 Phone Field Reference Ext TabSPA9x2 Phone Field Reference Proxy and RegistrationExt Tab Outbound Proxy is no or Outbound Proxy is emptyUsing multiple DNS A record per server name does not Subscriber InformationSPA9x2 Phone Field Reference Ext TabSPA9x2 Phone Field Reference Audio ConfigurationExt Tab Preferred codec for all calls. The actual codec used in a call stillExt Tab To enable silence suppression so that silent audio frames areSPA9x2 Phone Field Reference Dial Plan User TabUser Tab SPA9x2 Phone Field ReferenceWeb Information Service Settings SPA962, page Call Forward, page Speed Dial, page Supplementary Services, pageTraffic Service Information Settings SPA962, page Audio Volume, page Phone GUI Menu Color Settings SPA962 only, pageTraffic Service Information Settings SPA962 Web Information Service Settings SPA962Audio Volume Phone GUI Menu Color Settings SPA962 only932 Tab SPA962 only 932 Tab SPA962 onlyUnit 2, page -179General, page General, page Unit 2, page -179General Linksys SPA9x2 Phone Administration GuideSPA932 Status script is described in ”Unit/Key Configuration Scripts”Unit SPA932 StatusSPA932 Status SPA9x2 Phone Field ReferenceUnit 1-Displays information about the first SPA932 sidecar unit subscription expires, the SPA932 automatically requests a newLED Script Creating an LED ScriptCreating an LED Script LED Script ExamplesCreating an LED Script LED PatternDial Plan Digit Sequences Configuring a Dial PlanConfiguring a Dial Plan Digit Sequence Syntax Dial Plan RulesElement Repetition Sub-sequence SubstitutionLocal Timer Overrides Interdigit Timer Master OverrideL delay-valuespace P delay-value spaceInterdigit Long Timer Dial Plan TimersInterdigit Short Timer InterdigitLongTimer defaults to InterdigitShortTimer defaults toConfiguring a Dial Plan Dial PlansUS/Canada Contacts ContactsEU Contacts Contacts8060952NC-EW