Edit

Share via


New-CsAutoAttendantCallFlow

Use the New-CsAutoAttendantCallFlow cmdlet to create a new call flow.

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.

  • -RingResourceAccountDelegates

Syntax

New-CsAutoAttendantCallFlow
   -Name <String>
   -Menu <Object>
   [-Greetings <List>]
   [-Tenant <Guid>]
   [-ForceListenMenuEnabled]
   [<CommonParameters>]

Description

The New-CsAutoAttendantCallFlow cmdlet creates a new call flow for use with the Auto Attendant (AA) service. The AA service uses the call flow to handle inbound calls by playing a greeting (if present), and provide callers with actions through a menu.

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
$callFlow = New-CsAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu

This example creates a new call flow that renders the "Default Menu" menu.

-------------------------- Example 2 --------------------------

$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
$greeting = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!"
$callFlow = New-CsAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu -Greetings $greeting -ForceListenMenuEnabled

This example creates a new call flow that plays a greeting before rendering the "Default Menu" menu with Force listen menu enabled.

Parameters

-ForceListenMenuEnabled

If specified, DTMF and speech inputs will not be processed while the greeting or menu prompt is playing. It will enforce callers to listen to all menu options before making a selection.

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

-Greetings

If present, the prompts specified by the Greetings parameter (either TTS or Audio) are played before the call flow's menu is rendered.

You can create prompts by using the New-CsAutoAttendantPrompt 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

-Menu

The Menu parameter identifies the menu to render when the call flow is executed.

You can create a new menu by using the New-CsAutoAttendantMenu cmdlet.

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

-Name

The Name parameter represents a unique friendly name for the call flow.

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

-RingResourceAccountDelegates

If enabled for this call flow, Auto Attendant will first ring the delegates assigned to the resource account the call is on. If none of the delegates answer, the call is returned to the Auto Attendant for standard processing.

If there are no delegates assigned to the resource account the call is on then the Auto Attendant will process the call normally.

Voice applications private preview customers only.

Saving an auto attendant configuration through Teams admin center will remove this setting.

Type:Boolean
Position:Named
Default value:False
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.CallFlow