New-CsAutoAttendantPrompt
Use the New-CsAutoAttendantPrompt cmdlet to create a new prompt.
Syntax
AudioFile
New-CsAutoAttendantPrompt
-AudioFilePrompt <Object>
[-Tenant <Guid>]
[<CommonParameters>]
TextToSpeech
New-CsAutoAttendantPrompt
-TextToSpeechPrompt <String>
[-Tenant <Guid>]
[<CommonParameters>]
Dual
New-CsAutoAttendantPrompt
-AudioFilePrompt <Object>
-TextToSpeechPrompt <String>
[-Tenant <Guid>]
[<CommonParameters>]
Description
The New-CsAutoAttendantPrompt cmdlet creates a new prompt for the Auto Attendant (AA) service. A prompt is either an audio file that is played, or text that is read aloud to give callers additional information. A prompt can be disabled by setting the ActiveType to None.
Examples
Example 1
$ttsPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!"
This example creates a new prompt that reads the supplied text.
Example 2
$content = [System.IO.File]::ReadAllBytes('C:\Media\hello.wav')
$audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "hello.wav" -Content $content
$audioFilePrompt = New-CsAutoAttendantPrompt -AudioFilePrompt $audioFile
This example creates a new prompt that plays the selected audio file.
Example 3
$content = [System.IO.File]::ReadAllBytes('C:\Media\hello.wav')
$audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "hello.wav" -Content $content
$dualPrompt = New-CsAutoAttendantPrompt -ActiveType AudioFile -AudioFilePrompt $audioFile -TextToSpeechPrompt "Welcome to Contoso!"
This example creates a new prompt that has both audio file and text-to-speech data, but will play the audio file when the prompt is activated (rendered).
Parameters
-ActiveType
Applicable: Microsoft Teams
PARAMVALUE: None | TextToSpeech | AudioFile
The ActiveType parameter identifies the active type (modality) of the AA prompt. It can be set to None (the prompt is disabled), TextToSpeech (text-to-speech is played when the prompt is rendered) or AudioFile (audio file data is played when the prompt is rendered).
This is explicitly required if both Audio File and TTS prompts are specified. Otherwise, it is inferred.
Parameter properties
| Type: | Object |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Dual
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AudioFilePrompt
Applicable: Microsoft Teams
The AudioFilePrompt parameter represents the audio to play when the prompt is activated (rendered).
This parameter is required when audio file prompts are being created. You can create audio files by using the Import-CsOnlineAudioFile cmdlet.
Parameter properties
| Type: | Object |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AudioFile
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Dual
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Tenant
Applicable: Microsoft Teams
Parameter properties
| Type: | System.Guid |
| 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 |
-TextToSpeechPrompt
Applicable: Microsoft Teams
The TextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt that is to be read when the prompt is activated.
This parameter is required when text to speech prompts are being created.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
TextToSpeech
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Dual
| Position: | Named |
| Mandatory: | False |
| 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.