Copy-UMCustomPrompt
[This is pre-release documentation and subject to change in future releases. This topic's current status is: Milestone-Ready.]
Applies to: Exchange Server 2010 Beta* *Topic Last Modified: 2008-12-11
Use the Copy-UMCustomPrompt cmdlet to validate and then copy a .wav audio file from a specified location to the UM prompt publishing point on an Exchange 2010 Unified Messaging server. You can also use this cmdlet to copy a .wav audio file from the UM prompt publishing point to a file.
Syntax
Copy-UMCustomPrompt -Path <String> -UMDialPlan <UMDialPlanIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Copy-UMCustomPrompt -Path <String> -UMAutoAttendant <UMAutoAttendantIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Copy-UMCustomPrompt -TargetPath <String> -UMDialPlan <UMDialPlanIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Copy-UMCustomPrompt -TargetPath <String> -UMAutoAttendant <UMAutoAttendantIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Path |
Required |
System.String |
The Path parameter specifies the full path and name of the source file. The source file is the file that's copied to the UM prompt publishing point. |
TargetPath |
Required |
System.String |
The TargetPath parameter specifies which prompt file you want to copy from a prompt publishing point. |
UMAutoAttendant |
Required |
Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter |
The UMAutoAttendant parameter specifies the identifier for the UM auto attendant. This identifier is the directory object ID for the UM auto attendant. |
UMDialPlan |
Required |
Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter |
The UMDialPlan parameter specifies the identifier for the UM dial plan. This identifier is the directory object ID for the UM dial plan. This parameter isn't required if the UMAutoAttendant parameter is used. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name of the domain controller that writes this configuration change to Active Directory. |
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. |
Detailed Description
The Copy-UMCustomPrompt cmdlet validates and then copies a .wav audio file to the UM prompt publishing point. The UM prompt publishing point is a shared folder that's created on the first Unified Messaging server installed and is used to distribute UM custom prompts to other Unified Messaging servers in the Exchange organization. The Copy-UMCustomPrompt cmdlet supports the use of UM custom audio prompts by copying the specified audio file to the correct location for distribution to other UM servers in the Exchange organization.
Unified Messaging servers access the UM prompt publishing point at set intervals and copy the necessary .wav audio files to their local installation folder. After the file is copied locally to the UM server, the UM server can provide the audio for a specified custom prompt when it's required by the Telephone User Interface (TUI).
After this task is completed, the necessary custom prompts are copied to the prompt publishing point.
To run this cmdlet, you must be assigned, either directly or using a universal security group, one of the following management roles:
- Organization Management
- Organization Management - Tenant
- Unified Messaging Management
- Unified Messaging Management - Tenant
- Unified Messaging Prompt Management
- Unified Messaging Prompt Management - Tenant
While all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they are not included in the management roles assigned to you. For more information, see Permissions Information for Cmdlet Help and Procedural Topics.
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Examples
EXAMPLE 1
This example copies the prompt file named Main Welcome.wav into the folder C:\Prompts so it can be used as a set of custom prompts for the UM dial plan named Contoso. The prompt that's copied replaces the default welcome greeting for the dial plan. Therefore, the Copy-UMCustomPrompt cmdlet should be followed by the Set-UMDialPlan cmdlet. This sets the WelcomeGreetingFilename property to the value Campus Main Welcome.wav.
Copy-UMCustomPrompt -Path "C:\Prompts\Main Welcome.wav" -UMDialPlan Contoso
EXAMPLE 2
This example copies the prompt file named Tech Support Menu.wav in the current working directory into the set of custom prompts for the auto attendant named Technical Support. The prompt that's copied replaces the custom menu prompt used during business hours. Therefore, the Copy-UMCustomPrompt cmdlet should be followed by the Set-UMAutoAttendant cmdlet. This sets the BusinessHoursMainMenuFilename property to the value Tech Support Menu.wav.
Copy-UMCustomPrompt -Path "Tech Support Menu.wav" -UMAutoAttendant "Technical Support"
EXAMPLE 3
This example copies a custom prompt file named file.wav from the prompt publishing point for a UM dial plan.
Copy-UMCustomPrompt -MyUMDialPlan:dp -TargetPath:"D:\WAVFiles\file.wav"
EXAMPLE 4
This example copies a custom prompt file named file.wav from the prompt publishing point for a UM auto attendant.
Copy-UMCustomPrompt -MyUMAA:aa -TargetPath:"D:\WAVFiles\file.wav"