获取课程名称、主讲相关信息,可以过滤查询录播课程、直播课程数据
默认接口请求频率限制:20次/秒。
REST URL
GET https://sdk.xylink.com/api/rest/edu/external/lessons/list/{version}?enterpriseId=分配的企业id
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 |
version | String | Path | 是 | 无 | v1 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 |
pageIndex | int | Query | 是 | 无 | 页码 |
pageSize | int | Query | 是 | 无 | 分页大小(不超过50) |
lessStatus | String | Query | 否 | 无 | 课次状态过滤条件(0-未开课,1-开课中,2-已结课) |
searchStartTime | long | Query | 否 | 无 | 开课时间范围最小值(时间戳) |
searchEndTime | long | Query | 否 | 无 | 开课时间范围最大值(时间戳) |
type | long | Query | 否 | 无 | 2-live:直播,1-video:录播 |
keywords | String | Query | 否 | 无 | 关键字过滤(课程名称,讲师或云课堂号) |
departmentId | long | Query | 否 | 无 | 机构id,不传查询企业下所有课次,传值查询对应机构下课次 |
返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
{
"total": 4,
"pageIndex": 1,
"pageSize": 10,
"list": [
{
"lessonStatus": 2,
"speakerTeacherName": "外部联系人邮箱验证显示001",
"lessonNo": 1,
"cloudClassroomNo": "9007356459",
"lessonId": "559687737041485824",
"startTime": "1616640300000",
"endTime":"1616640300000",
"meetingId": "962894667861f5cb0178674012820367",
"endTime": "1616641200000",
"lessonName": "录制名称2",
"subject": "语文",
"grade": "三年级",
"schoolType": "小学",
"speakerTeacherId": 101868747
}
]
}
返回参数说明
参数名称 | 说明 |
total | 总数目 |
pageSize | 查询数量 |
pageIndex | 页码 |
list | 课程列表数 |
lessonId | 课次id |
subject | 培训科目 |
schoolType | 培训学段 |
grade | 培训班级 |
lessonName | 课次名称 |
lessonNo | 讲次序号,第一讲 |
speakerTeacherName | 主讲教师姓名 |
startTime | 课次开始时间点 |
endTime | 课次结束时间点 |
courseId | 课程ID |
courseName | 课程名称 |
meetingId | 预约会议ID |
cloudClassroomNo | 云会议室号 |
lessonStatus | 课程状态(0-未开课,1-开课中,2-已结课) |
speakerTeacherId | 主讲教师ID |