external help file	Module Name	online version	schema
TeamsFunctions-help.xml	TeamsFunctions	https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/New-TeamsAutoAttendantMenuOption.md	2.0.0

New-TeamsAutoAttendantMenuOption

SYNOPSIS

Creates a Menu Options Object

SYNTAX

DisconnectCall (Default)

New-TeamsAutoAttendantMenuOption [-DisconnectCall] [-EnableTranscription]
 [-EnableSharedVoicemailSystemPromptSuppression] [-WhatIf] [-Confirm] [<CommonParameters>]

Announcement

New-TeamsAutoAttendantMenuOption [-Press <String>] [-OrSay <String>] [-Announcement <String>]
 [-EnableTranscription] [-EnableSharedVoicemailSystemPromptSuppression] [-WhatIf] [-Confirm]
 [<CommonParameters>]

CallTarget

New-TeamsAutoAttendantMenuOption [-Press <String>] [-OrSay <String>] [-CallTarget <String>]
 [-EnableTranscription] [-EnableSharedVoicemailSystemPromptSuppression] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Operator

New-TeamsAutoAttendantMenuOption [-Press <String>] [-TransferToOperator] [-EnableTranscription]
 [-EnableSharedVoicemailSystemPromptSuppression] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates a Menu Options Object to be used in Auto Attendants Wrapper for New-CsAutoAttendantMenuOption with friendly names

EXAMPLES

EXAMPLE 1

New-TeamsAutoAttendantMenuOption -Disconnect

Creates a default Menu Option to be used for disconnecting the call.

EXAMPLE 2

New-TeamsAutoAttendantMenuOption -Press 0 -TransferToOperator

Creates a Menu Option on pressing 0 (voice response is 'Operator' by default) to Transfer to the Operator. Note: The Operator must be specified in the AutoAttendant!

EXAMPLE 3

New-TeamsAutoAttendantMenuOption -Press 1 -CallTarget "My Group"

Creates a Menu Option on pressing 1 or saying 'one' (default) to Transfer to the Call Target (Shared Voicemail) Voice Input is only parsed if available and activated in the Auto Attendant

EXAMPLE 4

New-TeamsAutoAttendantMenuOption -Press 2 -CallTarget Sales@domain.com -OrSay "Sales"

Creates a Menu Option on pressing 2 or saying 'Sales' to Transfer to the Call Target (User). Voice Input is only parsed if available and activated in the Auto Attendant

EXAMPLE 5

New-TeamsAutoAttendantMenuOption -Press 3 -CallTarget MyCQ@domain.com

Creates a Menu Option on pressing 3 to Transfer to the Call Target (Call Queue).

EXAMPLE 6

New-TeamsAutoAttendantMenuOption -Press 4 -CallTarget MyAA@domain.com

Creates a Menu Option on pressing 4 to Transfer to the Call Target (Auto Attendant).

EXAMPLE 7

New-TeamsAutoAttendantMenuOption -Press 5 -CallTarget "tel:+15551234567" -OrSay "Engineer"

Creates a Menu Option on pressing 5 or saying 'Engineer' to Transfer to the Call Target (ExternalPstn). Voice Input is only parsed if available and activated in the Auto Attendant

EXAMPLE 8

New-TeamsAutoAttendantMenuOption -Press 6 -Announcement "We are open Monday to Friday from 9 AM to 5 PM" -OrSay "Hours"

Creates a Menu Option on pressing 6 or saying 'Hours' to play an Announcement (Text-to-Voice) and return to the main menu.

EXAMPLE 9

New-TeamsAutoAttendantMenuOption -Press 7 -Announcement "C:\Temp\AudioFile-OpeningHours.wav" -OrSay "Hours"

Creates a Menu Option on pressing 7 or saying 'Hours' to play an Announcement (Audio File) and return to the main menu. The File must exist in the specified

EXAMPLE 10

New-TeamsAutoAttendantMenuOption -Press Pound -CallTarget "My Group"

Creates a Menu Option on pressing Pound (or Hash) or saying 'Pound' (default) to Transfer to the Call Target (Shared Voicemail) Voice Input is only parsed if available and activated in the Auto Attendant

EXAMPLE 11

New-TeamsAutoAttendantMenuOption -Press Star -CallTarget MyCQ@domain.com

Creates a Menu Option on pressing Star or saying 'Star' (default) to Transfer to the Call Target (Call Queue). Voice Input is only parsed if available and activated in the Auto Attendant

PARAMETERS

-DisconnectCall

Required to create a basic 'Disconnect' option. Switch. Default.

Type: SwitchParameter
Parameter Sets: DisconnectCall
Aliases:

Required: True
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Press

Required for binding a specific Dial Key. Values of 0-9, 'Pound' or 'Star'. Dtmf Tone (digit) to be pressed for this option. Set to Automatic if not provided.

Type: String
Parameter Sets: Announcement, CallTarget, Operator
Aliases: DtmfResponseTone

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OrSay

String. Optional for Option any call Target except Operator. Voice Response to be used for this option. Expected: Single word

Type: String
Parameter Sets: Announcement, CallTarget
Aliases: VoiceResponses, Say

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TransferToOperator

Switch. Required for Option TransferToOperator. No other input necessary, but Operator must be defined in the Auto Attendant. The AutoAttendant which will receive a Menu with this option, must have an Operator defined. Creating or Updating an Auto Attendant with an Operator that is not defined will lead to errors.

Type: SwitchParameter
Parameter Sets: Operator
Aliases: Operator

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-CallTarget

Required for Option TransferToCallTarget. String identifying the Call Target: UserPrincipalName (User, ResourceAccount), Group Name (Shared Voicemail), Tel Uri (ExternalPstn)

Type: String
Parameter Sets: CallTarget
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Announcement

Required for Option Announcement. String for the Audio File OR Text-to-Voice

Type: String
Parameter Sets: Announcement
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EnableTranscription

Optional. Where possible, tries to enable Voicemail Transcription. Effective only for SharedVoicemail Targets as an Operator or MenuOption. Otherwise has no effect.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-EnableSharedVoicemailSystemPromptSuppression

Optional. Where possible, tries to suppress System Prompts. Effective only for SharedVoicemail Targets as an Operator or MenuOption. Otherwise has no effect.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

System.Object

NOTES

This script determines the Type of CallTarget based on the provided String. As such it cannot distinguish between Redirect to 'User and Redirect' to 'Voicemail (personal)'. This is currently not an option on Auto Attendants, but may become one in the future. Redirect to Voicemail (personal) is available on Call Queues. Voice Input is only parsed if available and activated in the Auto Attendant

Files

New-TeamsAutoAttendantMenuOption.md

Latest commit

History