[关闭]
@sewise-dev 2018-07-27T02:28:35.000000Z 字数 47217 阅读 841

知识元3.5.0文档

知识元

  1. 列表项

更新历史

编号 版本 说明 作者 日期

1. 列表项

|1|v1.0|1.微录播相关接口|pakison|2017-06-16|

目录

1. 资源接口

1.1 上传资源

1.1.1 提交切片上传任务
接口功能

提交切片上传任务

接口地址

/uploadOuter/hashid
/appUuploadOuter/hashid (app端访问地址)

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
hashid 是 string 上传文件的md5
catType 是 int 目录类型，1:相机目录；2：默认目录；3：合成视频;4:自定义目录
catUuid 是 string 目录的uuid
fileName 是 string 文件的名称
size 否 int 文件的总大小
chunkSize 否 int 单个切片的大小
userinfo 是 json 用户登陆信息

userinfo

参数 必选 类型 说明
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
case int success为false时返回状态参数，1：文件已存在；2：出现错误
error string 错误信息，如错误，返回，否则没有

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/uploadOuter/hashid
Response
成功:{"success":true}
失败:{"success":false,"case":1}

1.1.2 上传切片
接口功能

上传切片

接口地址

/uploadOuter/hashid/:hashid
/appUploadOuter/hashid/:hashid (app端访问地址)

HTTP Content-Type

formdata/multipart

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
uuid 是 string 切片上传的任务id
userinfo 是 json 用户登陆信息

userinfo

参数 必选 类型 说明
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 单个切片上传结束结果
completed boolean 是否全部上传完成
taskidpath string 上传成功后返回的处理任务id文件地址
error string 错误信息，如错误，返回，否则没有

其他响应状态描述请参照：【备注】-【错误码】

最终文件路径以websocket返回，websocket通知事件为uploadEnd,websocket链接地址为ws://vtest.sewise.com/realtime/browser
返回字段 字段类型 说明
success boolean 文件处理的最后结果
taskid string 任务的taskid
path string 上传成功后返回的文件地址
imgPath string 上传成功后返回的图片地址
error string 错误信息，如错误，返回，否则没有
接口示例

Request
url: http://ip:port/uploadOuter/hashid/agsdagsdgdaegaeada
Response
成功:{"success":true,taskid:'agsdagsdgdaegaeada'}
失败:{"success":false,"error":"XXX"}

1.1.3 获取切片上传的任务信息
接口功能

获取切片上传的任务信息，主要用于断点续传

接口地址

/uploadOuter/resume/:hashid
/appUploadOuter/resume/:hashid (app端访问地址)

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
RequestBody
uuid 是 string 切片上传的任务id
userinfo 是 json 用户登陆信息

userinfo

参数 必选 类型 说明
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 单个切片上传结束结果
error string 错误信息，如错误，返回，否则没有
fileName string 文件的名称
size string 文件的总大小
chunkSize int 单个切片大小
lastIndex int 总共有多少个切片
index int 上传的最后一个切片的位置

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/uploadOuter/resume/agsdagsdgdaegaeada
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

1.2 获取资源

1.2.1 资源目录接口
1.2.1.1 创建资源目录

创建资源目录

接口地址

/catalog

HTTP Content-Type

application/json

HTTP 请求方式

post

请求参数
参数 必选 类型 说明
RequestBody
type 是 int 目录类型，1:相机目录；2：默认目录；3：合成视频;4:自定义目录
name 是 string 目录的名称
userinfo 是 json 用户登陆信息

userinfo

参数 必选 类型 说明
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
error string 错误信息，如错误，返回，否则没有

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/catalog
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}

1.2.1.2 获取目录列表

获取目录列表

接口地址

/catalog/list

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
userinfo 是 json 用户登陆信息

userinfo

参数 必选 类型 说明
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data array 目录列表数组
error string 错误信息，如错误，返回，否则没有

data

返回字段 字段类型 说明
uuid string 目录的uuid
type int 目录类型，1:相机目录；2：默认目录；3：合成视频;4:自定义目录
name string 目录名称
creator_uid string 用户的uid
create_time string 目录创建时间

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/catalog/list
Response
成功:{"success":true,data:[{xx}、{xx}...]}
失败:{"success":false,"error":"XXX"}

1.2.2 获取资源列表
接口功能

获取资源列表

接口地址

/source/list/:type

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
type 是 string 资源的类型,type：pdf、mp4、pic...
page 是 int 访问第几页的资源
size 是 int 每一页资源的数量
userinfo 是 json 用户登陆信息
catType int 目录类型，1:相机目录；2：默认目录；3：合成视频;4:自定义目录
catUuid string 目录的uuid

userinfo

参数 必选 类型 说明
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data arr 日期列表数组

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/source/source/list/
Response
成功:{"success":true,data:["xxx","xxx"]}
失败:{"success":false,"error":"XXX"}

1.2.3 获取资源列表
接口功能

获取pdf截图

接口地址

/img/:hashid?page=1

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
hashid 是 int pdf的hashid
page 是 int 访问第几页pdf
userinfo 是 json 用户登陆信息

userinfo

参数 必选 类型 说明
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

1.2.4 同步app上传第三方云存储资源数据
接口功能

获取资源列表

接口地址

/source/addCs

HTTP Content-Type

application/json

HTTP 请求方式

post

请求参数
参数 必选 类型 说明
RequestBody
source_hashid 是 string 资源的md5
cs_host 是 string 第三方云存储host
cs_path 是 string 第三方云存储路径
userinfo 是 json 用户登陆信息
name 是 string 资源的名称
type 否 string 资源的类型
size 否 string 资源的大小

userinfo

参数 必选 类型 说明
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
hashid string 资源的用户信息hashid

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/source/source/list/
Response
成功:{"success":true,hashid:"xxx"}
失败:{"success":false,"msg":"XXX"}

1.2.2 获取资源列表
接口功能

获取资源列表

接口地址

/source/list/:type

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
type 是 string 资源的类型,type：pdf、mp4、pic...
page 是 int 访问第几页的资源
size 是 int 每一页资源的数量
userinfo 是 json 用户登陆信息
catType int 目录类型，1:相机目录；2：默认目录；3：合成视频;4:自定义目录
catUuid string 目录的uuid

userinfo

参数 必选 类型 说明
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data arr 日期列表数组

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/source/source/list/
Response
成功:{"success":true,data:["xxx","xxx"]}
失败:{"success":false,"error":"XXX"}

1.3 分配微录播

1.3.1 分配微录播ip
接口功能

获取资源列表

接口地址

/host

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
url string 微录播的ip地址
sn string 微录播的sn码

其他响应状态描述请参照：【备注】-【错误码】

接口示例

Request
url: http://ip:port/host
Response
成功:{"success":true,url:"192.168.1.150",sn:'spa000662a'}
失败:{"success":false,"error":"XXX"}

2.教师端

2.1 我的微课列表

接口地址

/swl/all

HTTP Content-Type / 请求方式

application/json
GET

请求参数

RequestBody

参数 必选 类型 说明
page 否 string 页数，默认为1
size 否 string 一页显示数量，默认为15
stime 否 string 创建开始时间，默认为空
etime 否 string 创建结束时间，默认为空
title 否 string 题目，默认为空
teacher 否 string 创建者id，默认为空
userinfo 是 json 用户登陆信息

userinfo

参数 必选 类型 说明
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
pages Integer 返回总页数
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"userinfo"：'{"username":"xxx","role":1}'，"session":"xxx"} http://192.168.1.237/swl/all
Response
{"success":true,"data":[{"swlid":"95d78585-3314-4ad7-b44d-000bf133faec","creator_uid":"admin","creator_nickname":"管理员","title":"简介简介","duration":599.099,"image":"/video/photo/?path=storage/swlsource/video/39/f4c03753.mp4","is_open_topic":1,"video_url":"","poster":"","summary":"","require":"","create_time":"2017-02-08 16:39:54","knowledge":[{"klgid":"d5484376-85e4-4ed7-9434-b1ee92dd1fc1","title":"2","element_title":"","duration":23,"start_time":0,"end_time":23,"creator_uid":"admin","creator_nickname":"管理员","swpid":"918d03cf-3284-4da1-84ae-651529906173","swptitle":"","video_url":"storage/swlsource/video/39/f4c03753.mp4","video_name":"98888.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/5b/3686c2f8.pdf","assist_name":"3686c2f8.pdf","create_time":"2017-02-08 16:39:09","image":"storage/swlsource/pdf/5b/3686c2f8/1.png","hide":"","quote_count":"","topic_ids":"","knowledge_element":[{"elgid":"6d7ab477-a543-4f6b-a179-76918bead5cc","title":"2","creator_uid":"admin","creator_nickname":"管理员","pdf_url":"","pdf_json":{"id":0,"page":1,"sTime":0,"title":"2","type":"1","eTime":23,"duration":23},"vtt_json":[],"topic_json":[],"timeline_json":"","event_timeline_json":"","duration":23,"start_time":0,"end_time":23,"create_time":"2017-02-08 16:39:09"],"_id":148}],"question_total":0,"klg_total":9,"_id":11}]}],"pages":1}

2.2 知识点列表

接口地址

/knowledge/all

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
page 否 string 页数，默认为1
size 否 string 一页显示数量，默认为15
stime 否 string 创建开始时间，默认为空
etime 否 string 创建结束时间，默认为空
title 否 string 题目，默认为空
teacher 否 string 创建者id，默认为空
userinfo 是 json 用户登陆信息
参数 必选 类型 说明
userinfo
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
pages Integer 返回总页数
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userinfo"：{username:xxx,role:1}，"xxx":"xxx"} http://192.168.1.239/knowledge/all
Response
{"success":true,"data":[{"klgid":"b6c2d703-4046-478a-a9da-330e7f6af144","title":"","element_title":"","duration":101,"start_time":172,"end_time":273,"creator_uid":"admin","creator_nickname":"管理员","swpid":"918d03cf-3284-4da1-84ae-651529906173","swptitle":"","video_url":"storage/swlsource/video/39/f4c03753.mp4","video_name":"98888.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/5b/3686c2f8.pdf","assist_name":"3686c2f8.pdf","create_time":"2017-02-08 16:39:09","image":"storage/swlsource/pdf/5b/3686c2f8/4.png","hide":"","quote_count":"","topic_ids":"","knowledge_element":[{"elgid":"1a634112-915f-406d-ba9e-2d6243888e96","title":"","creator_uid":"admin","creator_nickname":"管理员","pdf_url":"","pdf_json":{"page":4,"sTime":172,"eTime":273,"id":3,"type":"1","title":"","duration":101},"vtt_json":[],"topic_json":[],"timeline_json":"","event_timeline_json":"","duration":101,"start_time":172,"end_time":273,"create_time":"2017-02-08 16:39:09"}]}],"pages":1}

2.3 知识点列表(公开)

接口地址

/knowledge/search

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
page 否 string 页数，默认为1
size 否 string 一页显示数量，默认为15
stime 否 string 创建开始时间，默认为空
etime 否 string 创建结束时间，默认为空
title 否 string 题目，默认为空
userinfo 是 json 用户登陆信息
open_type 否 int 公开类型；默认为空；1公开并引用；2公开不能引用
参数 必选 类型 说明
userinfo
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
pages Integer 返回总页数
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userinfo"：{username:xxx,role:1}，"xxx":"xxx"} http://192.168.1.239/knowledge/all
Response
{"success":true,"data":[{"klgid":"b6c2d703-4046-478a-a9da-330e7f6af144","title":"","element_title":"","duration":101,"start_time":172,"end_time":273,"creator_uid":"admin","creator_nickname":"管理员","swpid":"918d03cf-3284-4da1-84ae-651529906173","swptitle":"","video_url":"storage/swlsource/video/39/f4c03753.mp4","video_name":"98888.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/5b/3686c2f8.pdf","assist_name":"3686c2f8.pdf","create_time":"2017-02-08 16:39:09","image":"storage/swlsource/pdf/5b/3686c2f8/4.png","hide":"","quote_count":"","topic_ids":"","knowledge_element":[{"elgid":"1a634112-915f-406d-ba9e-2d6243888e96","title":"","creator_uid":"admin","creator_nickname":"管理员","pdf_url":"","pdf_json":{"page":4,"sTime":172,"eTime":273,"id":3,"type":"1","title":"","duration":101},"vtt_json":[],"topic_json":[],"timeline_json":"","event_timeline_json":"","duration":101,"start_time":172,"end_time":273,"create_time":"2017-02-08 16:39:09"}]}],"pages":1}

2.4 微课播放

2.4.1 学生学习进度统计
接口地址

/statistics/user/study/:swlid/:uid

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
RequestBody
swlid 是 string 课程的id值
uid 是 string 用户的id值
HTTP 响应状态

200

返回字段 字段类型 说明
status Booleans 返回状态码
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userinfo"：userinfo，"swlid":924} http://192.168.1.239/statistics/user/study/:swlid/:uid
Response
{"result":{"share":["0%","10%","20%","30%","40%","50%","60%","70%","80%","90%","100%"],"list":[[{"id":"fc3ef100-dc95-11e6-b872-dd7574160f84","precent":"0.2","create_time":"1484644742173","round":1,"data":{"correct_precent":"0.40","point_precent":"0.60","study_time":60}},{"id":"347903d0-dc96-11e6-9ea6-f192bce90860","precent":"0.4","create_time":"1484644836497","round":1,"data":{"correct_precent":"0.40","point_precent":"0.60","study_time":"120"}},{"id":"74406080-dc96-11e6-b605-ef0a6ba51af0","precent":"0.4","create_time":"1484644943508","round":1,"data":{"correct_precent":"0.40","point_precent":"0.60","study_time":"180"}}]]}}

2.4.2 错题排行
接口地址

/statistics/wrongranking/:swlid

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
RequestBody
swlid 是 string 课程的id值
HTTP 响应状态

200

返回字段 字段类型 说明
result Array 返回结果
接口示例

Request
curl -X get -H "Content-Type:application/json" -d {"userinfo"：userinfo，"swlid":53} http://192.168.1.239/statistics/wrongranking/:swlid
Response
{"result":[{"creator_uid":"admin","type":"single","question":"1+2=？","option":[5,10],"answer":[{"content":"2","rightAnswer":"false"},{"content":"3","rightAnswer":"true"}],"create_time":"2017-02-07 10:46:46","topic_id":"554770e7-881b-400b-9333-f1574965d847","_id":53,"id":"554770e7-881b-400b-9333-f1574965d847","uuid":"554770e7-881b-400b-9333-f1574965d847","question_id":"554770e7-881b-400b-9333-f1574965d847","showTime":6,"pdfDataID":1,"page":1,"rightJumpTime":6,"errorJumpTime":0,"answerindex":[1],"rate":{"rate":"0.33","wrong":5,"total":15},"optionsindex":[5,10]}]}

2.4.3 知识点统计
接口地址

/statistics/points/:swlid

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
RequestBody
swlid 是 string 课程的id值
HTTP 响应状态

200

返回字段 字段类型 说明
status Booleans 返回状态码
result Array 返回结果
接口示例

Request
curl -X get -H "Content-Type:application/json" -d {"userinfo"：userinfo，"swlid":53} http://192.168.1.239/statistics/points/:swlid
Response
{"success":true,"data":[{"id":0,"page":1,"sTime":0,"title":"开始","duration":0,"swpid":"pakit_53","_id":8879,"wipeInfo":{"totalnum":1,"wipenum":0,"wipepercent":"0"}},{"page":2,"sTime":10,"id":1,"title":"录制微课成为生活的一部分","duration":10,"swpid":"pakit_53","_id":8880,"wrongRateInfo":{"answernum":1,"wrongnum":1,"wrongpercent":"100"},"wipeInfo":{"totalnum":1,"wipenum":0,"wipepercent":"0"result":[{"title":"微录播是视智云推出的一款微型录制与播出系统2","duration":"4500","start_time":"50","end_time":"4500","creator_uid":"5112","creator_nickname":"张老师","swptitle":"微录播","video_url":"http://localhost:3000/image/1.mp4","video_name":"微课制作","assist_id":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","assist_url":"http://localhost:3000/image/1.pdf","assist_slice_number":"30","create_time":"2017-01-16 10:37:26","image":"http://localhost:3000/image/1.png","hide":"1","quote_count":"0","swlid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","wrong":{"count":0,"total":3},"clear":{"count":0,"total":3}},{"title":"微录播是视智云推出的一款微型录制与播出系统","duration":"4500","start_time":"50","end_time":"4500","creator_uid":"5112","creator_nickname":"张老师","swptitle":"微录播","video_url":"http://localhost:3000/image/1.mp4","video_name":"微课制作","assist_id":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","assist_url":"http://localhost:3000/image/1.pdf","assist_slice_number":"30","create_time":"2017-01-16 10:37:26","image":"http://localhost:3000/image/1.png","hide":"1","quote_count":"0","swlid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","wrong":{"count":9,"total":9},"clear":{"count":0,"total":3}}]}

2.5 微课制作

2.5.1 保存swp工程
接口地址

/swp/save

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
title 是 string swp工程的名称
name 是 string 视频的名称
fullname 是 string 视频的路径
pdf_json 否 json pdf数据串
id int 编号id
sTime double pdf的显示时间
page double 知识元在pdf中的位置，第几页
title string pdf的标题
pdf_file string pdf文件路径
type int 知识元是否组成知识点。0：否；1：单个知识元组成知识点；2多个知识元组成知识点
Knowledge_info json {id:知识点的id,title:知识点的题目}
vtt_json 否 json 字幕数据串
id int 编号id
sTime double 字幕的显示时间
eTime double 字幕的消失时间
content string 字幕的内容
topic_json 否 json 题目的数据串
question str 题目内容
answer array 答案信息
type string 题目类型。single：单选；multi:多选
id int 题目在题库中的id
showTime int 题目显示的时间
pdfDataID int 题目对应的pdfid
rightJumpTime int 答对跳转时间
errorJumpTime int 答错跳转时间
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"userinfo"：userinfo，"swpid":924} http://192.168.1.239/weikeAPI/getStuPro
Response
{"success":true}

3.学生端

3.1 获取教师列表

接口地址

/swl/share/fromList

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果

data信息解析

返回字段 字段类型 说明
username string 教师的username
nickname string 教师的昵称

请求接口用的都是username，nickname没有用到，nickname只是用来前端展示，一般是中文

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"userinfo"：userinfo} http://192.168.1.239/swl/share/fromList
Response
{"success":true,"data":[{"username":"admin","nickname":"管理员"},{"username":"pakit","nickname":"pakit"},{"username":"teacher2","nickname":"老师2号"},{"username":"kakaxi","nickname":"卡卡西"},{"username":"50","nickname":"吴老师"},{"username":"60","nickname":"严老师"},{"username":"70","nickname":"赵老师"},{"username":"yuwenlaoshi","nickname":"语文老师"}]}

3.2 我的微课

接口地址

/swl/all

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
page 否 string 页数，默认为1
size 否 string 一页显示数量，默认为15
stime 否 string 创建开始时间，默认为空
etime 否 string 创建结束时间，默认为空
title 否 string 题目，默认为空
teacher 否 string 创建者id，默认为空
userinfo 是 json 用户登陆信息
参数 必选 类型 说明
userinfo
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
pages Integer 返回总页数
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"userinfo"：{username:xxx,role:2}，"q":"k"} http://192.168.1.237/swl/all
Response
{"success":true,"data":[{"swlid":"95d78585-3314-4ad7-b44d-000bf133faec","creator_uid":"admin","creator_nickname":"管理员","title":"简介简介","duration":599.099,"image":"/video/photo/?path=storage/swlsource/video/39/f4c03753.mp4","is_open_topic":1,"video_url":"","poster":"","summary":"","require":"","create_time":"2017-02-08 16:39:54","knowledge":[{"klgid":"d5484376-85e4-4ed7-9434-b1ee92dd1fc1","title":"2","element_title":"","duration":23,"start_time":0,"end_time":23,"creator_uid":"admin","creator_nickname":"管理员","swpid":"918d03cf-3284-4da1-84ae-651529906173","swptitle":"","video_url":"storage/swlsource/video/39/f4c03753.mp4","video_name":"98888.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/5b/3686c2f8.pdf","assist_name":"3686c2f8.pdf","create_time":"2017-02-08 16:39:09","image":"storage/swlsource/pdf/5b/3686c2f8/1.png","hide":"","quote_count":"","topic_ids":"","knowledge_element":[{"elgid":"6d7ab477-a543-4f6b-a179-76918bead5cc","title":"2","creator_uid":"admin","creator_nickname":"管理员","pdf_url":"","pdf_json":{"id":0,"page":1,"sTime":0,"title":"2","type":"1","eTime":23,"duration":23},"vtt_json":[],"topic_json":[],"timeline_json":"","event_timeline_json":"","duration":23,"start_time":0,"end_time":23,"create_time":"2017-02-08 16:39:09"],"_id":148}],"question_total":0,"klg_total":9,"_id":11}]}],"pages":1}

3.3 知识点

接口地址

/knowledge/all

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
page 否 string 页数，默认为1
size 否 string 一页显示数量，默认为15
stime 否 string 创建开始时间，默认为空
etime 否 string 创建结束时间，默认为空
title 否 string 题目，默认为空
teacher 否 string 创建者id，默认为空
userinfo 是 json 用户登陆信息
参数 必选 类型 说明
userinfo
username 是 string 用户登陆信息
role 是 integer 用户角色，1为老师，2为学生
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
pages Integer 返回总页数
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"userinfo"：userinfo，"q":"zhisdhain"} http://192.168.1.239/knowledge/all
Response
{"success":true,"data":[{"klgid":"b6c2d703-4046-478a-a9da-330e7f6af144","title":"","element_title":"","duration":101,"start_time":172,"end_time":273,"creator_uid":"admin","creator_nickname":"管理员","swpid":"918d03cf-3284-4da1-84ae-651529906173","swptitle":"","video_url":"storage/swlsource/video/39/f4c03753.mp4","video_name":"98888.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/5b/3686c2f8.pdf","assist_name":"3686c2f8.pdf","create_time":"2017-02-08 16:39:09","image":"storage/swlsource/pdf/5b/3686c2f8/4.png","hide":"","quote_count":"","topic_ids":"","knowledge_element":[{"elgid":"1a634112-915f-406d-ba9e-2d6243888e96","title":"","creator_uid":"admin","creator_nickname":"管理员","pdf_url":"","pdf_json":{"page":4,"sTime":172,"eTime":273,"id":3,"type":"1","title":"","duration":101},"vtt_json":[],"topic_json":[],"timeline_json":"","event_timeline_json":"","duration":101,"start_time":172,"end_time":273,"create_time":"2017-02-08 16:39:09"}]}],"pages":1}

3.5 我的错题

接口地址

/statistics/student/wrong

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
RequestBody
creator_uid string 用户id 必需
swlid string 课件id 非必需
teacher_id string 老师id 非必需，用于需要根据老师id查询时
time string 时间id 非必需，用于需要根据老师id查询时
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
data Array 返回结果

data信息解析

返回字段 字段类型 说明
answer_id string 问题id
creator_uid string 学生id
teacher_id string 老师id
swlid string 课件id
klgid string 知识点id
topic_id string 问题id
question string 问题标题
create_time string 答题时间
round string 答题轮次
option Array 问题选项
answer Array 用户回答id
right_answer Array 正确答案id
is_right string 是否答对
接口示例

Request
curl -X get -H "Content-Type:application/json" -d {"userinfo"：userinfo，"q":"问题"} http://192.168.1.239/statistics/student/wrong
Response
{"status":200,"data":[{"creator_uid":"5112","klgid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","swlid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","topic_id":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","question":"nodejs底层使用什么语言实现的?","option":["javascript","c","java","go"],"answer":"2","right_answer":"1","is_right":"0","create_time":"2017-01-16 10:37:39"},{"creator_uid":"5112","klgid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","swlid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","topic_id":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","question":"nodejs底层使用什么语言实现的?","option":["javascript","c","java","go"],"answer":"2","right_answer":"1","is_right":"0","create_time":"2017-01-16 10:37:42"},{"creator_uid":"5112","klgid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","swlid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","topic_id":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","question":"nodejs底层使用什么语言实现的?","option":["javascript","c","java","go"],"answer":"2","right_answer":"1","is_right":"0","create_time":"2017-01-16 10:37:43"}]}

3.6 我的错题关联知识点功能

3.6.1 我的错题关联的知识点(单个微课)

接口地址

/statistics/student/wrongkonwledge

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
swlid string 课程id 必需
klgid string 问题关联的知识点id 必需
HTTP 响应状态

200

返回字段 字段类型 说明
result int 返回状态码

result

返回字段 字段类型 说明
title json 知识点名称
video_url json 视频路径
image json 截图
duration json 时长
swptitle json 课程名称
creator_nickname json 讲师
接口示例

Request
curl -X get -H "Content-Type:application/json" http://statistics.luobo.com/statistics/student/wrongkonwledge/:swlid/:klgid
Response
{"result":[{"klgid":"58059f12-e8a1-4f9e-94fe-7d99714e683d","title":"默认标题","element_title":"","duration":8,"start_time":0,"end_time":8,"creator_uid":"lilaoshi020701","creator_nickname":"李老师020701-修改信息","swpid":"85db4bd5-30f1-4070-9409-4279bf88c648","swptitle":"","video_url":"storage/swlsource/video/19/b42fb269.mp4","video_name":"黄老师课程-三合一.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/26/3e9c1005.pdf","assist_name":"3e9c1005.pdf","create_time":"2035-12-23 05:41:11","image":"storage/swlsource/pdf/26/3e9c1005/1.png","hide":"","quote_count":"","topic_ids":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","knowledge_element":[{"elgid":"9c348f41-a791-4497-bcb6-813b32b46e36","title":"默认标题","creator_uid":"lilaoshi020701","creator_nickname":"李老师020701-修改信息","pdf_url":"","pdf_json":{"id":0,"page":1,"sTime":0,"title":"默认标题","type":"1","eTime":8,"duration":8},"vtt_json":[{"sTime":4,"eTime":6,"content":"范德萨范德萨发大厦的地方"}],"topic_json":[{"creator_uid":"admin","type":"multiple","question":"黄老师课程-三合一的问答，PPT01","option":["D","D","C","D"],"answer":[{"content":"D","rightAnswer":"true"},{"content":"D","rightAnswer":"true"},{"content":"C","rightAnswer":"false"},{"content":"D","rightAnswer":"true"}],"create_time":"2035-12-23 04:54:07","topic_id":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","_id":136,"id":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","uuid":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","question_id":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","showTime":8,"pdfDataID":1,"page":2,"rightJumpTime":8,"errorJumpTime":0,"answerindex":[0,1,3]}],"timeline_json":"","event_timeline_json":"","duration":8,"start_time":0,"end_time":8,"create_time":"2035-12-23 05:41:11","klgid":"58059f12-e8a1-4f9e-94fe-7d99714e683d","swpid":"85db4bd5-30f1-4070-9409-4279bf88c648"}],"_id":2289}],"swltitle":"制作微课删除了知识点"}

3.6.2 我的错题关联的知识点(全部微课)

接口地址

/statistics/student/allwrongkonwledge

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
swlid string 课程id 必需
topic_id string 问题id 必需
HTTP 响应状态

200

返回字段 字段类型 说明
result int 返回状态码

result

返回字段 字段类型 说明
title json 知识点名称
video_url json 视频路径
image json 截图
duration json 时长
swptitle json 课程名称
creator_nickname json 讲师
接口示例

Request
curl -X get -H "Content-Type:application/json" http://statistics.luobo.com/statistics/student/allwrongkonwledge/:swlid/:topic_id
Response
{"result":[{"klgid":"58059f12-e8a1-4f9e-94fe-7d99714e683d","title":"默认标题","element_title":"","duration":8,"start_time":0,"end_time":8,"creator_uid":"lilaoshi020701","creator_nickname":"李老师020701-修改信息","swpid":"85db4bd5-30f1-4070-9409-4279bf88c648","swptitle":"","video_url":"storage/swlsource/video/19/b42fb269.mp4","video_name":"黄老师课程-三合一.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/26/3e9c1005.pdf","assist_name":"3e9c1005.pdf","create_time":"2035-12-23 05:41:11","image":"storage/swlsource/pdf/26/3e9c1005/1.png","hide":"","quote_count":"","topic_ids":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","knowledge_element":[{"elgid":"9c348f41-a791-4497-bcb6-813b32b46e36","title":"默认标题","creator_uid":"lilaoshi020701","creator_nickname":"李老师020701-修改信息","pdf_url":"","pdf_json":{"id":0,"page":1,"sTime":0,"title":"默认标题","type":"1","eTime":8,"duration":8},"vtt_json":[{"sTime":4,"eTime":6,"content":"范德萨范德萨发大厦的地方"}],"topic_json":[{"creator_uid":"admin","type":"multiple","question":"黄老师课程-三合一的问答，PPT01","option":["D","D","C","D"],"answer":[{"content":"D","rightAnswer":"true"},{"content":"D","rightAnswer":"true"},{"content":"C","rightAnswer":"false"},{"content":"D","rightAnswer":"true"}],"create_time":"2035-12-23 04:54:07","topic_id":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","_id":136,"id":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","uuid":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","question_id":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","showTime":8,"pdfDataID":1,"page":2,"rightJumpTime":8,"errorJumpTime":0,"answerindex":[0,1,3]}],"timeline_json":"","event_timeline_json":"","duration":8,"start_time":0,"end_time":8,"create_time":"2035-12-23 05:41:11","klgid":"58059f12-e8a1-4f9e-94fe-7d99714e683d","swpid":"85db4bd5-30f1-4070-9409-4279bf88c648"}],"_id":2289}],"swltitle":"制作微课删除了知识点"}

3.7 通过swlid获取课程

接口地址

/swl

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestPath
swlid 是 string 课程id
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Json 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" http://192.168.1.239/swl/swlid
Response
{"success":true,"data":{"page":3,"sTime":3,"id":2,"title":"阿萨德群","duration":2,"swpid":"pakit_8","_id":7609,"swpinfo":{"id":8,"name":"pa221.mp4","fullname":"storage/public/lubocam/pakit/pa221.mp4","type":"video","size":34657748,"time":1482990012,"phototime":134,"encrypt":0,"zip":1,"start_time":"0000-00-00 00:00:00","end_time":null,"duration":134,"camname":null,"sf1":null,"sf2":null,"sf3":null,"userid":"pakit","nickname":"pakit","swpid":"pakit_8","introduction":"","questionsnum":1,"knowlegenum":3,"_id":63}},{"page":2,"sTime":2,"id":1,"duration":2,"swpid":"pakit_10","_id":7668,"swpinfo":{"id":10,"name":"pa23.mp4","fullname":"storage/public/lubocam/pakit/pa23.mp4","type":"video","size":34657680,"time":1482990066,"phototime":134,"encrypt":0,"zip":1,"start_time":"0000-00-00 00:00:00","end_time":null,"duration":134,"camname":null,"sf1":null,"sf2":null,"sf3":null,"userid":"pakit","nickname":"pakit","swpid":"pakit_10","introduction":"","questionsnum":2,"knowlegenum":2,"_id":64}}}

3.8 撕书功能

3.8.1 保存撕书记录

接口地址

/wipe/add

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
wipe_id 否 string 唯一识别码uuid，撕书id
create_time 否 string 创建时间
username 是 string 创建者id
swlid 是 string 课件id
klgid 是 string 知识点id
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 保存结果
error string 错误信息，如错误，返回，否则没有
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"swlid"："123321"，klgid:"123321"}
url: http://ip:port/wipe/add
Response
成功:{"result":success}
失败:{"result":failure}

3.8.2 删除撕书记录

接口地址

/wipe/

HTTP Content-Type / 请求方式

application/json
DELETE

请求参数
参数 必选 类型 说明
RequestBody
wipe_id 否 string 唯一识别码uuid，撕书id
create_time 否 string 创建时间
username 是 string 创建者id
swlid 是 string 课件id
klgid 是 string 知识点id
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 删除记录结果
error string 错误信息，如错误，返回，否则没有
接口示例

Request
curl -X DELETE -H "Content-Type:application/json" -d {"swlid"："123321"，klgid:"123321"}
url: http://ip:port/wipe/delete
Response
{"success":true}

4. 课程

4.1 课程列表
接口地址

/course/all

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
RequestBody
title 否 string 课程标题，用于搜索
page 是 string 分页数
size 是 int 每页显示数目
stime 否 int 开始时间，用于搜索
etime 否 int 结束时间，用于搜索
grade 否 int 年级，用于搜索
subject 否 int 学科，用于搜索
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data array 返回数据

data

返回字段 字段类型 说明
data array 数组
totalPage int 总页数
total int 总数
options array 下拉选项
4.2 提交课程
接口地址

/course

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
courseid 否 string 课程id；修改时必传
image 否 string 图片
poster 否 string 封面
summary 否 string 简介
grade 否 string 年级；（大学时为科目）
subject 否 string 学科；(大学时为科目下的专业)
subject_category 否 string (大学时)学科分类
title 否 string 标题
HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
4.3 删除课程
接口地址

/course/:courseid

HTTP 请求方式

DELETE

HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
4.4 获取单个课程信息
接口地址

/course/:courseid

HTTP 请求方式

GET

HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
4.5 编辑课程标题
接口地址

/course/replace/title

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
courseid 是 string 课程id
title 否 string 标题
HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
4.6 编辑课程
接口地址

/course/:courseid

HTTP 请求方式

PUT

HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
4.7 课时列表
接口地址

/course/allchapter

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
courseid 是 string 课程id
HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
chapter int 第几章节
study_total int 学习人数
4.8 选择课时/复制课时
接口地址

/course/copyswl

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
swlid 是 string 课时id;多个课时id用','隔开
HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
4.9 选择学生列表
接口地址

/course/shareStudent/:courseid

HTTP 请求方式

GET

HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
4.10 删除课时
接口地址

/course/swl/:courseid/:swlid

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
users 是 array 用户列表
nickname 是 array 昵称
courseid 是 string 课程id
HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
4.11 课程分享
接口地址

/course/share/:courseid

HTTP 请求方式

POST

HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败

5. 课时

5.1 课程列表
接口地址

/swl/all

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
title 否 string 课程标题，用于搜索
page 是 string 分页数
size 是 int 每页显示数目
stime 否 int 开始时间，用于搜索
etime 否 int 结束时间，用于搜索
grade 否 int 年级，用于搜索
subject 否 int 学科，用于搜索
courseid 否 int 课程id，用于搜索
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data array 返回数据

data

返回字段 字段类型 说明
data array 数组
totalPage int 总页数
total int 总数
options array 下拉选项
5.2 提交课时
接口地址

/swl

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
swlid 否 string 课时id；修改时必传
courseid 是 string 课程id
image 是 string 截图
poster 是 string 封面
summary 是 string 简介
grade 是 string 年级（大学时为科目）
subject 是 string 学科（大学时为科目下专业）
coursetype 是 string 课程类型（预习课
subject_category 否 string 大学时学科
title 是 string 标题
is_open_topic 是 int 开启问答
is_open 否 int 是否发布
klg_total 是 int 知识点总数
question_total int 是 问题总数
duration 是 int 视频时长
video_url 是 string 视频地址
kplist 是 array 知识点数组
HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
5.3 删除课时
接口地址

/course/:swlid

HTTP 请求方式

DELETE

HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
5.4 获取单个课程信息
接口地址

/swl/:swlid

HTTP 请求方式

GET

HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
5.5 获取分享教师列表
接口地址

/swl/share/fromList

HTTP 请求方式

GET

HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
5.6 保存课时
接口地址

/swl/:swlid

HTTP 请求方式

PUT

HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
5.7 课时知识点播放列表
接口地址

/swl/goPlay/:swlid

HTTP 请求方式

GET

HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
data array 返回数据

6. 工程swp

6.1 工程列表
接口地址

/swp/all

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
title 否 string 课程标题，用于搜索
page 是 string 分页数
size 是 int 每页显示数目
stime 否 int 开始时间，用于搜索
etime 否 int 结束时间，用于搜索
grade 否 int 年级，用于搜索
subject 否 int 学科，用于搜索
courseid 否 int 课程id，用于搜索
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data array 返回数据

data

返回字段 字段类型 说明
data array 数组
totalPage int 总页数
total int 总数
options array 下拉选项
6.2 提交工程
接口地址

/swp

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
swpid 否 string id；修改时必传
sn 是 string 微录播主机sn
image 是 string 截图
grade 是 string 年级
subject 是 string 学科
title 是 string 标题
pdfName 是 string pdf名称
pdfUrl 是 int pdf地址
video_name 是 string 视频名称
video_url 是 string 视频地址
knowledge 是 array 知识点数组
HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
6.3 删除工程
接口地址

/swp/:swpid

HTTP 请求方式

DELETE

HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
6.4 获取单个工程信息
接口地址

/swp/:swlid

HTTP 请求方式

GET

HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败
6.5 保存工程
接口地址

/swp/:swpid

HTTP 请求方式

PUT

HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回请求状态；true请求成功；false请求失败

7. 知识点

7.1 创建知识点
接口地址

/swp/all

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
title 否 string 课程标题，用于搜索
page 是 string 分页数
size 是 int 每页显示数目
stime 否 int 开始时间，用于搜索
etime 否 int 结束时间，用于搜索
grade 否 int 年级，用于搜索
subject 否 int 学科，用于搜索
courseid 否 int 课程id，用于搜索
is_open 否 int 是否公开;默认:1，用于搜索
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data array 返回数据

data

返回字段 字段类型 说明
data array 数组
totalPage int 总页数
total int 总数
options array 下拉选项
7.2 知识点公开操作
接口地址

/knowledge/controlopen

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数(公开)
参数 必选 类型 说明
RequestBody
klgids 是 string 知识点id,多个用','隔开
is_open 是 int 1
open_type 是 int 公开类型；0：默认不公开;1:完全公开:可被检索、观看及引用;2:不完全公开:可被检索、观看，不可被引用
price 否 int 价格
请求参数(取消)
参数 必选 类型 说明
RequestBody
klgids 是 string 知识点id,多个用','隔开
is_open 是 int 0
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data array 返回数据
7.3 知识点编辑
接口地址

/knowledge/:klgid

HTTP Content-Type

application/json

HTTP 请求方式

PUT

请求参数
参数 必选 类型 说明
RequestBody
title 是 string 知识点标题
duration 否 int 知识点总时长
sn 否 string 微录播sn
location 是 string 地理坐标;格式X,Y
subject 是 int 学科
grade 是 int 年级
description 是 string 描述
video_name 否 string 视频名称
video_url 否 string 视频地址
pdfUrl 否 string pdf地址
pdfName 否 string pdf名称
resources 否 array 知识点内容hashid
clips 否 array 知识点内容
poster 是 string 封面
is_open 是 int 是否公开
open_type 是 int 公开类型；0：默认不公开;1:完全公开:可被检索、观看及引用;2:不完全公开:可被检索、观看，不可被引用
price 是 int 价格
tag 是 int 1
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data array 返回数据
7.4 知识点列表
接口地址

/knowledge/all

HTTP Content-Type / 请求方式

application/json
GET

请求参数

RequestBody

参数 必选 类型 说明
page 否 string 页数，默认为1
size 否 string 一页显示数量，默认为15
stime 否 string 创建开始时间，默认为空
etime 否 string 创建结束时间，默认为空
title 否 string 题目，默认为空
is_open 否 string 是否公开;1:公开
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
pages Integer 返回总页数
7.5 删除知识点
接口地址

/knowledge/:klgids
klgids多个klgid用','隔开

HTTP Content-Type / 请求方式

application/json
DELETE

HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果

8. 互动

8.1 点赞
接口地址

/agree

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
swlId 是 string 课时swlid
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data array 返回数据

{
"success": true,
"data": {
"agreeId": "6911be15-ec13-406a-b691-c787281b96e1",
"fromId": "339",
"swlId": "2d66db4b-ac61-4887-92b2-8326237ec6db",
"status": 1,
"createTime": "2017-08-02 17:00:00",
"_id": "598194901ce3f60c329d1951"
}
}

8.2 查询点赞状态
接口地址

/agree/{swlid}

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
RequestBody
swlId 是 string 课时swlid
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data array 返回数据

{
"success": true,
"data": {
"status": 1
}
}

8.3 点赞总数
接口地址

/agree/count/{swlid}

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
RequestBody
swlId 是 string 课时swlid
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data array 返回数据

{
"success": true,
"data": {
"swlId": "2d66db4b-ac61-4887-92b2-8326237ec6db",
"count": 8
}
}

9. m3u8切片任务对接

9.1 切片任务结果回调
接口地址

/m3u8/task_ret

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
taskid 是 string m3u8切片任务id
status 是 int 任务的状态
error 是 string 任务出错返回信息
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果
9.2 获取未完成的切片任务
接口地址

/m3u8/get_tasks

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
RequestBody
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 请求结果
data array 切片的任务数组

data数组结构

返回字段 字段类型 说明
m3u8_path string m3u8地址
callback_url string 回调的地址

10. 统计数据上报

10.1 统计数据上报
调用函数

service/agency.js uploadData

传参

|参数|必选|类型|说明|
|action|是|object|上报的内容|
|topic |是|string|上报的topic；必须以'_topic'结尾|

互动上报消息内容结构

{
"clientid":"org_2_0_0_0_0",//学校机构id org_2_0_0_0_0
"timetag":"1505182067",//时间戳 准确到秒
"user_type":"teacher",//用户类型;teacher,student
"user_id":"1",//帐号id
"user_name":"XXX",//帐号名
"course_id":"XXX",//课程id
"course_name":"XXX",//课程标题
"speak_total":"1",//发言数
}

11. 微录播主机健康数据

11.1 获取单个微录播主机健康数据
接口地址

/nodehost/getinfo/:sn

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
sn 是 string 微录播主机sn
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果
data json 微录播的主机健康数据

data

参数 类型 说明
sn string 主机的sn码
totalmem int 总的内存
cpu float 主机的cpu负载，百分比
freemem int 剩余的内存(单位：btye)
eth array 网卡信息（详细信息如下）
hds array 硬盘信息（详细信息如下）
vfs object 存储空间（详细信息如下）
onlineTime int 在线时长（单位：s）
updateTime string 更新时间（格式：yyyy-MM-dd HH:mm:ss）

eth

参数 类型 说明
name string 网卡名称
rx int 接收字节数(单位：btye)
tx int 发送字节数(单位：btye)
addressIP string 网卡地址

hds

参数 类型 说明
name string 硬盘名称
Power_On_Hours int 已经运转的时长(单位：h)
Temperature_Celsius int 当前的温度(单位：℃)

vfs

参数 类型 说明
total int 存储总空间
free int 剩余空间

12. m3u8播放

12.1 获取m3u8播放地址
接口地址

/m3u8/preview

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
predata 是 json_arr 预览的资源数组，包含开始和结束时间
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果
path string m3u8地址
duration int 单位是毫秒
12.2 刷新内网m3u8地址
接口地址

/m3u8/refresh

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
hashid 是 string m3u8的第一个资源的hashid
fullname 是 string m3u8的路径
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果
path string m3u8地址
duration int 单位是毫秒

13. 我的消息

13.1 直播提醒
接口地址

/appmsg/live

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
page 是 int 页数
size 是 int 页显示数目
access_token 是 int 授权认证
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果
data array 数据
13.2 课程提醒
接口地址

/appmsg/course

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
page 是 int 页数
size 是 int 页显示数目
access_token 是 int 授权认证
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果
data array 数据

data

返回字段 字段类型 说明
browse int 0未查阅，1已查阅
13.3 直播消息状态更新
接口地址

/appmsg/live

HTTP Content-Type

application/json

HTTP 请求方式

PUT

请求参数
参数 必选 类型 说明
RequestBody
share_id 是 string 分享直播id;多个share_id用','隔开
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果
data array 数据

data

返回字段 字段类型 说明
browse int 0未查阅，1已查阅
13.4 课程消息状态更新
接口地址

/appmsg/course

HTTP Content-Type

application/json

HTTP 请求方式

PUT

请求参数
参数 必选 类型 说明
RequestBody
share_id 是 string 分享课程id;多个share_id用','隔开
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果
data array 数据
13.5 我的消息查阅(返回未查看)
接口地址

/appmsg

HTTP Content-Type

application/json

HTTP 请求方式

GET

HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果
data array 数据

data

返回字段 字段类型 说明
live int 直播消息数据
course int 课程消息数据

{"success":true,"data":{"live":{"disbrowse":12,"item":{"_id":"5a0269dde7853011dded7e5d","direct_id":"1e0ecbf0-8c0c-4154-8b1d-4deb7d68ebb6","title":"课时20171108101905","introduction":"","poster":"","status":2,"hide":1,"creator_uid":"21","creator_nickname":"peng1","phone_id":"94652d25c5d3","live_url":"rtmp://live.galaxyclouds.cn/live/2918a000-08b2-4825-a620-9350de282c33","pdf_json":"","camera_json":"{\"cameraType\":2,\"currentVideoSn\":\"\",\"currentAudioSn\":\"\",\"data\":\"\",\"lesId\":\"1e0ecbf08c0c41548b1d4deb7d68ebb6\",\"schId\":\"1e0ecbf08c0c41548b1d4deb7d68ebb6\",\"studentLiveUrl\":\"\"}","people_num":0,"start_time":"2017-11-08 10:19:05","update_time":"2017-11-08 10:34:43","creator_username":"peng1","organId":"2","organName":"矽伟智小学","cdn_url":"rtmp://live.galaxyclouds.cn/live/2918a000-08b2-4825-a620-9350de282c33","channel_id":"5a0269986d68adfd57b3ab2c","get_peerstar":"1","share_id":"d9b7fc2e-9f1e-4cd1-a1db-dca3f77729d1"}},"course":{"disbrowse":37,"item":{"_id":"59b8a5497ce33571da986221","courseid":"253978ac-4126-46e4-a087-e8fed01eb8e4","creator_uid":"2","creator_nickname":"peng","title":"新课程201709131128","create_time":"2017-09-13 11:26:01","sn":"","summary":"","subject":101,"subject_category":"","grade":1,"poster":"","location":"","clist":[],"playNum":0,"cloud":0,"hide":0,"update_time":"2017-10-24 19:57:37","share_id":"80eebaf7-6b0f-418e-b914-690eb6d6d61f"}}}}

14. 相机表情

14.1 查询相机拍摄的相片列表
接口地址

/facelist/list

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
sn 是 string 相机sn
time 是 int 查询时间
lesId 是 int 课次id
order 是 int 排序;1:正序;-1:倒序
show 否 int 显示审核;1:需要审核
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果
data array 数据

返回示例
{"success":true,"data":[{"_id":"5aa777308fc6b0097d1bd761","sn":"ukitxwz100033","filewidth":4096,"fileheight":2160,"filename":"http://oss.sewise.com/upload/group17/ukitxwz100033/20180313150036/20180313150036.jpg","students":[{"uid":"1473","nickname":"昌14","curprecent":"0.90","precent":"0.68","top":1406,"left":3105,"width":203,"height":203},{"uid":"22759","nickname":"洪榆200","curprecent":"0.77","precent":"0.75","top":1212,"left":601,"width":152,"height":152},{"uid":"22900","nickname":"朱宗鹏341","curprecent":"0.68","precent":"0.68","top":1068,"left":2744,"width":152,"height":152}],"startDate":"2018-03-13 14:57","endDate":"2018-03-13 15:16","lesId":"3973","lesName":"-1","timetag":1520924463,"schId":"634","schName":"初一语文","tid":"1058","organId":"17","show":1}]}

14.2 查询课次相片下的学生专注度列表
接口地址

/facelist/student

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
tid 是 int 老师id
lesId 是 int 课次id
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果
data array 数据

返回示例
{"success":true,"data":[{"uid":"28095","nickname":"司诚杰","precent":0.93,"avator":"./upload/images/201803141455005aa8c744820fc.png"},{"uid":"28091","nickname":"罗卓婷","precent":0.91,"avator":"./upload/images/201803141454265aa8c7221d0b5.png"}]}

14.3 查询当前课堂表情专注度
接口地址

/facelist/teacher/focusRanking

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
tid 否 int 老师id
lesId 否 int 课次id
sid 否 int 学生id
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果
data array 数据

返回示例
{"success":true,"list":[{"time":1521072125,"precent":"0.87","count":6},{"time":1521072184,"precent":"0.92","count":3},{"time":1521072245,"precent":"0.85","count":6},{"time":1521072305,"precent":"0.96","count":4},{"time":1521072365,"precent":"0.83","count":4},{"time":1521072426,"precent":"0.92","count":2}]}

14.4 查询当前课堂表情百分比
接口地址

/facelist/teacher/faceRectangle

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
tid 否 int 老师id
lesId 否 int 课次id
sid 否 int 学生id
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果
happy string 开心百分比
calm string 平静百分比
low string 低落百分比

返回示例
{"success":true,"happy":"0.01","calm":"0.98","low":"0.00"}

14.5 修改表情数据
接口地址

/facelist/fixFace

HTTP Content-Type

application/json

HTTP 请求方式

post

请求参数
参数 必选 类型 说明
RequestBody
sn 是 string 相机sn
lesId 是 int 课次id
timetag 是 int 照片时间
studentlist 是 int 需要修改的帐号id
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果

返回示例
{"success":true}

14.6 相机上报
接口地址

/statistics/faceRectangle

HTTP Content-Type

application/json

HTTP 请求方式

post

请求参数
参数 必选 类型 说明
RequestBody
information 是 string 表情数据
filename 是 int 照片地址
userinfo 是 json 用户信息
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果

返回示例
请求数据：
{"filename":"http://oss.sewise.com/upload/group79/ukitxwz100009/20180315102804/20180315102804.jpg","information":[{"faceRectangle":{"height":121,"left":765,"top":1058,"width":121},"scores":{"anger":0.0005940085,"contempt":0.000714574358,"disgust":0.000444061821,"fear":0.00016569026,"happiness":0.002920535,"neutral":0.9849383,"sadness":0.00718134036,"surprise":0.00304147834},"sn":"ukitxwz100009","time":20180315102804,"uid":"28070"},{"faceRectangle":{"height":104,"left":1768,"top":929,"width":104},"scores":{"anger":0.0004059668,"contempt":0.00179332891,"disgust":6.299726e-05,"fear":2.61185978e-05,"happiness":0.000204029377,"neutral":0.96462,"sadness":0.032630492,"surprise":0.000257082836},"sn":"ukitxwz100009","time":20180315102804,"uid":"28098"},{"faceRectangle":{"height":100,"left":2571,"top":934,"width":100},"scores":{"anger":0.00470806146,"contempt":0.00295329327,"disgust":0.00137978932,"fear":0.00148263038,"happiness":0.0006220633,"neutral":0.9512106,"sadness":0.0129520418,"surprise":0.0246914737},"sn":"ukitxwz100009","time":20180315102804,"uid":"28110"},{"faceRectangle":{"height":68,"left":2568,"top":722,"width":68},"scores":{"anger":0.00652944,"contempt":0.009754655,"disgust":0.00139859971,"fear":0.000151364133,"happiness":0.0451641679,"neutral":0.9334973,"sadness":0.00127750461,"surprise":0.00222694757},"sn":"ukitxwz100009","time":20180315102804,"uid":"28072"}]}

返回结果：
{"success":true}

14.7 查询当前上课学生列表
接口地址

/api/v1/api/checkLesson

HTTP Content-Type

application/json

HTTP 请求方式

post

请求参数
参数 必选 类型 说明
RequestBody
userId 是 string 用户id;多个用','隔开
curtime 是 int 当前时间截，秒
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果

返回示例
请求数据：

返回结果：
{
"status": 200,
"data": [
28104
],
"students": ""
}

14.8 app表情上报
接口地址

/statistics/appFaceRectangle

HTTP Content-Type

application/json

HTTP 请求方式

post

请求参数
参数 必选 类型 说明
RequestBody
information 是 string 表情数据
filename 是 int 照片地址

information

参数 必选 类型 说明
RequestBody
faceRectangle 是 array 表情坐标
scores 是 array 表情数据
time 是 long 上报时间;以秒为准
type 是 int 上报类型;1:相机，2：课时上报
user 是 array 用户信息;用户id:uid,用户昵称:nickname，老师id:tid,机构id:organId
content 是 array 相关内容信息;如是课时上报，上报courseid,swlid,klgid,subject,klgtitle,playTime

|playTime|是|int|当前内容播放时间;秒为单位|

HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果

返回示例
请求数据：
{"filename":"a.jpg","information":{"faceRectangle":{"height":121,"left":765,"top":1058,"width":121},"scores":{"anger":0.000595,"contempt":0.0007145358,"disgust":0.000444061821,"fear":0.00016569026,"happiness":0.002920535,"neutral":0.9849383,"sadness":0.00718134036,"surprise":0.00304147834},"sn":"ukitxwz100009","time":20180315102804,"type":"2","user":{"uid":"1016","nickname":"333","tid":"1013","organId":"24"},"content":{"courseid":"f1e1396d-e5d0-4918-a3a8-0281dd2e6dad","swlid":"13d5b77c-d0a7-437c-a6bb-630533c5482a","klgid":"bee2b066401d3faad0b3204466756e0a","klgtitle":"角度与创意讲解-知识点1","subject":"541","playTime":"58"}}}

返回结果：
{"success":true}

15 知识点公共数据接口

15.1 知识点公共数据接口
接口地址

/api/v1/marks/list

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
organKind 否 string 机构类型id;1小学，2初中，3高中，4大学
parent 否 int 考点上一级id
parent 否 int 考点上一级id
请求参数（根据请求考点id返回数据结构）
参数 必选 类型 说明
RequestBody
ids 否 string 考点id;多个id用","隔开
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果

返回示例
请求数据：

15.2 知识点公共数据接口(微录播)
接口地址(只支持按机构类型分类)

/weilubo_api/getMarks

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
organKind 否 string 机构类型id;1小学，2初中，3高中，4大学
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean http请求结果

返回示例
请求数据：

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注