From f89c4013035920f944bae2d4ec7e516a85e482bd Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 10:35:41 -0700 Subject: [PATCH 01/17] Update New-CsAutoAttendant.md --- teams/teams-ps/teams/New-CsAutoAttendant.md | 28 ++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsAutoAttendant.md b/teams/teams-ps/teams/New-CsAutoAttendant.md index 98e32e7234..e96cf34a47 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendant.md +++ b/teams/teams-ps/teams/New-CsAutoAttendant.md @@ -18,7 +18,7 @@ Use the New-CsAutoAttendant cmdlet to create a new Auto Attendant (AA). ## SYNTAX ```powershell -New-CsAutoAttendant -Name -LanguageId -TimeZoneId -DefaultCallFlow [-CallFlows ] [-CallHandlingAssociations ] [-Operator ] [-VoiceId ] [-EnableVoiceResponse] [-InclusionScope ] [-ExclusionScope ] [-AuthorizedUsers ] [-HideAuthorizedUsers ] [-UserNameExtension ] [-Tenant ] [] +New-CsAutoAttendant -Name -LanguageId -TimeZoneId -DefaultCallFlow [-CallFlows ] [-CallHandlingAssociations ] [-Operator ] [-VoiceId ] [-EnableVoiceResponse] [-EnableMainlineAttendant] [-InclusionScope ] [-ExclusionScope ] [-AuthorizedUsers ] [-HideAuthorizedUsers ] [-UserNameExtension ] [-Tenant ] [] ``` ## DESCRIPTION @@ -32,6 +32,10 @@ You can create new AAs by using the New-CsAutoAttendant cmdlet; each newly creat > > - -HideAuthorizedUsers > - -UserNameExtension +> +> 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. +> +> -EnableMainLineAttendant **NOTES**: @@ -428,6 +432,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableMainlineAttendant +The EnableMainlineAttendant parameter indicates whether Mainline Attendant is enabled for this Auto attendant. + +> [!NOTE] +> 1. The Auto attendant must have a Resource account assigned +> 1. -LanguageId options are limited when Mainline Attendant is enabled - see [put link here]() +> 1. -VoiceId choices are limited when Mainline Attendate is enabled - see [put link here]() +> 1. -EnableVoice will be enabled automatically + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InclusionScope Specifies the users to which call transfers are allowed through directory lookup feature. If not specified, all users in the organization can be reached through directory lookup. From 1421fb3c8ad9ff9632831297c1dcc8d66325259e Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 10:55:49 -0700 Subject: [PATCH 02/17] Update New-CsAutoAttendant.md --- teams/teams-ps/teams/New-CsAutoAttendant.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/teams/teams-ps/teams/New-CsAutoAttendant.md b/teams/teams-ps/teams/New-CsAutoAttendant.md index e96cf34a47..b8dd18b723 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendant.md +++ b/teams/teams-ps/teams/New-CsAutoAttendant.md @@ -433,13 +433,15 @@ Accept wildcard characters: False ``` ### -EnableMainlineAttendant -The EnableMainlineAttendant parameter indicates whether Mainline Attendant is enabled for this Auto attendant. +_Voice applications private preview customers only._ + +The EnableMainlineAttendant parameter enables Mainline Attendant features for this Auto attendant. > [!NOTE] > 1. The Auto attendant must have a Resource account assigned -> 1. -LanguageId options are limited when Mainline Attendant is enabled - see [put link here]() -> 1. -VoiceId choices are limited when Mainline Attendate is enabled - see [put link here]() -> 1. -EnableVoice will be enabled automatically +> 1. `-LanguageId` options are limited when Mainline Attendant is enabled - see [put link here]() +> 1. `-VoiceId` choices are limited when Mainline Attendate is enabled - see [put link here]() +> 1. `-EnableVoice` will be enabled automatically ```yaml Type: SwitchParameter From 22622aac9870e2c3f4ebf816e324db6ddebca4dd Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 11:10:25 -0700 Subject: [PATCH 03/17] Update New-CsAutoAttendant.md --- teams/teams-ps/teams/New-CsAutoAttendant.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/teams/teams-ps/teams/New-CsAutoAttendant.md b/teams/teams-ps/teams/New-CsAutoAttendant.md index b8dd18b723..abe7b13da0 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendant.md +++ b/teams/teams-ps/teams/New-CsAutoAttendant.md @@ -435,6 +435,8 @@ Accept wildcard characters: False ### -EnableMainlineAttendant _Voice applications private preview customers only._ +_Saving an auto attendant configuration through Teams admin center will remove this setting._ + The EnableMainlineAttendant parameter enables Mainline Attendant features for this Auto attendant. > [!NOTE] From dc3e9582301365798256c905fa738afd07799c82 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 11:13:30 -0700 Subject: [PATCH 04/17] Update New-CsAutoAttendantCallFlow.md --- .../teams-ps/teams/New-CsAutoAttendantCallFlow.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md b/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md index 9ba87b7d68..2e4c482416 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md +++ b/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md @@ -91,6 +91,13 @@ If present, the prompts specified by the Greetings parameter (either TTS or Audi You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn.microsoft.com/powershell/module/teams/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: +> +> {insert text here} + ```yaml Type: System.Collections.Generic.List Parameter Sets: (All) @@ -138,14 +145,14 @@ Accept wildcard characters: False ### -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._ +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. + ```yaml Type: Boolean Parameter Sets: (All) From 6654df30b645ea45325ac516421854be67df8afe Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 11:15:46 -0700 Subject: [PATCH 05/17] Update New-CsAutoAttendantMenu.md --- teams/teams-ps/teams/New-CsAutoAttendantMenu.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantMenu.md b/teams/teams-ps/teams/New-CsAutoAttendantMenu.md index 762182a023..b6012b8fc6 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantMenu.md +++ b/teams/teams-ps/teams/New-CsAutoAttendantMenu.md @@ -82,7 +82,10 @@ Accept wildcard characters: False ### -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. +You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt) cmdlet. + +> [!NOTE] +> If Mainline Attendant is enabled, only TTS prompts are supported. ```yaml Type: Object From 8debe006921c0517d39f49c4f78a72c5cbf065af Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 11:31:17 -0700 Subject: [PATCH 06/17] Update New-CsAutoAttendantMenuOption.md --- .../teams/New-CsAutoAttendantMenuOption.md | 53 ++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md b/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md index 075d0dccbd..3727dc7102 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md +++ b/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md @@ -18,12 +18,19 @@ Use the New-CsAutoAttendantMenuOption cmdlet to create a new menu option. ## SYNTAX ``` -New-CsAutoAttendantMenuOption -Action -DtmfResponse [-VoiceResponses ] [-CallTarget ] [-Prompt ] [-Tenant ] [] +New-CsAutoAttendantMenuOption -Action -DtmfResponse [-VoiceResponses ] [-CallTarget ] [-Prompt ] [-MainlineAttendantTarget ] [-Description ] [-Tenant ] [] ``` ## DESCRIPTION The New-CsAutoAttendantMenuOption cmdlet creates a new menu option for the Auto Attendant (AA) service. The AA service uses the menu options to respond to a caller with the appropriate action. +> [!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. +> +> -Description +> -Action MainLineAttendantFlow +> -MainlineAttendantTarget + ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -52,6 +59,7 @@ This example creates a menu option to play an announcement for the defined promp ## PARAMETERS + ### -Action 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: @@ -152,6 +160,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Description +_Voice applications private preview customers only._ + +_Saving an auto attendant configuration through Teams admin center will remove this setting._ + +A description/set of keywords for the option. + +Used by Mainline Attendant only. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Limit: 500 characters +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MainlineAttendantTarget +_Voice applications private preview customers only._ + +_Saving an auto attendant configuration through Teams admin center will remove this setting._ + +The Mainline Attendant call flow target identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True if -Action = MainlineAttendantFlow +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant ```yaml From 84fdd6bbe086c7c1c48b61d8cd4c1f2055c706af Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 11:38:41 -0700 Subject: [PATCH 07/17] Update New-CsAutoAttendantMenuOption.md --- teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md b/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md index 3727dc7102..abca9d68fd 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md +++ b/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md @@ -169,6 +169,8 @@ A description/set of keywords for the option. Used by Mainline Attendant only. +Limit: 500 characters + ```yaml Type: System.String Parameter Sets: (All) @@ -178,7 +180,6 @@ applicable: Microsoft Teams Required: False Position: Named Default value: None -Limit: 500 characters Accept pipeline input: False Accept wildcard characters: False ``` From 3ed18bb2209520fab22d0decf053fdd7f5066ca4 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 11:45:25 -0700 Subject: [PATCH 08/17] Update New-CsAutoAttendant.md --- teams/teams-ps/teams/New-CsAutoAttendant.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsAutoAttendant.md b/teams/teams-ps/teams/New-CsAutoAttendant.md index abe7b13da0..40350125a7 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendant.md +++ b/teams/teams-ps/teams/New-CsAutoAttendant.md @@ -35,7 +35,7 @@ You can create new AAs by using the New-CsAutoAttendant cmdlet; each newly creat > > 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. > -> -EnableMainLineAttendant +> - -EnableMainLineAttendant **NOTES**: From 341fbb03a217cbe58574340ab2759bc812171b8a Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 11:46:21 -0700 Subject: [PATCH 09/17] Update New-CsAutoAttendantMenuOption.md --- teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md b/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md index abca9d68fd..3f723b2ff8 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md +++ b/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md @@ -27,9 +27,9 @@ The New-CsAutoAttendantMenuOption cmdlet creates a new menu option for the Auto > [!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. > -> -Description -> -Action MainLineAttendantFlow -> -MainlineAttendantTarget +> - -Description +> - -Action MainLineAttendantFlow +> - -MainlineAttendantTarget ## EXAMPLES From c765ee10647dde0841c4f9b260e454f741f480c0 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 12:13:35 -0700 Subject: [PATCH 10/17] Create Get-CsMainlineAttendantFlow.md --- .../teams/Get-CsMainlineAttendantFlow.md | 124 ++++++++++++++++++ 1 file changed, 124 insertions(+) create mode 100644 teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md new file mode 100644 index 0000000000..f1b59fd34e --- /dev/null +++ b/teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csmainlineattendantflow +applicable: Microsoft Teams +title: Get-CsMainlineAttendantFlow +author: tomkau +ms.author: tomkau +manager: bulenteg +ms.reviewer: +schema: 2.0.0 +--- + +# Get-CsMainlineAttendantFlow + +## SYNOPSIS +Creates new Call Queue in your Skype for Business Online organization. + +## SYNTAX + +``` +Get-CsMainlineAttendantFlow [-MaConfigId ] [-Type ] [-FlowId ] [-Tenant ] [] +``` + +## DESCRIPTION +The Get-CsMainlineAttendantFlow cmdlet returns information about the Mainline Attendant flows configured in your organization. + +> [!CAUTION] +> This cmdlet 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. + +## EXAMPLES + +### Example 1 +``` +Get-CsMainlineAttendantFlow +``` + +This example will list all the Mainline Attendant flows in the tenant. + +### Example 2 +``` +Get-CsMainlineAttendantFlow -MaConfig 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 Type 1 | Type 2 +``` + +This example will list all the Mainline Attendant flows with the specified type. + +### Example 4 +``` +Get-CsMainlineAttendantFlow -FlowId 956bca6-e2a0-4117-9b6f-023f80b31bbe5 +``` + +This example will list the Mainline Attendant flow with the specified flow id. + +## PARAMETERS + +### -MaConfigId +The Mainline Attendant configuration Id + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The Mainline Attendant flow type + +PARAMVALUE: Type 1 | Type 2 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowId +The Mainline Attendant flow id + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + From 0aa93339200c18148c33b62d0bbaa20f7fdaa805 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 12:36:25 -0700 Subject: [PATCH 11/17] Create New-CsMainlineAttendantAppointmentBookingFlow.md --- ...MainlineAttendantAppointmentBookingFlow.md | 545 ++++++++++++++++++ 1 file changed, 545 insertions(+) create mode 100644 teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md new file mode 100644 index 0000000000..bb3b2dbe67 --- /dev/null +++ b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md @@ -0,0 +1,545 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattendantappointmentbookingflow +applicable: Microsoft Teams +title: New-CsMainlineAttendantAppointmentBookingFlow +author: tomkau +ms.author: tomkau +manager: bulenteg +ms.reviewer: +schema: 2.0.0 +--- + +# New-CsMainlineAttendantAppointmentBookingFlow + +## SYNOPSIS +Creates new Mainline Attendant appointment booking flow + +## SYNTAX + +``` +New-CsMainlineAttendantAppointmentBookingFlow -Name -Description -CallerAuthenticationMethod -ApiAuthenticationType -ApiDefinitions [-Tenant ] [] +``` + +## DESCRIPTION +The New-CsMainlineAttendantAppointmentBookingFlow cmdlet creates a new appointment booking connection that can be used with Mainline Attendant + +> [!CAUTION] +> This cmdlet 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. + +## EXAMPLES + + +## PARAMETERS + +### -Name +The name of the appointment booking flow + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for the appointment booking flow + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +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: +applicable: Microsoft Teams + +Required: True +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: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiDefinitions +The parameters used by the API + +````json +{ + +"generateAuthToken" : { // Must be specified for "bearer_token_dynamic" + +"endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= + +"method_type": "GET" or "PUT" or "POST", + +"description" : "", + +"query_strings" : { // Description of the query string parameters in the endpoint + +"parameter1" : "", + +"parameter2" : "" + +}, + +"headers" : { + +"Authorization" : "Basic " or "api-key " or "Bearer ", // replace with an expected value + +"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. + +}, + +"response" : { // Response to 200 range of codes + +"token" : "" // this token will be used for APIs with "bearer_token_dynamic" auth type + +} + +}, + +"getCallerDetails" : [ // Can specify multiple endpoints below to get caller details by phone number, ID, email, etc. + +{ + +"endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= + +"method_type": "GET" or "PUT" or "POST", + +"description" : "", + +"query_strings" : { // Definition of the query string parameters in the endpoint + +"parameter1" : "", + +"parameter2" : "" + +}, + +"headers" : { + +"Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", // replace with an expected value. will be replaced by the response to generateAuthToken() + +"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. + +}, + +"body" : { // Sent as JSON payload + +"in_parameter1" : "", + +"in_parameter2" : "" + +}, + +"response" : { // Response to 200 range of codes + +"out_parameter1" : "", + +"out_parameter2" : "", + +"out_parameter3" : "" + +} + +}, + +{ + +"endpoint" : "", + +"method_type": "GET" or "PUT" or "POST", + +"description" : "", + +"query_strings" : { + +"parameter1" : "", + +"parameter2" : "" + +}, + +"headers" : { + +"Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", + +"X-API-Key" : "API-Key" + +}, + +"body" : { + +"in_parameter1" : "", + +"in_parameter2" : "" + +}, + +"response" : { + +"out_parameter1" : "", + +"out_parameter2" : "", + +"out_parameter3" : "" + +} + +} + +], + +"initiateCallerAuthentication" : [ // for SMS/email code, verification link + +{ + +"endpoint" : "", + +"method_type": "GET" or "PUT" or "POST", + +"description" : "", + +"query_strings" : { + +"parameter1" : "", + +"parameter2" : "" + +}, + +"headers" : { + +"Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", + +"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. + +}, + +"body" : { + +"in_parameter1" : "", // phone number, user ID, etc + +"in_parameter2" : "" // session ID + +}, + +"response" : { + +"out_parameter1" : "", // success/failure + +} + +} + +], + +"authenticateCaller" : [ // for SMS/email code, voiceprint, verification link, caller details + +{ + +"endpoint" : "", + +"method_type": "GET" or "PUT" or "POST", + +"description" : "", + +"query_strings" : { + +"parameter1" : "", + +"parameter2" : "" + +}, + +"headers" : { + +"Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", + +"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. + +}, + +"body" : { + +"in_parameter1" : "", // phone number, user ID, etc + +"in_parameter2" : "", // session ID + +"in_parameter3" : "", // VoicePrint payload or code + +}, + +"response" : { + +"out_parameter1" : "", // success/failure + +} + +} + +], + +"getAvailableAppointmentTimeslots" : [ + +{ + +"endpoint" : "", + +"method_type": "GET" or "PUT" or "POST", + +"description" : "", + +"query_strings" : { + +"parameter1" : "", + +"parameter2" : "" + +}, + +"headers" : { + +"Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", + +"X-API-Key" : "API-Key" + +}, + +"body" : { + +"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard + +"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard + +"in_parameter3" : "", // optional parameters like appointment type, doctor name, etc + +"in_parameter4" : "", // number of results + +}, + +"response" : { + +"time_slots" : [ + +{ + +"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard + +"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard + +"opt_parameter1" : "", // optional parameters like appointment type, doctor name, etc + +}, + +{ + +"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard + +"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard + +"opt_parameter1" : "", // optional parameters like appointment type, doctor name, etc + +} + +], + +"out_parameter3" : "", + +"out_parameter4" : "", + +} + +} + +], + +"bookAppointment" : [ + +{ + +"endpoint" : "", + +"method_type": "GET" or "PUT" or "POST", + +"description" : "", + +"query_strings" : { + +"parameter1" : "", + +"parameter2" : "" + +}, + +"headers" : { + +"Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", + +"X-API-Key" : "API-Key" + +}, + +"body" : { + +"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard + +"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard + +"in_parameter3" : "", // optional parameters like appointment type, doctor name, etc + +"in_parameter4" : "", // patient id + +}, + +"response" : { + +"out_parameter1" : "", // success/failure + +"out_parameter2" : "", + +} + +} + +], + +"getUpcomingAppointments" : [ + +{ + +"endpoint" : "", + +"method_type": "GET" or "PUT" or "POST", + +"description" : "", + +"query_strings" : { + +"parameter1" : "", + +"parameter2" : "" + +}, + +"headers" : { + +"Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", + +"X-API-Key" : "API-Key" + +}, + +"body" : { + +"in_parameter1" : "", // phone number, user ID, etc + +"in_parameter2" : "" + +}, + +"response" : { + +"time_slots" : [ + +{ + +"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard + +"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard + +"opt_parameter1" : "" // optional parameters like appointment type, doctor name, etc + +}, + +{ + +"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard + +"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard + +"opt_parameter1" : "" // optional parameters like appointment type, doctor name, etc + +} + +], + +"out_parameter3" : "", + +"out_parameter4" : "" + +} + +} + +] + +} +```` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + From f4c321a6092aab25852efde12d93db02fa65b730 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 13:30:07 -0700 Subject: [PATCH 12/17] Create New-CsMainlineAttendantQuestionAnswerFlow.md --- ...w-CsMainlineAttendantQuestionAnswerFlow.md | 275 ++++++++++++++++++ 1 file changed, 275 insertions(+) create mode 100644 teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md new file mode 100644 index 0000000000..86599fabf0 --- /dev/null +++ b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md @@ -0,0 +1,275 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/New-CsMainlineAttendantQuestionAnswerFlow +applicable: Microsoft Teams +title: New-CsMainlineAttendantQuestionAnswerFlow +author: tomkau +ms.author: tomkau +manager: bulenteg +ms.reviewer: +schema: 2.0.0 +--- + +# New-CsMainlineAttendantQuestionAnswerFlow + +## SYNOPSIS +Creates new Mainline Attendant question and answer (FAQ) flow + +## SYNTAX + +``` +New-CsMainlineAttendantQuestionAnswerFlow -Name -Description -ApiAuthenticationType -KnowledgeBase [-Tenant ] [] +``` + +## DESCRIPTION +The New-CsMainlineAttendantQuestionAnswerFlow cmdlet creates a question and answer connection that can be used with Mainline Attendant + +> [!CAUTION] +> This cmdlet 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. + +## EXAMPLES + + +## PARAMETERS + +### -Name +The name of the question and answer flow + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for the question and answer flow + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +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: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KnowledgeBase +The knowledge base definition + +````json +[ + +{ + +"address_type" : "local_file", + +"document_address" : "", // provide full path to the local address + +"description" : "" + + + +}, + +{ + +"address_type" : "webpage", + +"document_address" : "", // provide full path to the webpage + +"description" : "" + + + +}, + +{ + +"address_type" : "api_endpoint", + +"description" : "", + +"api_specification" : { + +"generateAuthToken" : { // Must be specified for "bearer_token_dynamic" + +"endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= + +"method_type": "GET" or "PUT" or "POST", + +"description" : "", + +"query_strings" : { // Description of the query string parameters in the endpoint + +"parameter1" : "", + +"parameter2" : "" + +}, + +"headers" : { + +"Authorization" : "Basic " or "api-key " or "Bearer ", // replace with an expected value + +"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. + +}, + +"response" : { // Response to 200 range of codes + +"token" : "" // this token will be used for APIs with "bearer_token_dynamic" auth type + +} + +}, + +"getResults1" : { + +"endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= + +"method_type": "GET" or "PUT" or "POST", + +"description" : "", + +"query_strings" : { // Definition of the query string parameters in the endpoint + +"parameter1" : "", + +"parameter2" : "" + +}, + +"headers" : { + +"Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", // replace with an expected value. will be replaced by the response to generateAuthToken() + +"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. + +}, + +"body" : { // Sent as JSON payload + +"in_parameter1" : "", + +"in_parameter2" : "" + +}, + +"response" : { // Response to 200 range of codes + +"out_parameter1" : "", + +"out_parameter2" : "", + +"out_parameter3" : "" + +} + +}, + +"getResults2" : { + +"endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= + +"method_type": "GET" or "PUT" or "POST" + +"description" : "", + +"query_strings" : { // Definition of the query string parameters in the endpoint + +"parameter1" : "", + +"parameter2" : "" + +}, + +"headers" : { + +"Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", // replace with an expected value. will be replaced by the response to generateAuthToken() + +"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. + +}, + +"body" : { // Sent as JSON payload + +"in_parameter1" : "", + +"in_parameter2" : "" + +}, + +"response" : { // Response to 200 range of codes + +"out_parameter1" : "", + +"out_parameter2" : "", + +"out_parameter3" : "" + +} + +} + +} + +} + +] +```` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + From 35f13a207d295dd6f20463b679564d652bf7636e Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 13:44:01 -0700 Subject: [PATCH 13/17] Update New-CsMainlineAttendantQuestionAnswerFlow.md --- .../teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md index 86599fabf0..83670ff333 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md +++ b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md @@ -85,7 +85,7 @@ Accept wildcard characters: False ### -KnowledgeBase The knowledge base definition -````json +```json [ { From a07996b9107231c20bcb9bb765d06f35d20ed5f3 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 13:44:46 -0700 Subject: [PATCH 14/17] Update New-CsMainlineAttendantAppointmentBookingFlow.md --- .../teams/New-CsMainlineAttendantAppointmentBookingFlow.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md index bb3b2dbe67..f32790ba38 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md +++ b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md @@ -103,7 +103,7 @@ Accept wildcard characters: False ### -ApiDefinitions The parameters used by the API -````json +```json { "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" @@ -515,7 +515,7 @@ The parameters used by the API ] } -```` +``` ```yaml Type: String From 5b674260edceedb5a14b2824800adc0dfe027ea4 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 13:45:10 -0700 Subject: [PATCH 15/17] Update New-CsMainlineAttendantQuestionAnswerFlow.md --- .../teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md index 83670ff333..c81e51f8db 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md +++ b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md @@ -245,7 +245,7 @@ The knowledge base definition } ] -```` +``` ```yaml Type: String From dd33fb6445c11930239407c02588a83055847762 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 14:07:57 -0700 Subject: [PATCH 16/17] Update New-CsMainlineAttendantQuestionAnswerFlow.md --- ...New-CsMainlineAttendantQuestionAnswerFlow.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md index c81e51f8db..358155e26f 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md +++ b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md @@ -85,6 +85,23 @@ Accept wildcard characters: False ### -KnowledgeBase The knowledge base definition +JSON 1 + +```json +[ + { + "name": "John", + "skills": [ "SQL", "C#", "Azure" ] + }, + { + "name": "Jane", + "surname": "Doe" + } +] +``` + +JSON 2 + ```json [ From 4495992169e2f523067941af4c706ad1c6cc1289 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 18 Jul 2025 14:15:34 -0700 Subject: [PATCH 17/17] Update New-CsMainlineAttendantQuestionAnswerFlow.md --- ...New-CsMainlineAttendantQuestionAnswerFlow.md | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md index 358155e26f..c81e51f8db 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md +++ b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md @@ -85,23 +85,6 @@ Accept wildcard characters: False ### -KnowledgeBase The knowledge base definition -JSON 1 - -```json -[ - { - "name": "John", - "skills": [ "SQL", "C#", "Azure" ] - }, - { - "name": "Jane", - "surname": "Doe" - } -] -``` - -JSON 2 - ```json [