Export-CsOnlineAudioFile
Use the Export-CsOnlineAudioFile cmdlet to download an existing audio file.
Syntax
Default (Default)
Export-CsOnlineAudioFile
-Identity <String>
[-ApplicationId <String>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[<CommonParameters>]
Description
The Export-CsOnlineAudioFile cmdlet downloads an existing Auto Attendant (AA), Call Queue (CQ) service or Music on Hold audio file.
Examples
Example 1
$content=Export-CsOnlineAudioFile -ApplicationId "HuntGroup" -Identity 57f800408f8848548dd1fbc18073fe46
[System.IO.File]::WriteAllBytes('C:\MyWaveFile.wav', $content)
This example exports a Call Queue audio file and saves it as MyWaveFile.wav.
Parameters
-ApplicationId
Applicable: Microsoft Teams
The ApplicationId parameter is the identifier for the application which will use this audio file. For example, if the audio file is used with an organizational auto attendant, then it needs to be set to "OrgAutoAttendant". If the audio file is used with a hunt group (call queue), then it needs to be set to "HuntGroup". If the audio file is used with Microsoft Teams, then it needs to be set to "TenantGlobal"
Supported values:
- OrgAutoAttendant
- HuntGroup
- TenantGlobal
Parameter properties
| Type: | System.String |
| Default value: | TenantGlobal |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HttpPipelinePrepend
{{ Fill HttpPipelinePrepend Description }}
Parameter properties
| Type: | Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Runtime.SendAsyncStep[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
The Id of the specific audio file that you would like to export.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
Byte
Notes
The audio content generated by Export-CsOnlineAudioFile is always in WAV format (PCM 16 bit and mono) irrespective on which format the audio was imported as. Therefore, ensure that the file extension used to store the content is WAV.
You are responsible for independently clearing and securing all necessary rights and permissions to use any music or audio file with your Microsoft Teams service, which may include intellectual property and other rights in any music, sound effects, audio, brands, names, and other content in the audio file from all relevant rights holders, which may include artists, actors, performers, musicians, songwriters, composers, record labels, music publishers, unions, guilds, rights societies, collective management organizations and any other parties who own, control or license the music copyrights, sound effects, audio and other intellectual property rights.