New-CsAutoAttendantMenuOption
Use the New-CsAutoAttendantMenuOption cmdlet to create a new menu option.
Syntax
Default (Default)
New-CsAutoAttendantMenuOption
[-VoiceResponses <List>]
[-CallTarget <Object>]
[-Prompt <Object>]
[-MainlineAttendantTarget <String>]
[-Description <String>]
[-AgentTarget <String>]
[-AgentTargetTagTemplateId <String>]
[-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.
Caution
The following configuration parameters will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time.
- -Description
- -Action AgentAndQueues
- -Action MainLineAttendantFlow
- -MainlineAttendantTarget
Examples
Example 1
$menuOption = New-CsAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0
This 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 $troubleShootEntity
This 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 $Prompt
This 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:
- AgentAndQueues - Restricted to VoiceApps TAP customers
- Announcement - plays a defined prompt then returns to the menu
- DisconnectCall - The call is disconnected.
- MainlineAttendantFlow - Restricted to VoiceApps TAP customers
- TransferCallToOperator - the call is transferred to the operator.
- TransferCallToTarget - The call is transferred to the menu option's call target.
Parameter properties
| Type: | Object |
| 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 |
-AgentTarget
The AgentTarget parameter is the GUID of the target Copilot or a 3rd party IVR agent.
Parameter properties
| Type: | String |
| 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 |
-AgentTargetTagTemplateId
The AgentTargetTagTemplateId parameter is the GUID of the Tag template to assign.
Parameter properties
| Type: | String |
| 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 |
-AgentTargetType
The AgentTargetType parameter indicates if a Copilot Studio or IVR application is invoked. The AgentTargetType must be set to one of the following values:
- Copilot - Restricted to VoiceApps TAP customers - requires that Mainline Attendant be enabled
- IVR - Restricted to VoiceApps TAP customers
Parameter properties
| Type: | Object |
| 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 |
-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.
Parameter properties
| Type: | Object |
| 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 |
-Description
Voice applications private preview customers only.
Saving an auto attendant configuration through Teams admin center will remove this setting.
A description/set of keywords for the option.
Used by Mainline Attendant only.
Limit: 500 characters
Parameter properties
| Type: | System.String |
| 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 |
-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.
Parameter properties
| Type: | Object |
| 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 |
-MainlineAttendantTarget
Voice applications private preview customers only.
Saving an auto attendant configuration through Teams admin center will remove this setting.
The Mainline Attendant call flow target identifier.
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 |
-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.
Parameter properties
| Type: | Microsoft.Rtc.Management.Hosted.OAA.Models.Prompt |
| 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 |
-Tenant
This parameter is reserved for Microsoft internal use only.
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 |
-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.
Parameter properties
| Type: | System.Collections.Generic.List |
| 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 |
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.