Export (0) Print
Expand All

Set-UMAutoAttendant

 

Applies to: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1

Topic Last Modified: 2007-06-28

The Set-UMAutoAttendant cmdlet modifies an existing Unified Messaging (UM) auto attendant.


Set-UMAutoAttendant -Identity <UMAutoAttendantIdParameter> [-AfterHoursKeyMapping <MultiValuedProperty>] [-AfterHoursKeyMappingEnabled <$true | $false>] [-AfterHoursMainMenuCustomPromptEnabled <$true | $false>] [-AfterHoursMainMenuCustomPromptFilename <String>] [-AfterHoursTransferToOperatorEnabled <$true | $false>] [-AfterHoursWelcomeGreetingEnabled <$true | $false>] [-AfterHoursWelcomeGreetingFilename <String>] [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] [-BusinessHoursKeyMapping <MultiValuedProperty>] [-BusinessHoursKeyMappingEnabled <$true | $false>] [-BusinessHoursMainMenuCustomPromptEnabled <$true | $false>] [-BusinessHoursMainMenuCustomPromptFilename <String>] [-BusinessHoursSchedule <ScheduleInterval[]>] [-BusinessHoursTransferToOperatorEnabled <$true | $false>] [-BusinessHoursWelcomeGreetingEnabled <$true | $false>] [-BusinessHoursWelcomeGreetingFilename <String>] [-CallSomeoneEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-ContactAddressList <AddressListIdParameter>] [-ContactRecipientContainer <OrganizationalUnitIdParameter>] [-ContactScope <DialPlan | GlobalAddressList | AddressList>] [-DomainController <Fqdn>] [-DTMFFallbackAutoAttendant <UMAutoAttendantIdParameter>] [-HolidaySchedule <MultiValuedProperty>] [-InfoAnnouncementEnabled <True | False | Uninteruptible>] [-InfoAnnouncementFilename <String>] [-Language <UMLanguage>] [-MatchedNameSelectionMethod <Title | Department | Location | None | PromptForAlias | InheritFromDialPlan>] [-Name <String>] [-NameLookupEnabled <$true | $false>] [-OperatorExtension <String>] [-PilotIdentifierList <MultiValuedProperty>] [-SendVoiceMsgEnabled <$true | $false>] [-SpeechEnabled <$true | $false>] [-TimeZone <String>] [-TimeZoneName <UMTimeZone>] [-WhatIf [<SwitchParameter>]]


Set-UMAutoAttendant [-AfterHoursKeyMapping <MultiValuedProperty>] [-AfterHoursKeyMappingEnabled <$true | $false>] [-AfterHoursMainMenuCustomPromptEnabled <$true | $false>] [-AfterHoursMainMenuCustomPromptFilename <String>] [-AfterHoursTransferToOperatorEnabled <$true | $false>] [-AfterHoursWelcomeGreetingEnabled <$true | $false>] [-AfterHoursWelcomeGreetingFilename <String>] [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] [-BusinessHoursKeyMapping <MultiValuedProperty>] [-BusinessHoursKeyMappingEnabled <$true | $false>] [-BusinessHoursMainMenuCustomPromptEnabled <$true | $false>] [-BusinessHoursMainMenuCustomPromptFilename <String>] [-BusinessHoursSchedule <ScheduleInterval[]>] [-BusinessHoursTransferToOperatorEnabled <$true | $false>] [-BusinessHoursWelcomeGreetingEnabled <$true | $false>] [-BusinessHoursWelcomeGreetingFilename <String>] [-CallSomeoneEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-ContactAddressList <AddressListIdParameter>] [-ContactRecipientContainer <OrganizationalUnitIdParameter>] [-ContactScope <DialPlan | GlobalAddressList | AddressList>] [-DomainController <Fqdn>] [-DTMFFallbackAutoAttendant <UMAutoAttendantIdParameter>] [-HolidaySchedule <MultiValuedProperty>] [-InfoAnnouncementEnabled <True | False | Uninteruptible>] [-InfoAnnouncementFilename <String>] [-Instance <UMAutoAttendant>] [-Language <UMLanguage>] [-MatchedNameSelectionMethod <Title | Department | Location | None | PromptForAlias | InheritFromDialPlan>] [-Name <String>] [-NameLookupEnabled <$true | $false>] [-OperatorExtension <String>] [-PilotIdentifierList <MultiValuedProperty>] [-SendVoiceMsgEnabled <$true | $false>] [-SpeechEnabled <$true | $false>] [-TimeZone <String>] [-TimeZoneName <UMTimeZone>] [-WhatIf [<SwitchParameter>]]

The Set-UMAutoAttendant cmdlet lets you change or modify the settings of an existing UM auto attendant. By default, some UM auto attendant parameters are required and are created. However, after a UM auto attendant is created, not all properties for the UM auto attendant are writable. Therefore, some values for the UM auto attendant cannot be changed or modified unless the UM auto attendant is deleted and a new one is created.

To run the Set-UMAutoAttendant cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

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.

AfterHoursKeyMapping

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the key mappings to be used for after business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator.

Example for a custom table that has 2 entries:

“Sales, 77899”,"Service, 78990”.

The default is disabled.

AfterHoursKeyMappingEnabled

Optional

System.Boolean

This parameter specifies whether to enable or disable key mappings for after business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator.

Example for a custom table that has 2 entries:

“Sales, 77899”,"Service, 78990”.

AfterHoursMainMenuCustomPromptEnabled

Optional

System.Boolean

This parameter specifies whether the after business hours custom main menu is enabled. The default is disabled.

AfterHoursMainMenuCustomPromptFilename

Optional

System.String

This parameter specifies the .wav file to be used for the after business hours custom main menu prompt.

AfterHoursTransferToOperatorEnabled

Optional

System.Boolean

This parameter specifies whether to allow calls to be transferred to the operator's extension number after business hours.

AfterHoursWelcomeGreetingEnabled

Optional

System.Boolean

This parameter specifies whether the after hours greeting is enabled. The system default audio will be used if this parameter is set to disabled. The default is disabled.

AfterHoursWelcomeGreetingFilename

Optional

System.String

This parameter specifies the .wav file to be used for the after hours greeting message.

AllowDialPlanSubscribers

Optional

System.Boolean

This parameter specifies whether to allow the dial plan subscribers to dial numbers that are resolved to a subscriber in the same dial plan. The default is $true.

AllowedInCountryOrRegionGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the list of in-country/region dial group names that are allowed. The names must match group names that are defined in the dial plan. The string must have fewer than 128 characters.

AllowedInternationalGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the list of international dial group names that are allowed. The names must match group names that are defined in the dial plan. The string must have fewer than 128 characters.

AllowExtensions

Optional

System.Boolean

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. The default is $false.

BusinessHoursKeyMapping

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the key mappings for business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator.

Example for a custom table that has 2 entries:

“Sales, 77899”,"Service, 78990”.

The default is disabled.

BusinessHoursKeyMappingEnabled

Optional

System.Boolean

This parameter specifies whether the custom menus for business hours will be enabled or disabled. The default is disabled.

BusinessHoursMainMenuCustomPromptEnabled

Optional

System.Boolean

This parameter specifies whether the business hours custom main menu prompt is enabled. The default is disabled.

BusinessHoursMainMenuCustomPromptFilename

Optional

System.String

This parameter specifies the .wav file to be used for the business hours custom main menu prompt.

BusinessHoursSchedule

Optional

Microsoft.Exchange.Common.ScheduleInterval[]

This parameter specifies the hours the business is open.

BusinessHoursTransferToOperatorEnabled

Optional

System.Boolean

This parameter specifies whether to allow call transfer to the operator's extension number during business hours.

BusinessHoursWelcomeGreetingEnabled

Optional

System.Boolean

This parameter specifies whether the custom business hours greeting is enabled. The system default audio will be used if this parameter is set to disabled. The default is disabled.

BusinessHoursWelcomeGreetingFilename

Optional

System.String

This parameter specifies the .wav file to be used for the welcome message.

CallSomeoneEnabled

Optional

System.Boolean

This parameter specifies whether the Call Someone feature is enabled.

Confirm

Optional

System.Management.Automation.SwitchParameter

This parameter causes the command to pause processing and requires that you acknowledge what the command will do before processing continues. The default value is $true.

ContactAddressList

Optional

Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter

This parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, it will define the scope for directory searches.

ContactRecipientContainer

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

This parameter specifies the name or identity of the container that will be used for directory searches.

ContactScope

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DialScopeEnum

This parameter specifies the scope of the directory search that will be given to callers when they access the UM auto attendant and specify a user's name.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service.

DTMFFallbackAutoAttendant

Optional

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

This parameter specifies the dual tone multi-frequency (DTMF) auto attendant that will be used if the speech-enabled auto attendant is unavailable. If the SpeechEnabled parameter is set to $true, this auto attendant must have an associated DTMF auto attendant to use as the fallback auto attendant.

HolidaySchedule

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the holiday schedule for the organization. The schedule is formatted as an array of strings. Each string contains three parts:

  • The name - limited to 64 characters.

  • The day (date) of the holiday.

  • The file name for the audio prompt. The audio prompt will be in the .wma format.

Example:

“Christmas, 12/25/2005, Christmas.wav”.

InfoAnnouncementEnabled

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.InfoAnnouncementEnabledEnum

This parameter specifies whether to enable the informational greeting. The default setting is $true.

InfoAnnouncementFilename

Optional

System.String

This parameter specifies the .wav file to be used for the informational announcement.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMAutoAttendant

This parameter specifies the UM auto attendant object input parameter. This parameter is required if the Identity parameter is not used.

Language

Optional

Microsoft.Exchange.Data.UMLanguage

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

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.AutoAttendantDisambiguationFieldEnum

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

Optional

System.String

This parameter specifies the display name to be used for the UM auto attendant. This name is limited to 64 characters.

NameLookupEnabled

Optional

System.Boolean

This parameter specifies whether to allow callers to perform directory lookups by dialing the name or by speaking the name. This parameter can prevent callers from connecting to unknown extensions.

OperatorExtension

Optional

System.String

This parameter specifies the extension number of the operator. If this parameter is not specified, the dial plan operator will be used. If the dial plan operator is not specified, the feature will not be enabled.

PilotIdentifierList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies a list of one or more pilot numbers. Pilot numbers are used to route incoming calls to Unified Messaging servers. They are then answered by the auto attendant.

SendVoiceMsgEnabled

Optional

System.Boolean

This parameter specifies whether to allow the Send Message feature.

SpeechEnabled

Optional

System.Boolean

This parameter specifies whether the auto attendant is speech-enabled. The default setting on the auto attendant is DTMF.

Timezone

Optional

System.String

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

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMTimeZone

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 determine a simple "contains" match. An error will be returned is if it is not unique.

WhatIf

Optional

System.Management.Automation.SwitchParameter

This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. The default value is $true.

 

Error Description

 

 

 

Exceptions Description

 

 

The first example configures a UM auto attendant named MySpeechEnabledAA to fall back to the MyDTMFAA, sets the operators extension to 50100, and enables transfers to this extension number after business hours.

The second example configures a UM auto attendant named MyAutoAttendant that has business hours configured to be 10:45 A.M. to 1:15 P.M. (Sunday), 9:00 A.M. to 5:00 P.M. (Monday), and 9:00 A.M. to 4:30 P.M. (Saturday) and holiday times and their associated greetings configured to be "New Years" on 2 January 2006, and "Building closed for construction" from 24 through 28 April 2006.

Set-UMAutoAttendant -Identity MySpeechEnabledAA -DTMFFallbackAutoAttendant MyDTMFAA -OperatorExtension 50100 -AfterHoursTransferToOperatorEnabled $true

Set-UMAutoAttendant -Identity MyUMAutoAttendant -BusinessHoursSchedule 0.10:45-0.13:15,1.09:00-1.17:00,6.09:00-6.16:30 -HolidaySchedule "New Year,newyrgrt.wav,1/2/2006","Building Closed for Construction,construction.wav,4/24/2006,4/28/2006"
 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft