Unified Messaging 2007 Provider::SetUMAutoAttendant

  • Article

This procedure sets the properties for an automatic attendant.

Arguments

Input Arguments Required Description

<preferredDomainController>

Yes

The domain controller to use for Active Directory actions.

<identity>

Yes

This parameter specifies the identifier for the UM auto attendant that is being viewed. This parameter is the directory object ID for the UM auto attendant.

<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.

<afterHoursKeyMappings>

No

The container for afterHoursKeyMapping entries

<afterHoursKeyMapping>

No

1 or more key mappings that the automatic attendant will use after hours.

<afterHoursKeyMappingEnabled>

No

This parameter enables or disables after hours key mappings

<afterHoursMainMenuCustomPromptEnabled>

No

The custom main menu is enabled.

<afterHoursMainMenuCustomPromptFileName>

No

The file name of a .wav file containing the after hours menu prompt.

<afterHoursTransferToOperatorEnabled>

No

This parameter allows a caller to be transferred to the operators extension after hours.

<afterHoursWelcomeGreetingEnabled>

No

This parameter enables an after hours greeting.

<afterHoursWelcomeGreetingFileName>

No

The file name of a .wav file containing the after hours greeting.

<allowDialPlanSubscribers>

No

This parameter specifies whether to allow the dial plan subscribers to dial numbers that are resolved to a subscriber in the same dial plan.

<missedCallNotificationEnabled>

No

This parameter specifies if missed call notifications will be sent

<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.

<businessHoursKeyMappings>

No

The parent container for businessHoursKeyMapping entries.

<businessHoursKeyMapping>

No

This parameter specifies a key mapping used during defined business hours.

<businessHoursKeyMappingEnabled>

No

This parameter enables business hours key mappings.

<businessHoursMainMenuCustomPromptEnabled>

No

This parameter enables the BusinessHourceMainMenuCustomPrompt.

<businessHoursMainMenuCustomPromptFileName>

No

The file name of a .wav file containing the business hours menu prompt.

<businessHoursSchedule>

No

This parameter specifies the business hours

<businessHoursTransferToOperatorEnabled>

No

This parameter allows a caller to be transferred to the operators extension business hours.

<businessHoursWelcomeGreetingEnabled>

No

This parameter enables an business hours greeting.

<businessHoursWelcomeGreetingFileName>

No

The file name of a .wav file containing the business hours greeting.

<callSomeoneEnabled>

No

This parameter enables the Call Someone feature

<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

<dtmfFallbackAutoAttendant>

No

This parameter sets a secondary automatic attendant to use but will only be used if speechEnabled is set to $true

<holidayScheduleList>

No

The parent container for holidayScheduled items.

<holidayScheduled>

No

One or more holiday dates in the form of "description, date, announcement wav filename"

<infoAnnouncementEnabled>

No

This parameter enables the info announcement specified in infoAnnouncementFileName.

<infoAnnouncementFileName>

No

The wav file to the played for an info announcement

<language>

No

This parameter specifies the language that is used by the UM auto attendant. This language is selected from the list of available dial plan languages.

<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

<name>

No

The new name for the auto attendant.

<nameLookupEnabled>

No

This parameter enables caller ability to do directly lookups.

<operatorExtension>

No

This parameter specifies the extension number of the operator.

<pilotIdentifierList>

No

The container for a list of pilot identifier, which may contain 1 or more nodes pilotNumber

<pilotNumber>

No

A single pilot number entry.

<sendVoiceMessageEnabled>

No

This parameter specifies whether to allow the Send Message feature.

<speechEnabled>

No

This parameter sets the automatic attendant to be speech enabled.

<timeZone>

No

This parameter specifies the time zone that will be used with the auto attendant. The default time zone is the time zone setting that is on the server.

<timeZoneName>

No

This parameter specifies all or part of a Microsoft Windows time zone display name. The string is compared to the display names in the local system registry to identify a simple "contains" match. An error will be returned is if it is not unique.

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='SetUMAutoAttendant'> 
                        <executeData> 
                                <identity>Fabrikam\AutoAttend1</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