Copy-UMCustomPrompt
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Copy-UMCustomPrompt cmdlet validates and then copies a .wav audio file from a specified location to the UM prompt publishing point on a computer that is running Microsoft Exchange Server 2007 that has the Unified Messaging (UM) server role installed. 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>]]
Detailed Description
The Copy-UMCustomPrompt cmdlet is used to validate and then copy a .wav audio file to the UM prompt publishing point. The UM prompt publishing point is a shared folder that is created on the first Unified Messaging server that is installed and is used to distribute UM custom prompts to other Unified Messaging servers in the Exchange 2007 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 Unified Messaging servers in the Exchange 2007 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 has been copied locally to the Unified Messaging server, the Unified Messaging server can provide the audio for a given custom prompt when it is required by the telephone user interface (TUI).
To run the Copy-UMCustomPrompt cmdlet, the account you use must be delegated the Exchange Organization Administrator role.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Path |
Required |
System.String |
This parameter specifies the full path and name of the source file. The source file is the file that will be copied to the UM prompt publishing point. |
TargetPath |
Required |
System.String |
This parameter specifies which prompt file you want to copy from a prompt publishing point. |
UMAutoAttendant |
Required |
Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter |
This 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 |
This parameter specifies the identifier for the UM dial plan. This identifier is the directory object ID for the UM dial plan. This parameter is not required if the UMAutoAttendant parameter is used. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
This parameter causes the command to pause processing and requires the administrator to acknowledge what the command will do before processing continues. The default value is $true. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory active directory service. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, the administrator can view what changes would occur without having to apply any of those changes. The default value is $true. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The first example copies the prompt file that is named Main Welcome.wav into the directory C:\Prompts so that it can be used as a set of custom prompts for the UM dial plan named Contoso. The prompt that is 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.
The second example copies the prompt file that is named Tech Support Menu.wav in the current working directory into the set of custom prompts for the auto attendant that is named Technical Support. The prompt that is copied replaces the custom menu prompt that is 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.
The third example copies a custom prompt file named file.wav from the prompt publishing point for a UM dial plan.
The fourth example copies a custom prompt file named file.wav from the prompt publishing point for a UM auto attendant.
Copy-UMCustomPrompt -Path "C:\Prompts\Main Welcome.wav" -UMDialPlan Contoso
Copy-UMCustomPrompt -Path "Tech Support Menu.wav" -UMAutoAttendant "Technical Support"
Copy-UMCustomPrompt -MyUMDialPlan:dp -TargetPath:"D:\WAVFiles\file.wav"
Copy-UMCustomPrompt -MyUMAA:aa -TargetPath:"D:\WAVFiles\file.wav"