forked from Azure/azure-rest-api-specs
-
Notifications
You must be signed in to change notification settings - Fork 8
/
communicationservicesrooms.json
630 lines (630 loc) · 18.2 KB
/
communicationservicesrooms.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
{
"swagger": "2.0",
"info": {
"title": "Azure Communication Room Service",
"description": "Azure Communication Room Service",
"version": "2023-03-31-preview"
},
"paths": {
"/rooms": {
"post": {
"tags": [
"Rooms"
],
"summary": "Creates a new room.",
"operationId": "Rooms_Create",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"in": "header",
"name": "Repeatability-Request-ID",
"description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-ID and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-ID is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.",
"type": "string",
"format": "uuid"
},
{
"in": "header",
"name": "Repeatability-First-Sent",
"description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date.",
"type": "string",
"format": "date-time-rfc1123"
},
{
"in": "body",
"name": "createRoomRequest",
"description": "The create room request body.",
"schema": {
"$ref": "#/definitions/CreateRoomRequest"
},
"required": true
}
],
"responses": {
"201": {
"description": "Request successful. The action returns a new room.",
"schema": {
"$ref": "#/definitions/RoomModel"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CommunicationErrorResponse"
},
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
}
}
},
"x-ms-examples": {
"Create a new meeting room.": {
"$ref": "./examples/Rooms_Create.json"
}
}
},
"get": {
"tags": [
"Rooms"
],
"summary": "Retrieves all created rooms.",
"operationId": "Rooms_List",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Request successful. The action returns a collection of rooms.",
"schema": {
"$ref": "#/definitions/RoomsCollection"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CommunicationErrorResponse"
},
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
}
}
},
"x-ms-examples": {
"List all rooms.": {
"$ref": "./examples/Rooms_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink",
"itemName": "value"
}
}
},
"/rooms/{roomId}": {
"get": {
"tags": [
"Rooms"
],
"summary": "Retrieves an existing room by id.",
"operationId": "Rooms_Get",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "roomId",
"description": "The id of the room requested.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Request successful. The action returns a room.",
"schema": {
"$ref": "#/definitions/RoomModel"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CommunicationErrorResponse"
},
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
}
}
},
"x-ms-examples": {
"Get meeting room.": {
"$ref": "./examples/Rooms_Get.json"
}
}
},
"patch": {
"tags": [
"Rooms"
],
"summary": "Update a room with given changes.",
"operationId": "Rooms_Update",
"consumes": [
"application/merge-patch+json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "roomId",
"description": "The id of the room requested.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "updateRoomRequest",
"description": "The update room request.",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateRoomRequest"
}
}
],
"responses": {
"200": {
"description": "Request successful. The action returns an updated room.",
"schema": {
"$ref": "#/definitions/RoomModel"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CommunicationErrorResponse"
},
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
}
}
},
"x-ms-examples": {
"Update meeting room's properties.": {
"$ref": "./examples/Rooms_Update.json"
}
}
},
"delete": {
"tags": [
"Rooms"
],
"summary": "Delete a room.",
"operationId": "Rooms_Delete",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "roomId",
"description": "The id of the room to be deleted.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"204": {
"description": "The room was successfully deleted."
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CommunicationErrorResponse"
},
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
}
}
},
"x-ms-examples": {
"Delete a meeting room.": {
"$ref": "./examples/Rooms_Delete.json"
}
}
}
},
"/rooms/{roomId}/participants": {
"get": {
"tags": [
"Participants"
],
"summary": "Get participants in a room.",
"operationId": "Participants_List",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "roomId",
"description": "The id of the room to get participants from.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Request successful. The action returns the participants of the room.",
"schema": {
"$ref": "#/definitions/ParticipantsCollection"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CommunicationErrorResponse"
},
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
}
}
},
"x-ms-examples": {
"Get participants": {
"$ref": "./examples/Participants_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink",
"itemName": "value"
}
},
"patch": {
"tags": [
"Participants"
],
"summary": "Update participants in a room.",
"operationId": "Participants_Update",
"consumes": [
"application/merge-patch+json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "roomId",
"description": "The id of the room to update the participants in.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "updateParticipantsRequest",
"description": "An updated set of participants of the room.",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateParticipantsRequest"
}
}
],
"responses": {
"200": {
"description": "The participants were successfully updated.",
"schema": {
"$ref": "#/definitions/UpdateParticipantsResult"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CommunicationErrorResponse"
},
"headers": {
"x-ms-error-code": {
"x-ms-client-name": "ErrorCode",
"type": "string"
}
}
}
},
"x-ms-examples": {
"Update participants": {
"$ref": "./examples/Participants_Update.json"
}
}
}
}
},
"definitions": {
"CommunicationError": {
"$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationError"
},
"CommunicationErrorResponse": {
"$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse"
},
"CreateRoomRequest": {
"description": "Request payload for creating new room.",
"type": "object",
"properties": {
"validFrom": {
"format": "date-time",
"description": "The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. The default value is the current date time.",
"type": "string",
"example": "2021-09-07T07:55:41Z"
},
"validUntil": {
"format": "date-time",
"description": "The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. The default value is the current date time plus 180 days.",
"type": "string",
"example": "2021-09-08T15:55:41Z"
},
"participants": {
"description": "(Optional) Participants to be invited to the room.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ParticipantProperties"
},
"example": {
"rawId1": {
"role": "Presenter"
},
"rawId2": {
"role": "Attendee"
},
"rawId3": null
}
}
}
},
"ParticipantProperties": {
"required": [
"role"
],
"type": "object",
"properties": {
"role": {
"$ref": "#/definitions/Role"
}
}
},
"ParticipantsCollection": {
"description": "A collection of participants in a room.",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"description": "A collection of participants.",
"type": "array",
"items": {
"$ref": "#/definitions/RoomParticipant"
}
},
"nextLink": {
"description": "If there are more participants that can be retrieved, the next link will be populated.",
"type": "string"
}
}
},
"Role": {
"description": "The role of a room participant. The default value is Attendee.",
"enum": [
"Presenter",
"Attendee",
"Consumer"
],
"type": "string",
"x-ms-enum": {
"name": "Role",
"modelAsString": true
}
},
"RoomModel": {
"description": "The meeting room.",
"type": "object",
"required": [
"createdAt",
"id",
"validFrom",
"validUntil"
],
"properties": {
"id": {
"description": "Unique identifier of a room. This id is server generated.",
"type": "string",
"example": "99199690362660524"
},
"createdAt": {
"format": "date-time",
"description": "The timestamp when the room was created at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.",
"type": "string",
"example": "2021-09-06T05:55:41Z"
},
"validFrom": {
"format": "date-time",
"description": "The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.",
"type": "string",
"example": "2021-09-07T07:55:41Z"
},
"validUntil": {
"format": "date-time",
"description": "The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.",
"type": "string",
"example": "2021-09-08T15:55:41Z"
}
}
},
"RoomParticipant": {
"description": "A participant of the room.",
"required": [
"rawId",
"role"
],
"type": "object",
"properties": {
"rawId": {
"description": "Raw ID representation of the communication identifier. Please refer to the following document for additional information on Raw ID. <br> https://learn.microsoft.com/azure/communication-services/concepts/identifiers?pivots=programming-language-rest#raw-id-representation",
"type": "string"
},
"role": {
"$ref": "#/definitions/Role"
}
}
},
"RoomsCollection": {
"description": "A collection of rooms.",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"description": "A collection of rooms",
"type": "array",
"items": {
"$ref": "#/definitions/RoomModel"
}
},
"nextLink": {
"description": "If there are more rooms that can be retrieved, the next link will be populated.",
"type": "string"
}
}
},
"UpdateParticipantsRequest": {
"description": "Participants to be updated in the room.",
"type": "object",
"properties": {
"participants": {
"description": "Participants to be updated.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ParticipantProperties"
},
"example": {
"rawId1": {
"role": "Presenter"
},
"rawId2": {
"role": "Attendee"
},
"rawId3": null
}
}
}
},
"UpdateParticipantsResult": {
"description": "Request response for updating participants.",
"type": "object"
},
"UpdateRoomRequest": {
"description": "Request payload for updating a room.",
"type": "object",
"properties": {
"validFrom": {
"format": "date-time",
"description": "(Optional) The timestamp from when the room is open for joining. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.",
"type": "string",
"example": "2021-09-07T07:55:41Z"
},
"validUntil": {
"format": "date-time",
"description": "(Optional) The timestamp from when the room can no longer be joined. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.",
"type": "string",
"example": "2021-09-08T15:55:41Z"
}
}
}
},
"parameters": {
"ApiVersionParameter": {
"in": "query",
"name": "api-version",
"description": "Version of API to invoke.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"Endpoint": {
"in": "path",
"name": "endpoint",
"description": "The endpoint of the Azure Communication resource.",
"required": true,
"type": "string",
"format": "url",
"x-ms-skip-url-encoding": true,
"x-ms-parameter-location": "client"
}
},
"securityDefinitions": {
"Authorization": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"description": "An authentication string containing a signature generated using HMAC-SHA256 scheme."
}
},
"security": [
{
"Authorization": []
}
],
"x-ms-parameterized-host": {
"hostTemplate": "{endpoint}",
"useSchemePrefix": false,
"parameters": [
{
"$ref": "#/parameters/Endpoint"
}
]
}
}