获取对应课次的详情信息。
默认接口请求频率限制:20次/秒。
REST URL
GET https://sdkapi.xylink.com/api/rest/external/{version}/edu/adapter/lesson/info/{lessonId}?
extId=分配的企业id&needPullStreamUrl=true/false
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 |
version | String | Path | 是 | 无 | v1 |
extId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 |
lessonId | long | Path | 是 | 无 | 课次id |
needPullStreamUrl | Boolean | Query | 否 | 无 | 当指定参数为true是才会返回直播拉流地址 |
返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
{
"lessonId":"462985830659526656",//课次id
"lessonName":"语文讲次",//课次名称
"lessonNo":1,//讲次序号,第一讲
"teacherList":[
{
"id":"27678189", //讲师id
"name":"李老师",//讲师姓名
"type":"people"//类型 people-讲师,device-终端
}
],
"listenerList":[ //听课老师或终端
{
"id":"27678120",//听课老师id
"name":"王老师",//听课老师
"type":"people"//类型 people-讲师,device-终端
}
],
"lessonTime":{//讲次开课时间段
"lessonDate":"2020-07-01",//开课日期
"endTime":"15:05:00",//课次结束时间点
"startTime":"15:00:00"//课次开始时间点
},
"status":{//讲次状态
"name":"未开课",
"value":"before_course"
},
"syncLive":true, //同步直播开关状态 true-开 false-关
"thirdPushUrl":"",//三方推流地址
"liveUrl":"http://live.xylink.com/live/v/2c949a2a72a98e0201730908da661947",//直播地址
"lessonIntro":"", //讲次介绍
"meetingId":"2c9497027305dd570173090893b2111b",//会议id
"videoList":[
{
"id":"473797242004713472",//id
"vodId":"5263329",//;录制文件id
"courseItemId":"473558688288735234",//课次id
"mimeType":"mp4",//录制文件类型
"fileSize":"3.9",//录制文件大小
"startTime":"2020-07-31 10:20",//录制文件开始时间
"cover":"https://cloud.xylink.com/vods/sharecenter/thumbnail?fileName=cloudcloud/9005803465/1156074676489_0_1596162040374_1280_720.jpg&fileId=11141074&securityKey=f4c672eb544dd17a8f69f0c7047242ba173b2231f9e",//录制文件封面
"fileName":"Z大语文"//录制文件名称
}
],
"enrolCount":0,//报名人数
"liveLayout":"default",//多视频窗口画面布局值
"liveLayoutName":"默认布局",//多视频窗口画面布局名称
"liveLayoutContent":"default",//内容分享画面布局值
"liveLayoutContentName":"默认布局",//内容分享画面布局名称
"lessonSyncResource":false,//课次是否同步资源平台 true-是 false-否
"livePullStreamUrl": //直播拉流地址
{"videoRtmp":"rtmp://xxx",
"videoFlv":"http://xxx",
"videoM3u8":"http://xxx"}
}
返回参数说明
参数名称 | 说明 |
lessonId | 课次id |
lessonName | 课次名称 |
lessonNo | 讲次序号,第一讲 |
teacherList | 教师列表 |
id | 讲师id |
name | 讲师姓名 |
type | 类型 people-讲师,device-终端 |
listenerList | 听课老师或终端 |
id | 听课老师id |
name | 听课老师 |
type | 类型 people-讲师,device-终端 |
lessonTime | 讲次开课时间段 |
lessonDate | 开课日期 |
endTime | 课次结束时间点 |
startTime | 课次开始时间点 |
status | 讲次状态 |
name | 讲次状态中文名称 |
value | 讲次状态英文名称 |
syncLive | 同步直播开关状态 true-开 false-关 |
thirdPushUrl | 三方推流地址 |
liveUrl | 直播地址 |
lessonIntro | 讲次介绍 |
meetingId | 会议id |
videoList | 录制文件列表 |
id | 主键 |
vodId | 录制文件id |
courseItemId | 课次id |
mimeType | 录制文件类型 |
fileSize | 录制文件大小 |
startTime | 录制文件开始时间 |
cover | 录制文件封面 |
fileName | 录制文件名称 |
enrolCount | 报名人数 |
liveLayout | 多视频窗口画面布局值 |
liveLayoutName | 多视频窗口画面布局名称 |
liveLayoutContent | 内容分享画面布局值 |
liveLayoutContentName | 内容分享画面布局名称 |
lessonSyncResource | 课次是否同步资源平台 true-是 false-否 |