From d7890452d1f2f358ac1d9a80ce955e7b7b716e45 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Sun, 17 Aug 2025 20:24:05 -0700 Subject: [PATCH 01/10] Update Set-CsMainlineAttendantAppointmentBookingFlow.md Updating to reflect the change to Instance to stay inline with other AA cmdlets. --- ...MainlineAttendantAppointmentBookingFlow.md | 91 ++----------------- 1 file changed, 6 insertions(+), 85 deletions(-) diff --git a/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantAppointmentBookingFlow.md index 61e17500cc..6c71801977 100644 --- a/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantAppointmentBookingFlow.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantAppointmentBookingFlow.md @@ -19,7 +19,7 @@ Changes an existing Mainline Attendant appointment booking flow ## SYNTAX ``` -Set-CsMainlineAttendantAppointmentBookingFlow -Identity [-Name ] [-Description ] [-CallerAuthenticationMethod ] [-ApiAuthenticationType ] [-ApiDefinitions ] [-Tenant ] [] +Set-CsMainlineAttendantAppointmentBookingFlow -Instance [-Tenant ] [] ``` ## DESCRIPTION @@ -33,96 +33,17 @@ The Set-CsMainlineAttendantAppointmentBookingFlow cmdlet changes an existing app ## PARAMETERS -### -Identity -The unique Id of the appointment booking flow to change +### -Instance +The Instance parameter is the object reference to the Mainline Attendant Booking flow. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the appointment booking flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for the appointment booking flow - -Limit: 500 characters. +You can retrieve an object reference to an existing Mainline Attendant Booking flow by using the [Get-CsMainlineAttendantAppointmentBookingFlow](Get-CsMainlineAttendantAppointBookingFlow.md) cmdlet and assigning the returned value to a variable. ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallerAuthenticationMethod -The method by which the caller is authenticated - -PARAVALUES: sms | email | verification_link | voiceprint | user_details - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiAuthenticationType -The method of authentication used by the API - -PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiDefinitions -The parameters used by the API - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False From 36563bb201635f22625fbc1dae1cb681be7dba55 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Sun, 17 Aug 2025 20:27:00 -0700 Subject: [PATCH 02/10] Update Set-CsMainlineAttendantQuestionAnswerFlow.md --- ...t-CsMainlineAttendantQuestionAnswerFlow.md | 74 ++----------------- 1 file changed, 6 insertions(+), 68 deletions(-) diff --git a/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantQuestionAnswerFlow.md index 5335328561..b6a024dda1 100644 --- a/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantQuestionAnswerFlow.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantQuestionAnswerFlow.md @@ -19,7 +19,7 @@ Changes an existing Mainline Attendant question and answer (FAQ) flow ## SYNTAX ``` -Set-CsMainlineAttendantQuestionAnswerFlow -Identity [-Name ] [-Description ] [-ApiAuthenticationType ] [-KnowledgeBase ] [-Tenant ] [] +Set-CsMainlineAttendantQuestionAnswerFlow -Instance [-Tenant ] [] ``` ## DESCRIPTION @@ -33,79 +33,17 @@ The Set-CsMainlineAttendantQuestionAnswerFlow cmdlet changes an existing questio ## PARAMETERS -### -Identity -The unique identifier for the question and answer flow. +### -Instance +The Instance parameter is the object reference to the Mainline Attendant Question and Answer flow to be modified. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the question and answer flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for the question and answer flow +You can retrieve an object reference to an existing Mainline Attendant Question and Answer Flow by using the [Get-CsMainlineAttendantQuestionAnswerFlow](Get-CsMainlineAttendantQuestionAnswerFlow.md) cmdlet and assigning the returned value to a variable. ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiAuthenticationType -The method of authentication used by the API - -PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KnowledgeBase -The knowledge base definition - -The parameters used by the API - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False From 19a1132351651ec6441ab5a7349669cd852d0cef Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Sun, 17 Aug 2025 20:34:24 -0700 Subject: [PATCH 03/10] Update New-CsAutoAttendantMenuOption.md --- .../New-CsAutoAttendantMenuOption.md | 18 +----------------- 1 file changed, 1 insertion(+), 17 deletions(-) diff --git a/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenuOption.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenuOption.md index a7848cfead..dbcd004508 100644 --- a/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenuOption.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenuOption.md @@ -64,8 +64,6 @@ This example creates a menu option to play an announcement for the defined promp ### -Action -> Applicable: Microsoft Teams - The Action parameter represents the action to be taken when the menu option is activated. The Action must be set to one of the following values: - Announcement - plays a defined prompt then returns to the menu @@ -87,8 +85,6 @@ Accept wildcard characters: False ### -CallTarget -> Applicable: Microsoft Teams - The CallTarget parameter represents the target for call transfer after the menu option is selected. CallTarget is required if the action of the menu option is TransferCallToTarget. @@ -109,8 +105,6 @@ Accept wildcard characters: False ### -Description -> Applicable: Microsoft Teams - _Voice applications private preview customers only._ _Saving an auto attendant configuration through Teams admin center will remove this setting._ @@ -135,8 +129,6 @@ Accept wildcard characters: False ### -DtmfResponse -> Applicable: Microsoft Teams - The DtmfResponse parameter indicates the key on the telephone keypad to be pressed to activate the menu option. The DtmfResponse must be set to one of the following values: - Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. @@ -158,8 +150,6 @@ Accept wildcard characters: False ### -MainlineAttendantTarget -> Applicable: Microsoft Teams - _Voice applications private preview customers only._ _Saving an auto attendant configuration through Teams admin center will remove this setting._ @@ -180,8 +170,6 @@ Accept wildcard characters: False ### -Prompt -> Applicable: Microsoft Teams - The **Prompt** parameter reflects the prompts to play when the menu option is activated. You can create new prompts by using the **New-CsAutoAttendantPrompt** cmdlet. @@ -202,9 +190,7 @@ Accept wildcard characters: False ### -Tenant -> Applicable: Microsoft Teams - -{{ Fill Tenant Description }} +This parameter is reserved for Microsoft internal use only. ```yaml Type: System.Guid @@ -220,8 +206,6 @@ Accept wildcard characters: False ### -VoiceResponses -> Applicable: Microsoft Teams - The VoiceResponses parameter represents the voice responses to select a menu option when Voice Responses are enabled for the auto attendant. Voice responses are currently limited to one voice response per menu option. From de7d155feaf9697f4b28463bc6490442e55e277e Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Sun, 17 Aug 2025 20:39:08 -0700 Subject: [PATCH 04/10] Update Set-CsMainlineAttendantAppointmentBookingFlow.md --- .../Set-CsMainlineAttendantAppointmentBookingFlow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantAppointmentBookingFlow.md index 6c71801977..97515a6d0b 100644 --- a/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantAppointmentBookingFlow.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsMainlineAttendantAppointmentBookingFlow.md @@ -36,7 +36,7 @@ The Set-CsMainlineAttendantAppointmentBookingFlow cmdlet changes an existing app ### -Instance The Instance parameter is the object reference to the Mainline Attendant Booking flow. -You can retrieve an object reference to an existing Mainline Attendant Booking flow by using the [Get-CsMainlineAttendantAppointmentBookingFlow](Get-CsMainlineAttendantAppointBookingFlow.md) cmdlet and assigning the returned value to a variable. +You can retrieve an object reference to an existing Mainline Attendant Booking flow by using the [Get-CsMainlineAttendantAppointmentBookingFlow](Get-CsMainlineAttendantAppointmentBookingFlow.md) cmdlet and assigning the returned value to a variable. ```yaml Type: Object From 78abede670e8e9c4aed314640c71232e487c8695 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Sun, 17 Aug 2025 20:43:06 -0700 Subject: [PATCH 05/10] Update Get-CsMainlineAttendantFlow.md --- .../Get-CsMainlineAttendantFlow.md | 21 ++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md b/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md index 1360745f2e..395e29c577 100644 --- a/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md @@ -19,7 +19,7 @@ The Get-CsMainlineAttendantFlow cmdlet returns information about the Mainline At ## SYNTAX ``` -Get-CsMainlineAttendantFlow [-MaConfigId ] [-Type ] [-FlowId ] [-Tenant ] [] +Get-CsMainlineAttendantFlow [-MaConfigId ] [-Type ] [-Identity ] [-Tenant ] [] ``` ## DESCRIPTION @@ -46,14 +46,21 @@ This example will list all the Mainline Attendant flows associated with the spec ### Example 3 ``` -Get-CsMainlineAttendantFlow -Type Type 1 | Type 2 +Get-CsMainlineAttendantFlow -Type Appointment ``` -This example will list all the Mainline Attendant flows with the specified type. +This example will list all the Mainline Attendant Appointment flows. ### Example 4 ``` -Get-CsMainlineAttendantFlow -FlowId 956bca6-e2a0-4117-9b6f-023f80b31bbe5 +Get-CsMainlineAttendantFlow -Type QuestionAnswer +``` + +This example will list all the Mainline Attendant Question and Answer flows with the specified type. + +### Example 5 +``` +Get-CsMainlineAttendantFlow -Identity 956bca6-e2a0-4117-9b6f-023f80b31bbe5 ``` This example will list the Mainline Attendant flow with the specified flow id. @@ -78,7 +85,7 @@ Accept wildcard characters: False ### -Type The Mainline Attendant flow type -PARAMVALUE: Appointment | QuestionAndAnswer +PARAMVALUE: Appointment | QuestionAnswer ```yaml Type: String @@ -92,8 +99,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FlowId -The Mainline Attendant flow id +### -Identity +The Mainline Attendant identity ```yaml Type: String From 03878603f404e568ed89052f692ae16eec1183cc Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Sun, 17 Aug 2025 20:48:41 -0700 Subject: [PATCH 06/10] Update Get-CsMainlineAttendantFlow.md --- teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md b/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md index 395e29c577..47d23e9e30 100644 --- a/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md @@ -63,7 +63,7 @@ This example will list all the Mainline Attendant Question and Answer flows with Get-CsMainlineAttendantFlow -Identity 956bca6-e2a0-4117-9b6f-023f80b31bbe5 ``` -This example will list the Mainline Attendant flow with the specified flow id. +This example will list the Mainline Attendant flow with the specified identity. ## PARAMETERS From 4f6f9a22c9cbc780cd6b1d648116c21a9f41fb22 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Sun, 17 Aug 2025 20:58:28 -0700 Subject: [PATCH 07/10] Update Get-CsPersonalAttendantSettings.md Updating for missing -InputObject parameter --- .../Get-CsPersonalAttendantSettings.md | 49 ++++++++++++++++--- 1 file changed, 43 insertions(+), 6 deletions(-) diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md b/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md index bd61deb0f6..af4f4e131f 100644 --- a/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md @@ -22,7 +22,7 @@ This cmdlet will show personal attendant settings for a user. ## SYNTAX ``` -Get-CsPersonalAttendantSettings -Identity [] +Get-CsPersonalAttendantSettings [-Identity ] [-InputObject ] [] ``` ## DESCRIPTION @@ -54,7 +54,29 @@ IsAutomaticRecordingEnabled : False This example shows that user1@contoso.com has personal attendant enabled (personal attendant communicates in English). Personal attendant will refer to its owner as User1. Personal attendant is only enabled for inbound Teams calls from the user's domain. Additional capabilities are turned off. -### Example 2 +Example 2 +``` +Get-CsPersonalAttendantSettings -InputObject @{ UserId = "user11@contoso.com"; } +``` +```outbput +IsPersonalAttendantEnabled : True +DefaultLanguage : en-US +DefaultVoice : Female +CalleeName : User1 +DefaultTone : Formal +IsBookingCalendarEnabled : False +IsNonContactCallbackEnabled : False +IsCallScreeningEnabled : False +AllowInboundInternalCalls : True +AllowInboundFederatedCalls : False +AllowInboundPSTNCalls : False +IsAutomaticTranscriptionEnabled : False +IsAutomaticRecordingEnabled : False +``` + +This example returns same output as Example 1 but fetched using identity parameter. + +### Example 3 ``` Get-CsPersonalAttendantSettings -Identity user1@contoso.com ``` @@ -77,7 +99,7 @@ IsAutomaticRecordingEnabled : False This example shows that user1@contoso.com has personal attendant enabled. In addition to previously mentioned capabilities, personal attendant is able to access personal bookings calendar, fetch the user's availability and schedule callbacks on behalf of the user. Calendar operations are enabled for all incoming callers. user1 must specify the bookings link in Teams Personal Attendant settings. -### Example 3 +### Example 4 ``` Get-CsPersonalAttendantSettings -Identity user1@contoso.com ``` @@ -99,7 +121,7 @@ IsAutomaticRecordingEnabled : False This example shows that user1@contoso.com has personal attendant enabled. In addition to previously mentioned capabilities, personal attendant is enabled for all incoming calls: the user's domain, other domains and PSTN. -### Example 4 +### Example 5 ``` Get-CsPersonalAttendantSettings -Identity user1@contoso.com ``` @@ -121,7 +143,7 @@ IsAutomaticRecordingEnabled : False This example shows that user1@contoso.com has personal attendant enabled. In addition to previously mentioned capabilities, personal attendant is enabled to evaluate the call's context and pass the info to the user. -### Example 5 +### Example 6 ``` Get-CsPersonalAttendantSettings -Identity user1@contoso.com ``` @@ -143,7 +165,7 @@ IsAutomaticRecordingEnabled : True This example shows that user1@contoso.com has personal attendant enabled. In addition to previously mentioned capabilities, personal attendant is automatically storing call transcription and recording. -### Example 6 +### Example 7 ``` Get-CsPersonalAttendantSettings -Identity user11@contoso.com ``` @@ -182,6 +204,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +The Identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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](https://go.microsoft.com/fwlink/?LinkID=113216). From a7091858dd656fd07b6f517f028cdecf63a25c9a Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Sun, 17 Aug 2025 21:01:39 -0700 Subject: [PATCH 08/10] Update Get-CsMainlineAttendantFlow.md --- .../MicrosoftTeams/Get-CsMainlineAttendantFlow.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md b/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md index 47d23e9e30..d6ddcd60a0 100644 --- a/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsMainlineAttendantFlow.md @@ -19,7 +19,7 @@ The Get-CsMainlineAttendantFlow cmdlet returns information about the Mainline At ## SYNTAX ``` -Get-CsMainlineAttendantFlow [-MaConfigId ] [-Type ] [-Identity ] [-Tenant ] [] +Get-CsMainlineAttendantFlow [-ConfigurationId ] [-Type ] [-Identity ] [-Tenant ] [] ``` ## DESCRIPTION @@ -39,14 +39,14 @@ This example will list all the Mainline Attendant flows in the tenant. ### Example 2 ``` -Get-CsMainlineAttendantFlow -MaConfig 0b31bbe5-e2a0-4117-9b6f-956bca6023f8 +Get-CsMainlineAttendantFlow -ConfigurationId 0b31bbe5-e2a0-4117-9b6f-956bca6023f8 ``` This example will list all the Mainline Attendant flows associated with the specific configuration id. ### Example 3 ``` -Get-CsMainlineAttendantFlow -Type Appointment +Get-CsMainlineAttendantFlow -Type AppointmentBooking ``` This example will list all the Mainline Attendant Appointment flows. @@ -67,7 +67,7 @@ This example will list the Mainline Attendant flow with the specified identity. ## PARAMETERS -### -MaConfigId +### -ConfigurationId The Mainline Attendant configuration Id ```yaml @@ -85,7 +85,7 @@ Accept wildcard characters: False ### -Type The Mainline Attendant flow type -PARAMVALUE: Appointment | QuestionAnswer +PARAMVALUE: AppointmentBooking | QuestionAnswer ```yaml Type: String From 593b5b326f7872e2b48fbdd9954c6adc39a14a65 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Mon, 18 Aug 2025 07:58:58 -0700 Subject: [PATCH 09/10] Update Get-CsPersonalAttendantSettings.md --- .../teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md b/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md index af4f4e131f..e9e473038d 100644 --- a/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md @@ -54,7 +54,7 @@ IsAutomaticRecordingEnabled : False This example shows that user1@contoso.com has personal attendant enabled (personal attendant communicates in English). Personal attendant will refer to its owner as User1. Personal attendant is only enabled for inbound Teams calls from the user's domain. Additional capabilities are turned off. -Example 2 +### Example 2 ``` Get-CsPersonalAttendantSettings -InputObject @{ UserId = "user11@contoso.com"; } ``` From 92ff6425ddf4cc182cebd6aa5f86dee5360467d5 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Mon, 18 Aug 2025 08:02:24 -0700 Subject: [PATCH 10/10] Update Get-CsPersonalAttendantSettings.md --- .../teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md b/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md index e9e473038d..67e5813c36 100644 --- a/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsPersonalAttendantSettings.md @@ -58,7 +58,7 @@ Personal attendant is only enabled for inbound Teams calls from the user's domai ``` Get-CsPersonalAttendantSettings -InputObject @{ UserId = "user11@contoso.com"; } ``` -```outbput +```output IsPersonalAttendantEnabled : True DefaultLanguage : en-US DefaultVoice : Female