Commands › Exchange Online
Set-UMDialPlan
Set various properties on a Unified Messaging (UM) dial plan.
Quick start script
# Set-UMDialPlan — 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-UMDialPlan
$before | Format-List
# 3. Make the change (dry run first)
Set-UMDialPlan -Identity <UMDialPlanIdParameter> -WhatIf
Set-UMDialPlan -Identity <UMDialPlanIdParameter>
# 4. Verify and diff
$after = Get-UMDialPlan
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-UMDialPlan [-Identity] <UMDialPlanIdParameter>
[-AccessTelephoneNumbers <MultiValuedProperty>]
[-AllowDialPlanSubscribers <Boolean>]
[-AllowedInCountryOrRegionGroups <MultiValuedProperty>]
[-AllowedInternationalGroups <MultiValuedProperty>]
[-AllowExtensions <Boolean>]
[-AllowHeuristicADCallingLineIdResolution <Boolean>]
[-AudioCodec <AudioCodecEnum>]
[-AutomaticSpeechRecognitionEnabled <Boolean>]
[-CallAnsweringRulesEnabled <Boolean>]
[-CallSomeoneEnabled <Boolean>]
[-ConfiguredInCountryOrRegionGroups <MultiValuedProperty>]
[-ConfiguredInternationalGroups <MultiValuedProperty>]
[-Confirm]
[-ContactAddressList <AddressListIdParameter>]
[-ContactRecipientContainer <OrganizationalUnitIdParameter>]
[-ContactScope <CallSomeoneScopeEnum>]
[-CountryOrRegionCode <String>]
[-DefaultLanguage <UMLanguage>]
[-DialByNamePrimary <DialByNamePrimaryEnum>]
[-DialByNameSecondary <DialByNameSecondaryEnum>]
[-DomainController <Fqdn>]
[-EquivalentDialPlanPhoneContexts <MultiValuedProperty>]
[-Extension <String>]
[-FaxEnabled <Boolean>]
[-ForceUpgrade]
[-InCountryOrRegionNumberFormat <NumberFormat>]
[-InfoAnnouncementEnabled <InfoAnnouncementEnabledEnum>]
[-InfoAnnouncementFilename <String>]
[-InputFailuresBeforeDisconnect <Int32>]
[-InternationalAccessCode <String>]
[-InternationalNumberFormat <NumberFormat>]
[-LegacyPromptPublishingPoint <String>]
[-LogonFailuresBeforeDisconnect <Int32>]
[-MatchedNameSelectionMethod <DisambiguationFieldEnum>]
[-MaxCallDuration <Int32>]
[-MaxRecordingDuration <Int32>]
[-Name <String>]
[-NationalNumberPrefix <String>]
[-NumberingPlanFormats <MultiValuedProperty>]
[-OperatorExtension <String>]
[-OutsideLineAccessCode <String>]
[-PilotIdentifierList <MultiValuedProperty>]
[-RecordingIdleTimeout <Int32>]
[-SendVoiceMsgEnabled <Boolean>]
[-TUIPromptEditingEnabled <Boolean>]
[-UMAutoAttendant <UMAutoAttendantIdParameter>]
[-VoIPSecurity <UMVoIPSecurityType>]
[-WelcomeGreetingEnabled <Boolean>]
[-WelcomeGreetingFilename <String>]
[-WhatIf]
[<CommonParameters>]Parameters (51)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Identity | UMDialPlanIdParameter | yes | The Identity 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 and Mailbox and Client Access servers to dial plans. |
| -AccessTelephoneNumbers | MultiValuedProperty | The AccessTelephoneNumbers parameter specifies a single valid voice mail pilot number or a list of valid voice mail pilot numbers. This list is presented to you when a user is being enabled for Unified Messaging. | |
| -AllowDialPlanSubscribers | Boolean | The AllowDialPlanSubscribers parameter specifies whether to allow subscribers dial numbers that resolve to a subscriber within the same dial plan. The default value is $true. | |
| -AllowedInCountryOrRegionGroups | MultiValuedProperty | The AllowedInCountryOrRegionGroups parameter specifies the list of in-country/region names from the same dial group that can be dialed. The name of the allowed in-country/region group must match the group name... | |
| -AllowedInternationalGroups | MultiValuedProperty | The AllowedInternationalGroups parameter specifies the list of international dial group names allowed. The international dial group name must match the group name specified in the dial plan. | |
| -AllowExtensions | Boolean | The AllowExtensions parameter specifies whether to allow calls to dial plan extensions. The default value is $false. | |
| -AllowHeuristicADCallingLineIdResolution | Boolean | The AllowHeuristicADCallingLineIdResolution parameter specifies whether to allow calling line ID resolution using telephone number fields that might be configured in Active Directory. When this parameter is set to... | |
| -AudioCodec | AudioCodecEnum | The AudioCodec parameter specifies the audio codec used for recording. Mp3 is the default setting. | |
| -AutomaticSpeechRecognitionEnabled | Boolean | The AutomaticSpeechRecognitionEnabled parameter specifies whether Automatic Speech Recognition (ASR) is enabled for users who are members of the dial plan. | |
| -CallAnsweringRulesEnabled | Boolean | The CallAnsweringRulesEnabled parameter specifies whether Call Answering Rules are enabled for UM-enabled users associated with the UM dial plan. | |
| -CallSomeoneEnabled | Boolean | The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled. | |
| -ConfiguredInCountryOrRegionGroups | MultiValuedProperty | The ConfiguredInCountryOrRegionGroups parameter specifies the in-country groups that can be used. Each string consists of four parts: | |
| -ConfiguredInternationalGroups | MultiValuedProperty | The ConfiguredInternationalGroups parameter specifies the international groups that can be used. Each string consists of four parts: | |
| -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 | CallSomeoneScopeEnum | The ContactScope parameter specifies the scope of the directory search provided to callers when they access the UM dial plan and specify a user's name. | |
| -CountryOrRegionCode | String | The CountryOrRegionCode parameter specifies the country or region code that precedes a telephone number used to place calls from other countries or regions to the country or region in which the UM dial plan is... | |
| -DefaultLanguage | UMLanguage | The DefaultLanguage parameter specifies the default language of the system. This default language is selected from the list of available languages. The default value is U.S. English. | |
| -DialByNamePrimary | DialByNamePrimaryEnum | The DialByNamePrimary parameter specifies that the Dial by Name lookup key is to be created from the specified source. The default value is LastFirst. | |
| -DialByNameSecondary | DialByNameSecondaryEnum | The DialByNameSecondary parameter specifies that the secondary Dial by Name lookup key is to be created from the specified source. The default value is SMTPAddress. | |
| -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... | |
| -EquivalentDialPlanPhoneContexts | MultiValuedProperty | The EquivalentDialPlanPhoneContexts parameter specifies the name of an equivalency dial plan. This parameter can be used when two UM dial plans exist but are in different forests or when a Private Branch eXchange... | |
| -Extension | String | The Extension parameter specifies the extension number used by the Call Someone feature when a call is transferred. | |
| -FaxEnabled | Boolean | The FaxEnabled parameter specifies whether the Mailbox servers associated with the UM dial plan answers and processes incoming fax calls. The default value is $true. | |
| -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. | |
| -InCountryOrRegionNumberFormat | NumberFormat | The InCountryOrRegionNumberFormat 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 inside the same country or... | |
| -InfoAnnouncementEnabled | InfoAnnouncementEnabledEnum | The InfoAnnouncementEnabled parameter specifies whether an informational announcement is enabled. This parameter can be set to True, False, or Uninterruptible. The default value is False. | |
| -InfoAnnouncementFilename | String | The InfoAnnouncementFilename parameter specifies the audio file name for an informational announcement. | |
| -InputFailuresBeforeDisconnect | Int32 | The InputFailuresBeforeDisconnect parameter specifies the number of sequential user input errors allowed before the call is disconnected. The default value is 3. | |
| -InternationalAccessCode | String | The InternationalAccessCode parameter specifies the code that precedes a telephone number to dial international calls. For example, 011 is the code used to call the United States. | |
| -InternationalNumberFormat | NumberFormat | The InternationalNumberFormat 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. | |
| -LegacyPromptPublishingPoint | String | The LegacyPromptPublishingPoint parameter was used to specify the location of the prompt publishing point for Exchange Server 2007 Unified Messaging servers. This parameter was used in coexistence scenarios when... | |
| -LogonFailuresBeforeDisconnect | Int32 | The LogonFailuresBeforeDisconnect parameter specifies the number of sequential unsuccessful logon attempts that can be made before the call is disconnected. The default value is 3. | |
| -MatchedNameSelectionMethod | DisambiguationFieldEnum | 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: | |
| -MaxCallDuration | Int32 | The MaxCallDuration parameter specifies the maximum length of time that a call can last before it's interrupted and the call is dropped. The default value is 30 minutes. | |
| -MaxRecordingDuration | Int32 | The MaxRecordingDuration parameter specifies the maximum length of time that messages can be recorded. This includes all kinds of calls. The default is 20 minutes. The value of this setting can be from 1 through 100.... | |
| -Name | String | The Name parameter specifies the display name to use for the UM dial plan. This name is limited to 64 characters. | |
| -NationalNumberPrefix | String | The NationalNumberPrefix parameter specifies the dialing code that precedes a telephone number when placing calls from one local area to another within a specific country or region. For example, 1 is the code used... | |
| -NumberingPlanFormats | MultiValuedProperty | The NumberingPlanFormats parameter specifies one or more phone number masks that can be used for resolving caller ID to names of users in Active Directory. | |
| -OperatorExtension | String | The OperatorExtension parameter specifies the extension number of the operator. If this parameter isn't specified, the Do Not Allow Transfer to the Operator feature is unavailable. | |
| -OutsideLineAccessCode | String | The OutsideLineAccessCode parameter specifies the code that precedes a telephone number to dial an external in-country telephone number. This code is also referred to as a trunk access code. The default value is 9. | |
| -PilotIdentifierList | MultiValuedProperty | The PilotIdentifierList parameter specifies the pilot numbers configured on the dial plan. A single dial plan can have multiple pilot numbers. The pilot numbers must be in the E.164 format. | |
| -RecordingIdleTimeout | Int32 | The RecordingIdleTimeout parameter specifies the length of time that a caller can be silent when recording a voice message before the recording is ended. The default value is 5 seconds. | |
| -SendVoiceMsgEnabled | Boolean | The SendVoiceMsgEnabled parameter specifies whether the Send Message feature is enabled. | |
| -TUIPromptEditingEnabled | Boolean | The TUIPromptEditingEnabled 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 | UMAutoAttendantIdParameter | The UMAutoAttendant parameter specifies the auto attendant run when the caller presses the star (\*) key. If this parameter is specified, it overrides the Call Someone feature. | |
| -VoIPSecurity | UMVoIPSecurityType | The VoIPSecurity parameter specifies whether the Voice over IP (VoIP) traffic is encrypted or that the signaling channel or the signaling and the media channels are encrypted by using mutual Transport Layer Security... | |
| -WelcomeGreetingEnabled | Boolean | The WelcomeGreetingEnabled parameter specifies whether a custom welcome greeting is enabled. The default value is $false. | |
| -WelcomeGreetingFilename | String | The WelcomeGreetingFilename parameter specifies the audio file name for the welcome greeting. | |
| -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.