[Index]

Model: device/exchangehybrid/UMDialPlan

Model Details

Title Description Details
DialByNamePrimary The DialByNamePrimary parameter specifies that the Dial by Name lookup key is to be created from the specified source. The default value is LastFirst.
  • Field Name: DialByNamePrimary
  • Type: String
NumberOfDigitsInExtension * The NumberOfDigitsInExtension parameter specifies the fixed number of digits in an extension number. The range for this parameter is from 1 through 20 digits.
  • Field Name: NumberOfDigitsInExtension
  • Type: Integer
AdminDisplayName
  • Field Name: AdminDisplayName
  • Type: String
InCountryOrRegionNumberFormat 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 region code.
  • Field Name: InCountryOrRegionNumberFormat
  • Type: String
OrganizationId
  • Field Name: OrganizationId
  • Type: String
OriginatingServer
  • Field Name: OriginatingServer
  • Type: String
AllowExtensions The AllowExtensions parameter specifies whether to allow calls to dial plan extensions. The default value is $false.
  • Field Name: AllowExtensions
  • Type: Boolean
FDSPollingInterval
  • Field Name: FDSPollingInterval
  • Type: Integer
NumberingPlanFormats 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.
  • Field Name: NumberingPlanFormats.[n]
  • Type: Array
PilotIdentifierList 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.
  • Field Name: PilotIdentifierList.[n]
  • Type: Array
InfoAnnouncementFilename The InfoAnnouncementFilename parameter specifies the audio file name for an informational announcement.
  • Field Name: InfoAnnouncementFilename
  • Type: String
GlobalCallRoutingScheme The GlobalCallRoutingScheme parameter specifies whether UM-enabled users and auto attendant numbers should be included in the global routing database. If the setting is E164, the numbers are provisioned in the global routing database.
  • Field Name: GlobalCallRoutingScheme
  • Type: String
SubscriberType The SubscriberType parameter specifies either Consumer or Enterprise as the type of dial plan. Enterprise dial plans are most likely to be used in a single organization. Consumer dial plans are used in hosted environments and can represent dial plans that may belong to different tenants.
  • Field Name: SubscriberType
  • Type: String
LogonFailuresBeforeDisconnect 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.
  • Field Name: LogonFailuresBeforeDisconnect
  • Type: Integer
LegacyPromptPublishingPoint The LegacyPromptPublishingPoint parameter specifies the location of the prompt publishing point for Microsoft Exchange Server 2007 Unified Messaging servers. In coexistence scenarios, this parameter is used when Exchange 2007 and Exchange Server 2010 Unified Messaging servers are added to the same Exchange 2010 UM dial plan.
  • Field Name: LegacyPromptPublishingPoint
  • Type: String
WhenCreatedUTC
  • Field Name: WhenCreatedUTC
  • Type: String
  • Format: date-time
OutsideLineAccessCode 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.
  • Field Name: OutsideLineAccessCode
  • Type: String
GenerateUMMailboxPolicy The GenerateUMMailboxPolicy parameter specifies whether a default UM mailbox policy is created when the UM dial plan is created. The default setting is to create a UM mailbox when the UM dial plan is created.
  • Field Name: GenerateUMMailboxPolicy
  • Type: Boolean
UMAutoAttendant 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.
  • Field Name: UMAutoAttendant
  • Type: String
RecordingIdleTimeout 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.
  • Field Name: RecordingIdleTimeout
  • Type: Integer
AccessTelephoneNumbers The AccessTelephoneNumbers parameter specifies the telephone number or numbers used for subscriber access. These numbers are sometimes referred to as pilot or pilot ID numbers. The telephone number is limited to 32 characters.
  • Field Name: AccessTelephoneNumbers.[n]
  • Type: Array
UMServers
  • Field Name: UMServers.[n]
  • Type: Array
DialByNameSecondary 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.
  • Field Name: DialByNameSecondary
  • Type: String
ConfiguredInCountryOrRegionGroups The ConfiguredInCountryOrRegionGroups parameter specifies the in-country groups that can be used. Each string consists of four parts: Group name (up to 32 characters) AllowedNumberString DialNumberString TextComment
  • Field Name: ConfiguredInCountryOrRegionGroups.[n]
  • Type: Array
ObjectClass
  • Field Name: ObjectClass.[n]
  • Type: Array
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
PSComputerName
  • Field Name: PSComputerName
  • Type: String
VoIPSecurity This parameter is available only in on-premises Exchange 2013. The VoIPSecurity parameter specifies whether the signaling channel is encrypted using mutual Transport Layer Security (TLS). The default setting is Unsecured.
  • Field Name: VoIPSecurity
  • Type: String
DefaultLanguage The DefaultLanguage parameter specifies the default language of the system. This default language is selected from the list of available languages. If there are no other UM language packs installed, the default value is en-US.
  • Field Name: DefaultLanguage
  • Type: String
InputFailuresBeforeDisconnect The InputFailuresBeforeDisconnect parameter specifies the number of sequential user input errors allowed before the call is disconnected. The default value is 3.
  • Field Name: InputFailuresBeforeDisconnect
  • Type: Integer
WelcomeGreetingEnabled The WelcomeGreetingEnabled parameter specifies whether a custom welcome greeting is enabled. The default value is $false.
  • Field Name: WelcomeGreetingEnabled
  • Type: Boolean
URIType The URIType parameter specifies the URI type to be sent and received with SIP messages from the Private Branch eXchange (PBX).
  • Field Name: URIType
  • Type: String
MatchedNameSelectionMethod 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: Title Department Location None PromptForAlias
  • Field Name: MatchedNameSelectionMethod
  • Type: String
PhoneContext
  • Field Name: PhoneContext
  • Type: String
DefaultOutboundCallingLineId The DefaultOutboundCallingLineId parameter specifies the phone number that a Mailbox server would use as the calling line ID when placing an outbound call. By default, this is set to $null and only the extension number of the UM-enabled user that places the outbound call is used. This parameter is reserved for internal Microsoft use.
  • Field Name: DefaultOutboundCallingLineId
  • Type: String
Identity The Identity parameter specifies the UM dial plan ID.
  • Field Name: Identity
  • Type: String
DistinguishedName
  • Field Name: DistinguishedName
  • Type: String
MaxRecordingDuration 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. Setting this value too low can cause long voice messages to be disconnected before they are completed. Setting this value too high lets users save lengthy voice messages in their Inboxes.
  • Field Name: MaxRecordingDuration
  • Type: Integer
Name * The Name parameter specifies the display name of the UM dial plan. This description is presented to the administrator when a user is enabled for Unified Messaging. The UM dial plan name field can contain as many as 64 characters.
  • Field Name: Name
  • Type: String
Extension The Extension parameter specifies the extension number used by the Call Someone feature when a call is transferred.
  • Field Name: Extension
  • Type: String
CountryOrRegionCode * 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 located. For example, 1 is the code used for North America, and 44 is the code used for the United Kingdom.
  • Field Name: CountryOrRegionCode
  • Type: String
InternationalNumberFormat 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.
  • Field Name: InternationalNumberFormat
  • Type: String
TUIPromptEditingEnabled 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.
  • Field Name: TUIPromptEditingEnabled
  • Type: Boolean
WelcomeGreetingFilename The WelcomeGreetingFilename parameter specifies the audio file name for the welcome greeting.
  • Field Name: WelcomeGreetingFilename
  • Type: String
ContactAddressList 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.
  • Field Name: ContactAddressList
  • Type: String
InfoAnnouncementEnabled 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.
  • Field Name: InfoAnnouncementEnabled
  • Type: String
UMMailboxPolicies
  • Field Name: UMMailboxPolicies.[n]
  • Type: Array
WhenCreated
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
AllowDialPlanSubscribers 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.
  • Field Name: AllowDialPlanSubscribers
  • Type: Boolean
AllowedInternationalGroups 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.
  • Field Name: AllowedInternationalGroups.[n]
  • Type: Array
InternationalAccessCode 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.
  • Field Name: InternationalAccessCode
  • Type: String
Organization The Organization parameter is reserved for internal Microsoft use.
  • Field Name: Organization
  • Type: String
ExchangeVersion
  • Field Name: ExchangeVersion
  • Type: String
CallSomeoneEnabled The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled.
  • Field Name: CallSomeoneEnabled
  • Type: Boolean
AudioCodec The AudioCodec parameter specifies the audio codec used for recording. Mp3 is the default setting.
  • Field Name: AudioCodec
  • Type: String
CallAnsweringRulesEnabled The CallAnsweringRulesEnabled parameter specifies whether Call Answering Rules are enabled for UM-enabled users associated with the UM dial plan.
  • Field Name: CallAnsweringRulesEnabled
  • Type: Boolean
ConfiguredInternationalGroups The ConfiguredInternationalGroups parameter specifies the international groups that can be used. Each string consists of four parts: Group name (up to 32 characters) AllowedNumberString DialNumberString TextComment
  • Field Name: ConfiguredInternationalGroups.[n]
  • Type: Array
SipResourceIdentifierRequired The SipResourceIdentifierRequired parameter specifies whether the Session Initiation Protocol (SIP) resource identifier is required to be specified when mailboxes are UM-enabled and associated with the dial plan. The default is $false but it can only be set to $true if the Uniform Resource Identifier (URI) type of the dial plan is E.164.
  • Field Name: SipResourceIdentifierRequired
  • Type: Boolean
DomainController This parameter is available only in on-premises Exchange 2013. The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.
  • Field Name: DomainController
  • Type: String
AllowHeuristicADCallingLineIdResolution The AllowHeuristicADCallingLineIdResolution parameter specifies whether to allow calling line ID resolution using telephone number fields that may be configured in Active Directory. When this parameter is set to $true, the telephone numbers such as those defined in the Mobile or Home telephone number fields in Active Directory are used. Setting this parameter to $true allows for resolution of calling IDs for both UM-enabled and non-UM-enabled users. The default is $true. You may want to set this parameter to $false if the telephone numbers for users aren't in a standard format. If the telephone numbers aren't in a standard format, the Mailbox server may not be able to correctly resolve the caller ID to a name of a user in a consistent manner.
  • Field Name: AllowHeuristicADCallingLineIdResolution
  • Type: Boolean
AllowedInCountryOrRegionGroups 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 specified in the UM dial plan.
  • Field Name: AllowedInCountryOrRegionGroups.[n]
  • Type: Array
IsValid
  • Field Name: IsValid
  • Type: Boolean
ObjectCategory
  • Field Name: ObjectCategory
  • Type: String
SendVoiceMsgEnabled The SendVoiceMsgEnabled parameter specifies whether the Send Message feature is enabled.
  • Field Name: SendVoiceMsgEnabled
  • Type: Boolean
OperatorExtension 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.
  • Field Name: OperatorExtension
  • Type: String
WhenChanged
  • Field Name: WhenChanged
  • Type: String
  • Format: date-time
WhenChangedUTC
  • Field Name: WhenChangedUTC
  • Type: String
  • Format: date-time
FaxEnabled The FaxEnabled parameter specifies whether the Mailbox servers associated with the dial plan answer and process incoming fax calls. The default is $true.
  • Field Name: FaxEnabled
  • Type: Boolean
ObjectState
  • Field Name: ObjectState
  • Type: String
ContactScope 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.
  • Field Name: ContactScope
  • Type: String
UMIPGateway
  • Field Name: UMIPGateway.[n]
  • Type: Array
EquivalentDialPlanPhoneContexts 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 (PBX) numbering plan spans two UM dial plans. Adding the name of the equivalency dial plan allows name lookups using a caller ID to search in the user's dial plan but then also search for a name for the calling line ID in any equivalent dial plans that are configured.
  • Field Name: EquivalentDialPlanPhoneContexts.[n]
  • Type: Array
NationalNumberPrefix 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 within North America, and 0 is the code used within the United Kingdom.
  • Field Name: NationalNumberPrefix
  • Type: String
AutomaticSpeechRecognitionEnabled The AutomaticSpeechRecognitionEnabled parameter specifies whether Automatic Speech Recognition (ASR) is enabled for users who are members of the dial plan.
  • Field Name: AutomaticSpeechRecognitionEnabled
  • Type: Boolean
RunspaceId
  • Field Name: RunspaceId
  • Type: String
Guid
  • Field Name: Guid
  • Type: String
Id
  • Field Name: Id
  • Type: String
MaxCallDuration 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.
  • Field Name: MaxCallDuration
  • Type: Integer
UMAutoAttendants
  • Field Name: UMAutoAttendants.[n]
  • Type: Array
API reference for device/exchangehybrid/UMDialPlan