Skip to content

Commit e5ce5d1

Browse files
CLYVRCLYVR
authored
Update New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md
1 parent 0bd5e9b commit e5ce5d1

File tree

1 file changed

+361
-2
lines changed

1 file changed

+361
-2
lines changed

‎teams/teams-ps/teams/New-CsMainlineAttenantAppointmentBookingFlowApiDefinitionsJSON.md

Lines changed: 361 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,367 @@ Creates new Mainline Attendant appointment booking flow
1717

1818
## SYNTAX
1919

20-
```
21-
New-CsMainlineAttendantAppointmentBookingFlow -Name <String> -Description <String> -CallerAuthenticationMethod <sms | email | verification_link | voiceprint | user_details> -ApiAuthenticationType <basic | api_key | bearer_token_static | bearer_token_dynamic> -ApiDefinitions <String> [-Tenant <Guid>] [<CommonParameters>]
20+
```json
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+
"query_strings" : { // Definition of the query string parameters in the endpoint
48+
"parameter1" : "<parameter1>",
49+
"parameter2" : "<parameter2>"
50+
},
51+
52+
"headers" : {
53+
"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()
54+
"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type.
55+
},
56+
57+
"body" : { // Sent as JSON payload
58+
"in_parameter1" : "<in_parameter1>",
59+
"in_parameter2" : "<in_parameter2>"
60+
},
61+
62+
"response" : { // Response to 200 range of codes
63+
"out_parameter1" : "<out_parameter1>",
64+
"out_parameter2" : "<out_parameter2>",
65+
"out_parameter3" : "<out_parameter3>"
66+
}
67+
},
68+
69+
{
70+
"endpoint" : "<endpoint2>",
71+
"method_type": "GET" or "PUT" or "POST",
72+
"description" : "<description>",
73+
"query_strings" : {
74+
"parameter1" : "<parameter1>",
75+
"parameter2" : "<parameter2>"
76+
},
77+
78+
"headers" : {
79+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>",
80+
"X-API-Key" : "API-Key"
81+
},
82+
83+
"body" : {
84+
"in_parameter1" : "<in_parameter1>",
85+
"in_parameter2" : "<in_parameter2>"
86+
},
87+
88+
"r esponse" : {
89+
"out_parameter1" : "<out_parameter1>",
90+
"out_parameter2" : "<out_parameter2>",
91+
"out_parameter3" : "<out_parameter3>"
92+
}
93+
}
94+
],
95+
96+
"initiateCallerAuthentication" : [ // for SMS/email code, verification link
97+
98+
{
99+
100+
"endpoint" : "<endpoint>",
101+
102+
"method_type": "GET" or "PUT" or "POST",
103+
104+
"description" : "<description>",
105+
106+
"query_strings" : {
107+
108+
"parameter1" : "<parameter1>",
109+
110+
"parameter2" : "<parameter2>"
111+
112+
},
113+
114+
"headers" : {
115+
116+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>",
117+
118+
"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type.
119+
120+
},
121+
122+
"body" : {
123+
124+
"in_parameter1" : "<in_parameter1>", // phone number, user ID, etc
125+
126+
"in_parameter2" : "<in_parameter2>" // session ID
127+
128+
},
129+
130+
"response" : {
131+
132+
"out_parameter1" : "<out_parameter1>", // success/failure
133+
134+
}
135+
136+
}
137+
138+
],
139+
140+
"authenticateCaller" : [ // for SMS/email code, voiceprint, verification link, caller details
141+
142+
{
143+
144+
"endpoint" : "<endpoint>",
145+
146+
"method_type": "GET" or "PUT" or "POST",
147+
148+
"description" : "<description>",
149+
150+
"query_strings" : {
151+
152+
"parameter1" : "<parameter1>",
153+
154+
"parameter2" : "<parameter2>"
155+
156+
},
157+
158+
"headers" : {
159+
160+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>",
161+
162+
"X-API-Key" : "API-Key" // Only applicable for "api_key" auth type.
163+
164+
},
165+
166+
"body" : {
167+
168+
"in_parameter1" : "<in_parameter1>", // phone number, user ID, etc
169+
170+
"in_parameter2" : "<in_parameter2>", // session ID
171+
172+
"in_parameter3" : "<in_parameter3>", // VoicePrint payload or code
173+
174+
},
175+
176+
"response" : {
177+
178+
"out_parameter1" : "<out_parameter1>", // success/failure
179+
180+
}
181+
182+
}
183+
184+
],
185+
186+
"getAvailableAppointmentTimeslots" : [
187+
188+
{
189+
190+
"endpoint" : "<endpoint>",
191+
192+
"method_type": "GET" or "PUT" or "POST",
193+
194+
"description" : "<description>",
195+
196+
"query_strings" : {
197+
198+
"parameter1" : "<parameter1>",
199+
200+
"parameter2" : "<parameter2>"
201+
202+
},
203+
204+
"headers" : {
205+
206+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>",
207+
208+
"X-API-Key" : "API-Key"
209+
210+
},
211+
212+
"body" : {
213+
214+
"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
215+
216+
"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
217+
218+
"in_parameter3" : "<in_parameter3>", // optional parameters like appointment type, doctor name, etc
219+
220+
"in_parameter4" : "<in_parameter4>", // number of results
221+
222+
},
223+
224+
"response" : {
225+
226+
"time_slots" : [
227+
228+
{
229+
230+
"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
231+
232+
"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
233+
234+
"opt_parameter1" : "<opt_parameter1>", // optional parameters like appointment type, doctor name, etc
235+
236+
},
237+
238+
{
239+
240+
"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
241+
242+
"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
243+
244+
"opt_parameter1" : "<opt_parameter1>", // optional parameters like appointment type, doctor name, etc
245+
246+
}
247+
248+
],
249+
250+
"out_parameter3" : "<out_parameter3>",
251+
252+
"out_parameter4" : "<out_parameter4>",
253+
254+
}
255+
256+
}
257+
258+
],
259+
260+
"bookAppointment" : [
261+
262+
{
263+
264+
"endpoint" : "<endpoint>",
265+
266+
"method_type": "GET" or "PUT" or "POST",
267+
268+
"description" : "<description>",
269+
270+
"query_strings" : {
271+
272+
"parameter1" : "<parameter1>",
273+
274+
"parameter2" : "<parameter2>"
275+
276+
},
277+
278+
"headers" : {
279+
280+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>",
281+
282+
"X-API-Key" : "API-Key"
283+
284+
},
285+
286+
"body" : {
287+
288+
"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
289+
290+
"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
291+
292+
"in_parameter3" : "<in_parameter3>", // optional parameters like appointment type, doctor name, etc
293+
294+
"in_parameter4" : "<in_parameter4>", // patient id
295+
296+
},
297+
298+
"response" : {
299+
300+
"out_parameter1" : "<out_parameter1>", // success/failure
301+
302+
"out_parameter2" : "<out_parameter2>",
303+
304+
}
305+
306+
}
307+
308+
],
309+
310+
"getUpcomingAppointments" : [
311+
312+
{
313+
314+
"endpoint" : "<endpoint>",
315+
316+
"method_type": "GET" or "PUT" or "POST",
317+
318+
"description" : "<description>",
319+
320+
"query_strings" : {
321+
322+
"parameter1" : "<parameter1>",
323+
324+
"parameter2" : "<parameter2>"
325+
326+
},
327+
328+
"headers" : {
329+
330+
"Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>",
331+
332+
"X-API-Key" : "API-Key"
333+
334+
},
335+
336+
"body" : {
337+
338+
"in_parameter1" : "<in_parameter1>", // phone number, user ID, etc
339+
340+
"in_parameter2" : "<in_parameter2>"
341+
342+
},
343+
344+
"response" : {
345+
346+
"time_slots" : [
347+
348+
{
349+
350+
"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
351+
352+
"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
353+
354+
"opt_parameter1" : "<opt_parameter1>" // optional parameters like appointment type, doctor name, etc
355+
356+
},
357+
358+
{
359+
360+
"start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
361+
362+
"end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard
363+
364+
"opt_parameter1" : "<opt_parameter1>" // optional parameters like appointment type, doctor name, etc
365+
366+
}
367+
368+
],
369+
370+
"out_parameter3" : "<out_parameter3>",
371+
372+
"out_parameter4" : "<out_parameter4>"
373+
374+
}
375+
376+
}
377+
378+
]
379+
380+
}
22381
```
23382

24383
## DESCRIPTION

0 commit comments

Comments
 (0)