Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Export-UMPrompt

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2012-09-11

Use the Export-UMPrompt cmdlet to export an audio file being used as a greeting prompt for Unified Messaging (UM) dial plans and auto attendants.

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

Export-UMPrompt -BusinessHoursWelcomeGreetingAndMenu <SwitchParameter> -UMAutoAttendant <UMAutoAttendantIdParameter> [-TestMenuKeyMapping <CustomMenuKeyMapping[]>] <COMMON PARAMETERS>
Export-UMPrompt -BusinessHoursWelcomeGreeting <SwitchParameter> -UMAutoAttendant <UMAutoAttendantIdParameter> [-TestBusinessName <String>] <COMMON PARAMETERS>
Export-UMPrompt -AfterHoursWelcomeGreetingAndMenu <SwitchParameter> -UMAutoAttendant <UMAutoAttendantIdParameter> [-TestMenuKeyMapping <CustomMenuKeyMapping[]>] <COMMON PARAMETERS>
Export-UMPrompt -PromptFileName <String> -UMAutoAttendant <UMAutoAttendantIdParameter> <COMMON PARAMETERS>
Export-UMPrompt -AfterHoursWelcomeGreeting <SwitchParameter> -UMAutoAttendant <UMAutoAttendantIdParameter> [-TestBusinessName <String>] <COMMON PARAMETERS>
Export-UMPrompt -BusinessHours <SwitchParameter> -UMAutoAttendant <UMAutoAttendantIdParameter> <COMMON PARAMETERS>
Export-UMPrompt -BusinessLocation <SwitchParameter> -UMAutoAttendant <UMAutoAttendantIdParameter> <COMMON PARAMETERS>
Export-UMPrompt -PromptFileName <String> -UMDialPlan <UMDialPlanIdParameter> <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

This example exports the welcome greeting for the UM dial plan MyUMDialPlan and saves it as the file welcomegreeting.mp3.

$prompt = Export-UMPrompt -PromptFileName "customgreeting.mp3" -UMDialPlan MyUMDialPlan
set-content -Path "d:\DialPlanPrompts\welcomegreeting.mp3" -Value $prompt.AudioData -Encoding Byte

This example exports the business hours welcome greeting used for the UM auto attendant MyUMAutoAttendant and saves it as the file BusinessHoursWelcomeGreeting.mp3.

$prompt = Export-UMPrompt -BusinessHoursWelcomeGreeting -UMAutoAttendant MyUMAutoAttendant
set-content -Path "d:\UMPrompts\BusinessHoursWelcomeGreeting.mp3" -Value $prompt.AudioData -Encoding Byte

This example exports a custom greeting for the UM auto attendant MyUMAutoAttendant and saves it to the file welcomegreetingbackup.mp3.

Export-UMPrompt -PromptFileName "welcomegreeting.mp3" -UMAutoAttendant MyUMAutoAttendant
set-content -Path "e:\UMPromptsBackup\welcomegreetingbackup.mp3" -Value $prompt.AudioData -Encoding Byte

This example exports the after hours welcome greeting for the UM auto attendant MyUMAutoAttendant, saves it as the file AfterHoursWelcomeGreeting.mp3, and uses Northwind Traders as the test business name.

Export-UMPrompt -AfterHoursWelcomeGreeting -UMAutoAttendant MyUMAutoAttendant -TestBusinessName "Northwind Traders"
set-content -Path "d:\AfterHoursWelcomeGreeting.mp3" -Value $prompt.AudioData -Encoding Byte

The Export-UMPrompt cmdlet exports prompts that belong to existing UM dial plan and UM auto attendant objects. After the Export-UMPrompt cmdlet exports a prompt, you can save a copy of the prompt to a local drive as an audio file. You can then play the audio file using a media player.

After this task is completed, the UM prompts are displayed or saved.

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 mailboxes" entry in the Unified Messaging Permissions topic.

 

Parameter Required Type Description

AfterHoursWelcomeGreeting

Required

System.Management.Automation.SwitchParameter

The AfterHoursWelcomeGreeting parameter specifies the system-generated after hours welcome greeting for the UM auto attendant specified.

AfterHoursWelcomeGreetingAndMenu

Required

System.Management.Automation.SwitchParameter

The AfterHoursWelcomeGreetingAndMenu parameter specifies the system-generated after hours welcome greeting and menu prompts for the UM auto attendant specified.

BusinessHours

Required

System.Management.Automation.SwitchParameter

The BusinessHours parameter specifies that the prompt to be returned is the business hours prompt of the auto attendant.

BusinessHoursWelcomeGreeting

Required

System.Management.Automation.SwitchParameter

The BusinessHoursWelcomeGreeting parameter specifies the system-generated business hours welcome greeting for the UM auto attendant specified.

BusinessHoursWelcomeGreetingAndMenu

Required

System.Management.Automation.SwitchParameter

The BusinessHoursWelcomeGreetingAndMenu parameter specifies the system-generated business hours welcome greeting and menu prompts for the UM auto attendant specified.

BusinessLocation

Required

System.Management.Automation.SwitchParameter

The BusinessLocation parameter specifies the business location greeting played for callers when the caller calls into a UM auto attendant and specifies the business location.

PromptFileName

Required

System.String

The PromptFileName parameter specifies the name of the custom prompt to export.

UMAutoAttendant

Required

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

The UMAutoAttendant parameter specifies the UM auto attendant ID. This parameter specifies the directory object identifier for the UM auto attendant.

UMDialPlan

Required

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

The UMDialPlan parameter specifies the UM dial plan ID. This parameter specifies the directory object identifier for the UM dial plan.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch can be used to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

TestBusinessName

Optional

System.String

The TestBusinessName parameter specifies whether the business name configured on a UM auto attendant or the business name specified by this parameter is used to generate the welcome greeting prompt.

TestMenuKeyMapping

Optional

Microsoft.Exchange.Data.CustomMenuKeyMapping[]

The TestMenuKeyMapping parameter specifies whether the existing key mappings configured on a UM auto attendant or the key mapping menu specified by this parameter is used to generate the welcome greeting and menu.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf 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.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.