Commands › Exchange Online
Set-UMAutoAttendant
Modify an existing Unified Messaging (UM) auto attendant.
Quick start script
# Set-UMAutoAttendant — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org
# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-UMAutoAttendant
$before | Format-List
# 3. Make the change (dry run first)
Set-UMAutoAttendant -Identity <UMAutoAttendantIdParameter> -WhatIf
Set-UMAutoAttendant -Identity <UMAutoAttendantIdParameter>
# 4. Verify and diff
$after = Get-UMAutoAttendant
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-UMAutoAttendant [-Identity] <UMAutoAttendantIdParameter>
[-AfterHoursKeyMapping <MultiValuedProperty>]
[-AfterHoursKeyMappingEnabled <Boolean>]
[-AfterHoursMainMenuCustomPromptEnabled <Boolean>]
[-AfterHoursMainMenuCustomPromptFilename <String>]
[-AfterHoursTransferToOperatorEnabled <Boolean>]
[-AfterHoursWelcomeGreetingEnabled <Boolean>]
[-AfterHoursWelcomeGreetingFilename <String>]
[-AllowDialPlanSubscribers <Boolean>]
[-AllowedInCountryOrRegionGroups <MultiValuedProperty>]
[-AllowedInternationalGroups <MultiValuedProperty>]
[-AllowExtensions <Boolean>]
[-BusinessHoursKeyMapping <MultiValuedProperty>]
[-BusinessHoursKeyMappingEnabled <Boolean>]
[-BusinessHoursMainMenuCustomPromptEnabled <Boolean>]
[-BusinessHoursMainMenuCustomPromptFilename <String>]
[-BusinessHoursSchedule <ScheduleInterval[]>]
[-BusinessHoursTransferToOperatorEnabled <Boolean>]
[-BusinessHoursWelcomeGreetingEnabled <Boolean>]
[-BusinessHoursWelcomeGreetingFilename <String>]
[-BusinessLocation <String>]
[-BusinessName <String>]
[-CallSomeoneEnabled <Boolean>]
[-Confirm]
[-ContactAddressList <AddressListIdParameter>]
[-ContactRecipientContainer <OrganizationalUnitIdParameter>]
[-ContactScope <DialScopeEnum>]
[-DomainController <Fqdn>]
[-DTMFFallbackAutoAttendant <UMAutoAttendantIdParameter>]
[-ForceUpgrade]
[-HolidaySchedule <MultiValuedProperty>]
[-InfoAnnouncementEnabled <InfoAnnouncementEnabledEnum>]
[-InfoAnnouncementFilename <String>]
[-Language <UMLanguage>]
[-MatchedNameSelectionMethod <AutoAttendantDisambiguationFieldEnum>]
[-Name <String>]
[-NameLookupEnabled <Boolean>]
[-OperatorExtension <String>]
[-PilotIdentifierList <MultiValuedProperty>]
[-SendVoiceMsgEnabled <Boolean>]
[-SpeechEnabled <Boolean>]
[-Timezone <String>]
[-TimeZoneName <UMTimeZone>]
[-WeekStartDay <DayOfWeek>]
[-WhatIf]
[<CommonParameters>]Parameters (46)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Identity | UMAutoAttendantIdParameter | yes | 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 | 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... | |
| -AfterHoursKeyMappingEnabled | 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... | |
| -AfterHoursMainMenuCustomPromptEnabled | Boolean | The AfterHoursMainMenuCustomPromptEnabled parameter specifies whether the after business hours custom main menu is enabled. The default value is disabled. | |
| -AfterHoursMainMenuCustomPromptFilename | String | The AfterHoursMainMenuCustomPromptFilename parameter specifies the .wav file to be used for the after business hours custom main menu prompt. | |
| -AfterHoursTransferToOperatorEnabled | Boolean | The AfterHoursTransferToOperatorEnabled parameter specifies whether to allow calls to be transferred to the operator's extension number after business hours. | |
| -AfterHoursWelcomeGreetingEnabled | 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 | String | The AfterHoursWelcomeGreetingFilename parameter specifies the .wav file to be used for the after hours greeting message. | |
| -AllowDialPlanSubscribers | 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 | 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 | 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 | 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 | 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... | |
| -BusinessHoursKeyMappingEnabled | Boolean | The BusinessHoursKeyMappingEnabled parameter specifies whether the custom menus for business hours are enabled or disabled. The default value is disabled. | |
| -BusinessHoursMainMenuCustomPromptEnabled | Boolean | The BusinessHoursMainMenuCustomPromptEnabled parameter specifies whether the business hours custom main menu prompt is enabled. The default value is disabled. | |
| -BusinessHoursMainMenuCustomPromptFilename | String | The BusinessHoursMainMenuCustomPromptFilename parameter specifies the .wav file to be used for the business hours custom main menu prompt. | |
| -BusinessHoursSchedule | ScheduleInterval[] | The BusinessHoursSchedule parameter specifies the hours the business is open. | |
| -BusinessHoursTransferToOperatorEnabled | Boolean | The BusinessHoursTransferToOperatorEnabled parameter specifies whether to allow call transfers to the operator's extension number during business hours. | |
| -BusinessHoursWelcomeGreetingEnabled | 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 | String | The BusinessHoursWelcomeGreetingFilename parameter specifies the .wav file to be used for the welcome message. | |
| -BusinessLocation | 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 | 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 | Boolean | The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled. The default value is $true. | |
| -Confirm | SwitchParameter | The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. | |
| -ContactAddressList | 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 | OrganizationalUnitIdParameter | The ContactRecipientContainer parameter specifies the name or identity of the container used for directory searches. | |
| -ContactScope | 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 | Fqdn | 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... | |
| -DTMFFallbackAutoAttendant | 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... | |
| -ForceUpgrade | SwitchParameter | The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. | |
| -HolidaySchedule | 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: | |
| -InfoAnnouncementEnabled | InfoAnnouncementEnabledEnum | The InfoAnnouncementEnabled parameter specifies whether to enable the informational greeting. The default setting is $true. | |
| -InfoAnnouncementFilename | String | The InfoAnnouncementFilename parameter specifies the .wav file to be used for the informational announcement. | |
| -Language | 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 | 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: | |
| -Name | String | The Name parameter specifies the display name to be used for the UM auto attendant. This name is limited to 64 characters. | |
| -NameLookupEnabled | 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 | 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 | 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 | Boolean | The SendVoiceMsgEnabled parameter specifies whether to allow the Send Message feature. | |
| -SpeechEnabled | Boolean | The SpeechEnabled parameter specifies whether the auto attendant is speech-enabled. The default setting on the UM auto attendant is $false. | |
| -Timezone | 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. | |
| -Timezone | 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 | UMTimeZone | The TimeZoneName parameter specifies all or part of a MicrosoftWindows 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... | |
| -WeekStartDay | 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 | SwitchParameter | The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch. |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.