New-CsAutoAttendantMenu
The New-CsAutoAttendantMenu cmdlet creates a new menu.
Syntax
Default (Default)
New-CsAutoAttendantMenu
-Name <String>
[-MenuOptions <List>]
[-Prompts <List>]
[-EnableDialByName]
[-Tenant <Guid>]
[-DirectorySearchMethod]
[<CommonParameters>]
Description
The New-CsAutoAttendantMenu cmdlet creates a new menu for the Auto Attendant (AA) service. The OAA service uses menus to provide callers with choices, and then takes action based on the selection.
Examples
Example 1
$menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign."
$menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -EnableDialByName -DirectorySearchMethod ByExtension
This example creates a new menu that allows the caller to reach a target by name, and also defines the Directory Search Method to Dial By Extension.
Example 2
$menuOptionZero = New-CsAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0
$menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign. For operator, press zero."
$menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -MenuOptions @($menuOptionZero) -EnableDialByName -DirectorySearchMethod ByName
This example creates a new menu that allows the caller to reach a target by name or the operator by pressing the 0 key, and also defines the Directory Search Method to Dial By Name.
Parameters
-DirectorySearchMethod
Applicable: Microsoft Teams
The DirectorySearchMethod parameter lets you define the type of Directory Search Method for the Auto Attendant menu, for more information, see Set up a Cloud auto attendant
Possible values are
- None
- ByName
- ByExtension
Parameter properties
| Type: | Microsoft.Rtc.Management.Hosted.OAA.Models.DirectorySearchMethod |
| 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 |
-EnableDialByName
Applicable: Microsoft Teams
The EnableDialByName parameter lets users do a directory search by recipient name and get transferred to the party.
Parameter properties
| Type: | SwitchParameter |
| 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 |
-MenuOptions
Applicable: Microsoft Teams
The MenuOptions parameter is a list of menu options for this menu. These menu options specify what action to take when the user sends a particular input.
You can create menu options by using the New-CsAutoAttendantMenuOption cmdlet.
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 |
-Name
Applicable: Microsoft Teams
The Name parameter represents a friendly name for the menu.
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 |
-Prompts
Applicable: Microsoft Teams
The Prompts parameter reflects the prompts to play when the menu is activated.
You can create prompts by using the New-CsAutoAttendantPrompt cmdlet.
Note
If Mainline Attendant is enabled, only TTS prompts are supported.
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 |
-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 |
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.