[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Imports a new audio file for use with Response Group application.


Import-CsRgsAudioFile -Identity <RgsIdentity> -Content <Byte[]> -FileName <String> [-Confirm [<SwitchParameter>]] [-Tenant <Nullable>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description



Rgs Identity

Identity of the service where the audio file is to be imported. (This must be the same service that hosts the Response Group Service itself.) For example: -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com".




File name for the audio file being imported. For example, the file name for the file C:\Media\Welcome.wav is this: Welcome.wav.



Byte array

Actual content of the audio file being imported. The Content property is populated by calling the Get-Content cmdlet. When calling Get-Content, set the –Encoding parameter to byte and the –ReadCount parameter to 0 (see the Examples section for more information).



Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.


Switch Parameter

Describes what would happen if you executed the command without actually executing the command.


Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

The Response Group application can use audio files (.WAV or .WMA formats only) in at least two different ways. For example, the service can play music (or an announcement of some type) any time callers are placed on hold. Alternatively, the Response Group Service occasionally needs to "talk" to callers; for example, with Interactive Voice Response the service might ask callers a question like "Are you calling about an existing order?" If you prefer, you can have the service read these questions using text-to-speech technology. Alternatively, you can play an audio recording of an actual person asking the question.

Regardless of how you choose to use audio files, the files themselves must be imported into the Response Group application using the Import-CsRgsAudioFile cmdlet. Note that you must run Import-CsRgsAudioFile each time you want to use an audio file, even if that file is already being used elsewhere in the Response Group application. For example, suppose Workflow A uses a given audio file as its custom music on hold. Suppose you now want to use that same audio file as the custom music on hold for Workflow B. Even though the audio file is already used by the Response Group application you will still need to import the file in order use the file with Workflow B.

Return Types


Creates new instances of the Microsoft.Rtc.Rgs.Management.WriteableSettings.AudioFile object.

Copy Code
$x = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "WhileYouWait.wav" -Content (Get-Content C:\Media\WhileYouWait.wav -Encoding byte -ReadCount 0)

$y = Get-CsRgsWorkflow -Identity "service:AplicationServer:atl-cs-001.litwareinc.com" - Name "Help Desk Workflow"
$y.CustomMusicOnHold = $x

Set-CsRgsWorkflow $y

The commands shown in Example 1 import an audio file (C:\Media\WhileYouWait.wav) and then assign that file to the CustomMusicOnHold property of a workflow. To perform this task, the first command uses Import-CsRgsAudioFile to import the audio file to the Response Group Service found on ApplicationServer:atl-cs-001.litwareinc.com. In addition to the-Identity parameter (which specifies the service location) the –FileName parameter is used to specify the file name of the file being imported.

Equally important, the –Content parameter is used to import the audio file. File importing is carried out by calling the Get-Content cmdlet followed by the path to the file being imported. Get-Content also requires you to set the encoding type to byte and the ReadCount to 0. (Setting the ReadCount to 0 ensures that the entire file is read in in a single operation.) The imported file is then stored in a variable named $x.

In the second command. Get-CsRgsWorkflow is used to create an object reference ($y) to the workflow Help Desk Workflow. After this object reference has been created, command 3 sets the value of the CustomMusicOnHold property to $x (the variable containing the imported audio file). Finally, the last command in the example uses Set-CsRgsWorkflow to write these changes to the actual workflow Help Desk Workflow. If you do not call Set-CsRgsWorkflow your modifications will exist only in memory, and will disappear as soon as you close Windows PowerShell or delete either $x or $y.