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