New-CsAutoAttendantMenuOption
Use the New-CsAutoAttendantMenuOption cmdlet to create a new menu option.
Syntax
New-CsAutoAttendantMenuOption
-Action <DisconnectCall | TransferCallToOperator | TransferCallToTarget>
-DtmfResponse <Tone0 | Tone1 | Tone2 | Tone3 | Tone4 | Tone5 | Tone6 | Tone7 | Tone8 | Tone9 | Automatic>
[-VoiceResponses <List>]
[-CallTarget <Object>]
[-Prompt <Object>]
[-Tenant <Guid>]
[<CommonParameters>] Description
The New-CsAutoAttendantMenuOption cmdlet creates a new menu option for the Auto Attendant (AA) service. The AA service uses the menu options to respond to a caller with the appropriate action.
Examples
-------------------------- Example 1 --------------------------
$menuOption = New-CsAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0This example creates a menu option to call the operator when the 0 key is pressed.
-------------------------- Example 2 --------------------------
$troubleShootObjectId = (Get-CsOnlineUser troubleShoot@contoso.com).ObjectId
$troubleShootEntity = New-CsAutoAttendantCallableEntity -Identity $troubleShootObjectId -Type ApplicationEndpoint
$menuOption = New-CsAutoAttendantMenuOption -Action TransferCallToTarget -DtmfResponse Tone1 -VoiceResponses "Sales" -CallTarget $troubleShootEntityThis example creates a menu option to transfer the call to an application endpoint when the caller speaks the word "Sales" or presses the 1 key.
-------------------------- Example 3 --------------------------
$Prompt = New-CsAutoAttendantPrompt -ActiveType TextToSpeech -TextToSpeechPrompt "Our Office is open from Monday to Friday from 9 AM to 5 PM"
$menuOption = New-CsAutoAttendantMenuOption -Action Announcement -DtmfResponse Tone2 -VoiceResponses "Hours" -Prompt $PromptThis example creates a menu option to play an announcement for the defined prompt. After playing the announcement, the Menu Prompt is repeated.
Parameters
-Action
The Action parameter represents the action to be taken when the menu option is activated. The Action must be set to one of the following values:
- Announcement - plays a defined prompt then returns to the menu
- DisconnectCall - The call is disconnected.
- TransferCallToOperator - the call is transferred to the operator.
- TransferCallToTarget - The call is transferred to the menu option's call target.
| Type: | Object |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Microsoft Teams |
-CallTarget
The CallTarget parameter represents the target for call transfer after the menu option is selected.
CallTarget is required if the action of the menu option is TransferCallToTarget.
Use the New-CsAutoAttendantCallableEntity cmdlet to create new callable entities.
| Type: | Object |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Microsoft Teams |
-DtmfResponse
The DtmfResponse parameter indicates the key on the telephone keypad to be pressed to activate the menu option. The DtmfResponse must be set to one of the following values:
- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9.
- ToneStar - Corresponds to DTMF tone *.
- TonePound - Corresponds to DTMF tone #.
- Automatic - The action is executed without user response.
| Type: | Object |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Microsoft Teams |
-Prompt
The Prompt parameter reflects the prompts to play when the menu option is activated.
You can create new prompts by using the New-CsAutoAttendantPrompt cmdlet.
This parameter is required if the Action is set to Announcement.
| Type: | Microsoft.Rtc.Management.Hosted.OAA.Models.Prompt |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Microsoft Teams |
-Tenant
| Type: | System.Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Microsoft Teams |
-VoiceResponses
The VoiceResponses parameter represents the voice responses to select a menu option when Voice Responses are enabled for the auto attendant.
Voice responses are currently limited to one voice response per menu option.
| Type: | System.Collections.Generic.List |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Microsoft Teams |
Inputs
None
Outputs
Microsoft.Rtc.Management.Hosted.OAA.Models.MenuOption