Reference - PowerShell cmdlets for voice applications

Important

Teams Phone Agent is now generally available.

Book a Teams Phone Agent Discovery Session to learn what Teams Phone Agent does, how it fits your organization, and how to plan your deployment. We can also help you work through setup and configuration questions. Teams Phone Agent Discovery Sessions

We want your feedback

Help us improve Teams Phone Agent. Share your feedback on our planning and setup documentation, the Teams admin centre experience, Teams Phone Agent features, or tell us about features and improvements you’d like to see.

The following cmdlet references are for Microsoft Teams Phone Agent, Auto Attendants, and Call Queues.

Teams Phone Agent

The following cmdlets are specific to Teams Phone Agent feature configuration. The Auto Attendant cmdlets must also be used in order to create a working Teams Phone Agent.

• Get-CsMainlineAttendantFlow
• New-CsMainlineAttendantAppointmentBookingFlow
• Get-CsMainlineAttendantAppointmentBookingFlow
• Set-CsMainlineAttendantAppointmentBookingFlow
• Remove-CsMainlineAttendantAppointmentBookingFlow
• New-CsMainlineAttendantQuestionAnswerFlow
• Get-CsMainlineAttendantQuestionAnswerFlow
• Set-CsMainlineAttendantQuestionAnswerFlow
• Remove-CsMainlineAttendantQuestionAnswerFlow
• Get-CsMainlineAttendantSupportedLanguages
• Get-CsMainlineAttendantSupportedVoices
• Get-CsMainlineAttendantTenantInformation

Auto Attendant

The following cmdlets allow you to create and manage an Auto Attendant:

• New-CsAutoAttendant
• Get-CsAutoAttendant
• Set-CsAutoAttendant
• Update-CsAutoAttendant
• Remove-CsAutoAttendant
• New-CsOnlineTimeRange
• New-CsOnlineDateTimeRange
• New-CsOnlineSchedule
• Get-CsAutoAttendantHolidays
• Import-CsAutoAttendantHolidays
• Export-CsAutoAttendantHolidays
• New-CsAutoAttendantDialScope
• New-CsAutoAttendantPrompt
• New-CsAutoAttendantCallableEntity
• New-CsAutoAttendantMenuOption
• New-CsAutoAttendantMenu
• New-CsAutoAttendantCallFlow
• New-CsAutoAttendantCallHandlingAssociation
• Get-CsAutoAttendantStatus
• Get-CsAutoAttendantTenantInformation

For a step-by-step guide to creating an Auto Attendant with PowerShell, see Creating Auto attendants with PowerShell cmdlets

Call Queue

The following cmdlets allow you to create and manage a Call Queue:

• New-CsCallQueue
• Get-CsCallQueue
• Set-CsCallQueue
• Remove-CsCallQueue

For a step-by-step guide to creating a Call Queue with PowerShell, see Call Queues with PowerShell

Compliance Recording for Call Queues

The following cmdlets allow you to create and manage Compliance Recording for Call Queue templates:

• New-CsComplianceRecordingForCallQueueTemplate
• Get-CsComplianceRecordingForCallQueueTemplate
• Set-CsComplianceRecordingForCallQueueTemplate
• Remove-CsComplianceRecordingForCallQueueTemplate

Shared call history

• New-CsSharedCallQueueHistoryTemplate
• Get-CsSharedCallQueueHistoryTemplate
• Set-CsSharedCallQueueHistoryTemplate
• Remove-CsSharedCallQueueHistoryTemplate

Common cmdlets used by Teams Phone Agent, Auto Attendant, and Call Queue

The following cmdlets are also required to manage common components of Teams Phone Agent, Auto Attendant and Call Queue such as:

• Users
• Resource accounts
• Licenses
• Phone numbers
• Audio files (for Auto Attendant and Call Queue only)
• Supported languages (for Auto Attendant and Call Queue only. See Teams Phone Agent for equivalent cmdlets.)

Automatic Recording for Teams Phone Agent and Call Queue

The following cmdlets allow you to create and manage Automatic Recording templates:

• New-CsAutoRecordingTemplate
• Get-CsAutoRecordingTemplate
• Set-CsAutoRecordingTemplate
• Remove-CsAutoRecordingTemplate

Users and Teams

• Users

  • Get-CsOnlineUser

• Teams:

  • Get-Team
  • Get-TeamChannel

Resource accounts

• New-CsOnlineApplicationInstance
• Find-CsOnlineApplicationInstance
• Get-CsOnlineApplicationInstance
• Set-CsOnlineApplicationInstance
• New-CsOnlineApplicationInstanceAssociation
• Get-CsOnlineApplicationInstanceAssociation
• Remove-CsOnlineApplicationInstanceAssociation
• Get-CsOnlineApplicationInstanceAssociationStatus

Teams Phone Resource Account licenses

• Get-MgSubscribedSku
• Set-MgUserLicense

Phone number assignment

• Get-CsPhoneNumberAssignment
• Set-CsPhoneNumberAssignment

Audio files (for Auto attendants and Call queues only)

• Get-CsOnlineAudioFile
• Import-CsOnlineAudioFile
• Export-CsOnlineAudioFile
• Remove-CsOnlineAudioFile

Supported languages (for Auto Attendant and Call Queue only)

• Get-CsAutoAttendantSupportedLanguage

Supported time zones (for Teams Phone Agent and Auto Attendant only)

• Get-CsAutoAttendantSupportedTimeZone

Voice applications policies

• Get-CsTeamsVoiceApplicationsPolicy
• Grant-CsTeamsVoiceApplicationsPolicy
• New-CsTeamsVoiceApplicationsPolicy
• Remove-CsTeamsVoiceApplicationsPolicy
• Set-CsTeamsVoiceApplicationsPolicy