New-CsAutoAttendantMenu

The New-CsAutoAttendantMenu cmdlet creates a new menu.

Syntax

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

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
Type:Microsoft.Rtc.Management.Hosted.OAA.Models.DirectorySearchMethod
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-EnableDialByName

The EnableDialByName parameter lets users do a directory search by recipient name and get transferred to the party.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-MenuOptions

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.

Type:System.Collections.Generic.List
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-Name

The Name parameter represents a friendly name for the menu.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-Prompts

The Prompts parameter reflects the prompts to play when the menu is activated.

You can create new prompts by using the New-CsAutoAttendantPrompt cmdlet.

Type:Object
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

Inputs

None

Outputs

Microsoft.Rtc.Management.Hosted.OAA.Models.Menu