tencentcloud-sdk-nodejs 4.0.539 → 4.0.541

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/CHANGELOG.md +665 -0
  2. package/SERVICE_CHANGELOG.md +683 -107
  3. package/package.json +1 -1
  4. package/products.md +33 -33
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/asr/v20190614/asr_models.ts +4 -4
  7. package/src/services/bma/v20221115/bma_client.ts +100 -9
  8. package/src/services/bma/v20221115/bma_models.ts +745 -22
  9. package/src/services/captcha/v20190722/captcha_client.ts +25 -1
  10. package/src/services/captcha/v20190722/captcha_models.ts +94 -64
  11. package/src/services/cbs/v20170312/cbs_client.ts +7 -3
  12. package/src/services/cdb/v20170320/cdb_client.ts +22 -14
  13. package/src/services/cdb/v20170320/cdb_models.ts +34 -60
  14. package/src/services/ckafka/v20190819/ckafka_models.ts +6 -0
  15. package/src/services/clb/v20180317/clb_client.ts +21 -9
  16. package/src/services/clb/v20180317/clb_models.ts +45 -0
  17. package/src/services/cme/v20191029/cme_models.ts +2 -2
  18. package/src/services/cwp/v20180228/cwp_client.ts +18 -6
  19. package/src/services/cwp/v20180228/cwp_models.ts +32 -1
  20. package/src/services/cynosdb/v20190107/cynosdb_client.ts +12 -0
  21. package/src/services/cynosdb/v20190107/cynosdb_models.ts +40 -0
  22. package/src/services/dlc/v20210125/dlc_models.ts +26 -2
  23. package/src/services/dts/v20211206/dts_models.ts +17 -5
  24. package/src/services/eb/v20210416/eb_models.ts +16 -1
  25. package/src/services/essbasic/v20210526/essbasic_client.ts +12 -0
  26. package/src/services/essbasic/v20210526/essbasic_models.ts +40 -0
  27. package/src/services/lcic/v20220817/lcic_client.ts +204 -58
  28. package/src/services/lcic/v20220817/lcic_models.ts +1352 -815
  29. package/src/services/lighthouse/v20200324/lighthouse_models.ts +6 -0
  30. package/src/services/monitor/v20180724/monitor_models.ts +4 -4
  31. package/src/services/organization/v20210331/organization_client.ts +2 -1
  32. package/src/services/organization/v20210331/organization_models.ts +33 -5
  33. package/src/services/partners/v20180321/partners_client.ts +15 -0
  34. package/src/services/partners/v20180321/partners_models.ts +55 -8
  35. package/src/services/redis/v20180412/redis_client.ts +3 -3
  36. package/src/services/redis/v20180412/redis_models.ts +2 -2
  37. package/src/services/rum/v20210622/rum_models.ts +3 -3
  38. package/src/services/ssa/v20180608/ssa_client.ts +16 -2
  39. package/src/services/ssa/v20180608/ssa_models.ts +183 -33
  40. package/src/services/tcb/v20180608/tcb_models.ts +20 -10
  41. package/src/services/tem/v20210701/tem_models.ts +42 -0
  42. package/src/services/teo/v20220901/teo_models.ts +8 -0
  43. package/src/services/tke/v20180525/tke_models.ts +10 -0
  44. package/src/services/tsf/v20180326/tsf_models.ts +95 -0
  45. package/src/services/vod/v20180717/vod_client.ts +35 -5
  46. package/src/services/vod/v20180717/vod_models.ts +986 -221
  47. package/src/services/vpc/v20170312/vpc_models.ts +7 -2
  48. package/tencentcloud/common/sdk_version.d.ts +1 -1
  49. package/tencentcloud/common/sdk_version.js +1 -1
  50. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +4 -4
  51. package/tencentcloud/services/bma/v20221115/bma_client.d.ts +31 -3
  52. package/tencentcloud/services/bma/v20221115/bma_client.js +45 -3
  53. package/tencentcloud/services/bma/v20221115/bma_models.d.ts +626 -19
  54. package/tencentcloud/services/captcha/v20190722/captcha_client.d.ts +9 -1
  55. package/tencentcloud/services/captcha/v20190722/captcha_client.js +12 -0
  56. package/tencentcloud/services/captcha/v20190722/captcha_models.d.ts +78 -52
  57. package/tencentcloud/services/cbs/v20170312/cbs_client.d.ts +6 -2
  58. package/tencentcloud/services/cbs/v20170312/cbs_client.js +6 -2
  59. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +15 -7
  60. package/tencentcloud/services/cdb/v20170320/cdb_client.js +16 -8
  61. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +30 -51
  62. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +5 -0
  63. package/tencentcloud/services/clb/v20180317/clb_client.d.ts +9 -5
  64. package/tencentcloud/services/clb/v20180317/clb_client.js +11 -5
  65. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +38 -0
  66. package/tencentcloud/services/cme/v20191029/cme_models.d.ts +2 -2
  67. package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +7 -3
  68. package/tencentcloud/services/cwp/v20180228/cwp_client.js +9 -3
  69. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +28 -1
  70. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +5 -1
  71. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +6 -0
  72. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +34 -0
  73. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +22 -2
  74. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +15 -5
  75. package/tencentcloud/services/eb/v20210416/eb_models.d.ts +13 -1
  76. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +5 -1
  77. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +6 -0
  78. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +34 -0
  79. package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +53 -5
  80. package/tencentcloud/services/lcic/v20220817/lcic_client.js +78 -6
  81. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +1197 -738
  82. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +5 -0
  83. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +4 -4
  84. package/tencentcloud/services/organization/v20210331/organization_client.d.ts +1 -1
  85. package/tencentcloud/services/organization/v20210331/organization_client.js +1 -1
  86. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +29 -5
  87. package/tencentcloud/services/partners/v20180321/partners_client.d.ts +8 -1
  88. package/tencentcloud/services/partners/v20180321/partners_client.js +9 -0
  89. package/tencentcloud/services/partners/v20180321/partners_models.d.ts +48 -8
  90. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +3 -3
  91. package/tencentcloud/services/redis/v20180412/redis_client.js +3 -3
  92. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +2 -2
  93. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +3 -3
  94. package/tencentcloud/services/ssa/v20180608/ssa_client.d.ts +5 -1
  95. package/tencentcloud/services/ssa/v20180608/ssa_client.js +6 -0
  96. package/tencentcloud/services/ssa/v20180608/ssa_models.d.ts +152 -28
  97. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +18 -10
  98. package/tencentcloud/services/tem/v20210701/tem_models.d.ts +35 -0
  99. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +7 -0
  100. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +8 -0
  101. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +79 -0
  102. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +5 -1
  103. package/tencentcloud/services/vod/v20180717/vod_client.js +6 -0
  104. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +801 -141
  105. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +6 -2
  106. package/test/bma.v20221115.test.js +72 -2
  107. package/test/captcha.v20190722.test.js +20 -0
  108. package/test/cdb.v20170320.test.js +10 -10
  109. package/test/clb.v20180317.test.js +12 -2
  110. package/test/cwp.v20180228.test.js +12 -2
  111. package/test/cynosdb.v20190107.test.js +10 -0
  112. package/test/essbasic.v20210526.test.js +10 -0
  113. package/test/lcic.v20220817.test.js +124 -4
  114. package/test/partners.v20180321.test.js +10 -0
  115. package/test/ssa.v20180608.test.js +10 -0
  116. package/test/vod.v20180717.test.js +10 -0
@@ -96,157 +96,745 @@ coteaching 双师
96
96
  * 录制布局。
97
97
  */
98
98
  RecordLayout?: number
99
+
100
+ /**
101
+ * 房间绑定的群组ID,非空时限制组成员进入
102
+ */
103
+ GroupId?: string
104
+ }
105
+
106
+ /**
107
+ * ModifyRoom返回参数结构体
108
+ */
109
+ export interface ModifyRoomResponse {
110
+ /**
111
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
112
+ */
113
+ RequestId?: string
114
+ }
115
+
116
+ /**
117
+ * DescribeAppDetail返回参数结构体
118
+ */
119
+ export interface DescribeAppDetailResponse {
120
+ /**
121
+ * SDK 对应的AppId
122
+ */
123
+ SdkAppId?: string
124
+
125
+ /**
126
+ * 应用配置
127
+ */
128
+ AppConfig?: AppConfig
129
+
130
+ /**
131
+ * 场景配置
132
+ */
133
+ SceneConfig?: Array<SceneItem>
134
+
135
+ /**
136
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
137
+ */
138
+ RequestId?: string
139
+ }
140
+
141
+ /**
142
+ * BatchDeleteRecord请求参数结构体
143
+ */
144
+ export interface BatchDeleteRecordRequest {
145
+ /**
146
+ * 房间ID列表
147
+ */
148
+ RoomIds: Array<number>
149
+
150
+ /**
151
+ * 低代码互动课堂的SdkAppId。
152
+ */
153
+ SdkAppId: number
154
+ }
155
+
156
+ /**
157
+ * BatchRegister请求参数结构体
158
+ */
159
+ export interface BatchRegisterRequest {
160
+ /**
161
+ * 批量注册用户信息列表
162
+ */
163
+ Users: Array<BatchUserRequest>
164
+ }
165
+
166
+ /**
167
+ * DeleteRoom返回参数结构体
168
+ */
169
+ export interface DeleteRoomResponse {
170
+ /**
171
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
172
+ */
173
+ RequestId?: string
174
+ }
175
+
176
+ /**
177
+ * ModifyUserProfile请求参数结构体
178
+ */
179
+ export interface ModifyUserProfileRequest {
180
+ /**
181
+ * 待修改用户ID
182
+ */
183
+ UserId: string
184
+
185
+ /**
186
+ * 待修改的用户名
187
+ */
188
+ Nickname?: string
189
+
190
+ /**
191
+ * 待修改头像url
192
+ */
193
+ Avatar?: string
194
+ }
195
+
196
+ /**
197
+ * CreateGroupWithMembers请求参数结构体
198
+ */
199
+ export interface CreateGroupWithMembersRequest {
200
+ /**
201
+ * 待创建群组名称
202
+ */
203
+ GroupName: string
204
+
205
+ /**
206
+ * 低代码平台应用ID
207
+ */
208
+ SdkAppId: number
209
+
210
+ /**
211
+ * 默认绑定主讲老师ID
212
+ */
213
+ TeacherId?: string
214
+
215
+ /**
216
+ * 群组成员列表,一次性最多200个
217
+ */
218
+ MemberIds?: Array<string>
219
+ }
220
+
221
+ /**
222
+ * DescribeDocumentsByRoom请求参数结构体
223
+ */
224
+ export interface DescribeDocumentsByRoomRequest {
225
+ /**
226
+ * 房间ID。
227
+ */
228
+ RoomId: number
229
+
230
+ /**
231
+ * 低代码互动课堂的SdkAppId
232
+ */
233
+ SdkAppId: number
234
+
235
+ /**
236
+ * 分页查询当前页数,从1开始递增,默认值为1
237
+ */
238
+ Page?: number
239
+
240
+ /**
241
+ * 每页数据量,最大1000,默认值为100
242
+ */
243
+ Limit?: number
244
+
245
+ /**
246
+ * 课件权限。
247
+ [0]:获取owner的私有课件;
248
+ [1]:获取owner的公开课件;
249
+ [0,1]:则获取owner的私有课件和公开课件;
250
+ [2]:获取owner的私有课件和所有人(包括owner)的公开课件。
251
+ 默认值为[2]
252
+ */
253
+ Permission?: Array<number>
254
+
255
+ /**
256
+ * 文档所有者的user_id,不填默认获取SdkAppId下所有课件
257
+ */
258
+ Owner?: string
259
+ }
260
+
261
+ /**
262
+ * BatchCreateGroupWithMembers返回参数结构体
263
+ */
264
+ export interface BatchCreateGroupWithMembersResponse {
265
+ /**
266
+ * 新创建群组ID列表,与输入创建参数顺序一致
267
+ */
268
+ GroupIds?: Array<string>
269
+
270
+ /**
271
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
272
+ */
273
+ RequestId?: string
274
+ }
275
+
276
+ /**
277
+ * CreateGroupWithMembers返回参数结构体
278
+ */
279
+ export interface CreateGroupWithMembersResponse {
280
+ /**
281
+ * 创建成功群组ID
282
+ */
283
+ GroupId?: string
284
+
285
+ /**
286
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
287
+ */
288
+ RequestId?: string
289
+ }
290
+
291
+ /**
292
+ * BatchAddGroupMember返回参数结构体
293
+ */
294
+ export interface BatchAddGroupMemberResponse {
295
+ /**
296
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
297
+ */
298
+ RequestId?: string
299
+ }
300
+
301
+ /**
302
+ * ModifyUserProfile返回参数结构体
303
+ */
304
+ export interface ModifyUserProfileResponse {
305
+ /**
306
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
307
+ */
308
+ RequestId?: string
309
+ }
310
+
311
+ /**
312
+ * ModifyApp返回参数结构体
313
+ */
314
+ export interface ModifyAppResponse {
315
+ /**
316
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
317
+ */
318
+ RequestId?: string
319
+ }
320
+
321
+ /**
322
+ * LoginOriginId请求参数结构体
323
+ */
324
+ export interface LoginOriginIdRequest {
325
+ /**
326
+ * 低代码互动课堂的SdkAppId。
327
+ */
328
+ SdkAppId: number
329
+
330
+ /**
331
+ * 用户在客户系统的Id,需要在同一应用下唯一。
332
+ */
333
+ OriginId: string
334
+ }
335
+
336
+ /**
337
+ * BatchRegister返回参数结构体
338
+ */
339
+ export interface BatchRegisterResponse {
340
+ /**
341
+ * 注册成功的用户列表
342
+ 注意:此字段可能返回 null,表示取不到有效值。
343
+ */
344
+ Users?: Array<BatchUserInfo>
345
+
346
+ /**
347
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
348
+ */
349
+ RequestId?: string
350
+ }
351
+
352
+ /**
353
+ * BindDocumentToRoom返回参数结构体
354
+ */
355
+ export interface BindDocumentToRoomResponse {
356
+ /**
357
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
358
+ */
359
+ RequestId?: string
360
+ }
361
+
362
+ /**
363
+ * CreateGroupWithSubGroup请求参数结构体
364
+ */
365
+ export interface CreateGroupWithSubGroupRequest {
366
+ /**
367
+ * 待创建的新群组名
368
+ */
369
+ GroupName: string
370
+
371
+ /**
372
+ * 低代码平台应用ID
373
+ */
374
+ SdkAppId: number
375
+
376
+ /**
377
+ * 子群组ID列表,子群组ID不能重复,最多40个
378
+ */
379
+ SubGroupIds: Array<string>
380
+
381
+ /**
382
+ * 群组默认主讲老师ID
383
+ */
384
+ TeacherId?: string
385
+ }
386
+
387
+ /**
388
+ * SetWatermark请求参数结构体
389
+ */
390
+ export interface SetWatermarkRequest {
391
+ /**
392
+ * 低代码互动课堂的SdkAppId。
393
+
394
+ */
395
+ SdkAppId: number
396
+
397
+ /**
398
+ * 老师视频区域的水印参数地址,设置为空字符串表示删除
399
+ */
400
+ TeacherUrl?: string
401
+
402
+ /**
403
+ * 白板视频区域的水印参数地址,设置为空字符串表示删除
404
+ */
405
+ BoardUrl?: string
406
+
407
+ /**
408
+ * 视频默认图片(在没有视频流的时候显示),设置为空字符串表示删除
409
+ */
410
+ VideoUrl?: string
411
+
412
+ /**
413
+ * 白板区域水印的宽度,取值:0-100,默认为0,表示区域X方向的百分比
414
+ */
415
+ BoardW?: number
416
+
417
+ /**
418
+ * 白板区域水印的高度,取值:0-100,默认为0, 表示区域Y方向的百分比
419
+ */
420
+ BoardH?: number
421
+
422
+ /**
423
+ * 白板区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
424
+ */
425
+ BoardX?: number
426
+
427
+ /**
428
+ * 白板区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
429
+ */
430
+ BoardY?: number
431
+
432
+ /**
433
+ * 老师视频区域水印的宽度,取值:0-100,默认为0,表示区域X方向的百分比
434
+ */
435
+ TeacherW?: number
436
+
437
+ /**
438
+ * 老师视频区域水印的高度,取值:0-100,默认为0, 表示区域Y方向的百分比
439
+ */
440
+ TeacherH?: number
441
+
442
+ /**
443
+ * 老师视频区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
444
+ */
445
+ TeacherX?: number
446
+
447
+ /**
448
+ * 老师视频区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
449
+ */
450
+ TeacherY?: number
451
+
452
+ /**
453
+ * 文字水印内容,设置为空字符串表示删除
454
+ */
455
+ Text?: string
456
+
457
+ /**
458
+ * 文字水印颜色
459
+ */
460
+ TextColor?: string
461
+ }
462
+
463
+ /**
464
+ * DescribeRoom请求参数结构体
465
+ */
466
+ export interface DescribeRoomRequest {
467
+ /**
468
+ * 房间Id。
469
+ */
470
+ RoomId: number
471
+ }
472
+
473
+ /**
474
+ * BatchCreateRoom返回参数结构体
475
+ */
476
+ export interface BatchCreateRoomResponse {
477
+ /**
478
+ * 创建成功课堂ID,与传入课堂信息顺序一致
479
+ */
480
+ RoomIds?: Array<number>
481
+
482
+ /**
483
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
484
+ */
485
+ RequestId?: string
486
+ }
487
+
488
+ /**
489
+ * UnbindDocumentFromRoom返回参数结构体
490
+ */
491
+ export interface UnbindDocumentFromRoomResponse {
492
+ /**
493
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
494
+ */
495
+ RequestId?: string
496
+ }
497
+
498
+ /**
499
+ * CreateDocument返回参数结构体
500
+ */
501
+ export interface CreateDocumentResponse {
502
+ /**
503
+ * 文档ID。
504
+ */
505
+ DocumentId: string
506
+
507
+ /**
508
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
509
+ */
510
+ RequestId?: string
511
+ }
512
+
513
+ /**
514
+ * DescribeGroup返回参数结构体
515
+ */
516
+ export interface DescribeGroupResponse {
517
+ /**
518
+ * 群组ID
519
+ */
520
+ GroupId?: string
521
+
522
+ /**
523
+ * 群组名称
524
+ */
525
+ GroupName?: string
526
+
527
+ /**
528
+ * 群主主讲人ID
529
+ 注意:此字段可能返回 null,表示取不到有效值。
530
+ */
531
+ TeacherId?: string
532
+
533
+ /**
534
+ * 群组类型
535
+ 0-基础群组
536
+ 1-组合群组,若为1时会返回子群组ID
537
+ */
538
+ GroupType?: number
539
+
540
+ /**
541
+ * 子群组ID列表
542
+ 注意:此字段可能返回 null,表示取不到有效值。
543
+ */
544
+ SubGroupIds?: Array<string>
545
+
546
+ /**
547
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
548
+ */
549
+ RequestId?: string
550
+ }
551
+
552
+ /**
553
+ * SetAppCustomContent返回参数结构体
554
+ */
555
+ export interface SetAppCustomContentResponse {
556
+ /**
557
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
558
+ */
559
+ RequestId?: string
560
+ }
561
+
562
+ /**
563
+ * 用户注册请求信息
564
+ */
565
+ export interface BatchUserRequest {
566
+ /**
567
+ * 低代码互动课堂的SdkAppId。
568
+
569
+ 注意:此字段可能返回 null,表示取不到有效值。
570
+ */
571
+ SdkAppId: number
572
+
573
+ /**
574
+ * 用户名称。
575
+
576
+ 注意:此字段可能返回 null,表示取不到有效值。
577
+ */
578
+ Name?: string
579
+
580
+ /**
581
+ * 用户在客户系统的Id,需要在同一应用下唯一。
582
+
583
+ 注意:此字段可能返回 null,表示取不到有效值。
584
+ */
585
+ OriginId?: string
586
+
587
+ /**
588
+ * 用户头像。
589
+
590
+ 注意:此字段可能返回 null,表示取不到有效值。
591
+ */
592
+ Avatar?: string
593
+ }
594
+
595
+ /**
596
+ * LoginUser返回参数结构体
597
+ */
598
+ export interface LoginUserResponse {
599
+ /**
600
+ * 用户Id。
601
+ */
602
+ UserId: string
603
+
604
+ /**
605
+ * 登录/注册成功后返回登录态token。有效期7天。
606
+ */
607
+ Token: string
608
+
609
+ /**
610
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
611
+ */
612
+ RequestId?: string
99
613
  }
100
614
 
101
615
  /**
102
- * BatchCreateRoom返回参数结构体
616
+ * ModifyGroup请求参数结构体
103
617
  */
104
- export interface BatchCreateRoomResponse {
618
+ export interface ModifyGroupRequest {
105
619
  /**
106
- * 创建成功课堂ID,与传入课堂信息顺序一致
620
+ * 需要修改的群组ID
107
621
  */
108
- RoomIds?: Array<number>
622
+ GroupId: string
109
623
 
110
624
  /**
111
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
625
+ * 低代码平台应用ID
112
626
  */
113
- RequestId?: string
627
+ SdkAppId: number
628
+
629
+ /**
630
+ * 默认绑定主讲老师ID
631
+ */
632
+ TeacherId?: string
633
+
634
+ /**
635
+ * 待修改的群组名称
636
+ */
637
+ GroupName?: string
114
638
  }
115
639
 
116
640
  /**
117
- * SetAppCustomContent请求参数结构体
641
+ * DescribeAppDetail请求参数结构体
118
642
  */
119
- export interface SetAppCustomContentRequest {
643
+ export interface DescribeAppDetailRequest {
120
644
  /**
121
- * 自定义内容。
645
+ * 应用ID。低代码互动课堂的SdkAppId。
646
+
647
+ */
648
+ ApplicationId: string
649
+
650
+ /**
651
+ * 开发商ID
122
652
  */
123
- CustomContent: Array<AppCustomContent>
653
+ DeveloperId: string
654
+ }
124
655
 
656
+ /**
657
+ * DeleteGroup请求参数结构体
658
+ */
659
+ export interface DeleteGroupRequest {
125
660
  /**
126
- * 应用ID
661
+ * 待删除群组ID列表
662
+ */
663
+ GroupIds: Array<string>
664
+
665
+ /**
666
+ * 低代码平台应用ID
127
667
  */
128
668
  SdkAppId: number
129
669
  }
130
670
 
131
671
  /**
132
- * 批量创建房间的房间信息
672
+ * AddGroupMember请求参数结构体
133
673
  */
134
- export interface RoomInfo {
674
+ export interface AddGroupMemberRequest {
135
675
  /**
136
- * 房间名称。
137
- 注意:此字段可能返回 null,表示取不到有效值。
138
- */
139
- Name: string
676
+ * 群组ID
677
+ */
678
+ GroupId: string
140
679
 
141
680
  /**
142
- * 预定的房间开始时间,unix时间戳。
681
+ * 低代码平台应用ID
682
+ */
683
+ SdkAppId: number
684
+
685
+ /**
686
+ * 成员列表,最大值200
687
+ */
688
+ MemberIds: Array<string>
689
+ }
690
+
691
+ /**
692
+ * DescribeGroupList请求参数结构体
693
+ */
694
+ export interface DescribeGroupListRequest {
695
+ /**
696
+ * 低代码平台应用ID
697
+ */
698
+ SdkAppId: number
699
+
700
+ /**
701
+ * 分页查询当前页数,默认从1开始递增。
702
+ */
703
+ Page?: number
704
+
705
+ /**
706
+ * 每页数据量,默认20,最大1000。
707
+ */
708
+ Limit?: number
709
+
710
+ /**
711
+ * 主讲人ID筛选群组,与MemberId有且只有一个,都传时以此字段获取
712
+ */
713
+ TeacherId?: string
714
+
715
+ /**
716
+ * 成员ID刷选群组,与TeacherId有且只有一个
717
+ */
718
+ MemberId?: string
719
+ }
720
+
721
+ /**
722
+ * 文档信息
723
+ */
724
+ export interface DocumentInfo {
725
+ /**
726
+ * 文档Id
143
727
  注意:此字段可能返回 null,表示取不到有效值。
144
728
  */
145
- StartTime: number
729
+ DocumentId?: string
146
730
 
147
731
  /**
148
- * 预定的房间结束时间,unix时间戳。
732
+ * 文档原址url
149
733
  注意:此字段可能返回 null,表示取不到有效值。
150
734
  */
151
- EndTime: number
735
+ DocumentUrl?: string
152
736
 
153
737
  /**
154
- * 分辨率。可以有如下取值: 1 标清 2 高清 3 全高清
738
+ * 文档名称
155
739
  注意:此字段可能返回 null,表示取不到有效值。
156
740
  */
157
- Resolution: number
741
+ DocumentName?: string
158
742
 
159
743
  /**
160
- * 最大连麦人数(不包括老师)。取值范围[0, 16]
744
+ * 文档所有者UserId
161
745
  注意:此字段可能返回 null,表示取不到有效值。
162
746
  */
163
- MaxMicNumber: number
747
+ Owner?: string
164
748
 
165
749
  /**
166
- * 房间子类型,可以有以下取值: videodoc 文档+视频 video 纯视频 coteaching 双师
750
+ * 应用Id
167
751
  注意:此字段可能返回 null,表示取不到有效值。
168
752
  */
169
- SubType: string
753
+ SdkAppId?: number
170
754
 
171
755
  /**
172
- * 老师ID。通过[注册用户]接口获取的UserId。
756
+ * 文档权限,0:私有课件 1:公共课件
173
757
  注意:此字段可能返回 null,表示取不到有效值。
174
758
  */
175
- TeacherId?: string
759
+ Permission?: number
176
760
 
177
761
  /**
178
- * 进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦
762
+ * 转码结果,无需转码为空,转码成功为结果url,转码失败为错误码
179
763
  注意:此字段可能返回 null,表示取不到有效值。
180
764
  */
181
- AutoMic?: number
765
+ TranscodeResult?: string
182
766
 
183
767
  /**
184
- * 释放音视频权限后是否自动取消连麦。可以有以下取值: 0 自动取消连麦(默认值) 1 保持连麦状态
768
+ * 转码类型
185
769
  注意:此字段可能返回 null,表示取不到有效值。
186
770
  */
187
- TurnOffMic?: number
771
+ TranscodeType?: number
188
772
 
189
773
  /**
190
- * 高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质
774
+ * 转码进度, 0 - 100 表示(0% - 100%)
191
775
  注意:此字段可能返回 null,表示取不到有效值。
192
776
  */
193
- AudioQuality?: number
777
+ TranscodeProgress?: number
194
778
 
195
779
  /**
196
- * 上课后是否禁止自动录制。可以有以下取值: 0 不禁止录制(自动开启录制,默认值) 1 禁止录制 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
780
+ * 转码状态,0为无需转码,1为正在转码,2为转码失败,3为转码成功
197
781
  注意:此字段可能返回 null,表示取不到有效值。
198
782
  */
199
- DisableRecord?: number
783
+ TranscodeState?: number
200
784
 
201
785
  /**
202
- * 助教Id列表。通过[注册用户]接口获取的UserId。
786
+ * 转码失败后的错误信息
203
787
  注意:此字段可能返回 null,表示取不到有效值。
204
788
  */
205
- Assistants?: Array<string>
789
+ TranscodeInfo?: string
206
790
 
207
791
  /**
208
- * rtc人数。
792
+ * 文档类型
209
793
  注意:此字段可能返回 null,表示取不到有效值。
210
794
  */
211
- RTCAudienceNumber?: number
795
+ DocumentType?: string
212
796
 
213
797
  /**
214
- * 观看类型。
798
+ * 文档大小,单位:字节
215
799
  注意:此字段可能返回 null,表示取不到有效值。
216
800
  */
217
- AudienceType?: number
801
+ DocumentSize?: number
218
802
 
219
803
  /**
220
- * 录制布局。
804
+ * 更新的UNIX时间戳
221
805
  注意:此字段可能返回 null,表示取不到有效值。
222
806
  */
223
- RecordLayout?: number
807
+ UpdateTime?: number
224
808
  }
225
809
 
226
810
  /**
227
- * SetWatermark返回参数结构体
811
+ * GetWatermark返回参数结构体
228
812
  */
229
- export interface SetWatermarkResponse {
813
+ export interface GetWatermarkResponse {
230
814
  /**
231
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
232
- */
233
- RequestId?: string
234
- }
815
+ * 老师视频区域的水印参数配置
816
+ 注意:此字段可能返回 null,表示取不到有效值。
817
+ */
818
+ TeacherLogo?: WatermarkConfig
235
819
 
236
- /**
237
- * ModifyRoom返回参数结构体
238
- */
239
- export interface ModifyRoomResponse {
240
820
  /**
241
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
242
- */
243
- RequestId?: string
244
- }
821
+ * 白板区域的水印参数配置
822
+ 注意:此字段可能返回 null,表示取不到有效值。
823
+ */
824
+ BoardLogo?: WatermarkConfig
825
+
826
+ /**
827
+ * 背景图片配置
828
+ 注意:此字段可能返回 null,表示取不到有效值。
829
+ */
830
+ BackgroundPicture?: BackgroundPictureConfig
831
+
832
+ /**
833
+ * 文字水印配置
834
+ 注意:此字段可能返回 null,表示取不到有效值。
835
+ */
836
+ Text?: TextMarkConfig
245
837
 
246
- /**
247
- * UnbindDocumentFromRoom返回参数结构体
248
- */
249
- export interface UnbindDocumentFromRoomResponse {
250
838
  /**
251
839
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
252
840
  */
@@ -254,229 +842,213 @@ export interface UnbindDocumentFromRoomResponse {
254
842
  }
255
843
 
256
844
  /**
257
- * DescribeUser请求参数结构体
845
+ * DeleteDocument返回参数结构体
258
846
  */
259
- export interface DescribeUserRequest {
847
+ export interface DeleteDocumentResponse {
260
848
  /**
261
- * 用户Id
849
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
262
850
  */
263
- UserId: string
851
+ RequestId?: string
264
852
  }
265
853
 
266
854
  /**
267
- * ModifyRoom请求参数结构体
855
+ * DeleteRecord请求参数结构体
268
856
  */
269
- export interface ModifyRoomRequest {
857
+ export interface DeleteRecordRequest {
270
858
  /**
271
- * 房间ID
859
+ * 房间Id
272
860
  */
273
861
  RoomId: number
274
862
 
275
863
  /**
276
- * 低代码互动课堂的SdkAppId
277
- */
278
- SdkAppId: number
864
+ * 低代码互动课堂的SdkAppId
279
865
 
280
- /**
281
- * 预定的房间开始时间,unix时间戳。直播开始后不允许修改。
282
- */
283
- StartTime?: number
866
+ */
867
+ SdkAppId: number
868
+ }
284
869
 
870
+ /**
871
+ * BatchDeleteGroupMember返回参数结构体
872
+ */
873
+ export interface BatchDeleteGroupMemberResponse {
285
874
  /**
286
- * 预定的房间结束时间,unix时间戳。直播开始后不允许修改。
875
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
287
876
  */
288
- EndTime?: number
877
+ RequestId?: string
878
+ }
289
879
 
880
+ /**
881
+ * CreateGroupWithSubGroup返回参数结构体
882
+ */
883
+ export interface CreateGroupWithSubGroupResponse {
290
884
  /**
291
- * 老师ID。直播开始后不允许修改。
885
+ * 新创建群组ID
292
886
  */
293
- TeacherId?: string
887
+ GroupId?: string
294
888
 
295
889
  /**
296
- * 房间名称。
890
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
297
891
  */
298
- Name?: string
299
-
300
- /**
301
- * 分辨率。可以有如下取值:
302
- 1 标清
303
- 2 高清
304
- 3 全高清
305
- 直播开始后不允许修改。
306
- */
307
- Resolution?: number
308
-
309
- /**
310
- * 最大连麦人数(不包括老师)。取值范围[0, 17)
311
- 直播开始后不允许修改。
312
- */
313
- MaxMicNumber?: number
892
+ RequestId?: string
893
+ }
314
894
 
895
+ /**
896
+ * 获取群组列表返回的群组信息
897
+ */
898
+ export interface GroupInfo {
315
899
  /**
316
- * 进入房间时是否自动连麦。可以有以下取值:
317
- 0 不自动连麦(默认值)
318
- 1 自动连麦
319
- 直播开始后不允许修改。
900
+ * 群组ID
901
+ 注意:此字段可能返回 null,表示取不到有效值。
320
902
  */
321
- AutoMic?: number
903
+ GroupId?: string
322
904
 
323
905
  /**
324
- * 高音质模式。可以有以下取值:
325
- 0 不开启高音质(默认值)
326
- 1 开启高音质
327
- 直播开始后不允许修改。
906
+ * 群组名称
907
+ 注意:此字段可能返回 null,表示取不到有效值。
328
908
  */
329
- AudioQuality?: number
330
-
331
- /**
332
- * 房间子类型,可以有以下取值:
333
- videodoc 文档+视频
334
- video 纯视频
335
- coteaching 双师
336
- 直播开始后不允许修改。
909
+ GroupName?: string
910
+
911
+ /**
912
+ * 群组主讲人ID
913
+ 注意:此字段可能返回 null,表示取不到有效值。
337
914
  */
338
- SubType?: string
915
+ TeacherId?: string
339
916
 
340
917
  /**
341
- * 禁止录制。可以有以下取值:
342
- 0 不禁止录制(默认值)
343
- 1 禁止录制
344
- 直播开始后不允许修改。
918
+ * 群组类型
919
+ 0-基础群组
920
+ 1-组合群组,若为1时会返回子群组ID列表
921
+ 注意:此字段可能返回 null,表示取不到有效值。
345
922
  */
346
- DisableRecord?: number
923
+ GroupType?: number
347
924
 
348
925
  /**
349
- * 助教Id列表。直播开始后不允许修改。
350
- */
351
- Assistants?: Array<string>
926
+ * 子群组ID列表,如有。
927
+ 注意:此字段可能返回 null,表示取不到有效值。
928
+ */
929
+ SubGroupIds?: string
352
930
  }
353
931
 
354
932
  /**
355
- * CreateDocument返回参数结构体
933
+ * DescribeDocument返回参数结构体
356
934
  */
357
- export interface CreateDocumentResponse {
935
+ export interface DescribeDocumentResponse {
358
936
  /**
359
- * 文档ID。
937
+ * 文档Id
360
938
  */
361
939
  DocumentId: string
362
940
 
363
941
  /**
364
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
942
+ * 文档原址url
365
943
  */
366
- RequestId?: string
367
- }
944
+ DocumentUrl: string
368
945
 
369
- /**
370
- * DescribeAppDetail返回参数结构体
371
- */
372
- export interface DescribeAppDetailResponse {
373
946
  /**
374
- * SDK 对应的AppId
947
+ * 文档名称
375
948
  */
376
- SdkAppId?: string
949
+ DocumentName: string
377
950
 
378
951
  /**
379
- * 应用配置
952
+ * 文档所有者UserId
380
953
  */
381
- AppConfig?: AppConfig
954
+ Owner: string
382
955
 
383
956
  /**
384
- * 场景配置
957
+ * 应用Id
385
958
  */
386
- SceneConfig?: Array<SceneItem>
959
+ SdkAppId: number
387
960
 
388
961
  /**
389
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
962
+ * 文档权限
390
963
  */
391
- RequestId?: string
392
- }
964
+ Permission: number
393
965
 
394
- /**
395
- * BindDocumentToRoom请求参数结构体
396
- */
397
- export interface BindDocumentToRoomRequest {
398
966
  /**
399
- * 房间ID。
967
+ * 转码结果,无需转码为空,转码成功为结果url,转码失败为错误码
400
968
  */
401
- RoomId: number
969
+ TranscodeResult: string
402
970
 
403
971
  /**
404
- * 文档ID。
972
+ * 转码类型
405
973
  */
406
- DocumentId: string
974
+ TranscodeType: number
407
975
 
408
976
  /**
409
- * 绑定类型。后台可透传到客户端,默认为0。客户端可以根据这个字段实现业务逻辑。
977
+ * 转码进度, 0 - 100 表示(0% - 100%)
410
978
  */
411
- BindType?: number
412
- }
979
+ TranscodeProgress: number
413
980
 
414
- /**
415
- * CreateDocument请求参数结构体
416
- */
417
- export interface CreateDocumentRequest {
418
981
  /**
419
- * 低代码互动课堂的SdkAppId。
982
+ * 转码状态,0为无需转码,1为正在转码,2为转码失败,3为转码成功
420
983
  */
421
- SdkAppId: number
984
+ TranscodeState: number
422
985
 
423
986
  /**
424
- * 文档地址。
987
+ * 转码失败后的错误信息
425
988
  */
426
- DocumentUrl: string
989
+ TranscodeInfo: string
427
990
 
428
991
  /**
429
- * 文档名称。
992
+ * 文档类型
430
993
  */
431
- DocumentName: string
994
+ DocumentType: string
432
995
 
433
996
  /**
434
- * 文档所有者的Id
997
+ * 文档大小,单位:字节
435
998
  */
436
- Owner: string
437
-
438
- /**
439
- * 转码类型,可以有如下取值:
440
- 0 无需转码(默认)
441
- 1 需要转码的文档,ppt,pptx,pdf,doc,docx
442
- 2 需要转码的视频,mp4,3pg,mpeg,avi,flv,wmv,rm,h264等
443
- 2 需要转码的音频,mp3,wav,wma,aac,flac,opus
444
- */
445
- TranscodeType?: number
999
+ DocumentSize: number
446
1000
 
447
1001
  /**
448
- * 权限,可以有如下取值:
449
- 0 私有文档(默认)
450
- 1 公共文档
451
- */
452
- Permission?: number
1002
+ * 更新的UNIX时间戳
1003
+ */
1004
+ UpdateTime: number
453
1005
 
454
1006
  /**
455
- * 文档后缀名。
1007
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
456
1008
  */
457
- DocumentType?: string
1009
+ RequestId?: string
1010
+ }
458
1011
 
1012
+ /**
1013
+ * DeleteGroupMember返回参数结构体
1014
+ */
1015
+ export interface DeleteGroupMemberResponse {
459
1016
  /**
460
- * 文档大小,单位 字节
1017
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
461
1018
  */
462
- DocumentSize?: number
1019
+ RequestId?: string
463
1020
  }
464
1021
 
465
1022
  /**
466
- * DescribeDocumentsByRoom返回参数结构体
1023
+ * DescribeGroupMemberList返回参数结构体
467
1024
  */
468
- export interface DescribeDocumentsByRoomResponse {
1025
+ export interface DescribeGroupMemberListResponse {
469
1026
  /**
470
- * 文档信息列表
1027
+ * 符合查询条件总条数
1028
+ */
1029
+ Total?: number
1030
+
1031
+ /**
1032
+ * 查询成员列表
471
1033
  注意:此字段可能返回 null,表示取不到有效值。
472
1034
  */
473
- Documents?: Array<DocumentInfo>
1035
+ MemberIds?: Array<string>
474
1036
 
475
1037
  /**
476
- * 符合查询条件文档总数
1038
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
477
1039
  */
478
- Total?: number
1040
+ RequestId?: string
1041
+ }
1042
+
1043
+ /**
1044
+ * 应用配置信息
1045
+ */
1046
+ export type AppConfig = null
479
1047
 
1048
+ /**
1049
+ * DeleteRecord返回参数结构体
1050
+ */
1051
+ export interface DeleteRecordResponse {
480
1052
  /**
481
1053
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
482
1054
  */
@@ -484,51 +1056,97 @@ export interface DescribeDocumentsByRoomResponse {
484
1056
  }
485
1057
 
486
1058
  /**
487
- * 批量注册用户信息
1059
+ * BatchCreateRoom请求参数结构体
488
1060
  */
489
- export interface BatchUserInfo {
1061
+ export interface BatchCreateRoomRequest {
490
1062
  /**
491
- * 低代码互动课堂的SdkAppId。
1063
+ * 低代码平台的SdkAppId。
1064
+ */
1065
+ SdkAppId: number
1066
+
1067
+ /**
1068
+ * 创建房间ID列表
1069
+ */
1070
+ RoomInfos: Array<RoomInfo>
1071
+ }
1072
+
1073
+ /**
1074
+ * DescribeGroupMemberList请求参数结构体
1075
+ */
1076
+ export interface DescribeGroupMemberListRequest {
1077
+ /**
1078
+ * 群组ID
1079
+ */
1080
+ GroupId: string
1081
+
1082
+ /**
1083
+ * 低代码平台应用ID
1084
+ */
1085
+ SdkAppId: number
1086
+
1087
+ /**
1088
+ * 分页值,默认1
1089
+ */
1090
+ Page?: number
1091
+
1092
+ /**
1093
+ * 每页数据量,默认20,最大1000
1094
+ */
1095
+ Limit?: number
1096
+ }
492
1097
 
1098
+ /**
1099
+ * 用户信息结构体
1100
+ */
1101
+ export interface UserInfo {
1102
+ /**
1103
+ * 应用Id。
1104
+ 注意:此字段可能返回 null,表示取不到有效值。
493
1105
  */
494
1106
  SdkAppId?: number
495
1107
 
496
1108
  /**
497
- * 用户ID
1109
+ * 用户Id
498
1110
  注意:此字段可能返回 null,表示取不到有效值。
499
1111
  */
500
1112
  UserId?: string
501
1113
 
502
1114
  /**
503
- * 用户在客户系统的Id。 若用户注册时该字段为空,则默认为 UserId 值一致。
1115
+ * 用户昵称。
504
1116
  注意:此字段可能返回 null,表示取不到有效值。
505
1117
  */
506
- OriginId?: string
1118
+ Name?: string
1119
+
1120
+ /**
1121
+ * 用户头像Url。
1122
+ 注意:此字段可能返回 null,表示取不到有效值。
1123
+ */
1124
+ Avatar?: string
507
1125
  }
508
1126
 
509
1127
  /**
510
- * SetAppCustomContent返回参数结构体
1128
+ * DescribeUser返回参数结构体
511
1129
  */
512
- export interface SetAppCustomContentResponse {
1130
+ export interface DescribeUserResponse {
513
1131
  /**
514
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
1132
+ * 应用Id
515
1133
  */
516
- RequestId?: string
517
- }
1134
+ SdkAppId: number
518
1135
 
519
- /**
520
- * LoginOriginId返回参数结构体
521
- */
522
- export interface LoginOriginIdResponse {
523
1136
  /**
524
1137
  * 用户Id。
525
1138
  */
526
1139
  UserId: string
527
1140
 
528
1141
  /**
529
- * 登录/注册成功后返回登录态token。有效期7天。
1142
+ * 用户昵称。
530
1143
  */
531
- Token: string
1144
+ Name: string
1145
+
1146
+ /**
1147
+ * 用户头像Url。
1148
+ */
1149
+ Avatar: string
532
1150
 
533
1151
  /**
534
1152
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -537,354 +1155,321 @@ export interface LoginOriginIdResponse {
537
1155
  }
538
1156
 
539
1157
  /**
540
- * 用户注册请求信息
1158
+ * DescribeDocument请求参数结构体
541
1159
  */
542
- export interface BatchUserRequest {
1160
+ export interface DescribeDocumentRequest {
543
1161
  /**
544
- * 低代码互动课堂的SdkAppId。
1162
+ * 文档Id(唯一id)
1163
+ */
1164
+ DocumentId: string
1165
+ }
545
1166
 
1167
+ /**
1168
+ * BatchDeleteRecord返回参数结构体
1169
+ */
1170
+ export interface BatchDeleteRecordResponse {
1171
+ /**
1172
+ * 本次操作删除成功的房间ID列表。如果入参列表中某个房间ID的录制文件已经删除,则出参列表中无对应的房间ID。
546
1173
  注意:此字段可能返回 null,表示取不到有效值。
547
1174
  */
548
- SdkAppId: number
1175
+ RoomIds?: Array<number>
549
1176
 
550
1177
  /**
551
- * 用户名称。
1178
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1179
+ */
1180
+ RequestId?: string
1181
+ }
552
1182
 
1183
+ /**
1184
+ * 水印配置
1185
+ */
1186
+ export interface WatermarkConfig {
1187
+ /**
1188
+ * 水印图片的url
553
1189
  注意:此字段可能返回 null,表示取不到有效值。
554
1190
  */
555
- Name?: string
1191
+ Url?: string
556
1192
 
557
1193
  /**
558
- * 用户在客户系统的Id,需要在同一应用下唯一。
1194
+ * 水印宽。为比例值
1195
+ 注意:此字段可能返回 null,表示取不到有效值。
1196
+ */
1197
+ Width?: number
559
1198
 
1199
+ /**
1200
+ * 水印高。为比例值
560
1201
  注意:此字段可能返回 null,表示取不到有效值。
561
1202
  */
562
- OriginId?: string
1203
+ Height?: number
563
1204
 
564
1205
  /**
565
- * 用户头像。
1206
+ * 水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间。
1207
+ 注意:此字段可能返回 null,表示取不到有效值。
1208
+ */
1209
+ LocationX?: number
566
1210
 
1211
+ /**
1212
+ * 水印Y偏移, 取值:0-100, 表示区域Y方向的百分比。比如50,则表示位于Y轴中间。
567
1213
  注意:此字段可能返回 null,表示取不到有效值。
568
1214
  */
569
- Avatar?: string
1215
+ LocationY?: number
570
1216
  }
571
1217
 
572
1218
  /**
573
- * BatchDeleteRecord请求参数结构体
1219
+ * SetAppCustomContent请求参数结构体
574
1220
  */
575
- export interface BatchDeleteRecordRequest {
1221
+ export interface SetAppCustomContentRequest {
576
1222
  /**
577
- * 房间ID列表
1223
+ * 自定义内容。
578
1224
  */
579
- RoomIds: Array<number>
1225
+ CustomContent: Array<AppCustomContent>
580
1226
 
581
1227
  /**
582
- * 低代码互动课堂的SdkAppId
1228
+ * 应用ID
583
1229
  */
584
1230
  SdkAppId: number
585
1231
  }
586
1232
 
587
1233
  /**
588
- * LoginUser返回参数结构体
1234
+ * DescribeUser请求参数结构体
589
1235
  */
590
- export interface LoginUserResponse {
1236
+ export interface DescribeUserRequest {
591
1237
  /**
592
1238
  * 用户Id。
593
1239
  */
594
1240
  UserId: string
595
-
596
- /**
597
- * 登录/注册成功后返回登录态token。有效期7天。
598
- */
599
- Token: string
600
-
601
- /**
602
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
603
- */
604
- RequestId?: string
605
1241
  }
606
1242
 
607
1243
  /**
608
- * DescribeAppDetail请求参数结构体
1244
+ * BatchCreateGroupWithMembers请求参数结构体
609
1245
  */
610
- export interface DescribeAppDetailRequest {
611
- /**
612
- * 应用ID。低代码互动课堂的SdkAppId。
613
-
614
- */
615
- ApplicationId: string
616
-
1246
+ export interface BatchCreateGroupWithMembersRequest {
617
1247
  /**
618
- * 开发商ID
1248
+ * 低代码平台应用ID
619
1249
  */
620
- DeveloperId: string
621
- }
1250
+ SdkAppId: number
622
1251
 
623
- /**
624
- * ModifyApp返回参数结构体
625
- */
626
- export interface ModifyAppResponse {
627
1252
  /**
628
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1253
+ * 批量创建群组基础信息,最大长度限制256
629
1254
  */
630
- RequestId?: string
631
- }
1255
+ GroupBaseInfos: Array<GroupBaseInfo>
632
1256
 
633
- /**
634
- * BatchRegister请求参数结构体
635
- */
636
- export interface BatchRegisterRequest {
637
1257
  /**
638
- * 批量注册用户信息列表
1258
+ * 群组绑定的成员列表,一次性最多200个
639
1259
  */
640
- Users: Array<BatchUserRequest>
1260
+ MemberIds?: Array<string>
641
1261
  }
642
1262
 
643
1263
  /**
644
- * DescribeRoom返回参数结构体
1264
+ * BindDocumentToRoom请求参数结构体
645
1265
  */
646
- export interface DescribeRoomResponse {
1266
+ export interface BindDocumentToRoomRequest {
647
1267
  /**
648
- * 房间名称。
1268
+ * 房间ID。
649
1269
  */
650
- Name?: string
1270
+ RoomId: number
651
1271
 
652
1272
  /**
653
- * 预定的房间开始时间,unix时间戳。
1273
+ * 文档ID。
654
1274
  */
655
- StartTime?: number
1275
+ DocumentId: string
656
1276
 
657
1277
  /**
658
- * 预定的房间结束时间,unix时间戳。
1278
+ * 绑定类型。后台可透传到客户端,默认为0。客户端可以根据这个字段实现业务逻辑。
659
1279
  */
660
- EndTime?: number
1280
+ BindType?: number
1281
+ }
661
1282
 
1283
+ /**
1284
+ * CreateDocument请求参数结构体
1285
+ */
1286
+ export interface CreateDocumentRequest {
662
1287
  /**
663
- * 老师的UserId
1288
+ * 低代码互动课堂的SdkAppId
664
1289
  */
665
- TeacherId?: string
1290
+ SdkAppId: number
666
1291
 
667
1292
  /**
668
- * 低代码互动课堂的SdkAppId。
1293
+ * 文档地址。
669
1294
  */
670
- SdkAppId?: number
1295
+ DocumentUrl: string
671
1296
 
672
1297
  /**
673
- * 分辨率。可以有如下取值:
674
- 1 标清
675
- 2 高清
676
- 3 全高清
677
- */
678
- Resolution?: number
1298
+ * 文档名称。
1299
+ */
1300
+ DocumentName: string
679
1301
 
680
1302
  /**
681
- * 最大连麦人数(不包括老师)。取值范围[0, 16]
1303
+ * 文档所有者的Id
682
1304
  */
683
- MaxMicNumber?: number
1305
+ Owner: string
684
1306
 
685
1307
  /**
686
- * 进入课堂时是否自动连麦。可以有以下取值:
687
- 0 不自动连麦(需要手动申请上麦,默认值)
688
- 1 自动连麦
1308
+ * 转码类型,可以有如下取值:
1309
+ 0 无需转码(默认)
1310
+ 1 需要转码的文档,ppt,pptx,pdf,doc,docx
1311
+ 2 需要转码的视频,mp4,3pg,mpeg,avi,flv,wmv,rm,h264等
1312
+ 2 需要转码的音频,mp3,wav,wma,aac,flac,opus
689
1313
  */
690
- AutoMic?: number
1314
+ TranscodeType?: number
691
1315
 
692
1316
  /**
693
- * 高音质模式。可以有以下取值:
694
- 0 不开启高音质(默认值)
695
- 1 开启高音质
1317
+ * 权限,可以有如下取值:
1318
+ 0 私有文档(默认)
1319
+ 1 公共文档
696
1320
  */
697
- AudioQuality?: number
1321
+ Permission?: number
698
1322
 
699
1323
  /**
700
- * 房间子类型,可以有以下取值:
701
- videodoc 文档+视频
702
- video 纯视频
703
- coteaching 双师
704
- */
705
- SubType?: string
1324
+ * 文档后缀名。
1325
+ */
1326
+ DocumentType?: string
706
1327
 
707
1328
  /**
708
- * 上课后是否禁止自动录制。可以有以下取值:
709
- 0 不禁止录制(自动开启录制,默认值)
710
- 1 禁止录制
711
- 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
712
- */
713
- DisableRecord?: number
1329
+ * 文档大小,单位 字节
1330
+ */
1331
+ DocumentSize?: number
1332
+ }
714
1333
 
1334
+ /**
1335
+ * 批量注册用户信息
1336
+ */
1337
+ export interface BatchUserInfo {
715
1338
  /**
716
- * 助教UserId列表。
717
- 注意:此字段可能返回 null,表示取不到有效值。
1339
+ * 低代码互动课堂的SdkAppId。
1340
+
718
1341
  */
719
- Assistants?: Array<string>
1342
+ SdkAppId?: number
720
1343
 
721
1344
  /**
722
- * 录制地址。仅在房间结束后存在。
1345
+ * 用户ID。
723
1346
  注意:此字段可能返回 null,表示取不到有效值。
724
1347
  */
725
- RecordUrl?: string
1348
+ UserId?: string
726
1349
 
727
1350
  /**
728
- * 课堂状态。0为未开始,1为正在上课,2为已结束,3为已过期。
1351
+ * 用户在客户系统的Id。 若用户注册时该字段为空,则默认为 UserId 值一致。
729
1352
  注意:此字段可能返回 null,表示取不到有效值。
730
1353
  */
731
- Status?: number
732
-
733
- /**
734
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
735
- */
736
- RequestId?: string
737
- }
738
-
739
- /**
740
- * DeleteRoom返回参数结构体
741
- */
742
- export interface DeleteRoomResponse {
743
- /**
744
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
745
- */
746
- RequestId?: string
1354
+ OriginId?: string
747
1355
  }
748
1356
 
749
1357
  /**
750
- * ModifyUserProfile请求参数结构体
1358
+ * BatchAddGroupMember请求参数结构体
751
1359
  */
752
- export interface ModifyUserProfileRequest {
1360
+ export interface BatchAddGroupMemberRequest {
753
1361
  /**
754
- * 待修改用户ID
1362
+ * 待添加群组ID列表,最大值100
755
1363
  */
756
- UserId: string
1364
+ GroupIds: Array<string>
757
1365
 
758
1366
  /**
759
- * 待修改的用户名
1367
+ * 低代码平台应用ID
760
1368
  */
761
- Nickname?: string
1369
+ SdkAppId: number
762
1370
 
763
1371
  /**
764
- * 待修改头像url
1372
+ * 待添加成员列表,最大值200
765
1373
  */
766
- Avatar?: string
1374
+ MemberIds: Array<string>
767
1375
  }
768
1376
 
769
1377
  /**
770
- * DescribeDocumentsByRoom请求参数结构体
1378
+ * DescribeRoom返回参数结构体
771
1379
  */
772
- export interface DescribeDocumentsByRoomRequest {
773
- /**
774
- * 房间ID。
775
- */
776
- RoomId: number
777
-
1380
+ export interface DescribeRoomResponse {
778
1381
  /**
779
- * 低代码互动课堂的SdkAppId
1382
+ * 房间名称。
780
1383
  */
781
- SdkAppId: number
1384
+ Name?: string
782
1385
 
783
1386
  /**
784
- * 分页查询当前页数,从1开始递增,默认值为1
1387
+ * 预定的房间开始时间,unix时间戳。
785
1388
  */
786
- Page?: number
1389
+ StartTime?: number
787
1390
 
788
1391
  /**
789
- * 每页数据量,最大1000,默认值为100
1392
+ * 预定的房间结束时间,unix时间戳。
790
1393
  */
791
- Limit?: number
792
-
793
- /**
794
- * 课件权限。
795
- [0]:获取owner的私有课件;
796
- [1]:获取owner的公开课件;
797
- [0,1]:则获取owner的私有课件和公开课件;
798
- [2]:获取owner的私有课件和所有人(包括owner)的公开课件。
799
- 默认值为[2]
800
- */
801
- Permission?: Array<number>
1394
+ EndTime?: number
802
1395
 
803
1396
  /**
804
- * 文档所有者的user_id,不填默认获取SdkAppId下所有课件
1397
+ * 老师的UserId。
805
1398
  */
806
- Owner?: string
807
- }
1399
+ TeacherId?: string
808
1400
 
809
- /**
810
- * DescribeCurrentMemberList请求参数结构体
811
- */
812
- export interface DescribeCurrentMemberListRequest {
813
1401
  /**
814
- * 房间Id
1402
+ * 低代码互动课堂的SdkAppId
815
1403
  */
816
- RoomId: number
1404
+ SdkAppId?: number
817
1405
 
818
1406
  /**
819
- * 分页查询当前页数,从1开始递增。
820
- */
821
- Page: number
1407
+ * 分辨率。可以有如下取值:
1408
+ 1 标清
1409
+ 2 高清
1410
+ 3 全高清
1411
+ */
1412
+ Resolution?: number
822
1413
 
823
1414
  /**
824
- * 每页数据量,最大1000。
1415
+ * 最大连麦人数(不包括老师)。取值范围[0, 16]
825
1416
  */
826
- Limit: number
827
- }
1417
+ MaxMicNumber?: number
828
1418
 
829
- /**
830
- * DescribeSdkAppIdUsers返回参数结构体
831
- */
832
- export interface DescribeSdkAppIdUsersResponse {
833
1419
  /**
834
- * 用户总数
835
- */
836
- Total?: number
1420
+ * 进入课堂时是否自动连麦。可以有以下取值:
1421
+ 0 不自动连麦(需要手动申请上麦,默认值)
1422
+ 1 自动连麦
1423
+ */
1424
+ AutoMic?: number
837
1425
 
838
1426
  /**
839
- * 当前获取用户信息数组列表
840
- 注意:此字段可能返回 null,表示取不到有效值。
1427
+ * 高音质模式。可以有以下取值:
1428
+ 0 不开启高音质(默认值)
1429
+ 1 开启高音质
841
1430
  */
842
- Users?: Array<UserInfo>
1431
+ AudioQuality?: number
843
1432
 
844
1433
  /**
845
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
846
- */
847
- RequestId?: string
848
- }
1434
+ * 房间子类型,可以有以下取值:
1435
+ videodoc 文档+视频
1436
+ video 纯视频
1437
+ coteaching 双师
1438
+ */
1439
+ SubType?: string
849
1440
 
850
- /**
851
- * GetWatermark返回参数结构体
852
- */
853
- export interface GetWatermarkResponse {
854
1441
  /**
855
- * 老师视频区域的水印参数配置
856
- 注意:此字段可能返回 null,表示取不到有效值。
1442
+ * 上课后是否禁止自动录制。可以有以下取值:
1443
+ 0 不禁止录制(自动开启录制,默认值)
1444
+ 1 禁止录制
1445
+ 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
857
1446
  */
858
- TeacherLogo?: WatermarkConfig
1447
+ DisableRecord?: number
859
1448
 
860
1449
  /**
861
- * 白板区域的水印参数配置
1450
+ * 助教UserId列表。
862
1451
  注意:此字段可能返回 null,表示取不到有效值。
863
1452
  */
864
- BoardLogo?: WatermarkConfig
1453
+ Assistants?: Array<string>
865
1454
 
866
1455
  /**
867
- * 背景图片配置
1456
+ * 录制地址。仅在房间结束后存在。
868
1457
  注意:此字段可能返回 null,表示取不到有效值。
869
1458
  */
870
- BackgroundPicture?: BackgroundPictureConfig
1459
+ RecordUrl?: string
871
1460
 
872
1461
  /**
873
- * 文字水印配置
1462
+ * 课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。
874
1463
  注意:此字段可能返回 null,表示取不到有效值。
875
1464
  */
876
- Text?: TextMarkConfig
1465
+ Status?: number
877
1466
 
878
1467
  /**
879
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
880
- */
881
- RequestId?: string
882
- }
1468
+ * 房间绑定的群组ID
1469
+ 注意:此字段可能返回 null,表示取不到有效值。
1470
+ */
1471
+ GroupId?: string
883
1472
 
884
- /**
885
- * DeleteDocument返回参数结构体
886
- */
887
- export interface DeleteDocumentResponse {
888
1473
  /**
889
1474
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
890
1475
  */
@@ -892,49 +1477,44 @@ export interface DeleteDocumentResponse {
892
1477
  }
893
1478
 
894
1479
  /**
895
- * DeleteRecord请求参数结构体
1480
+ * DescribeCurrentMemberList请求参数结构体
896
1481
  */
897
- export interface DeleteRecordRequest {
1482
+ export interface DescribeCurrentMemberListRequest {
898
1483
  /**
899
1484
  * 房间Id。
900
1485
  */
901
1486
  RoomId: number
902
1487
 
903
1488
  /**
904
- * 低代码互动课堂的SdkAppId。
905
-
906
- */
907
- SdkAppId: number
908
- }
909
-
910
- /**
911
- * 应用自定义内容
912
- */
913
- export interface AppCustomContent {
914
- /**
915
- * 场景参数,一个应用下可以设置多个不同场景。
1489
+ * 分页查询当前页数,从1开始递增。
916
1490
  */
917
- Scene: string
1491
+ Page: number
918
1492
 
919
1493
  /**
920
- * logo地址。
1494
+ * 每页数据量,最大1000。
921
1495
  */
922
- LogoUrl?: string
1496
+ Limit: number
1497
+ }
923
1498
 
1499
+ /**
1500
+ * DescribeSdkAppIdUsers返回参数结构体
1501
+ */
1502
+ export interface DescribeSdkAppIdUsersResponse {
924
1503
  /**
925
- * 主页地址,可设置用于跳转。
1504
+ * 用户总数
926
1505
  */
927
- HomeUrl?: string
1506
+ Total?: number
928
1507
 
929
1508
  /**
930
- * 自定义的js。
931
- */
932
- JsUrl?: string
1509
+ * 当前获取用户信息数组列表
1510
+ 注意:此字段可能返回 null,表示取不到有效值。
1511
+ */
1512
+ Users?: Array<UserInfo>
933
1513
 
934
1514
  /**
935
- * 自定义的css
1515
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
936
1516
  */
937
- CssUrl?: string
1517
+ RequestId?: string
938
1518
  }
939
1519
 
940
1520
  /**
@@ -990,502 +1570,476 @@ export interface DeleteDocumentRequest {
990
1570
  }
991
1571
 
992
1572
  /**
993
- * DescribeSdkAppIdUsers请求参数结构体
1573
+ * DeleteGroupMember请求参数结构体
994
1574
  */
995
- export interface DescribeSdkAppIdUsersRequest {
1575
+ export interface DeleteGroupMemberRequest {
996
1576
  /**
997
- * 应用ID
1577
+ * 群组ID,联合群组无法删除群组成员
998
1578
  */
999
- SdkAppId: number
1579
+ GroupId: string
1000
1580
 
1001
1581
  /**
1002
- * 分页,默认值为1
1582
+ * 低代码平台应用ID
1003
1583
  */
1004
- Page?: number
1584
+ SdkAppId: number
1005
1585
 
1006
1586
  /**
1007
- * 分页数据限制,默认值为20
1587
+ * 成员列表,最大值200
1008
1588
  */
1009
- Limit?: number
1589
+ MemberIds: Array<string>
1010
1590
  }
1011
1591
 
1012
1592
  /**
1013
- * DescribeUser返回参数结构体
1593
+ * GetWatermark请求参数结构体
1014
1594
  */
1015
- export interface DescribeUserResponse {
1016
- /**
1017
- * 应用Id。
1018
- */
1019
- SdkAppId: number
1020
-
1021
- /**
1022
- * 用户Id。
1023
- */
1024
- UserId: string
1025
-
1026
- /**
1027
- * 用户昵称。
1028
- */
1029
- Name: string
1030
-
1595
+ export interface GetWatermarkRequest {
1031
1596
  /**
1032
- * 用户头像Url
1033
- */
1034
- Avatar: string
1597
+ * 低代码互动课堂的SdkAppId
1035
1598
 
1036
- /**
1037
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1038
- */
1039
- RequestId?: string
1599
+ */
1600
+ SdkAppId: number
1040
1601
  }
1041
1602
 
1042
1603
  /**
1043
- * DescribeDocument返回参数结构体
1604
+ * 成员记录信息。
1044
1605
  */
1045
- export interface DescribeDocumentResponse {
1046
- /**
1047
- * 文档Id
1048
- */
1049
- DocumentId: string
1050
-
1606
+ export interface MemberRecord {
1051
1607
  /**
1052
- * 文档原址url
1608
+ * 用户ID。
1053
1609
  */
1054
- DocumentUrl: string
1610
+ UserId: string
1055
1611
 
1056
1612
  /**
1057
- * 文档名称
1613
+ * 用户名称。
1058
1614
  */
1059
- DocumentName: string
1615
+ UserName: string
1060
1616
 
1061
1617
  /**
1062
- * 文档所有者UserId
1618
+ * 在线时长,单位秒。
1063
1619
  */
1064
- Owner: string
1620
+ PresentTime: number
1065
1621
 
1066
1622
  /**
1067
- * 应用Id
1623
+ * 是否开启摄像头。
1068
1624
  */
1069
- SdkAppId: number
1625
+ Camera: number
1070
1626
 
1071
1627
  /**
1072
- * 文档权限
1628
+ * 是否开启麦克风。
1073
1629
  */
1074
- Permission: number
1630
+ Mic: number
1075
1631
 
1076
1632
  /**
1077
- * 转码结果,无需转码为空,转码成功为结果url,转码失败为错误码
1633
+ * 是否禁言。
1078
1634
  */
1079
- TranscodeResult: string
1635
+ Silence: number
1080
1636
 
1081
1637
  /**
1082
- * 转码类型
1638
+ * 回答问题数量。
1083
1639
  */
1084
- TranscodeType: number
1640
+ AnswerQuestions: number
1085
1641
 
1086
1642
  /**
1087
- * 转码进度, 0 - 100 表示(0% - 100%)
1643
+ * 举手数量。
1088
1644
  */
1089
- TranscodeProgress: number
1645
+ HandUps: number
1090
1646
 
1091
1647
  /**
1092
- * 转码状态,0为无需转码,1为正在转码,2为转码失败,3为转码成功
1648
+ * 首次进入房间的unix时间戳。
1093
1649
  */
1094
- TranscodeState: number
1650
+ FirstJoinTimestamp: number
1095
1651
 
1096
1652
  /**
1097
- * 转码失败后的错误信息
1653
+ * 最后一次退出房间的unix时间戳。
1098
1654
  */
1099
- TranscodeInfo: string
1655
+ LastQuitTimestamp: number
1100
1656
 
1101
1657
  /**
1102
- * 文档类型
1658
+ * 奖励次数。
1103
1659
  */
1104
- DocumentType: string
1660
+ Rewords: number
1105
1661
 
1106
1662
  /**
1107
- * 文档大小,单位:字节
1663
+ * 用户IP。
1108
1664
  */
1109
- DocumentSize: number
1665
+ IPAddress?: string
1110
1666
 
1111
1667
  /**
1112
- * 更新的UNIX时间戳
1668
+ * 用户位置信息。
1113
1669
  */
1114
- UpdateTime: number
1670
+ Location?: string
1115
1671
 
1116
1672
  /**
1117
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1673
+ * 用户设备平台信息。0:unknown 1:windows 2:mac 3:android 4:ios 5:web 6:h5 7:miniprogram (小程序)
1118
1674
  */
1119
- RequestId?: string
1675
+ Device?: number
1120
1676
  }
1121
1677
 
1122
1678
  /**
1123
- * ModifyUserProfile返回参数结构体
1679
+ * BatchDeleteGroupMember请求参数结构体
1124
1680
  */
1125
- export interface ModifyUserProfileResponse {
1681
+ export interface BatchDeleteGroupMemberRequest {
1126
1682
  /**
1127
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1683
+ * 待添加群组ID列表,最大值100
1128
1684
  */
1129
- RequestId?: string
1130
- }
1685
+ GroupIds: Array<string>
1131
1686
 
1132
- /**
1133
- * 文字水印配置
1134
- */
1135
- export interface TextMarkConfig {
1136
1687
  /**
1137
- * 文字水印内容
1138
- 注意:此字段可能返回 null,表示取不到有效值。
1139
- */
1140
- Text?: string
1688
+ * 低代码平台应用ID
1689
+ */
1690
+ SdkAppId: number
1141
1691
 
1142
1692
  /**
1143
- * 文字水印颜色
1144
- 注意:此字段可能返回 null,表示取不到有效值。
1145
- */
1146
- Color?: string
1693
+ * 待添加成员列表,最大值256
1694
+ */
1695
+ MemberIds: Array<string>
1147
1696
  }
1148
1697
 
1149
1698
  /**
1150
- * GetWatermark请求参数结构体
1699
+ * ModifyApp请求参数结构体
1151
1700
  */
1152
- export interface GetWatermarkRequest {
1701
+ export interface ModifyAppRequest {
1153
1702
  /**
1154
- * 低代码互动课堂的SdkAppId。
1155
-
1156
- */
1703
+ * 低代码互动课堂的SdkAppId。
1704
+ */
1157
1705
  SdkAppId: number
1158
- }
1159
1706
 
1160
- /**
1161
- * CreateSupervisor返回参数结构体
1162
- */
1163
- export interface CreateSupervisorResponse {
1164
1707
  /**
1165
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1708
+ * 回调地址。
1166
1709
  */
1167
- RequestId?: string
1168
- }
1169
-
1170
- /**
1171
- * 场景配置
1172
- */
1173
- export type SceneItem = null
1710
+ Callback?: string
1174
1711
 
1175
- /**
1176
- * DeleteRoom请求参数结构体
1177
- */
1178
- export interface DeleteRoomRequest {
1179
1712
  /**
1180
- * 房间ID
1713
+ * 回调key
1181
1714
  */
1182
- RoomId: number
1715
+ CallbackKey?: string
1183
1716
  }
1184
1717
 
1185
1718
  /**
1186
- * RegisterUser返回参数结构体
1719
+ * UnbindDocumentFromRoom请求参数结构体
1187
1720
  */
1188
- export interface RegisterUserResponse {
1189
- /**
1190
- * 用户Id。
1191
- */
1192
- UserId: string
1193
-
1721
+ export interface UnbindDocumentFromRoomRequest {
1194
1722
  /**
1195
- * 登录/注册成功后返回登录态token。有效期7天。
1723
+ * 房间ID。
1196
1724
  */
1197
- Token: string
1725
+ RoomId: number
1198
1726
 
1199
1727
  /**
1200
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
1728
+ * 文档ID。
1201
1729
  */
1202
- RequestId?: string
1730
+ DocumentId: string
1203
1731
  }
1204
1732
 
1205
1733
  /**
1206
- * 水印配置
1734
+ * RegisterUser请求参数结构体
1207
1735
  */
1208
- export interface WatermarkConfig {
1736
+ export interface RegisterUserRequest {
1209
1737
  /**
1210
- * 水印图片的url
1211
- 注意:此字段可能返回 null,表示取不到有效值。
1212
- */
1213
- Url?: string
1738
+ * 低代码互动课堂的SdkAppId。
1739
+ */
1740
+ SdkAppId: number
1741
+
1742
+ /**
1743
+ * 用户名称。
1744
+ */
1745
+ Name?: string
1214
1746
 
1215
1747
  /**
1216
- * 水印宽。为比例值
1217
- 注意:此字段可能返回 null,表示取不到有效值。
1218
- */
1219
- Width?: number
1748
+ * 用户在客户系统的Id,需要在同一应用下唯一。
1749
+ */
1750
+ OriginId?: string
1220
1751
 
1221
1752
  /**
1222
- * 水印高。为比例值
1223
- 注意:此字段可能返回 null,表示取不到有效值。
1224
- */
1225
- Height?: number
1753
+ * 用户头像。
1754
+ */
1755
+ Avatar?: string
1756
+ }
1226
1757
 
1758
+ /**
1759
+ * 批量创建群组基础信息
1760
+ */
1761
+ export interface GroupBaseInfo {
1227
1762
  /**
1228
- * 水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间。
1763
+ * 待创建群组名
1229
1764
  注意:此字段可能返回 null,表示取不到有效值。
1230
1765
  */
1231
- LocationX?: number
1766
+ GroupName: string
1232
1767
 
1233
1768
  /**
1234
- * 水印Y偏移, 取值:0-100, 表示区域Y方向的百分比。比如50,则表示位于Y轴中间。
1769
+ * 群组主讲人ID
1235
1770
  注意:此字段可能返回 null,表示取不到有效值。
1236
1771
  */
1237
- LocationY?: number
1772
+ TeacherId?: string
1238
1773
  }
1239
1774
 
1240
1775
  /**
1241
- * DescribeRoomStatistics请求参数结构体
1776
+ * LoginUser请求参数结构体
1242
1777
  */
1243
- export interface DescribeRoomStatisticsRequest {
1244
- /**
1245
- * 房间Id。
1246
- */
1247
- RoomId: number
1248
-
1778
+ export interface LoginUserRequest {
1249
1779
  /**
1250
- * 分页查询当前页数,从1开始递增。
1780
+ * 注册获取的用户id。
1251
1781
  */
1252
- Page: number
1782
+ UserId: string
1783
+ }
1253
1784
 
1785
+ /**
1786
+ * SetWatermark返回参数结构体
1787
+ */
1788
+ export interface SetWatermarkResponse {
1254
1789
  /**
1255
- * 每页数据量,最大1000
1790
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
1256
1791
  */
1257
- Limit: number
1792
+ RequestId?: string
1258
1793
  }
1259
1794
 
1260
1795
  /**
1261
- * 文档信息
1796
+ * 批量创建房间的房间信息
1262
1797
  */
1263
- export interface DocumentInfo {
1798
+ export interface RoomInfo {
1264
1799
  /**
1265
- * 文档Id
1800
+ * 房间名称。
1266
1801
  注意:此字段可能返回 null,表示取不到有效值。
1267
1802
  */
1268
- DocumentId?: string
1803
+ Name: string
1269
1804
 
1270
1805
  /**
1271
- * 文档原址url
1806
+ * 预定的房间开始时间,unix时间戳。
1272
1807
  注意:此字段可能返回 null,表示取不到有效值。
1273
1808
  */
1274
- DocumentUrl?: string
1809
+ StartTime: number
1275
1810
 
1276
1811
  /**
1277
- * 文档名称
1812
+ * 预定的房间结束时间,unix时间戳。
1278
1813
  注意:此字段可能返回 null,表示取不到有效值。
1279
1814
  */
1280
- DocumentName?: string
1815
+ EndTime: number
1281
1816
 
1282
1817
  /**
1283
- * 文档所有者UserId
1818
+ * 分辨率。可以有如下取值: 1 标清 2 高清 3 全高清
1284
1819
  注意:此字段可能返回 null,表示取不到有效值。
1285
1820
  */
1286
- Owner?: string
1821
+ Resolution: number
1287
1822
 
1288
1823
  /**
1289
- * 应用Id
1824
+ * 最大连麦人数(不包括老师)。取值范围[0, 16]
1290
1825
  注意:此字段可能返回 null,表示取不到有效值。
1291
1826
  */
1292
- SdkAppId?: number
1827
+ MaxMicNumber: number
1293
1828
 
1294
1829
  /**
1295
- * 文档权限,0:私有课件 1:公共课件
1830
+ * 房间子类型,可以有以下取值: videodoc 文档+视频 video 纯视频 coteaching 双师
1296
1831
  注意:此字段可能返回 null,表示取不到有效值。
1297
1832
  */
1298
- Permission?: number
1833
+ SubType: string
1299
1834
 
1300
1835
  /**
1301
- * 转码结果,无需转码为空,转码成功为结果url,转码失败为错误码
1836
+ * 老师ID。通过[注册用户]接口获取的UserId。
1302
1837
  注意:此字段可能返回 null,表示取不到有效值。
1303
1838
  */
1304
- TranscodeResult?: string
1839
+ TeacherId?: string
1305
1840
 
1306
1841
  /**
1307
- * 转码类型
1842
+ * 进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦
1308
1843
  注意:此字段可能返回 null,表示取不到有效值。
1309
1844
  */
1310
- TranscodeType?: number
1845
+ AutoMic?: number
1311
1846
 
1312
1847
  /**
1313
- * 转码进度, 0 - 100 表示(0% - 100%)
1848
+ * 释放音视频权限后是否自动取消连麦。可以有以下取值: 0 自动取消连麦(默认值) 1 保持连麦状态
1314
1849
  注意:此字段可能返回 null,表示取不到有效值。
1315
1850
  */
1316
- TranscodeProgress?: number
1851
+ TurnOffMic?: number
1317
1852
 
1318
1853
  /**
1319
- * 转码状态,0为无需转码,1为正在转码,2为转码失败,3为转码成功
1854
+ * 高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质
1320
1855
  注意:此字段可能返回 null,表示取不到有效值。
1321
1856
  */
1322
- TranscodeState?: number
1857
+ AudioQuality?: number
1323
1858
 
1324
1859
  /**
1325
- * 转码失败后的错误信息
1860
+ * 上课后是否禁止自动录制。可以有以下取值: 0 不禁止录制(自动开启录制,默认值) 1 禁止录制 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
1326
1861
  注意:此字段可能返回 null,表示取不到有效值。
1327
1862
  */
1328
- TranscodeInfo?: string
1863
+ DisableRecord?: number
1329
1864
 
1330
1865
  /**
1331
- * 文档类型
1866
+ * 助教Id列表。通过[注册用户]接口获取的UserId。
1332
1867
  注意:此字段可能返回 null,表示取不到有效值。
1333
1868
  */
1334
- DocumentType?: string
1869
+ Assistants?: Array<string>
1335
1870
 
1336
1871
  /**
1337
- * 文档大小,单位:字节
1872
+ * rtc人数。
1338
1873
  注意:此字段可能返回 null,表示取不到有效值。
1339
1874
  */
1340
- DocumentSize?: number
1875
+ RTCAudienceNumber?: number
1341
1876
 
1342
1877
  /**
1343
- * 更新的UNIX时间戳
1878
+ * 观看类型。
1344
1879
  注意:此字段可能返回 null,表示取不到有效值。
1345
1880
  */
1346
- UpdateTime?: number
1881
+ AudienceType?: number
1882
+
1883
+ /**
1884
+ * 录制布局。
1885
+ 注意:此字段可能返回 null,表示取不到有效值。
1886
+ */
1887
+ RecordLayout?: number
1888
+
1889
+ /**
1890
+ * 房间绑定的群组ID
1891
+ 注意:此字段可能返回 null,表示取不到有效值。
1892
+ */
1893
+ GroupId?: string
1347
1894
  }
1348
1895
 
1349
1896
  /**
1350
- * 成员记录信息。
1897
+ * DescribeDocumentsByRoom返回参数结构体
1351
1898
  */
1352
- export interface MemberRecord {
1899
+ export interface DescribeDocumentsByRoomResponse {
1353
1900
  /**
1354
- * 用户ID。
1355
- */
1356
- UserId: string
1901
+ * 文档信息列表
1902
+ 注意:此字段可能返回 null,表示取不到有效值。
1903
+ */
1904
+ Documents?: Array<DocumentInfo>
1357
1905
 
1358
1906
  /**
1359
- * 用户名称。
1907
+ * 符合查询条件文档总数
1360
1908
  */
1361
- UserName: string
1909
+ Total?: number
1362
1910
 
1363
1911
  /**
1364
- * 在线时长,单位秒。
1912
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1365
1913
  */
1366
- PresentTime: number
1914
+ RequestId?: string
1915
+ }
1367
1916
 
1917
+ /**
1918
+ * DescribeRoomStatistics请求参数结构体
1919
+ */
1920
+ export interface DescribeRoomStatisticsRequest {
1368
1921
  /**
1369
- * 是否开启摄像头。
1922
+ * 房间Id。
1370
1923
  */
1371
- Camera: number
1924
+ RoomId: number
1372
1925
 
1373
1926
  /**
1374
- * 是否开启麦克风。
1927
+ * 分页查询当前页数,从1开始递增。
1375
1928
  */
1376
- Mic: number
1929
+ Page: number
1377
1930
 
1378
1931
  /**
1379
- * 是否禁言。
1932
+ * 每页数据量,最大1000。
1380
1933
  */
1381
- Silence: number
1934
+ Limit: number
1935
+ }
1382
1936
 
1937
+ /**
1938
+ * ModifyRoom请求参数结构体
1939
+ */
1940
+ export interface ModifyRoomRequest {
1383
1941
  /**
1384
- * 回答问题数量。
1942
+ * 房间ID。
1385
1943
  */
1386
- AnswerQuestions: number
1944
+ RoomId: number
1387
1945
 
1388
1946
  /**
1389
- * 举手数量。
1947
+ * 低代码互动课堂的SdkAppId
1390
1948
  */
1391
- HandUps: number
1949
+ SdkAppId: number
1392
1950
 
1393
1951
  /**
1394
- * 首次进入房间的unix时间戳。
1952
+ * 预定的房间开始时间,unix时间戳。直播开始后不允许修改。
1395
1953
  */
1396
- FirstJoinTimestamp: number
1954
+ StartTime?: number
1397
1955
 
1398
1956
  /**
1399
- * 最后一次退出房间的unix时间戳。
1957
+ * 预定的房间结束时间,unix时间戳。直播开始后不允许修改。
1400
1958
  */
1401
- LastQuitTimestamp: number
1959
+ EndTime?: number
1402
1960
 
1403
1961
  /**
1404
- * 奖励次数。
1962
+ * 老师ID。直播开始后不允许修改。
1405
1963
  */
1406
- Rewords: number
1407
- }
1964
+ TeacherId?: string
1408
1965
 
1409
- /**
1410
- * ModifyApp请求参数结构体
1411
- */
1412
- export interface ModifyAppRequest {
1413
1966
  /**
1414
- * 低代码互动课堂的SdkAppId。
1967
+ * 房间名称。
1415
1968
  */
1416
- SdkAppId: number
1969
+ Name?: string
1417
1970
 
1418
1971
  /**
1419
- * 回调地址。
1420
- */
1421
- Callback?: string
1972
+ * 分辨率。可以有如下取值:
1973
+ 1 标清
1974
+ 2 高清
1975
+ 3 全高清
1976
+ 直播开始后不允许修改。
1977
+ */
1978
+ Resolution?: number
1422
1979
 
1423
1980
  /**
1424
- * 回调key。
1425
- */
1426
- CallbackKey?: string
1427
- }
1981
+ * 最大连麦人数(不包括老师)。取值范围[0, 17)
1982
+ 直播开始后不允许修改。
1983
+ */
1984
+ MaxMicNumber?: number
1428
1985
 
1429
- /**
1430
- * CreateSupervisor请求参数结构体
1431
- */
1432
- export type CreateSupervisorRequest = null
1986
+ /**
1987
+ * 进入房间时是否自动连麦。可以有以下取值:
1988
+ 0 不自动连麦(默认值)
1989
+ 1 自动连麦
1990
+ 直播开始后不允许修改。
1991
+ */
1992
+ AutoMic?: number
1433
1993
 
1434
- /**
1435
- * 背景图片配置
1436
- */
1437
- export interface BackgroundPictureConfig {
1438
1994
  /**
1439
- * 背景图片的url
1440
- 注意:此字段可能返回 null,表示取不到有效值。
1995
+ * 高音质模式。可以有以下取值:
1996
+ 0 不开启高音质(默认值)
1997
+ 1 开启高音质
1998
+ 直播开始后不允许修改。
1441
1999
  */
1442
- Url: string
1443
- }
2000
+ AudioQuality?: number
1444
2001
 
1445
- /**
1446
- * UnbindDocumentFromRoom请求参数结构体
1447
- */
1448
- export interface UnbindDocumentFromRoomRequest {
1449
2002
  /**
1450
- * 房间ID。
1451
- */
1452
- RoomId: number
2003
+ * 房间子类型,可以有以下取值:
2004
+ videodoc 文档+视频
2005
+ video 纯视频
2006
+ coteaching 双师
2007
+ 直播开始后不允许修改。
2008
+ */
2009
+ SubType?: string
1453
2010
 
1454
2011
  /**
1455
- * 文档ID。
1456
- */
1457
- DocumentId: string
1458
- }
2012
+ * 禁止录制。可以有以下取值:
2013
+ 0 不禁止录制(默认值)
2014
+ 1 禁止录制
2015
+ 直播开始后不允许修改。
2016
+ */
2017
+ DisableRecord?: number
1459
2018
 
1460
- /**
1461
- * LoginOriginId请求参数结构体
1462
- */
1463
- export interface LoginOriginIdRequest {
1464
2019
  /**
1465
- * 低代码互动课堂的SdkAppId。
2020
+ * 助教Id列表。直播开始后不允许修改。
1466
2021
  */
1467
- SdkAppId: number
2022
+ Assistants?: Array<string>
1468
2023
 
1469
2024
  /**
1470
- * 用户在客户系统的Id,需要在同一应用下唯一。
2025
+ * 房间绑定的群组ID
1471
2026
  */
1472
- OriginId: string
2027
+ GroupId?: string
1473
2028
  }
1474
2029
 
1475
2030
  /**
1476
- * 应用配置信息
2031
+ * LoginOriginId返回参数结构体
1477
2032
  */
1478
- export type AppConfig = null
2033
+ export interface LoginOriginIdResponse {
2034
+ /**
2035
+ * 用户Id。
2036
+ */
2037
+ UserId: string
1479
2038
 
1480
- /**
1481
- * BatchRegister返回参数结构体
1482
- */
1483
- export interface BatchRegisterResponse {
1484
2039
  /**
1485
- * 注册成功的用户列表
1486
- 注意:此字段可能返回 null,表示取不到有效值。
1487
- */
1488
- Users?: Array<BatchUserInfo>
2040
+ * 登录/注册成功后返回登录态token。有效期7天。
2041
+ */
2042
+ Token: string
1489
2043
 
1490
2044
  /**
1491
2045
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1494,54 +2048,69 @@ export interface BatchRegisterResponse {
1494
2048
  }
1495
2049
 
1496
2050
  /**
1497
- * DescribeCurrentMemberList返回参数结构体
2051
+ * 应用自定义内容
1498
2052
  */
1499
- export interface DescribeCurrentMemberListResponse {
2053
+ export interface AppCustomContent {
1500
2054
  /**
1501
- * 记录总数。当前房间的总人数。
2055
+ * 场景参数,一个应用下可以设置多个不同场景。
1502
2056
  */
1503
- Total?: number
2057
+ Scene: string
1504
2058
 
1505
2059
  /**
1506
- * 成员记录列表。
2060
+ * logo地址。
1507
2061
  */
1508
- MemberRecords?: Array<MemberRecord>
2062
+ LogoUrl?: string
1509
2063
 
1510
2064
  /**
1511
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2065
+ * 主页地址,可设置用于跳转。
1512
2066
  */
1513
- RequestId?: string
2067
+ HomeUrl?: string
2068
+
2069
+ /**
2070
+ * 自定义的js。
2071
+ */
2072
+ JsUrl?: string
2073
+
2074
+ /**
2075
+ * 自定义的css。
2076
+ */
2077
+ CssUrl?: string
1514
2078
  }
1515
2079
 
1516
2080
  /**
1517
- * LoginUser请求参数结构体
2081
+ * DeleteGroup返回参数结构体
1518
2082
  */
1519
- export interface LoginUserRequest {
2083
+ export interface DeleteGroupResponse {
1520
2084
  /**
1521
- * 注册获取的用户id
2085
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
1522
2086
  */
1523
- UserId: string
2087
+ RequestId?: string
1524
2088
  }
1525
2089
 
1526
2090
  /**
1527
- * BatchCreateRoom请求参数结构体
2091
+ * DescribeSdkAppIdUsers请求参数结构体
1528
2092
  */
1529
- export interface BatchCreateRoomRequest {
2093
+ export interface DescribeSdkAppIdUsersRequest {
1530
2094
  /**
1531
- * 低代码平台的SdkAppId。
2095
+ * 应用ID
1532
2096
  */
1533
2097
  SdkAppId: number
1534
2098
 
1535
2099
  /**
1536
- * 创建房间ID列表
2100
+ * 分页,默认值为1
1537
2101
  */
1538
- RoomInfos: Array<RoomInfo>
2102
+ Page?: number
2103
+
2104
+ /**
2105
+ * 分页数据限制,默认值为20
2106
+ */
2107
+ Limit?: number
1539
2108
  }
1540
2109
 
1541
2110
  /**
1542
- * BindDocumentToRoom返回参数结构体
2111
+ * CreateSupervisor返回参数结构体
1543
2112
  */
1544
- export interface BindDocumentToRoomResponse {
2113
+ export interface CreateSupervisorResponse {
1545
2114
  /**
1546
2115
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1547
2116
  */
@@ -1549,108 +2118,120 @@ export interface BindDocumentToRoomResponse {
1549
2118
  }
1550
2119
 
1551
2120
  /**
1552
- * 用户信息结构体
2121
+ * 场景配置
1553
2122
  */
1554
- export interface UserInfo {
1555
- /**
1556
- * 应用Id。
1557
- 注意:此字段可能返回 null,表示取不到有效值。
1558
- */
1559
- SdkAppId?: number
1560
-
1561
- /**
1562
- * 用户Id。
1563
- 注意:此字段可能返回 null,表示取不到有效值。
1564
- */
1565
- UserId?: string
1566
-
1567
- /**
1568
- * 用户昵称。
1569
- 注意:此字段可能返回 null,表示取不到有效值。
1570
- */
1571
- Name?: string
2123
+ export type SceneItem = null
1572
2124
 
2125
+ /**
2126
+ * DeleteRoom请求参数结构体
2127
+ */
2128
+ export interface DeleteRoomRequest {
1573
2129
  /**
1574
- * 用户头像Url
1575
- 注意:此字段可能返回 null,表示取不到有效值。
1576
- */
1577
- Avatar?: string
2130
+ * 房间ID
2131
+ */
2132
+ RoomId: number
1578
2133
  }
1579
2134
 
1580
2135
  /**
1581
- * SetWatermark请求参数结构体
2136
+ * RegisterUser返回参数结构体
1582
2137
  */
1583
- export interface SetWatermarkRequest {
1584
- /**
1585
- * 低代码互动课堂的SdkAppId。
1586
-
1587
- */
1588
- SdkAppId: number
1589
-
2138
+ export interface RegisterUserResponse {
1590
2139
  /**
1591
- * 老师视频区域的水印参数地址,设置为空字符串表示删除
2140
+ * 用户Id。
1592
2141
  */
1593
- TeacherUrl?: string
2142
+ UserId: string
1594
2143
 
1595
2144
  /**
1596
- * 白板视频区域的水印参数地址,设置为空字符串表示删除
2145
+ * 登录/注册成功后返回登录态token。有效期7天。
1597
2146
  */
1598
- BoardUrl?: string
2147
+ Token: string
1599
2148
 
1600
2149
  /**
1601
- * 视频默认图片(在没有视频流的时候显示),设置为空字符串表示删除
2150
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1602
2151
  */
1603
- VideoUrl?: string
2152
+ RequestId?: string
2153
+ }
1604
2154
 
2155
+ /**
2156
+ * DescribeGroup请求参数结构体
2157
+ */
2158
+ export interface DescribeGroupRequest {
1605
2159
  /**
1606
- * 白板区域水印的宽度,取值:0-100,默认为0,表示区域X方向的百分比
2160
+ * 群组ID
1607
2161
  */
1608
- BoardW?: number
2162
+ GroupId: string
1609
2163
 
1610
2164
  /**
1611
- * 白板区域水印的高度,取值:0-100,默认为0, 表示区域Y方向的百分比
2165
+ * 低代码平台应用ID
1612
2166
  */
1613
- BoardH?: number
2167
+ SdkAppId: number
2168
+ }
2169
+
2170
+ /**
2171
+ * CreateSupervisor请求参数结构体
2172
+ */
2173
+ export type CreateSupervisorRequest = null
1614
2174
 
2175
+ /**
2176
+ * 背景图片配置
2177
+ */
2178
+ export interface BackgroundPictureConfig {
1615
2179
  /**
1616
- * 白板区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
1617
- */
1618
- BoardX?: number
2180
+ * 背景图片的url
2181
+ 注意:此字段可能返回 null,表示取不到有效值。
2182
+ */
2183
+ Url: string
2184
+ }
1619
2185
 
2186
+ /**
2187
+ * DescribeCurrentMemberList返回参数结构体
2188
+ */
2189
+ export interface DescribeCurrentMemberListResponse {
1620
2190
  /**
1621
- * 白板区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
2191
+ * 记录总数。当前房间的总人数。
1622
2192
  */
1623
- BoardY?: number
2193
+ Total?: number
1624
2194
 
1625
2195
  /**
1626
- * 老师视频区域水印的宽度,取值:0-100,默认为0,表示区域X方向的百分比
2196
+ * 成员记录列表。
1627
2197
  */
1628
- TeacherW?: number
2198
+ MemberRecords?: Array<MemberRecord>
1629
2199
 
1630
2200
  /**
1631
- * 老师视频区域水印的高度,取值:0-100,默认为0, 表示区域Y方向的百分比
2201
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1632
2202
  */
1633
- TeacherH?: number
2203
+ RequestId?: string
2204
+ }
1634
2205
 
2206
+ /**
2207
+ * ModifyGroup返回参数结构体
2208
+ */
2209
+ export interface ModifyGroupResponse {
1635
2210
  /**
1636
- * 老师视频区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
2211
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1637
2212
  */
1638
- TeacherX?: number
2213
+ RequestId?: string
2214
+ }
1639
2215
 
2216
+ /**
2217
+ * DescribeGroupList返回参数结构体
2218
+ */
2219
+ export interface DescribeGroupListResponse {
1640
2220
  /**
1641
- * 老师视频区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
2221
+ * 记录总数。当前匹配群组总数。
1642
2222
  */
1643
- TeacherY?: number
2223
+ Total?: number
1644
2224
 
1645
2225
  /**
1646
- * 文字水印内容,设置为空字符串表示删除
1647
- */
1648
- Text?: string
2226
+ * 群组信息列表。
2227
+ 注意:此字段可能返回 null,表示取不到有效值。
2228
+ */
2229
+ GroupInfos?: Array<GroupInfo>
1649
2230
 
1650
2231
  /**
1651
- * 文字水印颜色
2232
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1652
2233
  */
1653
- TextColor?: string
2234
+ RequestId?: string
1654
2235
  }
1655
2236
 
1656
2237
  /**
@@ -1669,9 +2250,9 @@ export interface CreateRoomResponse {
1669
2250
  }
1670
2251
 
1671
2252
  /**
1672
- * DeleteRecord返回参数结构体
2253
+ * AddGroupMember返回参数结构体
1673
2254
  */
1674
- export interface DeleteRecordResponse {
2255
+ export interface AddGroupMemberResponse {
1675
2256
  /**
1676
2257
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1677
2258
  */
@@ -1679,62 +2260,18 @@ export interface DeleteRecordResponse {
1679
2260
  }
1680
2261
 
1681
2262
  /**
1682
- * DescribeRoom请求参数结构体
1683
- */
1684
- export interface DescribeRoomRequest {
1685
- /**
1686
- * 房间Id。
1687
- */
1688
- RoomId: number
1689
- }
1690
-
1691
- /**
1692
- * DescribeDocument请求参数结构体
1693
- */
1694
- export interface DescribeDocumentRequest {
1695
- /**
1696
- * 文档Id(唯一id)
1697
- */
1698
- DocumentId: string
1699
- }
1700
-
1701
- /**
1702
- * RegisterUser请求参数结构体
1703
- */
1704
- export interface RegisterUserRequest {
1705
- /**
1706
- * 低代码互动课堂的SdkAppId。
1707
- */
1708
- SdkAppId: number
1709
-
1710
- /**
1711
- * 用户名称。
1712
- */
1713
- Name?: string
1714
-
1715
- /**
1716
- * 用户在客户系统的Id,需要在同一应用下唯一。
1717
- */
1718
- OriginId?: string
1719
-
1720
- /**
1721
- * 用户头像。
1722
- */
1723
- Avatar?: string
1724
- }
1725
-
1726
- /**
1727
- * BatchDeleteRecord返回参数结构体
2263
+ * 文字水印配置
1728
2264
  */
1729
- export interface BatchDeleteRecordResponse {
2265
+ export interface TextMarkConfig {
1730
2266
  /**
1731
- * 本次操作删除成功的房间ID列表。如果入参列表中某个房间ID的录制文件已经删除,则出参列表中无对应的房间ID。
2267
+ * 文字水印内容
1732
2268
  注意:此字段可能返回 null,表示取不到有效值。
1733
2269
  */
1734
- RoomIds?: Array<number>
2270
+ Text?: string
1735
2271
 
1736
2272
  /**
1737
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1738
- */
1739
- RequestId?: string
2273
+ * 文字水印颜色
2274
+ 注意:此字段可能返回 null,表示取不到有效值。
2275
+ */
2276
+ Color?: string
1740
2277
  }