Unified Messaging 2007 Provider::SetUMDialPlan

  • Article

This procedure sets the properties for a dial plan.

Arguments

Input Arguments Required Description

<preferredDomainController>

Yes

The domain controller to use for Active Directory actions.

<identity>

Yes

This parameter specifies the UM dial plan ID. This parameter is the directory object identifier for the UM dial plan. This parameter is used to link mailboxes to dial plans and Unified Messaging servers to dial plans.

<propertyList >

Yes

The container for the list of properties.

<property >

Yes

The container for one or more properties to be set.

<Name>

Yes

The attribute of property node to define the property name the value is being set for.

<Value >

Yes

The property node may contain one or more value nodes to enter 1 or an array of values.

<accessTelephoneNumbers>

No

The parent container for accessTelephoneNumber node list.

<accessTelephoneNumber>

No

One or more of these define the list of access or pilot phone numbers. Range from 1 to 32 characters.

<allowDialPlanSubscribers>

No

This parameter specifies whether to let subscribers in a dial plan dial a number that resolves to another subscriber within the same dial plan. The default is $true.

<allowedInCountryGroups>

No

The parent container for countryGroup's nodes

<inCountryGroup>

No

This parameter specifies the list of in-country/region dial group names that are allowed.

<allowedInternationalGroups>

No

The parent container for internationalGroup's nodes

<internationalGroup>

No

This parameter specifies the list of international dial group names that are allowed.

<allowExtensions>

No

This parameter specifies whether callers can make calls to extensions that have the same number of digits as the number that is specified on the dial plan object.

<audioCodec>

No

This parameter specifies the audio codec that is used for recording. WMA is the default setting.

<automaticSpeechRecognitionEnabled>

No

This parameter specifies whether speech recognition is enabled for users who are members of the dial plan.

<callSomeoneEnabled>

No

This parameter enables the Call Someone feature.

<configuredInCountryGroups>

No

The parent container for one or more inCountryGroup nodes.

<inCountryGroup>

No

This parameter specifies one in-country group that can be used. Each node consists of four parts separated by commas:

  • A group name (up to 32 characters) o

  • AllowedNumber

  • DialNumber

  • TextComment

<configuredInternationalGroups>

No

The parent container for one or more internationalGroup nodes.

<internationalGroup>

No

This parameter specifies one international group that can be used. Each node consists of four parts, separated by commas:

  • A group name (up to 32 characters)

  • AllowedNumber

  • DialNumber

  • TextComment

<contactAddressList>

No

The identity of the address list.

<contactRecipientContainer>

No

The identity of the container that will be used for directory searches.

<contactScope>

No

This parameter specifies the scope of the search that will be given callers

<countryCode>

No

This parameter specifies the country code for a given country. This is the number that will be dialed for a specific country. For example, 1 in the United States.

<defaultLanguage>

No

The system default language. Its default value is USEnglish

<dialByNamePrimary>

No

This parameter specifies the lookup key for dial by name. Its default valueis Last, First.

<dialByNameSecondary>

No

This parameter specifies the second dial by name lookup key. Its default value is SMTP.

<equivalenceDialPlan>

No

This parameter specifies the name of the equivalency dial plan in another forest. When a telephony dial plan spans two forests and when a second dial plan object is created, the GUID from the original dial plan is copied to the user's proxy address in the other forest.

<extension>

No

The extension number

<faxEnabled>

No

This parameter specifies whether the system supports faxing. The Unified Messaging server will not load the fax components if the dial plan does not support faxing. The default is $true.

<fsdPollingInterval>

No

The interval, in minutes, between checks for new content made by the File Distribution Service on the publishing point. The range is from 1 to 1440 minutes. The default is 5 minutes.

<inCountryNumberFormat>

No

This parameter specifies the prefix string to use and the number of digits to take from the directory. This number is used when dialing into this dial plan from within the same country code.

<infoAnnouncementEnabled>

No

This parameter enables the info announcement specified in infoAnnouncementFileName.

<infoAnnouncementFileName>

No

The wav file to the played for an info announcement

<inputFailuresBeforeDisconnect>

No

This parameter specifies the number of sequential user input errors that will be allowed before the call is disconnected. The default is 3.

<inputRetries>

No

This parameter specifies the number of times a caller can re-enter input when the system times out. This applies to authenticated users and also call answering or auto attendant users. The default is 3.

<inputTimeout>

No

This parameter specifies the length of time that the system will wait for user input. This time limit applies to authenticated users and also call answering or auto attendant users. The default is 5 seconds.

<internationalAccessCode>

No

This parameter specifies a value that will be prepended to a number when dialing internationally. For example 011 or the US.

<internationalNumberFormat>

No

This parameter specifies the prefix string to use, and the number of digits to take from the directory, when dialing into this dial plan from a different country code.

<logonFailuresBeforeDisconnect>

No

The number of unsuccessful logons before disconnecting the call. Default is 3.

<matchedNameSelectionMethod>

No

This parameter specifies the selection to use to differentiate between users who have names that match the touchtone or speech input. This setting can be set to the following:

  • Department

  • Title

  • Location

  • None

  • Prompt for alias

  • Inherited from UM dial plan

<maxCallDuration>

No

The maximum duration of a call before the call is dropped.

<maxRecordingDuration>

No

The maximum time to record messages of any type. The default value is 20 minutes.

<name>

No

The new name for the dial plan.

<nationalNumberPrefix>

No

This parameter specifies the code that is pre-appended to a telephone number to dial out-of-area, in-country calls. For example, 1 in North America.

<ndrEnabled>

No

This parameter specifies whether UM call answering messages that are submitted will request non-delivery reports (NDRs). If this parameter is set to $false, messages will be submitted without requests for NDRs. If this parameter is set to $true, the user account specified on the VoiceMessageOriginator property must have an Exchange mailbox. The default is $false.

<operatorExtension>

No

This parameter specifies the extension number of the operator. If this parameter is not specified, the Do Not Allow Transfer to the Operator feature will be not available.

<outsideLineAccessCode>

No

This parameter specifies the code that is pre-appended to a telephone number to dial an external in-country telephone number. This code is also called a trunk access code. The default is 9.

<promptPublishingPoint>

No

This parameter specifies the UNC path of the server and share where custom prompts will reside. The default path is set to the first Unified Messaging server when it is added to a UM dial plan.

<recordingIdleTimeout>

No

The amount of time the caller can be silent before recording stops. Default is 5 minutes.

<sendVoiceMsgEnabled>

No

This parameter enables the Send Voice Message feature.

<tuiPromptEditingEnabled>

No

This parameter specifies whether authorized users are permitted to record UM dial plan or automated attendant prompts by using the telephone user interface (TUI). The default setting is $false.

<umAutoAttendant>

No

This parameter specifies the auto attendant that is executed when the caller presses the star key (*). If this parameter is specified, it will override the Call Someone feature.

<voIPSecurity>

No

This parameter specifies whether Voice over IP (VoIP) security will be used for the signaling channel, the signaling and media channels, or neither channel.

<welcomeGreetingEnabled>

No

This parameter specifies whether a custom Welcome greeting is enabled. The default is $false.

<welcomeGreetingFileName>

No

This parameter specifies the audio file name for the welcome greeting.

Remarks

Security

The caller must be at least a member of role: UserCreators.

Sample Code

Example XML Request

<request> 
        <data/> 
        <procedure> 
                <execute namespace='Unified Messaging 2007 Provider' procedure='SetUMDialPlan'> 
                        <executeData> 
                                <identity>DailPlan1</indentity> 
                                <preferredDomainController>dc01.fabrikam.local</preferredDomainController> 
                                <propertyList> 
                                        <property name="propertyName"> 
                                                <value>return value</value> 
                                                . 
                                        </property> 
                                        . 
                                </ propertyList> 
                        </executeData> 
                </execute> 
        </procedure> 
</request>

Applies To

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0