New-CsAutoAttendantCallFlow
Use the New-CsAutoAttendantCallFlow cmdlet to create a new call flow.
Syntax
Default (Default)
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.
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
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
Applicable: Microsoft Teams
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.
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 |
-Greetings
Applicable: Microsoft Teams
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.
Note
If Mainline Attendant is enabled, only TTS prompts are supported.
If Mainline Attendant is enabled and no greeting text is provided, the following default prompt will be played:
Hello, and thank you for calling [Auto attendant name]. How can I assist you today? Please note that this call may be recorded for compliance purposes.
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 |
-Menu
Applicable: Microsoft Teams
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.
Parameter properties
| Type: | System.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 |
-Name
Applicable: Microsoft Teams
The Name parameter represents a unique friendly name for the call flow.
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 |
-RingResourceAccountDelegates
Applicable: Microsoft Teams
Voice applications private preview customers only.
Saving an auto attendant configuration through Teams admin center will remove this setting.
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.
Parameter properties
| Type: | Boolean |
| Default value: | False |
| 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.