获取课节视频接口
直播云SDK API提供三种类型的视频流获取接口:
- 监课视频流获取接口,获取监课rtmp地址
- 回放视频获取接口,获取课后回放地址(mp4)
- 获取课节里面所有学生的上课时长
本章接口列表:
数目 | 接口名称 | 接口说明 |
---|---|---|
1 | 获取课节回放地址 | 课后可通过该接口获取回放视频流 |
2 | 获取课节里面所有学生的上课时长 | 该接口主要获取课节里面所有学生的上课时长,精确到分钟 |
获取回放地址
接口URl: /institution/get/stream/info
接口域名: http(s)://api.weclassroom.com
(测试环境:http://test-api.weclassroom.com
) (已废弃)
接口域名: http(s)://openapi.weclassroom.com
(测试环境:http://test-openapi.weclassroom.com
)
验签规则请查看附录下验签代码示例
api接口和openapi接口统一访问方式: GET
api接口上传参数:
参数 | 类型 | 是否必填 | 参数说明 |
---|---|---|---|
lesson_id | INT | 是 | 课堂ID,用于标识该课节 |
institution_id | INT | 是 | 机构ID,直播云下发用于标识对接机构ID |
user_id | STRING | 否 | 用户ID |
third_token | STRING | 是 | 对接机构用于验签的TOKEN |
openapi接口上传参数:
参数 | 说明 | 是否必填 | 类型 |
---|---|---|---|
applicationID | 下发机构key | 是 | string |
signMsg | 加密参数字符串 | 是 | string |
signMsg包含参数:
参数 | 类型 | 是否必填 | 参数说明 |
---|---|---|---|
lesson_id | INT | 是 | 课堂ID,用于标识该课节 |
institution_id | INT | 是 | 机构ID,直播云下发用于标识对接机构ID |
user_id | STRING | 否 | 用户ID |
返回格式:
参数 | 类型 | 参数说明 |
---|---|---|
status | INT | 返回状态信息:1.成功 0.失败 |
time | STRING | 服务器响应时间 |
msg | STRING | 对返回的状态信息的补充说明,如调用失败原因等 |
data | JSON | 查询成功才返回,返回为JSON数组,JSON数组见data参数说明 |
成功示例:
{
"status": "1",
"time": "2019-05-30 20:23:58",
"data": {
"id": 68337, //表自增id(可忽略)
"lesson_id": "12239", //课程id
"institution_id": 79, //机构id
"stream_url_new": "live_zby/79_12239_79_12239", //新集群监课地址
"stream_type": 1, //是否是新集群 0-不是,1-是
"stream_size": 23800823, //回放视频文件大小
"play_url": "vod/zby/79_12239_79_12239", //回放播放地址
"ip_add": "12.123.123.123", //回放视频所在服务器ip地址
"stream_date": [ //记录本堂课开始推流与结束推流的时间集合(如:多次推,断流时间集合)
[{
"s": 1558942929 //开始时间戳
},
{
"e": 1558944711 //结束时间戳
}
],
[{
"s": 1558944763
},
{
"e": 1559008859
}
]
],
"stream_play_host": "https://hb1v1rec-test.weclassroom.com:81", //视频回放的域名
"complete_play_url": "http://play-back.zhiboyun.eaydu.com/media/abc.mp4" //课程回放地址
}
}
失败示例:
{
"status": "0",
"time": "2019-05-30 20:32:16",
"message": "lesson stream does not exists"
}
获取课节里面所有学生的上课时长(OPENAPI类型接口)
接口说明: 该接口主要是获取某个课节里面所有学生的上课时长,精确到分钟,可用于查看用户上课时长。
注意事项: 该接口数据产生于下课事件触发之后,异步存储到数据库当中,数据入库有一定延时,所以建议在下课后的30分钟之后获取该数据。
接口URl: v2/data/lesson/student/duration
接口域名: http(s)://openapi.weclassroom.com (测试环境域名:test-openapi.weclassroom.com
)
验签规则请查看附录下验签代码示例
接口访问方式: POST
接口上传参数:
参数 | 说明 | 是否必填 | 类型 |
---|---|---|---|
applicationID | 下发机构key | 是 | string |
signMsg | 加密参数字符串 | 是 | string |
signMsg包含参数:
参数 | 说明 | 是否必填 | 类型 | 示例 |
---|---|---|---|---|
institutionId | 机构ID | 是 | int | 123 |
lessonId | 机构课节ID | 是 | int | 123 |
返回参数:
参数 | 类型 | 参数说明 |
---|---|---|
status | INT | 返回状态信息:1.成功 0.失败 |
code | INT | 返回状态码,详见附录openapi code对照表 |
msg | STRING | 响应信息 |
data | 结构体 | 返回学生和老师数据,详见data主要参数说明 |
成功示例:
{
"status": 1,
"code": 10000,
"msg": "请求成功",
"data": [
{
"user_id": "117263", //学生id
"duration": 60 //上课时长(单位:分钟)
}
]
}