diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md new file mode 100644 index 0000000000..f5161eb3d9 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsMainlineAttendantAppointmentBookingFlow +applicable: Microsoft Teams +title: Get-CsMainlineAttendantAppointmentBookingFlow +schema: 2.0.0 +ms.reviewer: +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsMainlineAttendantAppointmentBookingFlow + +## SYNOPSIS +The Get-CsMainlineAttendantAppointmentBookingFlow cmdlet returns the identified Mainline attendant appointment booking flow. + +## SYNTAX + +``` +Get-CsMainlineAttendantAppointmentBookingFlow [-Identity ] [-Tenant ] [-First ] [-Skip ] [-ExcludeContent ] [-Sort ] [-Descending ] [-NameFilter ] [] +``` + +## DESCRIPTION +The Get-CsMainlineAttendantAppointmentBookingFlow cmdlet lets you retrieve information about the Mainline attendant appointment booking flows n your organization. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsMainlineAttendantAppointmentBookingFlow +``` + +This example gets the first 100 Mainline attendant appointment booking flows in the organization. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsMainlineAttendantAppointmentBookingFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example gets the Mainline attendant appointment booking flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no appointment booking flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Identity +PARAMVALUE: Guid + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +PARAMVALUE: Guid + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +The First parameter gets the first N appointment flows, up to a maximum of 100 at a time. +When not specified, the default behavior is to return the first 100 appointment flows. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. +If a number greater than 100 is supplied, the request will fail. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 100 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +The Skip parameter skips the first N appointment flows. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeContent +The ExcludeContent parameter only displays the Name and Id of the appointment flow. + +```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 +``` + +### -Sort +The Sort parameter specifies the property used to sort. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: Name +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Descending +The Descending parameter sorts appointment booking flows in descending order + +```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 +``` + +### -NameFilter +The NameFilter parameter returns appointment booking flows where the name contains specified string + +```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 + +### Identity +Represents the unique identifier of an appointment booking flow. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md index f1b59fd34e..3b01b0dd8f 100644 --- a/teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md +++ b/teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md @@ -78,7 +78,7 @@ Accept wildcard characters: False ### -Type The Mainline Attendant flow type -PARAMVALUE: Type 1 | Type 2 +PARAMVALUE: Appointment | QuestionAndAnswer ```yaml Type: String diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md new file mode 100644 index 0000000000..fcaf4470cd --- /dev/null +++ b/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsMainlineAttendantQuestionAnswerFlow +applicable: Microsoft Teams +title: Get-CsMainlineAttendantQuestionAnswerFlow +schema: 2.0.0 +ms.reviewer: +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsMainlineAttendantQuestionAnswerFlow + +## SYNOPSIS +The Get-CsMainlineAttendantQuestionAnswerFlow cmdlet returns the identified Mainline attendant question and answer flow. + +## SYNTAX + +``` +Get-CsMainlineAttendantQuestionAnswerFlow [-Identity ] [-Tenant ] [-First ] [-Skip ] [-ExcludeContent ] [-Sort ] [-Descending ] [-NameFilter ] [] +``` + +## DESCRIPTION +The Get-CsMainlineAttendantQuestionAnswerFlow cmdlet lets you retrieve information about the Mainline attendant question and answer flows n your organization. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsMainlineAttendantQuestionAnswerFlow +``` + +This example gets the first 100 Mainline attendant question and answer flows in the organization. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsMainlineAttendantQuestionAnswerFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example gets the Mainline attendant question and answer flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no question and answer flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Identity +PARAMVALUE: Guid + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +PARAMVALUE: Guid + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -First +The First parameter gets the first N appointment flows, up to a maximum of 100 at a time. +When not specified, the default behavior is to return the first 100 question and answer flows. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. +If a number greater than 100 is supplied, the request will fail. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 100 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +The Skip parameter skips the first N appointment flows. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeContent +The ExcludeContent parameter only displays the Name and Id of the question and answer flow. + +```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 +``` + +### -Sort +The Sort parameter specifies the property used to sort. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: Name +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Descending +The Descending parameter sorts appointment booking flows in descending order + +```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 +``` + +### -NameFilter +The NameFilter parameter returns question and answer booking flows where the name contains specified string + +```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 + +### Identity +Represents the unique identifier of a question and answer booking flow. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + diff --git a/teams/teams-ps/teams/New-CsAutoAttendant.md b/teams/teams-ps/teams/New-CsAutoAttendant.md index 40350125a7..394233ef02 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendant.md +++ b/teams/teams-ps/teams/New-CsAutoAttendant.md @@ -443,7 +443,7 @@ The EnableMainlineAttendant parameter enables Mainline Attendant features for th > 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. `-EnableVoiceResponse` will be enabled automatically ```yaml Type: SwitchParameter diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md b/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md index 2e4c482416..f7dd275002 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md +++ b/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md @@ -96,7 +96,7 @@ You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn. > > If Mainline Attendant is enabled and no greeting text is provided, the following default prompt will be played: > -> {insert text here} +> *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.* ```yaml Type: System.Collections.Generic.List diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md index f32790ba38..f55a7ea3db 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md +++ b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md @@ -51,6 +51,8 @@ Accept wildcard characters: False ### -Description The description for the appointment booking flow +Limit: 500 characters. + ```yaml Type: String Parameter Sets: (All) @@ -103,419 +105,7 @@ 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" : "" - -} - -} - -] - -} -``` +For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](./New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md) ```yaml Type: String diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md new file mode 100644 index 0000000000..6403f8f04b --- /dev/null +++ b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md @@ -0,0 +1,298 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattendantappointmentbookingflowapidefinitionsJSON +applicable: Microsoft Teams +title: New-CsMainLineAttendantAppointmentBookingFlowApiDefinitionsJSON +author: tomkau +ms.author: tomkau +manager: bulenteg +ms.reviewer: +schema: 2.0.0 +--- + +# New-CsMainlineAttendantAppointmentBookingFlow -ApiDefinition JSON Example + +## SYNOPSIS +The [New-CsMainlineAttendantAppointmentBookingFlow](./New-CsMainlineAttendantAppointmentBookingFlow.md) -ApiDefinitions requires a JSON formatted response. + +## SYNTAX + +``` +{ + "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" : "" + } + } + ] +} +``` + +## PARAMETERS + +### -ApiDefinitions +The parameters used by the API - see the JSON example above. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: Yes +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +## INPUTS + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + + + diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md index c81e51f8db..6b178a7e40 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md +++ b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md @@ -85,167 +85,9 @@ Accept wildcard characters: False ### -KnowledgeBase The knowledge base definition -```json -[ +The parameters used by the API -{ - -"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" : "" - -} - -} - -} - -} - -] -``` +For an example, see [New-CsMainlineAttendantQuestionAnswerFlow -KnowledgeBase](./New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md) ```yaml Type: String diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md new file mode 100644 index 0000000000..94939608d0 --- /dev/null +++ b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md @@ -0,0 +1,131 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattendantquestionanswerflowknowledgebaseJSON +applicable: Microsoft Teams +title: New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON +author: tomkau +ms.author: tomkau +manager: bulenteg +ms.reviewer: +schema: 2.0.0 +--- + +# New-CsMainlineAttendantQuestionAnswerFlow -KnowledgeBase JSON Example + +## SYNOPSIS +The [New-CsMainlineAttendantQuestionAnswerFlow](./New-CsMainlineAttendantQuestionAnswerFlow.md) -Knowledge requires a path to a JSON formatted response. + +## SYNTAX + +``` +[ + { + "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" : "" + } + } + } + } +] +``` + +## PARAMETERS + +### -Knowledgebase +The parameters used by the Knowledgebase - see the JSON example above. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: Yes +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +## INPUTS + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + + + diff --git a/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md new file mode 100644 index 0000000000..e38af8fd7a --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md @@ -0,0 +1,86 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsMainlineAttendantAppointmentBookingFlow +applicable: Microsoft Teams +title: Remove-CsMainlineAttendantAppointmentBookingFlow +schema: 2.0.0 +ms.reviewer: +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsMainlineAttendantAppointmentBookingFlow + +## SYNOPSIS +The Remove-CsMainlineAttendantAppointmentBookingFlow cmdlet deletes an existing Mainline attendant appointment booking flow. + +## SYNTAX + +``` +Remove-CsMainlineAttendantAppointmentBookingFlow -Identity [-Tenant ] [] +``` + +## DESCRIPTION +The Remove-CsMainlineAttendantAppointmentBookingFlow cmdlet deletes an existing Mainline attendant appointment booking flow. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsMainlineAttendantAppointmentBookingFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example removes the Mainline attendant appointment booking flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no appointment booking flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Identity +PARAMVALUE: Guid + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +PARAMVALUE: Guid + +```yaml +Type: Guid +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 + +### Identity +Represents the unique identifier of a Mainline attendant appointment booking flow. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + diff --git a/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md new file mode 100644 index 0000000000..d57095be09 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md @@ -0,0 +1,86 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsMainlineAttendantQuestionAnswerFlow +applicable: Microsoft Teams +title: Remove-CsMainlineAttendantQuestionAnswerFlow +schema: 2.0.0 +ms.reviewer: +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsMainlineAttendantQuestionAnswerFlow + +## SYNOPSIS +The Remove-CsMainlineAttendantQuestionAnswerFlow cmdlet deletes an existing Mainline attendant question and answer flow. + +## SYNTAX + +``` +Remove-CsMainlineAttendantQuestionAnswerFlow -Identity [-Tenant ] [] +``` + +## DESCRIPTION +The Remove-CsMainlineAttendantQuestionAnswerFlow cmdlet deletes an existing Mainline attendant question and answer flow. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsMainlineAttendantQuestionAnswerFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example removes the Mainline attendant question and answer flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no question and answer flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Identity +PARAMVALUE: Guid + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +PARAMVALUE: Guid + +```yaml +Type: Guid +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 + +### Identity +Represents the unique identifier of a Mainline attendant question and answer flow. + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS + diff --git a/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md new file mode 100644 index 0000000000..bef2833cb8 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsMainlineAttendantAppointmentBookingFlow +applicable: Microsoft Teams +title: Set-CsMainlineAttendantAppointmentBookingFlow +author: tomkau +ms.author: tomkau +manager: bulenteg +ms.reviewer: +schema: 2.0.0 +--- + +# Set-CsMainlineAttendantAppointmentBookingFlow + +## SYNOPSIS +Changes an existing Mainline Attendant appointment booking flow + +## SYNTAX + +``` +Set-CsMainlineAttendantAppointmentBookingFlow -Identity [-Name ] [-Description ] [-CallerAuthenticationMethod ] [-ApiAuthenticationType ] [-ApiDefinitions ] [-Tenant ] [] +``` + +## DESCRIPTION +The Set-CsMainlineAttendantAppointmentBookingFlow cmdlet changes an existing appointment booking flow that is 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 + +### -Identity +The unique Id of the appointment booking flow to change + +```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 +``` + +### -Name +The name of the appointment booking flow + +```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 +``` + +### -Description +The description for the appointment booking flow + +Limit: 500 characters. + +```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 +``` + +### -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: 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: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApiDefinitions +The parameters used by the API + +For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](./New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md) + +```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 + + diff --git a/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md new file mode 100644 index 0000000000..68cb82c876 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsMainlineAttendantQuestionAnswerFlow +applicable: Microsoft Teams +title: Set-CsMainlineAttendantQuestionAnswerFlow +author: tomkau +ms.author: tomkau +manager: bulenteg +ms.reviewer: +schema: 2.0.0 +--- + +# Set-CsMainlineAttendantQuestionAnswerFlow + +## SYNOPSIS +Changes an existing Mainline Attendant question and answer (FAQ) flow + +## SYNTAX + +``` +Set-CsMainlineAttendantQuestionAnswerFlow -Identity [-Name ] [-Description ] [-ApiAuthenticationType ] [-KnowledgeBase ] [-Tenant ] [] +``` + +## DESCRIPTION +The Set-CsMainlineAttendantQuestionAnswerFlow cmdlet changes an existing 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 + +### -Identity +The unique identifier 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 +``` + +### -Name +The name of the question and answer flow + +```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 +``` + +### -Description +The description for the question and answer flow + +```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 +``` + +### -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: 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 + +For an example, see [New-CsMainlineAttendantQuestionAnswerFlow -KnowledgeBase](./New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md) + +```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 + +