Skip to content

Commit ee048fa

Browse files
CLYVRCLYVR
authored
Create New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md
1 parent bd04c22 commit ee048fa

File tree

1 file changed

+298
-0
lines changed

1 file changed

+298
-0
lines changed

‎teams/teams-ps/MicrosoftTeams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md

Lines changed: 298 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,298 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.dll-Help.xml
3+
online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattendantappointmentbookingflowapidefinitionsJSON
4+
applicable: Microsoft Teams
5+
title: New-CsMainLineAttendantAppointmentBookingFlowApiDefinitionsJSON
6+
author: tomkau
7+
ms.author: tomkau
8+
manager: bulenteg
9+
ms.reviewer:
10+
schema: 2.0.0
11+
---
12+
13+
# New-CsMainlineAttendantAppointmentBookingFlow -ApiDefinition JSON Example
14+
15+
## SYNOPSIS
16+
The [New-CsMainlineAttendantAppointmentBookingFlow](./New-CsMainlineAttendantAppointmentBookingFlow.md) -ApiDefinitions requires a JSON formatted response.
17+
18+
## SYNTAX
19+
20+
```
21+
{
22+
"generateAuthToken" : { // Must be specified for "bearer_token_dynamic"
23+
"endpoint" : "<endpoint>", // For example, https://www.contoso.com/home?parameter1=<parameter1>&parameter2=<parameter2>
24+
"method_type": "GET" or "PUT" or "POST",
25+
"description" : "<description>",
26+
27+
"query_strings" : { // Description of the query string parameters in the endpoint
28+
"parameter1" : "<parameter1>",
29+
"parameter2" : "<parameter2>"
30+
},
31+
32+
"headers" : {
33+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>", // replace <constant> with an expected value
34+
"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type.
35+
},
36+
37+
"response" : { // Response to 200 range of codes
38+
"token" : "<token>" // this token will be used for APIs with "bearer_token_dynamic" auth type
39+
}
40+
},
41+
42+
"getCallerDetails" : [ // Can specify multiple endpoints below to get caller details by phone number, ID, email, etc.
43+
{
44+
"endpoint" : "<endpoint1>", // For example, https://www.contoso.com/home?parameter1=<parameter1>&parameter2=<parameter2>
45+
"method_type": "GET" or "PUT" or "POST",
46+
"description" : "<description>",
47+
48+
"query_strings" : { // Definition of the query string parameters in the endpoint
49+
"parameter1" : "<parameter1>",
50+
"parameter2" : "<parameter2>"
51+
},
52+
53+
"headers" : {
54+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>", // replace <constant> with an expected value. <token> will be replaced by the response to generateAuthToken()
55+
"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type.
56+
},
57+
58+
"body" : { // Sent as JSON payload
59+
"in_parameter1" : "<in_parameter1>",
60+
"in_parameter2" : "<in_parameter2>"
61+
},
62+
63+
"response" : { // Response to 200 range of codes
64+
"out_parameter1" : "<out_parameter1>",
65+
"out_parameter2" : "<out_parameter2>",
66+
"out_parameter3" : "<out_parameter3>"
67+
}
68+
},
69+
70+
{
71+
"endpoint" : "<endpoint2>",
72+
"method_type": "GET" or "PUT" or "POST",
73+
"description" : "<description>",
74+
"query_strings" : {
75+
"parameter1" : "<parameter1>",
76+
"parameter2" : "<parameter2>"
77+
},
78+
79+
"headers" : {
80+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>",
81+
"X-API-Key" : "API-Key"
82+
},
83+
84+
"body" : {
85+
"in_parameter1" : "<in_parameter1>",
86+
"in_parameter2" : "<in_parameter2>"
87+
},
88+
89+
"response" : {
90+
"out_parameter1" : "<out_parameter1>",
91+
"out_parameter2" : "<out_parameter2>",
92+
"out_parameter3" : "<out_parameter3>"
93+
}
94+
}
95+
],
96+
97+
"initiateCallerAuthentication" : [ // for SMS/email code, verification link
98+
{
99+
"endpoint" : "<endpoint>",
100+
"method_type": "GET" or "PUT" or "POST",
101+
"description" : "<description>",
102+
103+
"query_strings" : {
104+
"parameter1" : "<parameter1>",
105+
"parameter2" : "<parameter2>"
106+
},
107+
108+
"headers" : {
109+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>",
110+
"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type.
111+
},
112+
113+
"body" : {
114+
"in_parameter1" : "<in_parameter1>", // phone number, user ID, etc
115+
"in_parameter2" : "<in_parameter2>" // session ID
116+
},
117+
118+
"response" : {
119+
"out_parameter1" : "<out_parameter1>", // success/failure
120+
}
121+
}
122+
],
123+
124+
"authenticateCaller" : [ // for SMS/email code, voiceprint, verification link, caller details
125+
{
126+
"endpoint" : "<endpoint>",
127+
"method_type": "GET" or "PUT" or "POST",
128+
"description" : "<description>",
129+
130+
"query_strings" : {
131+
"parameter1" : "<parameter1>",
132+
"parameter2" : "<parameter2>"
133+
},
134+
135+
"headers" : {
136+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>",
137+
"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type.
138+
},
139+
140+
"body" : {
141+
"in_parameter1" : "<in_parameter1>", // phone number, user ID, etc
142+
"in_parameter2" : "<in_parameter2>", // session ID
143+
"in_parameter3" : "<in_parameter3>", // VoicePrint payload or code
144+
},
145+
146+
"response" : {
147+
"out_parameter1" : "<out_parameter1>", // success/failure
148+
}
149+
}
150+
],
151+
152+
"getAvailableAppointmentTimeslots" : [
153+
{
154+
"endpoint" : "<endpoint>",
155+
"method_type": "GET" or "PUT" or "POST",
156+
"description" : "<description>",
157+
158+
"query_strings" : {
159+
"parameter1" : "<parameter1>",
160+
"parameter2" : "<parameter2>"
161+
},
162+
163+
"headers" : {
164+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>",
165+
"X-API-Key" : "API-Key"
166+
},
167+
168+
"body" : {
169+
"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
170+
"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
171+
"in_parameter3" : "<in_parameter3>", // optional parameters like appointment type, doctor name, etc
172+
"in_parameter4" : "<in_parameter4>", // number of results
173+
},
174+
175+
"response" : {
176+
"time_slots" : [
177+
{
178+
"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
179+
"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
180+
"opt_parameter1" : "<opt_parameter1>", // optional parameters like appointment type, doctor name, etc
181+
},
182+
183+
{
184+
"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
185+
"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
186+
"opt_parameter1" : "<opt_parameter1>", // optional parameters like appointment type, doctor name, etc
187+
}
188+
],
189+
190+
"out_parameter3" : "<out_parameter3>",
191+
"out_parameter4" : "<out_parameter4>",
192+
}
193+
}
194+
],
195+
196+
"bookAppointment" : [
197+
{
198+
"endpoint" : "<endpoint>",
199+
"method_type": "GET" or "PUT" or "POST",
200+
"description" : "<description>",
201+
202+
"query_strings" : {
203+
"parameter1" : "<parameter1>",
204+
"parameter2" : "<parameter2>"
205+
},
206+
207+
"headers" : {
208+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>",
209+
"X-API-Key" : "API-Key"
210+
},
211+
212+
"body" : {
213+
"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
214+
"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
215+
"in_parameter3" : "<in_parameter3>", // optional parameters like appointment type, doctor name, etc
216+
"in_parameter4" : "<in_parameter4>", // patient id
217+
},
218+
219+
"response" : {
220+
"out_parameter1" : "<out_parameter1>", // success/failure
221+
"out_parameter2" : "<out_parameter2>",
222+
}
223+
}
224+
],
225+
226+
"getUpcomingAppointments" : [
227+
{
228+
"endpoint" : "<endpoint>",
229+
"method_type": "GET" or "PUT" or "POST",
230+
"description" : "<description>",
231+
232+
"query_strings" : {
233+
"parameter1" : "<parameter1>",
234+
"parameter2" : "<parameter2>"
235+
},
236+
237+
"headers : {
238+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>",
239+
"X-API-Key" : "API-Key"
240+
},
241+
242+
"body" : {
243+
"in_parameter1" : "<in_parameter1>", // phone number, user ID, etc
244+
"in_parameter2" : "<in_parameter2>"
245+
},
246+
247+
"response" : {
248+
"time_slots" : [
249+
{
250+
"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
251+
"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
252+
"opt_parameter1" : "<opt_parameter1>" // optional parameters like appointment type, doctor name, etc
253+
},
254+
255+
{
256+
"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
257+
"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
258+
"opt_parameter1" : "<opt_parameter1>" // optional parameters like appointment type, doctor name, etc
259+
}
260+
],
261+
262+
"out_parameter3" : "<out_parameter3>",
263+
"out_parameter4" : "<out_parameter4>"
264+
}
265+
}
266+
]
267+
}
268+
```
269+
270+
## PARAMETERS
271+
272+
### -ApiDefinitions
273+
The parameters used by the API - see the JSON example above.
274+
275+
```yaml
276+
Type: String
277+
Parameter Sets: (All)
278+
Aliases:
279+
280+
Required: Yes
281+
Position: 0
282+
Default value: None
283+
Accept pipeline input: False
284+
Accept wildcard characters: False
285+
```
286+
287+
## INPUTS
288+
289+
## OUTPUTS
290+
291+
### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue
292+
293+
## NOTES
294+
295+
## RELATED LINKS
296+
297+
298+

0 commit comments

Comments
 (0)