From c0812e4e48256f513f35a7a7ce01df6cd5f6c366 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 09:19:13 -0700 Subject: [PATCH 01/54] Update New-CsAutoAttendantCallFlow.md Updating with default announcement. --- teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From 7ca69fe0de028b3592ef3965e2b0d123f4c6f9a7 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 09:29:44 -0700 Subject: [PATCH 02/54] Update New-CsMainlineAttendantAppointmentBookingFlow.md --- ...MainlineAttendantAppointmentBookingFlow.md | 414 +----------------- 1 file changed, 1 insertion(+), 413 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md index f32790ba38..f426b2d39a 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md +++ b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md @@ -103,419 +103,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-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md) ```yaml Type: String From 3b8641c21e027eb572095565835b2df100795e53 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 09:30:48 -0700 Subject: [PATCH 03/54] Create New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md --- ...ointmentBookingFlow-ApiDefinitions-JSON.md | 434 ++++++++++++++++++ 1 file changed, 434 insertions(+) create mode 100644 teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md diff --git a/teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md b/teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md new file mode 100644 index 0000000000..e68935ac31 --- /dev/null +++ b/teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md @@ -0,0 +1,434 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattenantappointmentbookingflow-apidefinitions-JSON +applicable: Microsoft Teams +title: New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON +author: tomkau +ms.author: tomkau +manager: bulenteg +ms.reviewer: +schema: 2.0.0 +--- + +# New-CsMainlineAttendantAppointmentBookingFlow -Apidefinitions JSON example + +## SYNOPSIS +JSON example for the -ApiDefintions parameter + + + + + +```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" : "" + +} + +} + +] + +} +``` From 59be238c0132eb240dc9254a191856de2f5a1195 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 09:43:11 -0700 Subject: [PATCH 04/54] Update New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md --- ...ointmentBookingFlow-ApiDefinitions-JSON.md | 41 +++++++++++++------ 1 file changed, 28 insertions(+), 13 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md b/teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md index e68935ac31..ce2678fe80 100644 --- a/teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md +++ b/teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md @@ -1,13 +1,32 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattenantappointmentbookingflow-apidefinitions-JSON -applicable: Microsoft Teams -title: New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 +title: New-CsMainlineAttenantAppointmentBookingFlow-ApiDefinitions-JSON +author: mkbond007 +ms.author: mabond +manager: pamgreen +ms.reviewer: colongma +ms.date: 06/23/2025 +ms.topic: article +ms.tgt.pltfrm: cloud +ms.service: msteams +ms.subservice: teams-calling +ms.collection: + - M365-voice + - m365initiative-voice + - Tier1 + - ContentFreshnessFY24 +search.appverid: MET150 +audience: Admin +appliesto: + - Microsoft Teams + - Skype for Business +ms.localizationpriority: medium +f1.keywords: + - CSH +ms.custom: + - Reporting + - ms.teamsadmincenter.directrouting.cqd + - ms.lync.lac.ToolsCallQualityDashboard +description: New-CsMainlineAttendantAppointmentBookingFlow JSON example for the -ApiDefinitions parameter. --- # New-CsMainlineAttendantAppointmentBookingFlow -Apidefinitions JSON example @@ -15,10 +34,6 @@ schema: 2.0.0 ## SYNOPSIS JSON example for the -ApiDefintions parameter - - - - ```json { From b29a8067a9311f6a86f43fcef899db44b4eb6f80 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 09:45:09 -0700 Subject: [PATCH 05/54] Update New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md --- ...ointmentBookingFlow-ApiDefinitions-JSON.md | 49 +++++++------------ 1 file changed, 18 insertions(+), 31 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md b/teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md index ce2678fe80..972362d6d4 100644 --- a/teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md +++ b/teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md @@ -36,37 +36,24 @@ JSON example for the -ApiDefintions parameter ```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 - -} - + "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. From b5df9266546bee75b521d3449e87743ef05f90df Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 09:52:10 -0700 Subject: [PATCH 06/54] Update New-CsMainlineAttendantAppointmentBookingFlow.md --- .../teams/New-CsMainlineAttendantAppointmentBookingFlow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md index f426b2d39a..af5551f490 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 -For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md) +For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](./New-CsMainlineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md) ```yaml Type: String From 6db6220fd75cae00d3616ba08d72fa5348ad9b23 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 09:52:51 -0700 Subject: [PATCH 07/54] Rename New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md to New-CsMainlineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md --- ...MainlineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename teams/teams-ps/teams/{New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md => New-CsMainlineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md} (100%) diff --git a/teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md similarity index 100% rename from teams/teams-ps/teams/New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md rename to teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md From 9e05207ae91e3c0e6a1b3b771d1df899e1703eff Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 09:59:08 -0700 Subject: [PATCH 08/54] Rename New-CsMainlineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md to New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename teams/teams-ps/teams/{New-CsMainlineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md => New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md} (100%) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md similarity index 100% rename from teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md rename to teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md From e062b4027425a78c8f174ac866139103c61f200b Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 09:59:45 -0700 Subject: [PATCH 09/54] Update New-CsMainlineAttendantAppointmentBookingFlow.md --- .../teams/New-CsMainlineAttendantAppointmentBookingFlow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md index af5551f490..8f57e9743b 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 -For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](./New-CsMainlineAttenantAppointmentBookingFlow-ApiDefinitions-JSON.md) +For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](./New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md) ```yaml Type: String From a88cca6e48bf699d8cfea73ffc9ddf0e4419cefc Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 10:07:23 -0700 Subject: [PATCH 10/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ppointmentBookingFlowApiDefinitionsJSON.md | 37 +++++-------------- 1 file changed, 9 insertions(+), 28 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index 972362d6d4..e26255fe3f 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -1,32 +1,13 @@ --- -title: New-CsMainlineAttenantAppointmentBookingFlow-ApiDefinitions-JSON -author: mkbond007 -ms.author: mabond -manager: pamgreen -ms.reviewer: colongma -ms.date: 06/23/2025 -ms.topic: article -ms.tgt.pltfrm: cloud -ms.service: msteams -ms.subservice: teams-calling -ms.collection: - - M365-voice - - m365initiative-voice - - Tier1 - - ContentFreshnessFY24 -search.appverid: MET150 -audience: Admin -appliesto: - - Microsoft Teams - - Skype for Business -ms.localizationpriority: medium -f1.keywords: - - CSH -ms.custom: - - Reporting - - ms.teamsadmincenter.directrouting.cqd - - ms.lync.lac.ToolsCallQualityDashboard -description: New-CsMainlineAttendantAppointmentBookingFlow JSON example for the -ApiDefinitions parameter. +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattenantappointmentbookingflowapidefinitionsJSON +applicable: Microsoft Teams +title: New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON +author: tomkau +ms.author: tomkau +manager: bulenteg +ms.reviewer: +schema: 2.0.0 --- # New-CsMainlineAttendantAppointmentBookingFlow -Apidefinitions JSON example From d6493c43351ec8dae5ccf7dcdd1aada6911b5fcf Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 10:16:24 -0700 Subject: [PATCH 11/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ppointmentBookingFlowApiDefinitionsJSON.md | 27 +++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index e26255fe3f..2396d073ba 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -2,7 +2,7 @@ external help file: Microsoft.Rtc.Management.dll-Help.xml online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattenantappointmentbookingflowapidefinitionsJSON applicable: Microsoft Teams -title: New-CsMainLineAttenantAppointmentBookingFlow-ApiDefinitions-JSON +title: New-CsMainLineAttenantAppointmentBookingFlowApiDefinitionsJSON author: tomkau ms.author: tomkau manager: bulenteg @@ -10,9 +10,30 @@ ms.reviewer: schema: 2.0.0 --- -# New-CsMainlineAttendantAppointmentBookingFlow -Apidefinitions JSON example +# 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 + +### -ApiDefinition + JSON example for the -ApiDefintions parameter ```json @@ -415,3 +436,5 @@ JSON example for the -ApiDefintions parameter } ``` + +### -Parameter2 From 8a6f18af3ecc4861f21cb18ee08d78edd348203a Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 10:22:18 -0700 Subject: [PATCH 12/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...nlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index 2396d073ba..b81217105e 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -10,7 +10,7 @@ ms.reviewer: schema: 2.0.0 --- -# New-CsMainlineAttendantAppointmentBookingFlow +# New-CsMainlineAttendantAppointmentBookingFlow -ApiDefinition JSON Example ## SYNOPSIS Creates new Mainline Attendant appointment booking flow @@ -438,3 +438,7 @@ JSON example for the -ApiDefintions parameter ``` ### -Parameter2 + +this is parameter two + + From 0bd5e9b7b376283e1cd3b7c37791c2a963370944 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 10:27:04 -0700 Subject: [PATCH 13/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ppointmentBookingFlowApiDefinitionsJSON.md | 132 +++++++----------- 1 file changed, 47 insertions(+), 85 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index b81217105e..ac4734f186 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -59,95 +59,57 @@ JSON example for the -ApiDefintions parameter }, "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" : "", // 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" : "" - -} - -} - + "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" : "" + }, + + "r esponse" : { + "out_parameter1" : "", + "out_parameter2" : "", + "out_parameter3" : "" + } +} ], "initiateCallerAuthentication" : [ // for SMS/email code, verification link From e5ce5d132b4b95fc05aa26f11f2253003194d720 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 10:28:35 -0700 Subject: [PATCH 14/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ppointmentBookingFlowApiDefinitionsJSON.md | 363 +++++++++++++++++- 1 file changed, 361 insertions(+), 2 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index ac4734f186..e33a754b97 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -17,8 +17,367 @@ Creates new Mainline Attendant appointment booking flow ## SYNTAX -``` -New-CsMainlineAttendantAppointmentBookingFlow -Name -Description -CallerAuthenticationMethod -ApiAuthenticationType -ApiDefinitions [-Tenant ] [] +```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" : "" + }, + + "r esponse" : { + "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" : "" + +} + +} + +] + +} ``` ## DESCRIPTION From 9bd1473e1a7961d11f1af72e22919ef9d77112f6 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 10:36:07 -0700 Subject: [PATCH 15/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ppointmentBookingFlowApiDefinitionsJSON.md | 100 +++++++++--------- 1 file changed, 50 insertions(+), 50 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index e33a754b97..554ea467de 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -17,7 +17,7 @@ Creates new Mainline Attendant appointment booking flow ## SYNTAX -```json +``` { "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= @@ -27,70 +27,70 @@ Creates new Mainline Attendant appointment booking flow "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" : "" - }, + "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" : "" + }, - "response" : { // Response to 200 range of codes - "out_parameter1" : "", - "out_parameter2" : "", - "out_parameter3" : "" - } -}, + "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. + }, -{ - "endpoint" : "", - "method_type": "GET" or "PUT" or "POST", - "description" : "", - "query_strings" : { - "parameter1" : "", - "parameter2" : "" - }, + "body" : { // Sent as JSON payload + "in_parameter1" : "", + "in_parameter2" : "" + }, - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", - "X-API-Key" : "API-Key" + "response" : { // Response to 200 range of codes + "out_parameter1" : "", + "out_parameter2" : "", + "out_parameter3" : "" + } }, - "body" : { - "in_parameter1" : "", - "in_parameter2" : "" - }, + { + "endpoint" : "", + "method_type": "GET" or "PUT" or "POST", + "description" : "", + "query_strings" : { + "parameter1" : "", + "parameter2" : "" + }, - "r esponse" : { - "out_parameter1" : "", - "out_parameter2" : "", - "out_parameter3" : "" - } -} + "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 From 905b2d5a5fa35b595ffeeb663b533bb8b5ada4d3 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 10:41:03 -0700 Subject: [PATCH 16/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...sMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index 554ea467de..70ebc5362a 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -17,7 +17,7 @@ Creates new Mainline Attendant appointment booking flow ## SYNTAX -``` +```json { "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= From 539430180c3206ecfc4e9d208a6b5bdc7eae19ec Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 11:18:34 -0700 Subject: [PATCH 17/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ppointmentBookingFlowApiDefinitionsJSON.md | 37 ++++++++++++++----- 1 file changed, 28 insertions(+), 9 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index 70ebc5362a..acf3f3c6bf 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -1,13 +1,32 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattenantappointmentbookingflowapidefinitionsJSON -applicable: Microsoft Teams -title: New-CsMainLineAttenantAppointmentBookingFlowApiDefinitionsJSON -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 +title: New-CsMainlineAttenantAppointmentBookingFlow -ApiDefinitions JSON Example +author: mkbond007 +ms.author: mabond +manager: pamgreen +ms.reviewer: colongma +ms.date: 06/23/2025 +ms.topic: article +ms.tgt.pltfrm: cloud +ms.service: msteams +ms.subservice: teams-calling +ms.collection: + - M365-voice + - m365initiative-voice + - Tier1 + - ContentFreshnessFY24 +search.appverid: MET150 +audience: Admin +appliesto: + - Microsoft Teams + - Skype for Business +ms.localizationpriority: medium +f1.keywords: + - CSH +ms.custom: + - Reporting + - ms.teamsadmincenter.directrouting.cqd + - ms.lync.lac.ToolsCallQualityDashboard +description: New-CsMainlineAttendantAppointmentBookingFlow JSON example for the -ApiDefinitions parameter. --- # New-CsMainlineAttendantAppointmentBookingFlow -ApiDefinition JSON Example From d787be2444088cadbe1b9853a354e1c2c320b484 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 11:22:40 -0700 Subject: [PATCH 18/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ppointmentBookingFlowApiDefinitionsJSON.md | 37 +++++-------------- 1 file changed, 9 insertions(+), 28 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index acf3f3c6bf..70ebc5362a 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -1,32 +1,13 @@ --- -title: New-CsMainlineAttenantAppointmentBookingFlow -ApiDefinitions JSON Example -author: mkbond007 -ms.author: mabond -manager: pamgreen -ms.reviewer: colongma -ms.date: 06/23/2025 -ms.topic: article -ms.tgt.pltfrm: cloud -ms.service: msteams -ms.subservice: teams-calling -ms.collection: - - M365-voice - - m365initiative-voice - - Tier1 - - ContentFreshnessFY24 -search.appverid: MET150 -audience: Admin -appliesto: - - Microsoft Teams - - Skype for Business -ms.localizationpriority: medium -f1.keywords: - - CSH -ms.custom: - - Reporting - - ms.teamsadmincenter.directrouting.cqd - - ms.lync.lac.ToolsCallQualityDashboard -description: New-CsMainlineAttendantAppointmentBookingFlow JSON example for the -ApiDefinitions parameter. +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattenantappointmentbookingflowapidefinitionsJSON +applicable: Microsoft Teams +title: New-CsMainLineAttenantAppointmentBookingFlowApiDefinitionsJSON +author: tomkau +ms.author: tomkau +manager: bulenteg +ms.reviewer: +schema: 2.0.0 --- # New-CsMainlineAttendantAppointmentBookingFlow -ApiDefinition JSON Example From bc68265f04e163c08cbe29aad0e49e26435338cb Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 11:39:21 -0700 Subject: [PATCH 19/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ppointmentBookingFlowApiDefinitionsJSON.md | 578 ++---------------- 1 file changed, 65 insertions(+), 513 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index 70ebc5362a..1e68cbaea4 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -91,548 +91,105 @@ Creates new Mainline Attendant appointment booking flow "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" : "" - -} - -} - -] - -} -``` - -## 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 - -### -ApiDefinition - -JSON example for the -ApiDefintions parameter - -```json -{ - "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" - "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= + "initiateCallerAuthentication" : [ // for SMS/email code, verification link + { + "endpoint" : "", "method_type": "GET" or "PUT" or "POST", "description" : "", - "query_strings" : { // Description of the query string parameters in the endpoint + "query_strings" : { "parameter1" : "", "parameter2" : "" - }, + }, "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer ", // replace with an expected value + "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", "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 + "body" : { + "in_parameter1" : "", // phone number, user ID, etc + "in_parameter2" : "" // session ID + }, + + "response" : { + "out_parameter1" : "", // success/failure + } } -}, + ], -"getCallerDetails" : [ // Can specify multiple endpoints below to get caller details by phone number, ID, email, etc. +"authenticateCaller" : [ // for SMS/email code, voiceprint, verification link, caller details { - "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= + "endpoint" : "", "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" - }, + "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. + }, "body" : { - "in_parameter1" : "", - "in_parameter2" : "" - }, + "in_parameter1" : "", // phone number, user ID, etc + "in_parameter2" : "", // session ID + "in_parameter3" : "", // VoicePrint payload or code + }, - "r esponse" : { - "out_parameter1" : "", - "out_parameter2" : "", - "out_parameter3" : "" + "response" : { + "out_parameter1" : "", // success/failure + } } -} -], - -"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 + "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" + }, -"out_parameter3" : "", + "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 + }, -"out_parameter4" : "", + "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" : [ @@ -758,8 +315,3 @@ JSON example for the -ApiDefintions parameter } ``` -### -Parameter2 - -this is parameter two - - From 78e0e14b16d31612727a506382c6734efcefe3b7 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 11:43:45 -0700 Subject: [PATCH 20/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...sMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index 1e68cbaea4..c3ee093389 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -17,7 +17,7 @@ Creates new Mainline Attendant appointment booking flow ## SYNTAX -```json +``` { "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= From b695033305e874d4c080e55845546c1d1003ac28 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 11:53:21 -0700 Subject: [PATCH 21/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...nlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index c3ee093389..3427a68a37 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -13,10 +13,14 @@ schema: 2.0.0 # New-CsMainlineAttendantAppointmentBookingFlow -ApiDefinition JSON Example ## SYNOPSIS -Creates new Mainline Attendant appointment booking flow +The [New-CsMainlineAttendantAppointmentBookingFlow](./New-CsMainlineAttendantAppointmentBookingFlow.md) -ApiDefinitions requires a JSON formatted response. ## SYNTAX + + +## + ``` { "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" From 52654120e26a7eb75b661d93b8ce244ffc2c0696 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 11:55:52 -0700 Subject: [PATCH 22/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ppointmentBookingFlowApiDefinitionsJSON.md | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index 3427a68a37..6a40bf45a5 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -19,7 +19,10 @@ The [New-CsMainlineAttendantAppointmentBookingFlow](./New-CsMainlineAttendantApp -## +## PARAMETERS + +### -ApiDefinitions +The parameters used by the API ``` { @@ -319,3 +322,18 @@ The [New-CsMainlineAttendantAppointmentBookingFlow](./New-CsMainlineAttendantApp } ``` +### 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 513c3a13dee2885ba43af421bb2e10a0d29d7244 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 12:00:09 -0700 Subject: [PATCH 23/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ppointmentBookingFlowApiDefinitionsJSON.md | 24 +++++++++++++------ 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index 6a40bf45a5..6a85823a8d 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -17,13 +17,6 @@ The [New-CsMainlineAttendantAppointmentBookingFlow](./New-CsMainlineAttendantApp ## SYNTAX - - -## PARAMETERS - -### -ApiDefinitions -The parameters used by the API - ``` { "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" @@ -322,6 +315,23 @@ The parameters used by the API } ``` +## PARAMETERS + +### -ApiDefinitions +The parameters used by the API + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: Yes +Position: 0 +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). From ca4c516f3591c90db5f6fbdfa7c2a8aff6d26a41 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 12:05:02 -0700 Subject: [PATCH 24/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index 6a85823a8d..746075b2a9 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -17,6 +17,8 @@ The [New-CsMainlineAttendantAppointmentBookingFlow](./New-CsMainlineAttendantApp ## SYNTAX +Note: The following is JSON and not PowerShell as noted. + ``` { "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" @@ -318,7 +320,7 @@ The [New-CsMainlineAttendantAppointmentBookingFlow](./New-CsMainlineAttendantApp ## PARAMETERS ### -ApiDefinitions -The parameters used by the API +The parameters used by the API - see the JSON example above. ```yaml Type: String From 510fe3b294b64f6b9812808e8a5bc9ccc7637f94 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 12:50:20 -0700 Subject: [PATCH 25/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index 746075b2a9..0259f7fb8d 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -17,8 +17,6 @@ The [New-CsMainlineAttendantAppointmentBookingFlow](./New-CsMainlineAttendantApp ## SYNTAX -Note: The following is JSON and not PowerShell as noted. - ``` { "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" @@ -317,6 +315,8 @@ Note: The following is JSON and not PowerShell as noted. } ``` +Note: The above is JSON and not PowerShell as noted. + ## PARAMETERS ### -ApiDefinitions From 3afd9cc7fa2b912722fabd7b51df245a086ecf0d Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 12:59:28 -0700 Subject: [PATCH 26/54] Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md --- ...sMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md index 0259f7fb8d..5c6204999c 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md @@ -315,8 +315,6 @@ The [New-CsMainlineAttendantAppointmentBookingFlow](./New-CsMainlineAttendantApp } ``` -Note: The above is JSON and not PowerShell as noted. - ## PARAMETERS ### -ApiDefinitions From b9895537036a0b149661297dae002cb374e2d0fd Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 13:13:50 -0700 Subject: [PATCH 27/54] Create New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md --- ...dantQuestionAnswerFlowKnowledgeBaseJSON.md | 134 ++++++++++++++++++ 1 file changed, 134 insertions(+) create mode 100644 teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md new file mode 100644 index 0000000000..0c72d7a339 --- /dev/null +++ b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md @@ -0,0 +1,134 @@ +--- +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 +``` + +### 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 5b29803dfe9f97623c0f807aa9692bc6ef7a390d Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 13:15:32 -0700 Subject: [PATCH 28/54] 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 c81e51f8db..62d4e141d2 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 +``` [ { From e10ed81a42a2a12320be9c6acf0736ca56cff036 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 13:24:50 -0700 Subject: [PATCH 29/54] Update New-CsMainlineAttendantQuestionAnswerFlow.md --- ...w-CsMainlineAttendantQuestionAnswerFlow.md | 162 +----------------- 1 file changed, 2 insertions(+), 160 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md index 62d4e141d2..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 -``` -[ - -{ - -"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" : "" +The parameters used by the API -}, - -"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 From 8faf4d198325f5c232e9b076379d88cc86b851cf Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 13:30:11 -0700 Subject: [PATCH 30/54] 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 40350125a7..522132fef3 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. `-EnableVoiceResonse` will be enabled automatically ```yaml Type: SwitchParameter From 1e172f448467bd03bd5dea67c4b7f83280d5cbcd Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 13:33:36 -0700 Subject: [PATCH 31/54] Update Get-CsMainlineAttendantFlow.md --- teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From 967227d6487d7990d4783d7a57e212f8bac8693d Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 13:35:49 -0700 Subject: [PATCH 32/54] Update New-CsMainlineAttendantAppointmentBookingFlow.md --- .../teams/New-CsMainlineAttendantAppointmentBookingFlow.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md index 8f57e9743b..c50be03387 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) From 3eedeec5874246e1476a8b499b22f054b98baa2b Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 14:22:00 -0700 Subject: [PATCH 33/54] Create Get-CsMainlineAttendantAppointmentBookingFlow.md --- .../teams/Get-CsMainlineAttendantAppointmentBookingFlow.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md new file mode 100644 index 0000000000..8b13789179 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md @@ -0,0 +1 @@ + From 2cb7589196f0f04eb77e6ebc386aeecfcdfd0a1d Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 14:22:35 -0700 Subject: [PATCH 34/54] Create Remove-CsMainlineAttendantAppointmentBookingFlow.md --- .../teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md diff --git a/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md new file mode 100644 index 0000000000..8b13789179 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md @@ -0,0 +1 @@ + From 1e988aa554aa3568df96373b974dddeeeff7631d Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 14:23:03 -0700 Subject: [PATCH 35/54] Create Set-CsMainlineAttendantAppointmentBookingFlow.md --- .../teams/Set-CsMainlineAttendantAppointmentBookingFlow.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md diff --git a/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md new file mode 100644 index 0000000000..8b13789179 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md @@ -0,0 +1 @@ + From 5ff5fedfce9371bc7197fd6d845f196c8052f770 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 14:26:28 -0700 Subject: [PATCH 36/54] Create Get-CsMainlineAttendantQuestionAnswerFlow.md --- .../teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md new file mode 100644 index 0000000000..8b13789179 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md @@ -0,0 +1 @@ + From 75d696fb9cf9c51cc25e0b663a3dbf4816460ea9 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 14:26:50 -0700 Subject: [PATCH 37/54] Create Remove-CsMainlineAttendantQuestionAnswerFlow.md --- .../teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md diff --git a/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md new file mode 100644 index 0000000000..8b13789179 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md @@ -0,0 +1 @@ + From 67ff496bc3087e322a30ada22f97f077340f2884 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 14:27:13 -0700 Subject: [PATCH 38/54] Create Set-CsMainlineAttendantQuestionAnswerFlow.md --- .../teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md diff --git a/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md new file mode 100644 index 0000000000..8b13789179 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md @@ -0,0 +1 @@ + From 1a8cf178665d907d5c7a86beb7e6faee997bf8df Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 14:59:16 -0700 Subject: [PATCH 39/54] Update Remove-CsMainlineAttendantAppointmentBookingFlow.md --- ...MainlineAttendantAppointmentBookingFlow.md | 85 +++++++++++++++++++ 1 file changed, 85 insertions(+) diff --git a/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md index 8b13789179..e38af8fd7a 100644 --- a/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md +++ b/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md @@ -1 +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 From 20fe3082d9ae25ca5f8f0b2e7c8ebb108cb0e469 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 15:02:47 -0700 Subject: [PATCH 40/54] Update Remove-CsMainlineAttendantQuestionAnswerFlow.md --- ...e-CsMainlineAttendantQuestionAnswerFlow.md | 85 +++++++++++++++++++ 1 file changed, 85 insertions(+) diff --git a/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md index 8b13789179..d57095be09 100644 --- a/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md +++ b/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md @@ -1 +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 From a60207030a4ec401379a0aefcf67f5254719bff0 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 15:10:43 -0700 Subject: [PATCH 41/54] Update Get-CsMainlineAttendantAppointmentBookingFlow.md --- ...MainlineAttendantAppointmentBookingFlow.md | 190 ++++++++++++++++++ 1 file changed, 190 insertions(+) diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md index 8b13789179..d5cca4d129 100644 --- a/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md +++ b/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md @@ -1 +1,191 @@ +--- +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 Call Queues. + +## 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 From c5787de64f9ffe649de6a272e5c381a28e3c5a11 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 15:15:13 -0700 Subject: [PATCH 42/54] Update Get-CsMainlineAttendantQuestionAnswerFlow.md --- ...t-CsMainlineAttendantQuestionAnswerFlow.md | 191 ++++++++++++++++++ 1 file changed, 191 insertions(+) diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md index 8b13789179..237d09f0a4 100644 --- a/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md +++ b/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md @@ -1 +1,192 @@ +--- +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 + From ae39a033fcd97a83f1f88512e324761c65a050c5 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 15:15:53 -0700 Subject: [PATCH 43/54] Update Get-CsMainlineAttendantAppointmentBookingFlow.md --- .../teams/Get-CsMainlineAttendantAppointmentBookingFlow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md index d5cca4d129..5a396bd039 100644 --- a/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md +++ b/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md @@ -15,7 +15,7 @@ ms.reviewer: williamlooney # Get-CsMainlineAttendantAppointmentBookingFlow ## SYNOPSIS -The Get-CsMainlineAttendantAppointmentBookingFlow cmdlet returns the identified Call Queues. +The Get-CsMainlineAttendantAppointmentBookingFlow cmdlet returns the identified Mainline attendant appointment booking flow. ## SYNTAX From ec84a27504b0511c7f71ad640aa90d1ece12af83 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 16:11:15 -0700 Subject: [PATCH 44/54] Update Set-CsMainlineAttendantAppointmentBookingFlow.md --- ...MainlineAttendantAppointmentBookingFlow.md | 151 ++++++++++++++++++ 1 file changed, 151 insertions(+) diff --git a/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md index 8b13789179..c43556ae6c 100644 --- a/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md +++ b/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md @@ -1 +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-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.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 + From 1dc812bc4bca816936709060f7cc0061b59519dc Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 16:16:49 -0700 Subject: [PATCH 45/54] Update Set-CsMainlineAttendantQuestionAnswerFlow.md --- ...t-CsMainlineAttendantQuestionAnswerFlow.md | 133 ++++++++++++++++++ 1 file changed, 133 insertions(+) diff --git a/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md index 8b13789179..68cb82c876 100644 --- a/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md +++ b/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md @@ -1 +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 + From 99be4ee0e86d37d8b75c324a328a6ce3ee36229e Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 16:29:05 -0700 Subject: [PATCH 46/54] Update Get-CsMainlineAttendantQuestionAnswerFlow.md --- .../teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md | 1 - 1 file changed, 1 deletion(-) diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md index 237d09f0a4..fcaf4470cd 100644 --- a/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md +++ b/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md @@ -1,4 +1,3 @@ - --- external help file: Microsoft.Rtc.Management.dll-Help.xml online version: https://learn.microsoft.com/powershell/module/teams/Get-CsMainlineAttendantQuestionAnswerFlow From e5abc116eaec7499305188e7bd4c915d6efd976b Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Wed, 23 Jul 2025 16:29:46 -0700 Subject: [PATCH 47/54] Update Get-CsMainlineAttendantAppointmentBookingFlow.md --- .../teams/Get-CsMainlineAttendantAppointmentBookingFlow.md | 1 - 1 file changed, 1 deletion(-) diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md index 5a396bd039..f5161eb3d9 100644 --- a/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md +++ b/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md @@ -1,4 +1,3 @@ - --- external help file: Microsoft.Rtc.Management.dll-Help.xml online version: https://learn.microsoft.com/powershell/module/teams/Get-CsMainlineAttendantAppointmentBookingFlow From 1af36307d76fc0ba09d6b8f87ae20601fdf0773e Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 25 Jul 2025 10:55:55 -0700 Subject: [PATCH 48/54] 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 522132fef3..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. `-EnableVoiceResonse` will be enabled automatically +> 1. `-EnableVoiceResponse` will be enabled automatically ```yaml Type: SwitchParameter From 5fd6321bfc32b22e05c6535acd6df2d081e1e8db Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 25 Jul 2025 10:57:59 -0700 Subject: [PATCH 49/54] Update and rename New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md to New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md --- ...nlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename teams/teams-ps/teams/{New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md => New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md} (98%) diff --git a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md similarity index 98% rename from teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md rename to teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md index 5c6204999c..6349f6bba9 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md @@ -1,8 +1,8 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattenantappointmentbookingflowapidefinitionsJSON +online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattendantappointmentbookingflowapidefinitionsJSON applicable: Microsoft Teams -title: New-CsMainLineAttenantAppointmentBookingFlowApiDefinitionsJSON +title: New-CsMainLineAttendantAppointmentBookingFlowApiDefinitionsJSON author: tomkau ms.author: tomkau manager: bulenteg From 8b8de646aa1b0bb181329dbc76e542379c8f5ba4 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 25 Jul 2025 11:01:30 -0700 Subject: [PATCH 50/54] Update New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md index 6349f6bba9..2bad4c3564 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md @@ -332,9 +332,6 @@ 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 From bdbcc122e93014dd85d8918cd43bbbbb1e5aa11e Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 25 Jul 2025 11:02:04 -0700 Subject: [PATCH 51/54] Update New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md --- ...w-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md index 0c72d7a339..94939608d0 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md @@ -117,9 +117,6 @@ 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 From 2456ca0eefb08877af37bf759a57a40bc96259b9 Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 25 Jul 2025 11:04:08 -0700 Subject: [PATCH 52/54] Update New-CsMainlineAttendantAppointmentBookingFlow.md --- .../teams/New-CsMainlineAttendantAppointmentBookingFlow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md index c50be03387..f55a7ea3db 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md +++ b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md @@ -105,7 +105,7 @@ Accept wildcard characters: False ### -ApiDefinitions The parameters used by the API -For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](./New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md) +For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](./New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md) ```yaml Type: String From d4243a4a1aaee99fa6d22aef9ab1750698270a3e Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 25 Jul 2025 13:05:49 -0700 Subject: [PATCH 53/54] Update New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md --- ...ppointmentBookingFlowApiDefinitionsJSON.md | 536 ++++++++---------- 1 file changed, 244 insertions(+), 292 deletions(-) diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md index 2bad4c3564..6403f8f04b 100644 --- a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md +++ b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md @@ -19,299 +19,251 @@ The [New-CsMainlineAttendantAppointmentBookingFlow](./New-CsMainlineAttendantApp ``` { - "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" : "" + "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 + } } - } - ], - - "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" : "" - -} - -} - -] - + ], + + "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" : "" + } + } + ] } ``` From ce3af2fe4a9e370dc3b0893fbef1902d4f1c5d6f Mon Sep 17 00:00:00 2001 From: Colin Longman Date: Fri, 25 Jul 2025 13:12:58 -0700 Subject: [PATCH 54/54] Update Set-CsMainlineAttendantAppointmentBookingFlow.md --- .../teams/Set-CsMainlineAttendantAppointmentBookingFlow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md index c43556ae6c..bef2833cb8 100644 --- a/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md +++ b/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md @@ -121,7 +121,7 @@ Accept wildcard characters: False ### -ApiDefinitions The parameters used by the API -For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](./New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md) +For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](./New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md) ```yaml Type: String