Set-UMAutoAttendant

 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-UMAutoAttendant cmdlet to modify an existing Unified Messaging (UM) auto attendant.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

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>] [-BusinessLocation <String>] [-BusinessName <String>] [-CallSomeoneEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-ContactAddressList <AddressListIdParameter>] [-ContactRecipientContainer <OrganizationalUnitIdParameter>] [-ContactScope <DialPlan | GlobalAddressList | AddressList>] [-DomainController <Fqdn>] [-DTMFFallbackAutoAttendant <UMAutoAttendantIdParameter>] [-ForceUpgrade <SwitchParameter>] [-HolidaySchedule <MultiValuedProperty>] [-InfoAnnouncementEnabled <True | False | Uninterruptible>] [-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>] [-WeekStartDay <Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday>] [-WhatIf [<SwitchParameter>]]

This example configures the UM auto attendant MySpeechEnabledAA to fall back to the MyDTMFAA, sets the operator's extension to 50100, enables transfers to this extension number after business hours and enables a caller to press the * button on a telephone keypad to get to the Outlook Voice Access welcome greeting when a UM auto attendant menu is being played.

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

This example configures the UM auto attendant MyUMAutoAttendant that has business hours configured to be 10:45 to 13:15 (Sunday), 09:00 to 17:00 (Monday), and 09:00 to 16:30 (Saturday) and holiday times and their associated greetings configured to be "New Year" on January 2, 2013, and "Building Closed for Construction" from April 24, 2013 through April 28, 2013.

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/2013","Building Closed for Construction,construction.wav,4/24/2013,4/28/2013"

This example configures the UM auto attendant MyAutoAttendant and enables business hours key mappings so that when callers press 1, they're forwarded to another UM auto attendant named SalesAutoAttendant. When they press 2, they're forwarded to extension number 12345 for Support, and when they press 3, they're sent to another auto attendant that plays an audio file.

Set-UMAutoAttendant -Identity MyAutoAttendant -BusinessHoursKeyMappingEnabled $true -BusinessHoursKeyMapping "1,Sales,,SalesAutoAttendant","2,Support,12345","3,Directions,,,directions.wav"

The Set-UMAutoAttendant cmdlet changes or modifies 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 can't be changed or modified unless the UM auto attendant is deleted and a new UM auto attendant is created.

After this task is completed, the parameters and values specified are configured on the UM auto attendant.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "UM auto attendants" entry in the Unified Messaging permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

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

AfterHoursKeyMapping

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

The following is an example for a custom table that has two entries:

"Sales, 77899","Service, 78990".

The default value is disabled.

AfterHoursKeyMappingEnabled

Optional

System.Boolean

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

The following is an example for a custom table that has two entries:

"Sales, 77899","Service, 78990".

AfterHoursMainMenuCustomPromptEnabled

Optional

System.Boolean

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

AfterHoursMainMenuCustomPromptFilename

Optional

System.String

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

AfterHoursTransferToOperatorEnabled

Optional

System.Boolean

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

AfterHoursWelcomeGreetingEnabled

Optional

System.Boolean

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

AfterHoursWelcomeGreetingFilename

Optional

System.String

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

AllowDialPlanSubscribers

Optional

System.Boolean

The AllowDialPlanSubscribers 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 value is $true.

AllowedInCountryOrRegionGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

AllowedInternationalGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

AllowExtensions

Optional

System.Boolean

The AllowExtensions parameter specifies whether callers can make calls to extensions that have the same number of digits as the number specified on the dial plan object. The default value is $false.

BusinessHoursKeyMapping

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

The following is an example for a custom table that has two entries:

"Sales, 77899","Service, 78990".

The default is disabled.

BusinessHoursKeyMappingEnabled

Optional

System.Boolean

The BusinessHoursKeyMappingEnabled parameter specifies whether the custom menus for business hours are enabled or disabled. The default value is disabled.

BusinessHoursMainMenuCustomPromptEnabled

Optional

System.Boolean

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

BusinessHoursMainMenuCustomPromptFilename

Optional

System.String

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

BusinessHoursSchedule

Optional

Microsoft.Exchange.Common.ScheduleInterval[]

The BusinessHoursSchedule parameter specifies the hours the business is open.

BusinessHoursTransferToOperatorEnabled

Optional

System.Boolean

The BusinessHoursTransferToOperatorEnabled parameter specifies whether to allow call transfers to the operator's extension number during business hours.

BusinessHoursWelcomeGreetingEnabled

Optional

System.Boolean

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

BusinessHoursWelcomeGreetingFilename

Optional

System.String

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

BusinessLocation

Optional

System.String

The BusinessLocation parameter specifies what the Mailbox server should read to the caller who selected the business location option on a UM auto attendant menu.

BusinessName

Optional

System.String

The BusinessName parameter specifies the name of the company or organization being used to generate the UM auto attendant welcome greeting for callers.

CallSomeoneEnabled

Optional

System.Boolean

The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled. The default value is $true.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

ContactAddressList

Optional

Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter

The ContactAddressList parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, this parameter defines the scope for directory searches.

ContactRecipientContainer

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

The ContactRecipientContainer parameter specifies the name or identity of the container used for directory searches.

ContactScope

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DialScopeEnum

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

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

DTMFFallbackAutoAttendant

Optional

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

The DTMFFallbackAutoAttendant parameter specifies the dual tone multi-frequency (DTMF) auto attendant 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.

ForceUpgrade

Optional

System.Management.Automation.SwitchParameter

The ForceUpgrade switch specifies whether you're prompted for confirmation before a UM auto attendant object is upgraded.

HolidaySchedule

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

  • Name, which is limited to 64 characters

  • File name for the audio prompt, which is in the .wav format

  • Day (date) of the holiday

The following is an example:

"Christmas, Christmas.wav, 12/25/2013".

InfoAnnouncementEnabled

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.InfoAnnouncementEnabledEnum

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

InfoAnnouncementFilename

Optional

System.String

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

Language

Optional

Microsoft.Exchange.Data.UMLanguage

The Language parameter specifies the language 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

The MatchedNameSelectionMethod 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

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

NameLookupEnabled

Optional

System.Boolean

The NameLookupEnabled 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

The OperatorExtension parameter specifies the extension number of the operator. If this parameter isn't specified, the dial plan operator is used. If the dial plan operator isn't specified, the feature isn't enabled.

PilotIdentifierList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The PilotIdentifierList parameter specifies a list of one or more pilot numbers. Pilot numbers are used to route incoming calls to Mailbox servers. The calls are then answered by the UM auto attendant.

SendVoiceMsgEnabled

Optional

System.Boolean

The SendVoiceMsgEnabled parameter specifies whether to allow the Send Message feature.

SpeechEnabled

Optional

System.Boolean

The SpeechEnabled parameter specifies whether the auto attendant is speech-enabled. The default setting on the UM auto attendant is $false.

TimeZone

Optional

System.String

The Timezone parameter specifies the time zone used with the auto attendant. The default time zone is the time zone setting on the server.

TimeZoneName

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMTimeZone

The TimeZoneName 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 is returned if the time zone name isn't correct.

WeekStartDay

Optional

System.DayOfWeek

The WeekStartDay parameter specifies the starting day of the week. The valid values for this parameter are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show: