@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
2,956 lines (2,940 loc) • 80.7 kB
TypeScript
/**
* CreateRoom请求参数结构体
*/
export interface CreateRoomRequest {
/**
* 房间名称。
*/
Name: string;
/**
* 预定的房间开始时间，unix时间戳（秒）。
*/
StartTime: number;
/**
* 预定的房间结束时间，unix时间戳（秒）。
*/
EndTime: number;
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
/**
* 分辨率。可以有如下取值：
1 标清
2 高清
3 全高清
*/
Resolution: number;
/**
* 设置房间/课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。取值范围[0,16]，当取值为0时表示当前课堂/直播，不支持连麦互动。
*/
MaxMicNumber: number;
/**
* 房间子类型，可以有以下取值：
videodoc 文档+视频
video 纯视频
*/
SubType: string;
/**
* 老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。
*/
TeacherId?: string;
/**
* 进入课堂时是否自动连麦。可以有以下取值：
0 不自动连麦（需要手动申请上麦，默认值）
1 自动连麦
*/
AutoMic?: number;
/**
* 释放音视频权限后是否自动取消连麦。可以有以下取值：
0 自动取消连麦（默认值）
1 保持连麦状态
*/
TurnOffMic?: number;
/**
* 声音音质。可以有以下取值：
0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。
*/
AudioQuality?: number;
/**
* 上课后是否禁止自动录制。可以有以下取值：
0 不禁止录制（自动开启录制，默认值）
1 禁止录制
注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。
*/
DisableRecord?: number;
/**
* 助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。
*/
Assistants?: Array<string>;
/**
* rtc人数。
*/
RTCAudienceNumber?: number;
/**
* 观看类型。互动观看 （默认）
*/
AudienceType?: number;
/**
* 录制模板。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744
*/
RecordLayout?: number;
/**
* 房间绑定的群组ID,非空时限制组成员进入
*/
GroupId?: string;
/**
* 是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
0 不允许直接控制（需同意，默认值）
1 允许直接控制（无需同意）
*/
EnableDirectControl?: number;
/**
* 开启专注模式。
0 收看全部角色音视频(默认)
1 只看老师和助教
*/
InteractionMode?: number;
/**
* 横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型
*/
VideoOrientation?: number;
/**
* 开启课后评分。 0：不开启(默认) 1：开启
*/
IsGradingRequiredPostClass?: number;
/**
* 房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (预留参数，暂未开放)
*/
RoomType?: number;
/**
* 拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟
*/
EndDelayTime?: number;
/**
* 直播方式：0 常规模式（默认）1 回放直播模式（伪直播）
*/
LiveType?: number;
/**
* 伪直播链接
*/
RecordLiveUrl?: string;
/**
* 是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1的时候有效
*/
EnableAutoStart?: number;
/**
* 录制文件背景图片，支持png、jpg、jpeg、bmp格式，暂不支持透明通道
*/
RecordBackground?: string;
}
/**
* DescribeQuestionList请求参数结构体
*/
export interface DescribeQuestionListRequest {
/**
* 房间ID
*/
RoomId: number;
/**
* 分页查询当前页数，从1开始递增，默认值为1
*/
Page?: number;
/**
* 分页查询当前页数，从1开始递增，默认值为1
*/
Limit?: number;
}
/**
* ModifyRoom返回参数结构体
*/
export interface ModifyRoomResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAppDetail返回参数结构体
*/
export interface DescribeAppDetailResponse {
/**
* SDK 对应的AppId
*/
SdkAppId?: string;
/**
* 应用配置
*/
AppConfig?: AppConfig;
/**
* 场景配置
*/
SceneConfig?: Array<SceneItem>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteSupervisor请求参数结构体
*/
export interface DeleteSupervisorRequest {
/**
* 应用ID
*/
SdkAppId: number;
/**
* 用户ID列表
*/
Users: Array<string>;
}
/**
* DeleteUser请求参数结构体
*/
export interface DeleteUserRequest {
/**
* 待删除用户的ID
*/
UserId: string;
}
/**
* 水印配置
*/
export interface WatermarkConfig {
/**
* 水印图片的url
注意：此字段可能返回 null，表示取不到有效值。
*/
Url?: string;
/**
* 水印宽。为比例值
注意：此字段可能返回 null，表示取不到有效值。
*/
Width?: number;
/**
* 水印高。为比例值
注意：此字段可能返回 null，表示取不到有效值。
*/
Height?: number;
/**
* 水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间。
注意：此字段可能返回 null，表示取不到有效值。
*/
LocationX?: number;
/**
* 水印Y偏移, 取值:0-100, 表示区域Y方向的百分比。比如50，则表示位于Y轴中间。
注意：此字段可能返回 null，表示取不到有效值。
*/
LocationY?: number;
}
/**
* DescribeSupervisors返回参数结构体
*/
export interface DescribeSupervisorsResponse {
/**
* 数据总量
*/
Total?: number;
/**
* 分页查询当前页数
*/
Page?: number;
/**
* 当前页数据量
*/
Limit?: number;
/**
* 巡课列表
*/
UserIds?: Array<string>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteUser返回参数结构体
*/
export interface DeleteUserResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BatchDeleteRecord请求参数结构体
*/
export interface BatchDeleteRecordRequest {
/**
* 房间ID列表
*/
RoomIds: Array<number | bigint>;
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
}
/**
* ModifyApp返回参数结构体
*/
export interface ModifyAppResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BatchRegister请求参数结构体
*/
export interface BatchRegisterRequest {
/**
* 批量注册用户信息列表
*/
Users: Array<BatchUserRequest>;
}
/**
* DeleteRoom返回参数结构体
*/
export interface DeleteRoomResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyUserProfile请求参数结构体
*/
export interface ModifyUserProfileRequest {
/**
* 待修改用户ID
*/
UserId: string;
/**
* 待修改的用户名
*/
Nickname?: string;
/**
* 待修改头像url
*/
Avatar?: string;
}
/**
* CreateGroupWithMembers请求参数结构体
*/
export interface CreateGroupWithMembersRequest {
/**
* 待创建群组名称
*/
GroupName: string;
/**
* 低代码平台应用ID
*/
SdkAppId: number;
/**
* 默认绑定主讲老师ID
*/
TeacherId?: string;
/**
* 群组成员列表,一次性最多200个
*/
MemberIds?: Array<string>;
}
/**
* DescribeDocumentsByRoom请求参数结构体
*/
export interface DescribeDocumentsByRoomRequest {
/**
* 房间ID。
*/
RoomId: number;
/**
* 低代码互动课堂的SdkAppId
*/
SdkAppId: number;
/**
* 分页查询当前页数，从1开始递增，默认值为1
*/
Page?: number;
/**
* 每页数据量，最大1000，默认值为100
*/
Limit?: number;
/**
* 课件权限。
[0]：获取owner的私有课件；
[1]：获取owner的公开课件;
[0,1]：则获取owner的私有课件和公开课件；
[2]：获取owner的私有课件和所有人(包括owner)的公开课件。
默认值为[2]
*/
Permission?: Array<number | bigint>;
/**
* 文档所有者的user_id，不填默认获取SdkAppId下所有课件
*/
Owner?: string;
}
/**
* BatchCreateGroupWithMembers返回参数结构体
*/
export interface BatchCreateGroupWithMembersResponse {
/**
* 新创建群组ID列表，与输入创建参数顺序一致
*/
GroupIds?: Array<string>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetRoomEvent返回参数结构体
*/
export interface GetRoomEventResponse {
/**
* 该房间的事件总数，keyword搜索不影响该值。
*/
Total?: number;
/**
* 详细事件内容。包含相应的类型、发生的时间戳。
注意：此字段可能返回 null，表示取不到有效值。
*/
Events?: Array<EventInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 成员记录信息。
*/
export interface MemberRecord {
/**
* 用户ID。
*/
UserId: string;
/**
* 用户名称。
*/
UserName: string;
/**
* 在线时长，单位秒。
*/
PresentTime: number;
/**
* 是否开启摄像头。
*/
Camera: number;
/**
* 是否开启麦克风。
*/
Mic: number;
/**
* 是否禁言。
*/
Silence: number;
/**
* 回答问题数量。
*/
AnswerQuestions: number;
/**
* 举手数量。
*/
HandUps: number;
/**
* 首次进入房间的unix时间戳。
*/
FirstJoinTimestamp: number;
/**
* 最后一次退出房间的unix时间戳。
*/
LastQuitTimestamp: number;
/**
* 奖励次数。
*/
Rewords: number;
/**
* 用户IP。
*/
IPAddress?: string;
/**
* 用户位置信息。
*/
Location?: string;
/**
* 用户设备平台信息。0:unknown 1:windows 2:mac 3:android 4:ios 5:web 6:h5 7:miniprogram （小程序）
*/
Device?: number;
/**
* 每个成员上麦次数。
*/
PerMemberMicCount?: number;
/**
* 每个成员发送消息数量。
*/
PerMemberMessageCount?: number;
/**
* 用户角色。0代表学生；1代表老师； 2助教；3巡课。
*/
Role?: number;
/**
* 上课班号
*/
GroupId?: string;
/**
* 子上课班号
注意：此字段可能返回 null，表示取不到有效值。
*/
SubGroupId?: Array<string>;
/**
* 用户的上台状态
注意：此字段可能返回 null，表示取不到有效值。
*/
Stage?: number;
/**
* 用户状态。0为未到，1为在线，2为离线，3为被踢，4为永久被踢，5为暂时掉线
注意：此字段可能返回 null，表示取不到有效值。
*/
CurrentState?: number;
}
/**
* DeleteAppCustomContent请求参数结构体
*/
export interface DeleteAppCustomContentRequest {
/**
* 应用ID。
*/
SdkAppId: number;
/**
* 指定需要删除的已设置的scene场景自定义元素，如果为空则删除应用下已设置的所有自定义元素。
*/
Scenes?: Array<string>;
}
/**
* SendRoomNotificationMessage返回参数结构体
*/
export interface SendRoomNotificationMessageResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BatchAddGroupMember返回参数结构体
*/
export interface BatchAddGroupMemberResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyUserProfile返回参数结构体
*/
export interface ModifyUserProfileResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetWatermark返回参数结构体
*/
export interface GetWatermarkResponse {
/**
* 老师视频区域的水印参数配置
注意：此字段可能返回 null，表示取不到有效值。
*/
TeacherLogo?: WatermarkConfig;
/**
* 白板区域的水印参数配置
注意：此字段可能返回 null，表示取不到有效值。
*/
BoardLogo?: WatermarkConfig;
/**
* 背景图片配置
注意：此字段可能返回 null，表示取不到有效值。
*/
BackgroundPicture?: BackgroundPictureConfig;
/**
* 文字水印配置
注意：此字段可能返回 null，表示取不到有效值。
*/
Text?: TextMarkConfig;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* LoginOriginId请求参数结构体
*/
export interface LoginOriginIdRequest {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
/**
* 用户在客户系统的Id，需要在同一应用下唯一。
*/
OriginId: string;
}
/**
* BatchRegister返回参数结构体
*/
export interface BatchRegisterResponse {
/**
* 注册成功的用户列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Users?: Array<BatchUserInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindDocumentToRoom返回参数结构体
*/
export interface BindDocumentToRoomResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateGroupWithSubGroup请求参数结构体
*/
export interface CreateGroupWithSubGroupRequest {
/**
* 待创建的新群组名
*/
GroupName: string;
/**
* 低代码平台应用ID
*/
SdkAppId: number;
/**
* 子群组ID列表，子群组ID不能重复，最多40个
*/
SubGroupIds: Array<string>;
/**
* 群组默认主讲老师ID
*/
TeacherId?: string;
}
/**
* 房间列表
*/
export interface RoomItem {
/**
* 名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 房间ID
注意：此字段可能返回 null，表示取不到有效值。
*/
RoomId?: number;
/**
* 房间状态。0 未开始 ；1进行中 ；2 已结束；3已过期
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: number;
/**
* 开始时间
注意：此字段可能返回 null，表示取不到有效值。
*/
StartTime?: number;
/**
* 结束时间
注意：此字段可能返回 null，表示取不到有效值。
*/
EndTime?: number;
/**
* 实际开始时间
注意：此字段可能返回 null，表示取不到有效值。
*/
RealStartTime?: number;
/**
* 实际结束时间
注意：此字段可能返回 null，表示取不到有效值。
*/
RealEndTime?: number;
/**
* 分辨率。1 标清
2 高清
3 全高清
注意：此字段可能返回 null，表示取不到有效值。
*/
Resolution?: number;
/**
* 最大允许连麦人数
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxRTCMember?: number;
/**
* 房间录制地址。已废弃，使用新字段 RecordUrl
注意：此字段可能返回 null，表示取不到有效值。
*/
ReplayUrl?: string;
/**
* 录制地址（协议为https)。仅在房间结束后存在。
注意：此字段可能返回 null，表示取不到有效值。
*/
RecordUrl?: string;
/**
* 最高房间内人数（不包括老师），0表示不限制，默认为0
注意：此字段可能返回 null，表示取不到有效值。
*/
MaxMicNumber?: number;
/**
* 打开学生麦克风/摄像头的授权开关
注意：此字段可能返回 null，表示取不到有效值。
*/
EnableDirectControl?: number;
/**
* 开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教
注意：此字段可能返回 null，表示取不到有效值。
*/
InteractionMode?: number;
/**
* 横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型
注意：此字段可能返回 null，表示取不到有效值。
*/
VideoOrientation?: number;
/**
* 开启课后评分。 0：不开启(默认) 1：开启
注意：此字段可能返回 null，表示取不到有效值。
*/
IsGradingRequiredPostClass?: number;
/**
* 房间类型。0:小班课（默认值）；1:大班课；2:1V1（后续扩展）
注意：此字段可能返回 null，表示取不到有效值。
*/
RoomType?: number;
/**
* 拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟
注意：此字段可能返回 null，表示取不到有效值。
*/
EndDelayTime?: number;
/**
* 直播方式：0 常规模式（默认）1 回放直播模式（伪直播）
注意：此字段可能返回 null，表示取不到有效值。
*/
LiveType?: number;
/**
* 伪直播回放链接
注意：此字段可能返回 null，表示取不到有效值。
*/
RecordLiveUrl?: string;
/**
* 是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1的时候有效
注意：此字段可能返回 null，表示取不到有效值。
*/
EnableAutoStart?: number;
/**
* 录制文件背景图片，支持png、jpg、jpeg、bmp格式，暂不支持透明通道
注意：此字段可能返回 null，表示取不到有效值。
*/
RecordBackground?: string;
}
/**
* 课堂评分字段
*/
export interface ClassScoreItem {
/**
* 课堂iD
注意：此字段可能返回 null，表示取不到有效值。
*/
RoomId?: number;
/**
* 用户ID
注意：此字段可能返回 null，表示取不到有效值。
*/
UserId?: string;
/**
* 评分时间
注意：此字段可能返回 null，表示取不到有效值。
*/
CreateTime?: number;
/**
* 课堂评分
注意：此字段可能返回 null，表示取不到有效值。
*/
Score?: number;
/**
* 课堂评价
注意：此字段可能返回 null，表示取不到有效值。
*/
ScoreMsg?: string;
}
/**
* DescribeRoom请求参数结构体
*/
export interface DescribeRoomRequest {
/**
* 房间Id。
*/
RoomId: number;
}
/**
* BatchDescribeDocument请求参数结构体
*/
export interface BatchDescribeDocumentRequest {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
/**
* 分页查询当前页数，从1开始递增
*/
Page: number;
/**
* 每页数据量，最大1000
*/
Limit: number;
/**
* 课件权限。[0]：获取owner的私有课件；[1]：获取owner的公开课件; [0,1]：则获取owner的私有课件和公开课件；[2]：获取owner的私有课件和所有人(包括owner)的公开课件
*/
Permission: Array<number | bigint>;
/**
* 课件所有者的user_id，不填默认获取SdkAppId下所有课件
*/
Owner?: string;
/**
* 课件名称搜索词
*/
Keyword?: string;
/**
* 课件id列表，从列表中查询，忽略错误的id
*/
DocumentId?: Array<string>;
}
/**
* RegisterUser请求参数结构体
*/
export interface RegisterUserRequest {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
/**
* 用户名称。
*/
Name?: string;
/**
* 用户在客户系统的Id，需要在同一应用下唯一。
*/
OriginId?: string;
/**
* 用户头像。
*/
Avatar?: string;
}
/**
* BatchCreateRoom返回参数结构体
*/
export interface BatchCreateRoomResponse {
/**
* 创建成功课堂ID，与传入课堂信息顺序一致
*/
RoomIds?: Array<number | bigint>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UnbindDocumentFromRoom返回参数结构体
*/
export interface UnbindDocumentFromRoomResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateDocument返回参数结构体
*/
export interface CreateDocumentResponse {
/**
* 文档ID。
*/
DocumentId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeGroup返回参数结构体
*/
export interface DescribeGroupResponse {
/**
* 群组ID
*/
GroupId?: string;
/**
* 群组名称
*/
GroupName?: string;
/**
* 群主主讲人ID
注意：此字段可能返回 null，表示取不到有效值。
*/
TeacherId?: string;
/**
* 群组类型
0-基础群组
1-组合群组，若为1时会返回子群组ID
*/
GroupType?: number;
/**
* 子群组ID列表
注意：此字段可能返回 null，表示取不到有效值。
*/
SubGroupIds?: Array<string>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SetAppCustomContent返回参数结构体
*/
export interface SetAppCustomContentResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 用户注册请求信息
*/
export interface BatchUserRequest {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
/**
* 用户名称。
*/
Name?: string;
/**
* 用户在客户系统的Id，需要在同一应用下唯一。
*/
OriginId?: string;
/**
* 用户头像。
*/
Avatar?: string;
}
/**
* LoginUser返回参数结构体
*/
export interface LoginUserResponse {
/**
* 用户Id。
*/
UserId?: string;
/**
* 注册成功后返回登录态token，有效期7天。token过期后可以通过调用“登录”或“源账号登录”进行更新。
*/
Token?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyGroup请求参数结构体
*/
export interface ModifyGroupRequest {
/**
* 需要修改的群组ID
*/
GroupId: string;
/**
* 低代码平台应用ID
*/
SdkAppId: number;
/**
* 默认绑定主讲老师ID
*/
TeacherId?: string;
/**
* 待修改的群组名称
*/
GroupName?: string;
}
/**
* DescribeAppDetail请求参数结构体
*/
export interface DescribeAppDetailRequest {
/**
* 应用ID。低代码互动课堂的SdkAppId。
*/
ApplicationId: string;
/**
* 开发商ID
*/
DeveloperId: string;
}
/**
* KickUserFromRoom返回参数结构体
*/
export interface KickUserFromRoomResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteGroup请求参数结构体
*/
export interface DeleteGroupRequest {
/**
* 待删除群组ID列表
*/
GroupIds: Array<string>;
/**
* 低代码平台应用ID
*/
SdkAppId: number;
}
/**
* StartRoom请求参数结构体
*/
export interface StartRoomRequest {
/**
* 房间ID。
*/
RoomId: number;
}
/**
* AddGroupMember请求参数结构体
*/
export interface AddGroupMemberRequest {
/**
* 群组ID
*/
GroupId: string;
/**
* 低代码平台应用ID
*/
SdkAppId: number;
/**
* 成员列表，最大值200
*/
MemberIds: Array<string>;
}
/**
* DescribeGroupList请求参数结构体
*/
export interface DescribeGroupListRequest {
/**
* 低代码平台应用ID
*/
SdkAppId: number;
/**
* 分页查询当前页数，默认从1开始递增。
*/
Page?: number;
/**
* 每页数据量，默认20，最大1000。
*/
Limit?: number;
/**
* 主讲人ID筛选群组，与MemberId有且只有一个,都传时以此字段获取
*/
TeacherId?: string;
/**
* 成员ID刷选群组，与TeacherId有且只有一个
*/
MemberId?: string;
}
/**
* GetRoomMessage请求参数结构体
*/
export interface GetRoomMessageRequest {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
/**
* 房间Id。
*/
RoomId: number;
/**
* 消息序列。获取该序列以前的消息(不包含该seq消息)
*/
Seq?: number;
/**
* 消息拉取的条数。最大数量不能超过套餐包限制。
*/
Limit?: number;
}
/**
* DescribeDocuments返回参数结构体
*/
export interface DescribeDocumentsResponse {
/**
* 符合查询条件文档总数
*/
Total?: number;
/**
* 文档信息列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Documents?: Array<DocumentInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 文档信息
*/
export interface DocumentInfo {
/**
* 文档Id
注意：此字段可能返回 null，表示取不到有效值。
*/
DocumentId?: string;
/**
* 文档原址url
注意：此字段可能返回 null，表示取不到有效值。
*/
DocumentUrl?: string;
/**
* 文档名称
注意：此字段可能返回 null，表示取不到有效值。
*/
DocumentName?: string;
/**
* 文档所有者UserId
注意：此字段可能返回 null，表示取不到有效值。
*/
Owner?: string;
/**
* 应用Id
注意：此字段可能返回 null，表示取不到有效值。
*/
SdkAppId?: number;
/**
* 文档权限，0：私有课件 1：公共课件
注意：此字段可能返回 null，表示取不到有效值。
*/
Permission?: number;
/**
* 转码结果，无需转码为空，转码成功为结果url，转码失败为错误码
注意：此字段可能返回 null，表示取不到有效值。
*/
TranscodeResult?: string;
/**
* 转码类型
注意：此字段可能返回 null，表示取不到有效值。
*/
TranscodeType?: number;
/**
* 转码进度， 0 - 100 表示（0% - 100%）
注意：此字段可能返回 null，表示取不到有效值。
*/
TranscodeProgress?: number;
/**
* 转码状态，0为无需转码，1为正在转码，2为转码失败，3为转码成功
注意：此字段可能返回 null，表示取不到有效值。
*/
TranscodeState?: number;
/**
* 转码失败后的错误信息
注意：此字段可能返回 null，表示取不到有效值。
*/
TranscodeInfo?: string;
/**
* 文档类型
注意：此字段可能返回 null，表示取不到有效值。
*/
DocumentType?: string;
/**
* 文档大小，单位：字节
注意：此字段可能返回 null，表示取不到有效值。
*/
DocumentSize?: number;
/**
* 更新的UNIX时间戳
注意：此字段可能返回 null，表示取不到有效值。
*/
UpdateTime?: number;
/**
* 课件页数
注意：此字段可能返回 null，表示取不到有效值。
*/
Pages?: number;
/**
* 宽，仅在静态转码的课件有效
注意：此字段可能返回 null，表示取不到有效值。
*/
Width?: number;
/**
* 高，仅在静态转码的课件有效
注意：此字段可能返回 null，表示取不到有效值。
*/
Height?: number;
/**
* 封面，仅转码的课件会生成封面
注意：此字段可能返回 null，表示取不到有效值。
*/
Cover?: string;
/**
* 课件预览地址
注意：此字段可能返回 null，表示取不到有效值。
*/
Preview?: string;
}
/**
* DeleteDocument返回参数结构体
*/
export interface DeleteDocumentResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteRecord请求参数结构体
*/
export interface DeleteRecordRequest {
/**
* 房间Id。
*/
RoomId: number;
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
}
/**
* BatchDeleteGroupMember返回参数结构体
*/
export interface BatchDeleteGroupMemberResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateGroupWithSubGroup返回参数结构体
*/
export interface CreateGroupWithSubGroupResponse {
/**
* 新创建群组ID
*/
GroupId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDocuments请求参数结构体
*/
export interface DescribeDocumentsRequest {
/**
* 学校id
*/
SchoolId: number;
/**
* 分页查询当前页数，从1开始递增
*/
Page: number;
/**
* 每页数据量，最大1000
*/
Limit: number;
/**
* 课件权限。[0]：获取owner的私有课件；[1]：获取owner的公开课件; [0,1]：则获取owner的私有课件和公开课件；[2]：获取owner的私有课件和所有人(包括owner)的公开课件
*/
Permission: Array<number | bigint>;
/**
* 课件所有者的user_id，不填默认获取school_id下所有课件
*/
Owner?: string;
/**
* 课件名称搜索词
*/
Keyword?: string;
/**
* 课件id列表，从列表中查询，忽略错误的id
*/
DocumentId?: Array<string>;
}
/**
* 单条消息体内容
*/
export interface MessageItem {
/**
* 消息类型。0表示文本消息，1表示图片消息
注意：此字段可能返回 null，表示取不到有效值。
*/
MessageType?: number;
/**
* 文本消息内容。message type为0时有效。
注意：此字段可能返回 null，表示取不到有效值。
*/
TextMessage?: string;
/**
* 图片消息URL。 message type为1时有效。
注意：此字段可能返回 null，表示取不到有效值。
*/
ImageMessage?: string;
}
/**
* 获取群组列表返回的群组信息
*/
export interface GroupInfo {
/**
* 群组ID
注意：此字段可能返回 null，表示取不到有效值。
*/
GroupId?: string;
/**
* 群组名称
注意：此字段可能返回 null，表示取不到有效值。
*/
GroupName?: string;
/**
* 群组主讲人ID
注意：此字段可能返回 null，表示取不到有效值。
*/
TeacherId?: string;
/**
* 群组类型
0-基础群组
1-组合群组，若为1时会返回子群组ID列表
注意：此字段可能返回 null，表示取不到有效值。
*/
GroupType?: number;
/**
* 子群组ID列表，如有。
注意：此字段可能返回 null，表示取不到有效值。
*/
SubGroupIds?: string;
}
/**
* GetRoomEvent请求参数结构体
*/
export interface GetRoomEventRequest {
/**
* 房间Id。
*/
RoomId: number;
/**
* 应用Id。
*/
SdkAppId: number;
/**
* 起始页，1开始。keyword为空时有效。
*/
Page: number;
/**
* 每页个数。keyword为空时有效。一次性最多200条。
*/
Limit: number;
/**
* 搜索事件类型。有以下事件类型:
RoomStart:房间开始
RoomEnd:房间结束
MemberJoin:成员加入
MemberQuit:成员退出
RecordFinish:录制结束
CameraOn: 摄像头打开
CameraOff: 摄像头关闭
MicOn: 麦克风打开
MicOff: 麦克风关闭
ScreenOn: 屏幕共享打开
ScreenOff: 屏幕共享关闭
VisibleOn: 页面可见
VisibleOff: 页面不可见
*/
Keyword?: string;
}
/**
* DescribeDocument返回参数结构体
*/
export interface DescribeDocumentResponse {
/**
* 文档Id
*/
DocumentId?: string;
/**
* 文档原址url
*/
DocumentUrl?: string;
/**
* 文档名称
*/
DocumentName?: string;
/**
* 文档所有者UserId
*/
Owner?: string;
/**
* 应用Id
*/
SdkAppId?: number;
/**
* 文档权限
*/
Permission?: number;
/**
* 转码结果，无需转码为空，转码成功为结果url，转码失败为错误码
*/
TranscodeResult?: string;
/**
* 转码类型
*/
TranscodeType?: number;
/**
* 转码进度， 0 - 100 表示（0% - 100%）
*/
TranscodeProgress?: number;
/**
* 转码状态，0为无需转码，1为正在转码，2为转码失败，3为转码成功
*/
TranscodeState?: number;
/**
* 转码失败后的错误信息
*/
TranscodeInfo?: string;
/**
* 文档类型
*/
DocumentType?: string;
/**
* 文档大小，单位：字节
*/
DocumentSize?: number;
/**
* 更新的UNIX时间戳
*/
UpdateTime?: number;
/**
* 课件页数
*/
Pages?: number;
/**
* 课件预览地址
*/
Preview?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteGroupMember返回参数结构体
*/
export interface DeleteGroupMemberResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeGroupMemberList返回参数结构体
*/
export interface DescribeGroupMemberListResponse {
/**
* 符合查询条件总条数
*/
Total?: number;
/**
* 查询成员列表
注意：此字段可能返回 null，表示取不到有效值。
*/
MemberIds?: Array<string>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ForbidSendMsg请求参数结构体
*/
export interface ForbidSendMsgRequest {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
/**
* 房间ID。
*/
RoomId: number;
/**
* 需要禁言的用户账号，最多支持500个账号
*/
MembersAccount: Array<string>;
/**
* 需禁言时间，单位为秒，为0时表示取消禁言，4294967295为永久禁言。
*/
MuteTime: number;
}
/**
* DescribeRoomForbiddenUser请求参数结构体
*/
export interface DescribeRoomForbiddenUserRequest {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
/**
* 房间ID。
*/
RoomId: number;
}
/**
* 房间事件信息。
*/
export interface EventInfo {
/**
* 事件发生的秒级unix时间戳。
*/
Timestamp?: number;
/**
* 事件类型,有以下值:
RoomStart:房间开始 RoomEnd:房间结束 MemberJoin:成员加入 MemberQuit:成员退出 RecordFinish:录制结束
CameraOn: 摄像头打开
CameraOff: 摄像头关闭
MicOn: 麦克风打开
MicOff: 麦克风关闭
ScreenOn: 屏幕共享打开
ScreenOff: 屏幕共享关闭
VisibleOn: 页面可见
VisibleOff: 页面不可见
*/
EventType?: string;
/**
* 事件详细内容，包含房间号,成员类型事件包含用户Id。
注意：此字段可能返回 null，表示取不到有效值。
*/
EventData?: EventDataInfo;
}
/**
* DescribeScoreList请求参数结构体
*/
export interface DescribeScoreListRequest {
/**
* 课堂ID
*/
RoomId: number;
/**
* 分页查询当前页数，从1开始递增
*/
Page?: number;
/**
* 默认是10条
*/
Limit?: number;
}
/**
* 应用配置信息
*/
export declare type AppConfig = null;
/**
* DeleteRecord返回参数结构体
*/
export interface DeleteRecordResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAnswerList请求参数结构体
*/
export interface DescribeAnswerListRequest {
/**
* 问题ID
*/
QuestionId: string;
/**
* 1
*/
Page?: number;
/**
* 100
*/
Limit?: number;
}
/**
* BatchCreateRoom请求参数结构体
*/
export interface BatchCreateRoomRequest {
/**
* 低代码平台的SdkAppId。
*/
SdkAppId: number;
/**
* 创建房间ID列表
*/
RoomInfos: Array<RoomInfo>;
}
/**
* DescribeGroupMemberList请求参数结构体
*/
export interface DescribeGroupMemberListRequest {
/**
* 群组ID
*/
GroupId: string;
/**
* 低代码平台应用ID
*/
SdkAppId: number;
/**
* 分页值，默认1
*/
Page?: number;
/**
* 每页数据量，默认20，最大1000
*/
Limit?: number;
}
/**
* DescribeRoomForbiddenUser返回参数结构体
*/
export interface DescribeRoomForbiddenUserResponse {
/**
* 禁言用户信息数组，内容包括被禁言的成员 ID，及其被禁言到的时间（使用 UTC 时间，即世界协调时间）
注意：此字段可能返回 null，表示取不到有效值。
*/
MutedAccountList?: Array<MutedAccountList>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 用户信息结构体
*/
export interface UserInfo {
/**
* 应用Id。
注意：此字段可能返回 null，表示取不到有效值。
*/
SdkAppId?: number;
/**
* 用户Id。
注意：此字段可能返回 null，表示取不到有效值。
*/
UserId?: string;
/**
* 用户昵称。
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 用户头像Url。
注意：此字段可能返回 null，表示取不到有效值。
*/
Avatar?: string;
/**
* 用户在客户系统的Id
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginId?: string;
}
/**
* DescribeUser返回参数结构体
*/
export interface DescribeUserResponse {
/**
* 应用Id。
*/
SdkAppId?: number;
/**
* 用户Id。
*/
UserId?: string;
/**
* 用户昵称。
*/
Name?: string;
/**
* 用户头像Url。
*/
Avatar?: string;
/**
* 用户在客户系统的Id
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeScoreList返回参数结构体
*/
export interface DescribeScoreListResponse {
/**
* 总数
*/
Total?: number;
/**
* 课堂评分列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Scores?: Array<ClassScoreItem>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDocument请求参数结构体
*/
export interface DescribeDocumentRequest {
/**
* 文档Id（唯一id）
*/
DocumentId: string;
}
/**
* BatchDeleteRecord返回参数结构体
*/
export interface BatchDeleteRecordResponse {
/**
* 本次操作删除成功的房间ID列表。如果入参列表中某个房间ID的录制文件已经删除，则出参列表中无对应的房间ID。
注意：此字段可能返回 null，表示取不到有效值。
*/
RoomIds?: Array<number | bigint>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 表情消息
*/
export interface FaceMsgContent {
/**
* 表情索引，用户自定义。
*/
Index: number;
/**
* 额外数据。
*/
Data?: string;
}
/**
* SetAppCustomContent请求参数结构体
*/
export interface SetAppCustomContentRequest {
/**
* 自定义内容。
*/
CustomContent: Array<AppCustomContent>;
/**
* 应用ID。
*/
SdkAppId: number;
}
/**
* DescribeUser请求参数结构体
*/
export interface DescribeUserRequest {
/**
* 用户Id。
*/
UserId: string;
}
/**
* RegisterUser返回参数结构体
*/
export interface RegisterUserResponse {
/**
* 用户Id。
*/
UserId: string;
/**
* 登录/注册成功后返回登录态token。有效期7天。
*/
Token: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StartRoom返回参数结构体
*/
export interface StartRoomResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindDocumentToRoom请求参数结构体
*/
export interface BindDocumentToRoomRequest {
/**
* 房间ID。
*/
RoomId: number;
/**
* 文档ID。
*/
DocumentId: string;
/**
* 绑定类型。后台可透传到客户端，默认为0。客户端可以根据这个字段实现业务逻辑。
*/
BindType?: number;
}
/**
* CreateDocument请求参数结构体
*/
export interface CreateDocumentRequest {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
/**
* 文档地址。
*/
DocumentUrl: string;
/**
* 文档名称。
*/
DocumentName: string;
/**
* 文档所有者的Id
*/
Owner: string;
/**
* 转码类型，可以有如下取值：
0 无需转码（默认），bmp，jpg，jpeg，png，gif
1 需要转码的文档，ppt，pptx，pdf，doc，docx，xls，xlsx
2 需要转码的视频，mp4，3pg，mpeg，avi，flv，wmv，rm，h264等
2 需要转码的音频，mp3，wav，wma，aac，flac，opus
*/
TranscodeType?: number;
/**
* 权限，可以有如下取值：
0 私有文档（默认）
1 公共文档
*/
Permission?: number;
/**
* 文档后缀名。
*/
DocumentType?: string;
/**
* 文档大小，单位 字节
*/
DocumentSize?: number;
/**
* 是否对不支持元素开启自动处理的功能。默认关闭。
自动处理的元素如下：
1. 墨迹：移除不支持的墨迹（例如WPS墨迹）
2. 自动翻页：移除PPT上所有自动翻页设置，并设置为单击鼠标翻页
3. 已损坏音视频：移除PPT上对损坏音视频的引用
*/
AutoHandleUnsupportedElement?: boolean;
}
/**
* GetRoomMessage返回参数结构体
*/
export interface GetRoomMessageResponse {
/**
* 消息列表
*/
Messages?: Array<MessageList>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 批量注册用户信息
*/
export interface BatchUserInfo {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId?: number;
/**
* 用户ID。
注意：此字段可能返回 null，表示取不到有效值。
*/
UserId?: string;
/**
* 用户在客户系统的Id。 若用户注册时该字段为空，则默认为 UserId 值一致。
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginId?: string;
}
/**
* BatchAddGroupMember请求参数结构体
*/
export interface BatchAddGroupMemberRequest {
/**
* 待添加群组ID列表，最大值100
*/
GroupIds: Array<string>;
/**
* 低代码平台应用ID
*/
SdkAppId: number;
/**
* 待添加成员列表，最大值200
*/
MemberIds: Array<string>;
}
/**
* DescribeRoom返回参数结构体
*/
export interface DescribeRoomResponse {
/**
* 房间名称。
*/
Name?: string;
/**
* 预定的房间开始时间，unix时间戳（秒）。
*/
StartTime?: number;
/**
* 预定的房间结束时间，unix时间戳（秒）。
*/
EndTime?: number;
/**
* 老师的UserId。
*/
TeacherId?: string;
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId?: number;
/**
* 观看类型。互动观看 （默认）
*/
AudienceType?: number;
/**
* 分辨率。可以有如下取值：
1 标清
2 高清
3 全高清
*/
Resolution?: number;
/**
* 最大连麦人数（不包括老师）。取值范围[0, 16]
*/
MaxMicNumber?: number;
/**
* 进入课堂时是否自动连麦。可以有以下取值：
0 不自动连麦（需要手动申请上麦，默认值）
1 自动连麦
*/
AutoMic?: number;
/**
* 高音质模式。可以有以下取值：
0 不开启高音质（默认值）
1 开启高音质
*/
AudioQuality?: number;
/**
* 房间子类型，可以有以下取值：
videodoc 文档+视频
video 纯视频
*/
SubType?: string;
/**
* 上课后是否禁止自动录制。可以有以下取值：
0 不禁止录制（自动开启录制，默认值）
1 禁止录制
注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。
*/
DisableRecord?: number;
/**
* 助教UserId列表。
注意：此字段可能返回 null，表示取不到有效值。
*/
Assistants?: Array<string>;
/**
* 录制地址（协议为https)。仅在房间结束后存在。
注意：此字段可能返回 null，表示取不到有效值。
*/
RecordUrl?: string;
/**
* 课堂状态。0为未开始，1为已开始，2为已结束，3为已过期。
注意：此字段可能返回 null，表示取不到有效值。
*/
Status?: number;
/**
* 房间绑定的群组ID
注意：此字段可能返回 null，表示取不到有效值。
*/
GroupId?: string;
/**
* 打开学生麦克风/摄像头的授权开关
*/
EnableDirectControl?: number;
/**
* 开启专注模式。
0 收看全部角色音视频(默认)
1 只看老师和助教
*/
InteractionMode?: number;
/**
* 横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型
*/
VideoOrientation?: number;
/**
* 该房间是否开启了课后评分功能。0：未开启 1：开启
*/
IsGradingRequiredPostClass?: number;
/**
* 房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (后续扩展)
*/
RoomType?: number;
/**
* 录制时长
*/
VideoDuration?: number;
/**
* 拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟
*/
EndDelayTime?: number;
/**
* 直播方式：0 常规模式（默认）1 回放直播模式（伪直播）
*/
LiveType?: number;
/**
* 伪直播链接
*/
RecordLiveUrl?: string;
/**
* 是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1的时候有效
*/
EnableAutoStart?: number;
/**
* 录制文件背景图片，支持png、jpg、jpeg、bmp格式，暂不支持透明通道
*/
RecordBackground?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCurrentMemberList请求参数结构体
*/
export interface DescribeCurrentMemberListRequest {
/**
* 房间Id。
*/
RoomId: number;
/**
* 分页查询当前页数，从1开始递增。
*/
Page: number;
/**
* 每页数据量，最大1000。
*/
Limit: number;
}
/**
* SendRoomNotificationMessage请求参数结构体
*/
export interface SendRoomNotificationMessageRequest {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
/**
* 房间ID。
*/
RoomId: number;
/**
* 消息。
*/
MsgContent: string;
}
/**
* DescribeSdkAppIdUsers返回参数结构体
*/
export interface DescribeSdkAppIdUsersResponse {
/**
* 用户总数
*/
Total?: number;
/**
* 当前获取用户信息数组列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Users?: Array<UserInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 房间事件对应的信息。
*/
export interface EventDataInfo {
/**
* 事件发生的房间号。
注意：此字段可能返回 null，表示取不到有效值。
*/
RoomId?: number;
/**
* 事件发生的用户。
注意：此字段可能返回 null，表示取不到有效值。
*/
UserId?: string;
/**
* 用户设备类型。0: Unknown; 1: Windows; 2: macOS; 3: Android; 4: iOS; 5: Web; 6: Mobile webpage; 7: Weixin Mini Program.
注意：此字段可能返回 null，表示取不到有效值。
*/
Device?: number;
/**
* 录制时长。单位：秒
注意：此字段可能返回 null，表示取不到有效值。
*/
Duration?: number;
/**
* 录制文件大小
注意：此字段可能返回 null，表示取不到有效值。
*/
RecordSize?: number;
/**
* 录制url
注意：此字段可能返回 null，表示取不到有效值。
*/
RecordUrl?: string;
}
/**
* DescribeAnswerList返回参数结构体
*/
export interface DescribeAnswerListResponse {
/**
* 符合查询条件的房间答案总数
*/
Total?: number;
/**
* 房间提问答案列表
注意：此字段可能返回 null，表示取不到有效值。
*/
AnswerInfo?: Array<AnswerInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRoomStatistics返回参数结构体
*/
export interface DescribeRoomStatisticsResponse {
/**
* 峰值在线成员人数。
*/
PeakMemberNumber?: number;
/**
* 累计在线人数。
*/
MemberNumber?: number;
/**
* 记录总数。包含进入房间或者应到未到的。
*/
Total?: number;
/**
* 成员记录列表。
*/
MemberRecords?: Array<MemberRecord>;
/**
* 秒级unix时间戳，实际房间开始时间。
注意：此字段可能返回 null，表示取不到有效值。
*/
RealStartTime?: number;
/**
* 秒级unix时间戳，实际房间结束时间。
注意：此字段可能返回 null，表示取不到有效值。
*/
RealEndTime?: number;
/**
* 房间消息总数。
*/
MessageCount?: number;
/**
* 房间连麦总数。
*/
MicCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteDocument请求参数结构体
*/
export interface DeleteDocumentRequest {
/**
* 文档ID。
*/
DocumentId: string;
}
/**
* DescribeSupervisors请求参数结构体
*/
export interface DescribeSupervisorsRequest {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
/**
* 每页数据量，最大100。 不填默认20.
*/
Limit?: number;
/**
* 分页查询当前页数，从1开始递增，不填默认为1。
*/
Page?: number;
}
/**
* 历史消息列表
*/
export interface MessageList {
/**
* 消息时间戳
注意：此字段可能返回 null，表示取不到有效值。
*/
Timestamp?: number;
/**
* 消息发送者
注意：此字段可能返回 null，表示取不到有效值。
*/
FromAccount?: string;
/**
* 消息序列号，当前课堂内唯一且单调递增
注意：此字段可能返回 null，表示取不到有效值。
*/
Seq?: number;
/**
* 历史消息列表
注意：此字段可能返回 null，表示取不到有效值。
*/
MessageBody?: Array<MessageItem>;
}
/**
* DescribeGroup请求参数结构体
*/
export interface DescribeGroupRequest {
/**
* 群组ID
*/
GroupId: string;
/**
* 低代码平台应用ID
*/
SdkAppId: number;
}
/**
* EndRoom返回参数结构体
*/
export interface EndRoomResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetWatermark请求参数结构体
*/
export interface GetWatermarkRequest {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
}
/**
* EndRoom请求参数结构体
*/
export interface EndRoomRequest {
/**
* 房间ID。
*/
RoomId: number;
}
/**
* CreateGroupWithMembers返回参数结构体
*/
export interface CreateGroupWithMembersResponse {
/**
* 创建成功群组ID
*/
GroupId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BatchDeleteGroupMember请求参数结构体
*/
export interface BatchDeleteGroupMemberRequest {
/**
* 待添加群组ID列表，最大值100
*/
GroupIds: Array<string>;
/**
* 低代码平台应用ID
*/
SdkAppId: number;
/**
* 待添加成员列表，最大值256
*/
MemberIds: Array<string>;
}
/**
* 单张图片信息
*/
export interface ImageInfo {
/**
* 图片类型：
1-原图
2-大图
3-缩略图
*/
Type: number;
/**
* 图片数据大小，单位：字节。
*/
Size: number;
/**
* 图片宽度，单位为像素。
*/
Width: number;
/**
* 图片高度，单位为像素。
*/
Height: number;
/**
* 图片下载地址。
*/
URL: string;
}
/**
* ModifyApp请求参数结构体
*/
export interface ModifyAppRequest {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
/**
* 回调地址。
*/
Callback?: string;
/**
* 回调key。
*/
CallbackKey?: string;
}
/**
* UnbindDocumentFromRoom请求参数结构体
*/
export interface UnbindDocumentFromRoomRequest {
/**
* 房间ID。
*/
RoomId: number;
/**
* 文档ID。
*/
DocumentId: string;
}
/**
* 禁言用户信息数组，内容包括被禁言的成员 ID，及其被禁言到的时间（使用 UTC 时间，即世界协调时间）
*/
export interface MutedAccountList {
/**
* 用户 ID
注意：此字段可能返回 null，表示取不到有效值。
*/
MemberAccount?: string;
/**
* 禁言到的时间（使用 UTC 时间，即世界协调时间）
注意：此字段可能返回 null，表示取不到有效值。
*/
MutedUntil?: number;
}
/**
* 批量创建群组基础信息
*/
export interface GroupBaseInfo {
/**
* 待创建群组名
*/
GroupName: string;
/**
* 群组主讲人ID
*/
TeacherId?: string;
}
/**
* LoginUser请求参数结构体
*/
export interface LoginUserRequest {
/**
* 注册获取的用户id。
*/
UserId: string;
}
/**
* 图片消息
*/
export interface ImageMsgContent {
/**
* 图片的唯一标识，客户端用于索引图片的键值。
*/
UUID: string;
/**
* 图片格式。
JPG = 1
GIF = 2
PNG = 3
BMP = 4
其他 = 255
*/
ImageFormat: number;
/**
* 图片信息
*/
ImageInfoList: Array<ImageInfo>;
}
/**
* 每个选项答题人数统计
*/
export interface AnswerStat {
/**
* 选项（按照位表示是否选择，如0x1表示选择A，0x11表示选择AB）
*/
Answer?: number;
/**
* 答题人数
*/
Count?: number;
}
/**
* SendRoomNormalMessage返回参数结构体
*/
export interface SendRoomNormalMessageResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteSupervisor返回参数结构体
*/
export interface DeleteSupervisorResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SetWatermark返回参数结构体
*/
export interface SetWatermarkResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 批量创建房间的房间信息
*/
export interface RoomInfo {
/**
* 房间名称。
*/
Name: string;
/**
* 预定的房间开始时间，unix时间戳。
*/
StartTime: number;
/**
* 预定的房间结束时间，unix时间戳。
*/
EndTime: number;
/**
* 分辨率。可以有如下取值： 1 标清 2 高清 3 全高清
*/
Resolution: number;
/**
* 最大连麦人数（不包括老师）。取值范围[0, 16]
*/
MaxMicNumber: number;
/**
* 房间子类型，可以有以下取值： videodoc 文档+视频 video 纯视频
*/
SubType: string;
/**
* 老师ID。通过[注册用户]接口获取的UserId。
*/
TeacherId?: string;
/**
* 进入课堂时是否自动连麦。可以有以下取值： 0 不自动连麦（需要手动申请上麦，默认值） 1 自动连麦
*/
AutoMic?: number;
/**
* 释放音视频权限后是否自动取消连麦。可以有以下取值： 0 自动取消连麦（默认值） 1 保持连麦状态
*/
TurnOffMic?: number;
/**
* 高音质模式。可以有以下取值： 0 不开启高音质（默认值） 1 开启高音质
*/
AudioQuality?: number;
/**
* 上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。
*/
DisableRecord?: number;
/**
* 助教Id列表。通过[注册用户]接口获取的UserId。
*/
Assistants?: Array<string>;
/**
* rtc人数。
*/
RTCAudienceNumber?: number;
/**
* 观看类型。
*/
AudienceType?: number;
/**
* 录制布局。
*/
RecordLayout?: number;
/**
* 房间绑定的群组ID
*/
GroupId?: string;
/**
* 打开学生麦克风/摄像头的授权开关
*/
EnableDirectControl?: number;
/**
* 开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教
*/
InteractionMode?: number;
/**
* 横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型
*/
VideoOrientation?: number;
/**
* 开启课后评分。 0：不开启(默认) 1：开启
*/
IsGradingRequiredPostClass?: number;
/**
* 房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (后续扩展)
*/
RoomType?: number;
/**
* 拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟
*/
EndDelayTime?: number;
/**
* 直播方式：0 常规模式（默认）1 回放直播模式（伪直播）
*/
LiveType?: number;
/**
* 伪直播回放链接
*/
RecordLiveUrl?: string;
/**
* 是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1的时候有效
*/
EnableAutoStart?: number;
}
/**
* ModifyRoom请求参数结构体
*/
export interface ModifyRoomRequest {
/**
* 房间ID。
*/
RoomId: number;
/**
* 低代码互动课堂的SdkAppId
*/
SdkAppId: number;
/**
* 预定的房间开始时间，unix时间戳（秒）。直播开始后不允许修改。
*/
StartTime?: number;
/**
* 预定的房间结束时间，unix时间戳（秒）。直播开始后不允许修改。
*/
EndTime?: number;
/**
* 老师ID。直播开始后不允许修改。
*/
TeacherId?: string;
/**
* 房间名称。
*/
Name?: string;
/**
* 分辨率。可以有如下取值：
1 标清
2 高清
3 全高清
直播开始后不允许修改。
*/
Resolution?: number;
/**
* 设置房间/课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。
取值范围[0,16]，当取值为0时表示当前课堂/直播，不支持连麦互动。
*/
MaxMicNumber?: number;
/**
* 进入房间时是否自动连麦。可以有以下取值：
0 不自动连麦（默认值）
1 自动连麦
直播开始后不允许修改。
*/
AutoMic?: number;
/**
* 高音质模式。可以有以下取值：
0 不开启高音质（默认值）
1 开启高音质
直播开始后不允许修改。
*/
AudioQuality?: number;
/**
* 房间子类型，可以有以下取值：
videodoc 文档+视频
video 纯视频
直播开始后不允许修改。
*/
SubType?: string;
/**
* 禁止录制。可以有以下取值：
0 不禁止录制（默认值）
1 禁止录制
直播开始后不允许修改。
*/
DisableRecord?: number;
/**
* 助教Id列表。直播开始后不允许修改。
*/
Assistants?: Array<string>;
/**
* 房间绑定的群组ID。直播开始后不允许修改。
*/
GroupId?: string;
/**
* 打开学生麦克风/摄像头的授权开关。直播开始后不允许修改。
*/
EnableDirectControl?: number;
/**
* 开启专注模式。
0 收看全部角色音视频(默认)
1 只看老师和助教
*/
InteractionMode?: number;
/**
* 横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型
*/
VideoOrientation?: number;
/**
* 开启课后评分。 0：不开启(默认) 1：开启
*/
IsGradingRequiredPostClass?: number;
/**
* 房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 （预留参数、暂未开放)
*/
RoomType?: number;
/**
* 录制模板。仅可修改还未开始的房间。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744
*/
RecordLayout?: number;
/**
* 拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟
*/
EndDelayTime?: number;
/**
* 直播方式：0 常规模式（默认）1 回放直播模式（伪直播）
*/
LiveType?: number;
/**
* 伪直播链接
*/
RecordLiveUrl?: string;
/**
* 是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1的时候有效
*/
EnableAutoStart?: number;
}
/**
* 房间问答答案详情
*/
export interface AnswerInfo {
/**
* 用户名
*/
Name?: string;
/**
* 答案（按照位表示是否选择，如0x1表示选择A，0x11表示选择AB）
*/
Answer?: number;
/**
* 答题用时
*/
CostTime?: number;
/**
* 用户ID
*/
UserId?: string;
/**
* 答案是否正确（1正确0错误）
*/
IsCorrect?: number;
}
/**
* DescribeRoomStatistics请求参数结构体
*/
export interface DescribeRoomStatisticsRequest {
/**
* 房间Id。
*/
RoomId: number;
/**
* 分页查询当前页数，从1开始递增。
*/
Page: number;
/**
* 每页数据量，最大1000。
*/
Limit: number;
}
/**
* DescribeDocumentsByRoom返回参数结构体
*/
export interface DescribeDocumentsByRoomResponse {
/**
* 文档信息列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Documents?: Array<DocumentInfo>;
/**
* 符合查询条件文档总数
*/
Total?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* LoginOriginId返回参数结构体
*/
export interface LoginOriginIdResponse {
/**
* 用户Id。
*/
UserId: string;
/**
* 登录/注册成功后返回登录态token。有效期7天。
*/
Token: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeQuestionList返回参数结构体
*/
export interface DescribeQuestionListResponse {
/**
* 符合查询条件的房间问答问题总数
*/
Total?: number;
/**
* 房间问答问题列表
注意：此字段可能返回 null，表示取不到有效值。
*/
QuestionInfo?: Array<QuestionInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetRooms返回参数结构体
*/
export interface GetRoomsResponse {
/**
* 总数
*/
Total?: number;
/**
* 房间列表
*/
Rooms?: Array<RoomItem>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 房间问答问题详情
*/
export interface QuestionInfo {
/**
* 问题ID
*/
QuestionId?: string;
/**
* 问题内容
*/
QuestionContent?: string;
/**
* 倒计时答题设置的秒数（0 表示不计时）
*/
Duration?: number;
/**
* 正确答案（按照位表示是否选择，如0x1表示选择A，0x11表示选择AB）
*/
CorrectAnswer?: number;
/**
* 每个选项答题人数统计
注意：此字段可能返回 null，表示取不到有效值。
*/
AnswerStats?: Array<AnswerStat>;
}
/**
* KickUserFromRoom请求参数结构体
*/
export interface KickUserFromRoomRequest {
/**
* 房间Id。
*/
RoomId: number;
/**
* 低代码平台的SdkAppId。
*/
SdkAppId: number;
/**
* 需要踢出成员Id
*/
UserId: string;
/**
* 踢出类型：
1：临时踢出，可以使用Duration参数指定污点时间，污点时间间隔内用户无法进入房间。
2：永久踢出
*/
KickType: number;
/**
* 污点时间(单位秒)，KickType = 1时生效，默认为0
*/
Duration: number;
}
/**
* SetWatermark请求参数结构体
*/
export interface SetWatermarkRequest {
/**
* 低代码互动课堂的SdkAppId。
*/
SdkAppId: number;
/**
* 老师视频区域的水印参数地址，设置为空字符串表示删除
*/
TeacherUrl?: string;
/**
* 白板视频区域的水印参数地址，设置为空字符串表示删除
*/
BoardUrl?: string;
/**
* 视频默认图片（在没有视频流的时候显示），设置为空字符串表示删除
*/
VideoUrl?: string;
/**
* 白板区域水印的宽度，取值:0-100，默认为0，表示区域X方向的百分比
*/
BoardW?: number;
/**
* 白板区域水印的高度，取值:0-100，默认为0, 表示区域Y方向的百分比
*/
BoardH?: number;
/**
* 白板区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间
*/
BoardX?: number;
/**
* 白板区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间
*/
BoardY?: number;
/**
* 老师视频区域水印的宽度，取值:0-100，默认为0，表示区域X方向的百分比
*/
TeacherW?: number;
/**
* 老师视频区域水印的高度，取值:0-100，默认为0, 表示区域Y方向的百分比
*/
TeacherH?: number;
/**
* 老师视频区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间
*/
TeacherX?: number;
/**
* 老师视频区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间
*/
TeacherY?: number;
/**
* 文字水印内容，设置为空字符串表示删除
*/
Text?: string;
/**
* 文字水印颜色
*/
TextColor?: string;
}
/**
* GetRooms请求参数结构体
*/
export interface GetRoomsRequest {
/**
* 低代码平台的SdkAppId。
*/
SdkAppId: number;
/**
* 开始时间。默认以当前时间减去半小时作为开始时间。
*/
StartTime?: number;
/**
* 结束时间。默认以当前时间加上半小时作为结束时间。
*/
EndTime?: number;
/**
* 分页查询当前页数，从1开始递增
*/
Page?: number;
/**
* 默认是10条
*/
Limit?: number;
/**
* 课堂状态。默认展示所有课堂，0为未开始，1为正在上课，2为已结束，3为已过期
*/
Status?: Array<number | bigint>;
}
/**