TeamsFunctions

22.10

Public/AutoAttendant/Import-TeamsAudioFile.ps1

# Module: TeamsFunctions
# Function: Support, CallQueue, AutoAttendant
# Author: David Eberhardt
# Updated: 01-JAN-2021
# Status: Live




function Import-TeamsAudioFile {
  <#
  .SYNOPSIS
    Imports an AudioFile for CallQueues or AutoAttendants
  .DESCRIPTION
    Imports an AudioFile for CallQueues or AutoAttendants with Import-CsOnlineAudioFile
  .PARAMETER File
    File to be imported
  .PARAMETER ApplicationType
    ApplicationType of the entity it is for
  .EXAMPLE
    Import-TeamsAudioFile -File C:\Temp\MyMusicOnHold.wav -ApplicationType CallQueue
 
    Imports MyMusicOnHold.wav into Teams, assigns it the type CallQueue and returns the imported Object for further use.
  .INPUTS
    System.String
  .OUTPUTS
    Microsoft.Rtc.Management.Hosted.Online.Models.AudioFile
  .NOTES
    Translation of Import-CsOnlineAudioFile to process with New/Set-TeamsResourceAccount
    Simplifies the ApplicationType input for friendly names
    Captures different behavior of Get-Content (ByteStream syntax) in PowerShell 6 and above VS PowerShell 5 and below
  .COMPONENT
    TeamsCallQueue
    TeamsAutoAttendant
  .FUNCTIONALITY
    Imports an AudioFile for CallQueues or AutoAttendants with Import-CsOnlineAudioFile
  .LINK
    https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/Import-TeamsAudioFile.md
  .LINK
    https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/about_TeamsAutoAttendant.md
  .LINK
    https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/about_TeamsCallQueue.md
  .LINK
    https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/
  #>

  [CmdletBinding()]
  [OutputType([System.Object])]
  param(
    [Parameter(Mandatory)]
    [ArgumentCompleter( { 'C:\Temp\' })]
    [string]$File,

    [Parameter(Mandatory)]
    [ValidateSet('CallQueue', 'AutoAttendant')]
    [string]$ApplicationType

  ) #param

  begin {
    Show-FunctionStatus -Level Live
    Write-Verbose -Message "[BEGIN ] $($MyInvocation.MyCommand)"

    # Asserting MicrosoftTeams Connection
    if ( -not (Assert-MicrosoftTeamsConnection) ) { break }

  } #begin

  process {
    Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand)"
    # Testing File
    if ( -not (Assert-TeamsAudioFile "$File")) { return }
    $FileName = Split-Path $File -Leaf

    # remodelling ApplicationType to ApplicationId
    $ApplicationId = switch ($ApplicationType) {
      'CallQueue' { 'HuntGroup' }
      'AutoAttendant' { 'OrgAutoAttendant' }
    }

    try {
      # Importing Content
      if ($PSVersionTable.PSVersion.Major -ge 6) {
        $content = Get-Content $File -AsByteStream -ReadCount 0 -ErrorAction STOP
      }
      else {
        $content = Get-Content $File -Encoding byte -ReadCount 0 -ErrorAction STOP
      }

      # Importing file
      $parameters = $null
      $Parameters += @{ 'ApplicationId' = "$ApplicationId" }
      $Parameters += @{ 'FileName' = "$FileName" }
      $Parameters += @{ 'Content' = $Content }
      $Parameters += @{ 'ErrorAction' = 'STOP' }

      if ($PSBoundParameters.ContainsKey('Debug') -or $DebugPreference -eq 'Continue') {
        " Function: $($MyInvocation.MyCommand.Name) - Parameters (Import-CsOnlineAudioFile)", ($Parameters | Format-Table -AutoSize | Out-String).Trim() | Write-Debug
      }
      $AudioFile = Import-CsOnlineAudioFile @Parameters
      Write-Output $AudioFile
    }
    catch {
      Write-Error "Importing file failed - Please check file size and compression ratio. If in doubt, provide in WAV Format. Exception: $($_.Exception.Message)" -ErrorAction Stop
    }
  } #process

  end {
    Write-Verbose -Message "[END ] $($MyInvocation.MyCommand)"
  } #end
} #Import-TeamsAudioFile