[关闭]
@sewise-dev 2018-05-09T09:55:15.000000Z 字数 49623 阅读 1021

知识元外部API接口文档

知识元

更新历史

编号 版本 说明 作者 日期
1 v1.0 1.创建文档 Seven 2017-06-30

目录

【备注】

1. 全局返回码说明

每次调用接口时，可能获得正确或错误的返回码，开发者可以根据返回码信息调试接口，排查错误。

返回码 说明
-1 系统繁忙，此时请开发者稍候再试
0 请求失败
1 请求成功
200 响应成功
403 禁止访问
404 异常错误
500 数据验证错误
40001 不合法的凭证，或者access_token无效。
40004 不合法请求

HTTP请求状态返回格式

返回字段 字段类型 说明
status Integer 请求返回码(详细请见状态表)
message String 返回描述
data Array 返回结果

错误样例
{
"status": 40013,
"message": {"0":"invalid appid"}
}
成功样例
{
"status": 200,
"data": {"access_token":"ACCESS_TOKEN","expires_in":7200}
}

1.用户中心

1.1 获取access_token（第三方平台）

接口地址

/v1/channel/token

HTTP Content-Type / 请求方式

application/json
GET/POST

请求参数
参数 必选 类型 说明
RequestBody
appid 是 String 第三方用户唯一凭证
secret 是 String 第三方用户唯一凭证密钥，即appsecret
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/v1/channel/token?appid=xxx&secret=xxx&uid=xxx
Response
{"status": 200,"data":{"access_token":"gUYwMqAVz11X5LLRMuDQadO8FQqkFS1wNxxrRKnM","expire": "2017-07-12 10:47:40"}}

1.2 验证access_token鉴权有效性（第三方平台）

接口地址

/v1/channel/auth

HTTP Content-Type / 请求方式

application/json
GET/POST

请求参数
参数 必选 类型 说明
PathParam
access_token 是 String 授权签名

例如： /v1/channel/auth?access_token={access_token}

HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/v1/channel/auth?access_token={access_token}
Response
{"status":200,"data":{xxx}}

1.3 获取单用户授权access_tokne（单用户）

接口地址

/v1/user/getToken

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 第三方平台鉴权签证
uid 是 string 第三方平台的用户uid

或

参数 必选 类型 说明
RequestBody
appid 是 String 第三方用户唯一凭证
secret 是 String 第三方用户唯一凭证密钥，即appsecret
uid 是 string 第三方平台的用户uid
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X get -H "Content-Type:application/json" -d http://v.sewise.com/weike?access_token=QVlBvVaijyRW2cRDVyF823zQoD8nXAV5QnBaK75O&uid=33846

1.4 配置回调地址

接口地址

/v1/channel/configure

HTTP Content-Type / 请求方式

application/json
post

请求参数
参数 必选 类型 说明
RequestBody
appid 是 String 第三方用户唯一凭证
secret 是 String 第三方用户唯一凭证密钥，即appsecret
callbackUrl 是 string 回调地址
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X get -H "Content-Type:application/json" -d http://v.sewise.com/v1/channel/configure
Response
{"status":200,"data":"http:\/\/manage.yunduoketang.cn\/video\/weiluboCallback"}

1.5 渠道跳转微录播

接口地址

/weike?access_token={access_token}&uid={uid}

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 第三方平台鉴权签证
uid 是 string 第三方平台的用户uid

或

参数 必选 类型 说明
RequestBody
access_token 是 string 单用户鉴权签证
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X get -H "Content-Type:application/json" -d http://v.sewise.com/weike?access_token=QVlBvVaijyRW2cRDVyF823zQoD8nXAV5QnBaK75O&uid=33846

2.录课

2.1 课程列表

接口地址

/course/all

HTTP Content-Type / 请求方式

application/json
GET

请求参数

RequestBody

参数 必选 类型 说明
RequestBody
access_token 是 string 第三方平台鉴权签证
uid 是 string 第三方子用户uid
size 否 int 页码
page 否 int 页数
title 否 string 搜索标题

或

参数 必选 类型 说明
RequestBody
access_token 是 string 单用户鉴权签证
size 否 int 页码
page 否 int 页数
title 否 string 搜索标题
HTTP 响应状态

200

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

Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/course/all?access_token=xxxxxx

2.2.1 该课程所有课时列表

接口地址

/course/allChapter

HTTP Content-Type / 请求方式

application/json
GET

请求参数

RequestBody

参数 必选 类型 说明
RequestBody
courseid 是 string 第三方平台鉴权签证
access_token 是 string 第三方平台鉴权签证
uid 是 string 第三方子用户uid
HTTP 响应状态

200

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

Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/course/allChapter?courseid=xxxxx&access_token=xxxxxx
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}]}]}

2.2.2 云空间课时列表

接口地址

/swl/cloudChapter

HTTP Content-Type / 请求方式

application/json
GET

请求参数

RequestBody

参数 必选 类型 说明
RequestBody
access_token 是 string 第三方平台鉴权签证
uid 是 string 第三方子用户uid
HTTP 响应状态

200

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

Request
curl -X GET -H "Content-Type:application/json" -d http://api.sewise.com/swl/cloudChapter?access_token=xxxxxx
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}]}]}

2.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，默认为空
access_token 是 string 第三方平台鉴权签证
uid 是 string 第三方子用户uid
HTTP 响应状态

200

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

Request
curl -X get -H "Content-Type:application/json" -d
http://api.sewise.com/knowledge/all?access_token=xxxx
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 公开课列表

接口地址

/course/allCloud

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
page 否 string 页数，默认为1
size 否 string 一页显示数量，默认为15
stime 否 string 创建开始时间，默认为空
etime 否 string 创建结束时间，默认为空
title 否 string 题目，默认为空
grade 否 string 年级，默认为空
subject 否 string 学科，默认为空
order 否 string 按时间/标题排序，默认为按时间
access_token 是 string 第三方平台鉴权签证
uid 是 string 第三方子用户uid
HTTP 响应状态

200

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

Request
curl -X get -H "Content-Type:application/json" -d
http://vtest.sewise.com/course/allCloud?access_token=xxxx

Response
{"success":true,"data":[]}

2.5 生成APP录课二维码

接口地址

/weike/qrcode/{access_token}

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 第三方平台鉴权签证
uid 是 string 第三方子用户uid
HTTP 响应状态

200

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

Request
curl -X get -H "Content-Type:application/json" -d
http://api.sewise.com/weike/qrcode?access_token=xxxx

2.6 生成课时回调

接口地址

/xxxx

HTTP Content-Type / 请求方式

application/json
post

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

200

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

Request
{
"success": true,
"data": {
"_id": "5955b556433499315916b6dd",
"swlid": "03992d26-3f5f-4a56-b686-2acdb4a374b0",
"creator_uid": "36",
"creator_nickname": "张国荣",
"title": "滑雪",
"image": "/img/f0d035d31776ff06c00731f9eeb54fac",
"is_open_topic": 1,
"poster": "/resource/1ed538294ab08a348110eece18050dd7",
"summary": "",
"require": "",
"create_time": "2017-06-30 10:20:06",
"courseid": "cf5958e4-d405-4236-b641-ed8efa73ee51",
"is_open": 1,
"question_total": 1,
"klg_total": 5,
"duration": 154.969777,
"video_url": "/resource/f0d035d31776ff06c00731f9eeb54fac",
"click": 1,
"grade": 3,
"subject": 107,
"coursetype": "预习课",
"subject_category": "",
"hide": 0,
"cloud": 1,
"hashId": "b290b9c3930366ac3876d6a6e460eb94",
"m3u8_path_out": "/storage/swlsource/m3u8/cs/b290b9c3930366ac3876d6a6e460eb94.m3u8",
"coursetitle": "新课程201706301006",
"chapter": 4
}
}

2.7 删除课时

接口地址

/course/swl/{courseid}/{swlid}?access_token={access_token}

HTTP Content-Type / 请求方式

application/json
delete

请求参数
参数 必选 类型 说明
RequestBody
courseid 是 string 课程id
swlid 是 string 课时id
access_token 是 string 第三方平台鉴权签证
HTTP 响应状态

200

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

Request
{"success":true,"swlid":"19d31f15-1c6e-43ea-9039-70363b610561"}

3.播放

3.1 微课信息

接口地址

/swl/{swlid}?access_token={access_token}&uid={uid}

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestPath
swlid 是 string 知识点课id
access_token 是 string 第三方平台鉴权签证
uid 是 string 第三方子用户uid
HTTP 响应状态

200

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

Request
curl -X GET -H "Content-Type:application/json" http://v.sewise.com/swl/{swlid}{access_token}{uid}
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.2 播放器播放

接口地址

/swl/m3u8

HTTP Content-Type / 请求方式

application/json
GET

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

200

返回字段 字段类型 说明
success Booleans 返回状态码
path String 播放地址
接口示例

Request
curl -X GET -H "Content-Type:application/json" http://v.sewise.com/swl/m3u8
Response
{"success":true,"path":"http://sp05av100033108a.nrp.sewise.com.cn/storage/swlsource/m3u8/preview/1499674999620_29DA.m3u8"}

3.3 发布云空间

接口地址

/course/toCloud

HTTP Content-Type / 请求方式

application/json
post

请求参数
参数 必选 类型 说明
RequestPath
courseArr 是 数组 课程id的集合
access_token 是 string 第三方平台鉴权签证
uid 是 string 第三方子用户uid
HTTP 响应状态

200
Response
{"success":true,"msg":""}

3.4 删除云空间课程

接口地址

/course/cloudDelete/:courseid

HTTP Content-Type / 请求方式

application/json
delete

请求参数
参数 必选 类型 说明
RequestPath
courseid 是 string 课程的id，多个用逗号隔开
access_token 是 string 第三方平台鉴权签证
uid 是 string 第三方子用户uid
HTTP 响应状态

200
Response
{"success":true,"msg":""}

4.学生端

4.1 获取教师列表

接口地址

/swl/share/fromList

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 单用户鉴权签证
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 {"access_token"："xxxxxx"} http://api.sewise.com/swl/share/fromList?access_token=xxxx
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":"语文老师"}]}

4.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，默认为空
access_token 是 string 单用户鉴权签证
HTTP 响应状态

200

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

Request
curl -X GET -H "Content-Type:application/json" -d {"access_token"："xxxxx"，"q":"k"} http://api.sewise.com/swl/all?{access_token}
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}

4.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，默认为空
access_token 是 string 单用户鉴权签证
HTTP 响应状态

200

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

Request
curl -X GET -H "Content-Type:application/json" -d {"access_token"："xxxx"，"q":"zhisdhain"} http://api.sewise.com/knowledge/all?{access_token}
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}

4.4 我的错题

接口地址

/statistics/student/wrong

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 单用户鉴权签证
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 {"access_token"："xxx"，"q":"问题"} http://api.sewise.com/statistics/student/wrong?{access_token}
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"}]}

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

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

接口地址

/statistics/student/wrongkonwledge

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
access_token 是 string 单用户鉴权签证
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://api.sewise.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":"制作微课删除了知识点"}

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

接口地址

/statistics/student/allwrongkonwledge

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
access_token 是 string 单用户鉴权签证
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://api.sewise.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":"制作微课删除了知识点"}

4.6 通过swlid获取课程

接口地址

/swl

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestPath
access_token 是 string 单用户鉴权签证
swlid 是 string 课程id
HTTP 响应状态

200

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

Request
curl -X GET -H "Content-Type:application/json" http://api.sewise.com/swl/swlid?{access_token}
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}}}

4.7 撕书功能

4.7.1 保存撕书记录

接口地址

/wipe/add

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 单用户鉴权签证
wipe_id 否 string 唯一识别码uuid，撕书id
create_time 否 string 创建时间
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://api.sewise.com/wipe/add
Response
成功:{"result":success}
失败:{"result":failure}

4.7.2 删除撕书记录

接口地址

/wipe/

HTTP Content-Type / 请求方式

application/json
DELETE

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 单用户鉴权签证
wipe_id 否 string 唯一识别码uuid，撕书id
create_time 否 string 创建时间
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://api.sewise.com/wipe/delete
Response
{"success":true}

5 题库

5.1 题目保存

接口功能

保存题目，新增题目

接口地址

/question?access_token={access_token}

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
topicStr 是 Json 题目内容,JSON字符串,如JSON.stringify({"question":"2+2=?","answer":[{"content":"3","rightAnswer":false},{"content":"4","rightAnswer":true},{"content":"5","rightAnswer":false}],"type":"single","option":["3","4","5"],"answerArray":[1]})
topicStr

组成形式：{json}，如下为json的参数

参数 必选 类型 说明
type 是 string 类型：多选multiselect、单选single、填空fill
question 是 string 题目、问题
option 是 array 选项内容如：[选项1,选项2,选项3,选项4]
answerArray 是 array 答案的数组下标，如[1,2]
from 否 string 问答来源
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
msg string 错误信息，如错误，返回，否则没有
data json 新增的题目信息
接口示例

Request
url: http://ip:port/question?access_token=xxxx
Response
成功:{"success":true,"data":{"topic_id":"ab548019-0a5c-47d0-8f28-f193fe35199d","creator_uid":"777","question":"2+2=?","option":["3","4","5"],"answer":[1],"type":"single","create_time":"2017-06-23 09:18:26","from":"","_id":"594c6c622d374406a37038a9"}}
失败:{"success":false,"msg":"XXX"}

5.2 题目更新

接口功能

更新题目

接口地址

/question?access_token={access_token}

HTTP Content-Type

application/json

HTTP 请求方式

PUT

请求参数
参数 必选 类型 说明
RequestBody
topic_id 是 string id
topicStr 是 Json 题库内容,JSON字符串,如JSON.stringify({"question":"2+2=?","answer":[{"content":"3","rightAnswer":false},{"content":"4","rightAnswer":true},{"content":"5","rightAnswer":false}],"type":"single","option":["3","4","5"],"answerArray":[1]})
topicStr

组成形式：{json}，如下为json的参数

参数 必选 类型 说明
type 是 string 类型：多选multiselect、单选single、填空fill
question 是 string 题目、问题
option 是 array 选项内容如：[选项1,选项2,选项3,选项4]
answerArray 是 array 答案的数组下标，如[1,2]
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 任务结果
msg string 错误信息，如错误，返回，否则没有
topic_id string 题目topic_id
接口示例

Request
url: http://ip:port/question?access_token=xxxx
Response
成功:{"success":true}
失败:{"success":false,"msg":"XXX"}

5.3 删除题目

接口功能

删除题目

接口地址

/question?access_token={access_token}

HTTP Content-Type

application/json

HTTP 请求方式

DELETE

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

200

返回字段 字段类型 说明
success boolean 任务结果
msg string 错误信息，如错误，返回，否则没有
topic_id string 题目topic_id
接口示例

Request
url: http://ip:port/question?access_token=xxxx
Response
成功:{"success":true}
失败:{"success":false,"msg":"XXX"}

5.4 题目详情

接口功能

获取单个或多个题目信息

接口地址

/question/title?access_token={access_token}

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
RequestBody
topic_id 是 string topic_id，若要获取多个，用“，”分开，如：“1576542,132t4341”
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 任务结果
msg string 错误信息，如错误，返回，否则没有
data array 数组形式返回题目信息
接口示例

Request
url: http://ip:port/question?access_token={access_token}
Response
成功:{"success":true,"data":[{"_id":"594a674cbbeb40304ce63e82","topic_id":"179d4bd3-52f8-4ad5-82d9-8e51c548ca68","creator_uid":"777","question":"1+1=?","option":["21","2"],"answer":[1],"type":"single","create_time":"2017-06-21 20:32:12","from":""}]}
失败:{"success":false,"msg":"XXX"}

5.5 题库列表

接口功能

查询题库列表

接口地址

/question?access_token={access_token}

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
QueryParam
page 否 int 查询页数，默认为1
size 否 int 一页显示数量，默认为15
q 否 String 题目名称模糊搜索
tid 否 String 老师名称
stime 否 String 开始时间，格式为2017-02-06 10:02:23
etime 否 String 结束时间，有开始时间的时候必传
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 任务结果
msg string 错误信息，如错误，返回，否则没有
data array 数据集合

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

接口示例

Request
url: http://ip:port/question?access_token=xxxx&page=""&size=""&q=""

Response
成功:{"success":true,"data":[{},{},...]}
失败:{"success":false,"error":"XXX"}

5.6 答题

接口功能

回答题目

接口地址

/question/answer?access_token={access_token}

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
QueryParam
uid 是 string 用户id
klgid 是 string 知识点id
swlid 是 string 课件id
questionid 是 string 问题id值
answerid 是 string 数组JSON字符串,如JSON.stringify(['xxx','xxx'])
tid 是 string 老师名称
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 任务结果
isRight boolean 是否回答正确
msg string 错误信息，如错误，返回，否则没有
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {questionid:"",klgid:"",answerid:"",swpid:""}
url: http://ip:port/question/answer?access_token={access_token}

Response
成功:{"success":true,"isRight": false}
失败:{"success":false,"error":"XXX"}

6.外部播放器API

6.1内嵌方式

介绍：
1.该播放器默认响应屏幕大小，当屏幕大于播放器设置的宽，将会以屏幕的宽为播放器的宽，以16：9的比例初始化播放器。可通过response参数设置该属性。
2.指定播放器的生成位置，可通过参数domNode传入节点的id。也可以直接将生成的代码粘贴在容器内。
注意：一个页面只能引用一个播放器，生成新的播放器，应先将原先的播放器容器销毁。

6.1.1 播放器引用方式

通过嵌入html页面的方式渲染播放器

参数

参数 必选 类型 说明
host 是 string 微录播域名
swlid 是 string 微课swlid
uname 是 int 微录播用户id
uid 是 int 自主平台用户id
access_token 是 string 自主平台access_token
type 是 int 用户类型，默认1为学生，2为老师
callback 否 boolean 是否需要主动发送播放进度
callbackUrl 否 string 主动发送的地址（当callback为true,此参数必须）
playProgress 否 int 设置播放进度（数值范围：1-100），设置此参，播放进度将会从此开始播放
width 否 string 设置播放器的宽度
height 否 string 设置播放器的高度
domNode 否 string dom节点的id，可往此节点处创建播放器
response 否 boolean 播放器是否响应的标识，默认true

拼写规则

1.生成设置参数

  1. var obj ={
  2.     'host' : 'http://vtest.sewise.com' ,
  3.     'swlid' : '4593843e-05c1-460e-af30-831920a930ed' ,
  4.     'uname' : 12 ,
  5.     'callback' : true ,
  6.     'callbackUrl' : 'http://vtest2.sewise.com/addplay?userid=12' , //自主平台路径，此处userid是为不同用户保存不同进度
  7.     'playProgress' : 50,
  8.     'width':'745px',//此参数可选，传此参数可设置播放器的宽度
  9.     'height':'418px',//此参数可选，传此参数可设置播放器的高度
  10.     'domNode':'playbox',//此参数可选，dom节点的id，可往此节点处创建播放器
  11.     'response':true//此参数可选,设置播放器是否响应
  12. }
  13. var playerdata = encodeURI(JSON.stringify(obj));//将参数转成json字符串，再进行encodeURI转码
  14. var playerhtml = '<script id="sewiseswlplayer" src="'+obj.host+'/widgets/libs/sewiseswlplayer.js?data='+playerdata+'" charset="utf-8"></script>';//播放地址

2.代码生成结果

  1. <script id="sewiseswlplayer" src="http://vtest.sewise.com/widgets/libs/sewiseswlplayer.js?data=%7B%22host%22:%22http://vtest.sewise.com%22,%22swlid%22:%224593843e-05c1-460e-af30-831920a930ed%22,%22uname%22:12,%22callback%22:true,%22callbackUrl%22:%22http://vtest2.sewise.com/addplay?userid=12%22,%22playProgress%22:50%7D" charset="utf-8"></script>

3.将代码放入html页面，即可生成sewise播放器

callbackUrl要求

播放器主动传递的参数

请求方式：post

参数 类型 说明
precent int 百分比(数值范围：1-100)
total_time int 视频总时长(s)
playTime int 当前播放时间(s)

6.1.2 播放器接口

支持的接口

  • pause 暂停
  • play 播放
  • stop 停止
  • seek 设置播放器跳转的位置（秒）
  • playTime 获取当前视频播放到的位置（秒）

接口使用方式

播放器引用成功后，将会生成一个全局的函数变量：window.getSWLPlayer

示例

  1. //以鼠标移出播放器，播放自动暂停为例
  2. window.getSWLPlayer(function (sw) {
  3.     //sw为播放器对象
  4.     $(sw.el).on('mouseleave',function(){//表示离开播放器组件
  5.         sw.pause();//调用播放器暂停方法
  6.     })
  7.     sw.seek(20);//调用seek方法，播放器将跳转至20s
  8. })

6.2链接方式

1.链接的方式，相当于加载一个页面
2.播放器默认居中显示，宽度为屏幕的60%，屏幕宽度小于748px时，以屏幕的宽为播放器的宽，可通过参数设置播放器的宽高，以设置的值为准。

参数

参数 必选 类型 说明
host 是 string 微录播域名
swlid 是 string 微课swlid
uname 是 int 微录播用户id
width 否 string 设置播放器的宽度
height 否 string 设置播放器的高度

拼写规则

  1. //设置三个必须参数
  2. var host = 'http://vtest.sewise.com';
  3. var swlid = '4593843e-05c1-460e-af30-831920a930ed';
  4. var uname = 12;
  5. var url = host + '/weike/sewiseplay?swlid=' + swlid + '&uname=' + uname;//生成路径即为：http://vtest.sewise.com/weike/sewiseplay?swlid=4593843e-05c1-460e-af30-831920a930ed&uname=12
  7. //若要设置宽
  8. var width = '745px'
  9. url = url + '&width='+width;//生成路径即为：http://vtest.sewise.com/weike/sewiseplay?swlid=4593843e-05c1-460e-af30-831920a930ed&uname=12&width=745px
  11. //若要设置高
  12. var height = '418px'
  13. url = url + '&height='+height;//生成路径即为：http://vtest.sewise.com/weike/sewiseplay?swlid=4593843e-05c1-460e-af30-831920a930ed&uname=12&width=745px&height=418px

示例

  1. http://vtest.sewise.com/weike/sewiseplay?swlid=4593843e-05c1-460e-af30-831920a930ed&uname=12&width=745px&height=418px

6.3 插件形式

注意：
1.播放器的宽高由dom容器决定，因此初始化播放器的dom容器一定要设置宽高。
2.该插件依赖jquery库，请引用高于1.9.1版本的jquery库。

6.3.1 引入js

1.引入高于1.9.1版本的jquery库
2.引入微录播播放器js文件，http://vtest.sewise.com/widgets/libs/sewiseSPlayer.js

6.3.2 参数

参数 必选 类型 说明
host 是 string 微录播域名
swlid 是 string 微课swlid
uname 是 int 微录播用户id
init 否 boolean 是否自动初始化播放器，默认true
uid 是 int 自主平台用户id
access_token 是 string 自主平台access_token
type 是 int 用户类型，默认1为学生，2为老师
playProgress 否 int 设置播放进度（数值范围：1-100），设置此参，播放进度将会从此开始播放
callback 否 boolean 是否需要主动发送播放进度
callbackUrl 否 string 主动发送的地址（当callback为true,此参数必须）
moblieOpenQueation 否 boolean 针对移动端参数，开启问答参数，默认false

callbackUrl要求

播放器主动传递的参数

请求方式：post

参数 类型 说明
precent int 百分比(数值范围：1-100)
total_time int 视频总时长(s)
playTime int 当前播放时间(s) 
  1. /**
  2.  *
  3.  * @param {string} dom 容器的selector
  4.  * @param {Object} param 初始化参数
  5.  */   
  6. var player = new SewiseSPlayer(domSelector, param);  // 初始化实例

6.3.3 方法

  • init 初始化播放器(当参数init为false,可调用此方法初始化播放器)
  • pause 暂停
  • play 播放
  • stop 停止
  • seek 设置播放器跳转的位置（秒）
  • playTime 获取当前视频播放到的位置（秒）
  • resizePlayer 调整播放器样式（当播放器容器改变时，需主动调用此方法调整播放器样式）
  • destroy 销毁播放器

6.3.4 示例

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>Sewise播放器 demo</title>
  6.     <script src="jquery-1.12.1.min.js"></script>
  7.     <script src="http://vtest.sewise.com/widgets/libs/sewiseSPlayer.js"></script>
  8. </head>
  9. <body>
  10. <div id="main" style="width:100%;height:480px"></div>
  11. </body>
  12. <script>
  13.     var player = new SewiseSPlayer('#main', {
  14.         'host' : 'http://vtest.sewise.com' ,
  15.         'swlid' : 'c2247eb3-e008-4e46-b1a5-9a2fb1010d3c' ,
  16.         'uname' : 12 
  17.     });
  18.     //player.play();//播放
  19.     //player.pause();//暂停
  20.     //player.stop();//停止
  21.     //player.seek(50);//设置播放器跳转的位置（秒）
  22. </script>
  23. </html>

7 直播

7.1 我的直播课（学生）

接口地址

/direct/share/list?access_token={access_token}

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 单用户鉴权签证

或

参数 必选 类型 说明
RequestBody
access_token 是 string 第三方平台鉴权签证
uid 是 string 第三方平台用户uid
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
msg string 错误信息，如错误，返回，否则没有
data json 新增的题目信息
接口示例

Request
url: http://vtest.sewise.com/direct/current?access_token=xxxx
Response
成功:{"success":true,"data":{"xxx"}}
失败:{"success":false,"msg":"XXX"}

8 老师配置推送接口

8.1 老师推送信息

接口地址

/push_info?access_token={access_token}

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 单用户鉴权签证
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
msg string 错误信息，如错误，返回，否则没有
data json 新增的题目信息
接口示例

Request
url: http://vtest.sewise.com/direct/current?access_token=xxxx
Response
成功:{"success":true,"data":{"xxx"}}
失败:{"success":false,"msg":"XXX"}

8.2 创建推送信息

接口地址

/push_info?access_token={access_token}

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 单用户鉴权签证
title 是 string 规则标题
depend 是 string 组课依据;答错知识点:wrong;未掌握知识点:grap
pushtype 是 string 组课周期;每周:week;每月:month
status 是 int 1:开启；0关闭
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
msg string 错误信息，如错误，返回，否则没有
data json 新增的题目信息
接口示例

Request
url: http://vtest.sewise.com/direct/current?access_token=xxxx
Response
成功:{"success":true,"data":{"xxx"}}
失败:{"success":false,"msg":"XXX"}

8.3 请求单个信息

接口地址

/push_info/:pushId?access_token={access_token}

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 单用户鉴权签证
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
msg string 错误信息，如错误，返回，否则没有
data json 信息
接口示例

Request
url: http://vtest.sewise.com/direct/current?access_token=xxxx
Response
成功:{"success":true,"data":{"xxx"}}
失败:{"success":false,"msg":"XXX"}

8.4 保存单个信息

接口地址

/push_info/:pushId?access_token={access_token}

HTTP Content-Type

application/json

HTTP 请求方式

put

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 单用户鉴权签证
title 是 string 规则标题
depend 是 string 组课依据;答错知识点:wrong;未掌握知识点:grap
pushtype 是 string 组课周期;每周:week;每月:month
status 是 int 1:开启；0关闭
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
msg string 错误信息，如错误，返回，否则没有
data json 信息
接口示例

Request
url: http://vtest.sewise.com/direct/current?access_token=xxxx
Response
成功:{"success":true,"data":{"xxx"}}
失败:{"success":false,"msg":"XXX"}

9. 课堂

9.1 我的课表

接口地址

/v1/schedule/list

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
HTTP 响应状态

200

返回字段 字段类型 说明
status int 状态码
data array 当前提交的内容

返回示例
{"status":200,"data":[{"schId":"1","schName":"\u7b2c\u4e09\u90e8\u95e8\u7814\u7a76","info":{"lesId":"1","lesName":"5-6","startTime":"13:00","endTime":"14:50","startDate":"2017-08-24","endDate":"2017-08-24","address":"\u6587\u79d1\u697cH5-201","day":"\u5468\u56db","week":"1"}},{"schId":"2","schName":"\u516c\u5171\u884c\u653f\u5b66","info":{"lesId":"19","lesName":"3-4","startTime":"10:10","endTime":"12:00","startDate":"2017-08-29","endDate":"2017-08-29","address":"\u6587\u79d1\u697cH5-302","day":"\u5468\u4e8c","week":"2"}},{"schId":"3","schName":"\u65c5\u6e38\u65e5\u8bed","info":{"lesId":"35","lesName":"1-2","startTime":"8:00","endTime":"9:50","startDate":"2017-08-24","endDate":"2017-08-24","address":"\u6587\u79d1\u697cH5-204","day":"\u5468\u56db","week":"1"}},{"schId":"4","schName":"\u516c\u5171\u884c\u653f\u5b66","info":{"lesId":"53","lesName":"7-8","startTime":"15:10","endTime":"17:00","startDate":"2017-08-28","endDate":"2017-08-28","address":"\u6587\u79d1\u697cH5-205","day":"\u5468\u4e00","week":"2"}}]}

9.2.1 课次表(列表模式)

接口地址

/v1/lesson/list

HTTP Content-Type

application/json

HTTP 请求方式

GET/POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
schId 是 string 课表schId
page 否 int 页码
pageSize 否 int 页数
now 否 int 是否获取未开始的：1，0
startDate 否 string 开始日期：2017-08-01
endDate 否 string 结束日期：2017-09-01
HTTP 响应状态

200

返回字段 字段类型 说明
status int 状态码
data array 当前提交的内容
-- inspect 签到统计
-- meetInfo 签到情况

返回示例
{"status":200,"data":[{"lesId":"2","lesName":"5-6","startTime":"13:00","endTime":"14:50","startDate":"2017-08-31","endDate":"2017-08-31","address":"\u6587\u79d1\u697cH5-201","day":"\u5468\u56db","week":"2","inspect":{"tobe":0,"to":0,"absent":0},"meetInfo":{"signTime":"","status":1}},{"lesId":"1","lesName":"5-6","startTime":"13:00","endTime":"14:50","startDate":"2017-08-24","endDate":"2017-08-24","address":"\u6587\u79d1\u697cH5-201","day":"\u5468\u56db","week":"1","inspect":{"tobe":4,"to":1,"absent":3},"meetInfo":{"signTime":null,"status":-1}}]}

9.2.2 课次表(日历模式)

接口地址

/v1/lesson/list

HTTP Content-Type

application/json

HTTP 请求方式

GET/POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
week 是 int 周数
HTTP 响应状态

200

返回字段 字段类型 说明
status int 状态码
data array 当前提交的内容

返回示例
{"status":200,"data":{"\u5468\u4e00":[{"lesId":"53","lesName":"7-8","startTime":"15:10","endTime":"17:00","startDate":"2017-08-28","endDate":"2017-08-28","address":"\u6587\u79d1\u697cH5-205","day":"\u5468\u4e00","week":"2"}],"\u5468\u4e8c":[{"lesId":"19","lesName":"3-4","startTime":"10:10","endTime":"12:00","startDate":"2017-08-29","endDate":"2017-08-29","address":"\u6587\u79d1\u697cH5-302","day":"\u5468\u4e8c","week":"2"}],"\u5468\u4e09":[],"\u5468\u56db":[{"lesId":"2","lesName":"5-6","startTime":"13:00","endTime":"14:50","startDate":"2017-08-31","endDate":"2017-08-31","address":"\u6587\u79d1\u697cH5-201","day":"\u5468\u56db","week":"2"},{"lesId":"36","lesName":"1-2","startTime":"08:00","endTime":"09:50","startDate":"2017-08-31","endDate":"2017-08-31","address":"\u6587\u79d1\u697cH5-204","day":"\u5468\u56db","week":"2"}],"\u5468\u4e94":[],"\u5468\u516d":[],"\u5468\u65e5":[]}}

9.3 学生列表

接口地址

/v1/schedule/personList

HTTP Content-Type

application/json

HTTP 请求方式

GET/POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
schId 是 string 课表schId
page 否 int 页码
pageSize 否 int 页数
HTTP 响应状态

200

返回字段 字段类型 说明
status int 状态码
data array 当前提交的内容

返回示例
{"status":200,"totalCount":4,"data":[{"userId":"744","nickName":"\u5c0f\u5b66\u751f01","avatar":"\/widgets\/assets\/images\/pic-b.png"},{"userId":"745","nickName":"\u5c0f\u5b66\u751f02","avatar":"\/widgets\/assets\/images\/pic-b.png"},{"userId":"746","nickName":"\u5c0f\u5b66\u751f03","avatar":"\/widgets\/assets\/images\/pic-b.png"},{"userId":"747","nickName":"\u5c0f\u5b66\u751f04","avatar":"\/widgets\/assets\/images\/pic-b.png"}]}

9.4 发起点名

接口地址

/v1/lesson/launchCall

HTTP Content-Type

application/json

HTTP 请求方式

GET/POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
lesId 是 string 课次lesId
duration 否 int 有效时长（秒）
position 否 string 位置坐标
HTTP 响应状态

200

|返回字段|字段类型|说明 |
|:----- |:------|:--------------------v--------- |
| status |int|状态码|
| data |array|当前提交的内容|

返回示例
{"status":200,"data":{"rollId":"2","lesId":"1","userId":"48","expire":"2017-08-23 01:14:32","creationDate":"2017-08-23 01:09:32"}}

9.5 签到

接口地址

/v1/lesson/signIn

HTTP Content-Type

application/json

HTTP 请求方式

GET/POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
lesId 是 string 课次lesId
HTTP 响应状态

200

|返回字段|字段类型|说明 |
|:----- |:------|:--------------------v--------- |
| status |int|状态码|
| data |array|当前提交的内容|

返回示例
{"status":200,"data":{"id":"1","lesId":"1","userId":"44","signTime":"2017-08-23 10:27:04","creationDate":"2017-08-23 10:24:27"}}

9.6 课堂管理

接口地址

/v1/lesson/manage

HTTP Content-Type

application/json

HTTP 请求方式

GET/POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
lesId 是 string 课次lesId
HTTP 响应状态

200

|返回字段|字段类型|说明 |
|:----- |:------|:--------------------v--------- |
| status |int|状态码|
| data |array|内容|
| -- |tobe|应到|
| -- |to|实到|
| -- |absent|旷课|

返回示例
{"status":200,"data":{"schId":"1","schName":"\u7b2c\u4e09\u90e8\u95e8\u7814\u7a76","userId":"743","creationDate":"2017-08-22 16:19:06","lesId":"1","lesName":"5-6","startTime":"13:00","endTime":"14:50","startDate":"2017-08-24","endDate":"2017-08-24","address":"\u6587\u79d1\u697cH5-201","day":"\u5468\u56db","week":"1","modifiedDate":"2017-08-22 16:19:09","inspect":{"tobe":4,"to":1,"absent":3}}}

9.7 获取点名详情

接口地址

/v1/lesson/rollCall

HTTP Content-Type

application/json

HTTP 请求方式

GET/POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
lesId 是 string 课次lesId
HTTP 响应状态

200

|返回字段|字段类型|说明 |
|:----- |:------|:--------------------v--------- |
| status |int|状态码|
| data |array|内容|
| -- |tobe|应到|
| -- |to|实到|
| -- |left|剩余时间|

返回示例
{"status":200,"data":{"tobe":4,"to":1,"left":"00:00:00","person":[{"lesId":"1","userId":"744","signTime":"2017-08-23 11:08:55"}]}}

9.8 课程管理(学生)

接口地址

v1/schedule/status

HTTP Content-Type

application/json

HTTP 请求方式

GET/POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
schId 是 string 课程schId
HTTP 响应状态

200

返回字段 字段类型 说明
status int 状态码
data array 内容
-- done 已结束
-- todo 未开始
-- absent 旷课

返回示例
{"status":200,"data":{"schName":"\u7b2c\u4e09\u90e8\u95e8\u7814\u7a76","done":0,"todo":17,"absent":0}}

9.9 课次保存/编辑

接口地址

v1/lesson/save

HTTP Content-Type

application/json

HTTP 请求方式

GET/POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
lesId 否 string 课次lesId（编辑必传）
lesName 否 string 课次名称
startTime 否 string 课次开始时间
startDate 否 string 课次开始日期
status 否 int 直播状态：0.未开始 1.准备中 2.直播中 3.已结束，默认0
fileUrl 否 string 课件地址
swlId 否 string 课时swlid
duration 否 int 时长

.....

HTTP 响应状态

200

|返回字段|字段类型|说明 |
|:----- |:------|:--------------------v--------- |
| status |int|状态码|
| data |array|内容|

返回示例
{"status":200,"data":{"lesId":"1","lesName":"5-6","startTime":"18:52","endTime":"18:52","startDate":"2017-08-29","endDate":"2017-08-29","address":"\u6587\u79d1\u697cH5-201","day":"\u5468\u56db","week":"1","schId":"1","status":"1","fileUrl":null,"swlId":null,"duration":"3600","creationDate":"2017-08-22 16:19:06","modifiedDate":"2017-08-29 18:52:04"}}

10. 互动-问答

10.1 发起问答

接口地址

/v1/question/save

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
type 否 int 类型：1. 单选 2.多选 3.填空
title 否 string 题目标题
options 单选、多选：是，填空：否 string 选项（竖号分割）
content 否 string 选项内容（竖号分割）
duration 否 int 时长（秒）

例子：
who are you?
A.我 B.你 C.他 D.她
A|B|C|D 我|你|他|她

HTTP 响应状态

200

返回字段 字段类型 说明
status int 状态码
data array 当前提交的内容

返回示例
{"status":200,"data":{"quesId":"5","type":1,"title":"who are you?","userId":"743","expire":"2017-08-26 11:19:30","creationDate":"2017-08-26 11:14:30","options":[{"quesId":"5","option":"A","content":"\u6211"},{"quesId":"5","option":"B","content":"\u4f60"},{"quesId":"5","option":"C","content":"\u4ed6"},{"quesId":"5","option":"D","content":"\u5979"}]}}

10.2 回复问答

接口地址

/v1/question/reply

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
quesId 是 int 问题id
options 单选、多选：是，填空：否 string 选项opId（逗号分割）
content 否，填空时传 string 内容
HTTP 响应状态

200

返回字段 字段类型 说明
status int 状态码
data array 当前提交的内容

返回示例
{"status":200,"data":{"ansId":"1","userId":"744","quesId":"1","content":"A,B","creationDate":"2017-08-25 16:24:44"}}

10.3 问答详情

接口地址

/v1/question/info

HTTP Content-Type

application/json

HTTP 请求方式

GET/POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
quesId 是 int 问题id
HTTP 响应状态

200

返回字段 字段类型 说明
status int 状态码
data array 当前提交的内容
-- to 已投
-- duration 剩余时长（秒）
-- summary 汇总统计
-- options 选项内容
-- answer 回答的学生列表

返回示例
{"status":200,"data":{"to":1,"duration":0,"summary":{"A":1,"B":1,"C":0,"D":0},"options":[{"quesId":"1","option":"A","content":"\u6211"},{"quesId":"1","option":"B","content":"\u4f60"},{"quesId":"1","option":"C","content":"\u4ed6"},{"quesId":"1","option":"D","content":"\u5979"}],"answerList":[{"ansId":"1","userId":"744","quesId":"1","content":"A,B","creationDate":"2017-08-25 16:57:27"}]}}

10.4 问答列表

接口地址

/v1/question/list

HTTP Content-Type

application/json

HTTP 请求方式

GET/POST

请求参数
参数 必选 类型 说明
RequestBody
access_token 是 string 用户access_token
uid 是 int 老师userId,老师本人可不传
startTime 是 int 开始时间，课次开始时间
endTime 是 int 结束时间，课次已结束时（传课次结束时间戳）；进行时（当前时间戳）
HTTP 响应状态

200

返回字段 字段类型 说明
status int 状态码
data array 当前提交的内容

返回示例
{"status":200,"data":[{"quesId":"2","type":"1","title":"who are you?","userId":"743","expire":"2017-08-25 15:40:33","creationDate":"2017-08-25 15:35:33","data":{"to":0,"duration":0}},{"quesId":"3","type":"1","title":"who are you?","userId":"743","expire":"2017-08-25 15:57:16","creationDate":"2017-08-25 15:52:16","data":{"to":0,"duration":0}},{"quesId":"4","type":"1","title":"who are you?","userId":"743","expire":"2017-08-26 11:19:12","creationDate":"2017-08-26 11:14:12","data":{"to":0,"duration":0}},{"quesId":"5","type":"1","title":"who are you?","userId":"743","expire":"2017-08-26 11:19:30","creationDate":"2017-08-26 11:14:30","data":{"to":0,"duration":0}}]}

11. 消息

11.1 消息记录

接口地址

/record

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
user 是 json 用户信息（或access_token）
type 否 int 类型：1.文字 2.图片 3.文件 4.语言
lesId 否 int 课次id
groupId 否 int 分组id
data 是 json 内容集合
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 状态码
data array 当前提交的内容

返回示例
{"success":true,"data":{"userId":"894","type":1,"lesId":"2","groupId":"","data":"{\"lesId\": \"111\",\"duration\": 60,\"title\": \"发起问答\", \"location\": \"11422,44552\",\"quesId\": 123,\"A\": 1, \"B\": 2,\"C\": 3,\"D\": 4}","createTime":"2017-08-29 19:57:17","_id":"59a5569dc6ace32421f6ca2b"}}

11.2 获取消息列表

接口地址

/record/list

HTTP Content-Type

application/json

HTTP 请求方式

get

请求参数
参数 必选 类型 说明
RequestBody
user 是 json 用户信息（或access_token）
time 否 int 时间戳
direction 否 string 向前:history,向后:future，默认history
type 否 int 类型：1.文字 2.图片 3.文件 4.语言
lesId 是 int 课次id
groupId 否 int 分组id
page 否 int 页数
pageSize 否 int 页码，默认15
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 状态码
data array 当前提交的内容

返回示例
{"success":true,"data":[{"_id":"59a55413c6ace32421f6ca2a","userId":"894","type":1,"lesId":"2","groupId":"","data":"{\"lesId\": \"111\",\"duration\": 60,\"title\": \"发起问答\", \"location\": \"11422,44552\",\"quesId\": 123,\"A\": 1, \"B\": 2,\"C\": 3,\"D\": 4}","createTime":"2017-08-29 19:46:27"},{"_id":"59a5569dc6ace32421f6ca2b","userId":"894","type":1,"lesId":"2","groupId":"","data":"{\"lesId\": \"111\",\"duration\": 60,\"title\": \"发起问答\", \"location\": \"11422,44552\",\"quesId\": 123,\"A\": 1, \"B\": 2,\"C\": 3,\"D\": 4}","createTime":"2017-08-29 19:57:17"},{"_id":"59a557f27338672512a3739b","userId":"894","type":1,"lesId":"2","groupId":"","data":"{\"lesId\": \"111\",\"duration\": 60,\"title\": \"发起问答\", \"location\": \"11422,44552\",\"quesId\": 123,\"A\": 1, \"B\": 2,\"C\": 3,\"D\": 4}","createTime":"2017-08-29 20:02:58"},{"_id":"59a55803365a132518cb743e","userId":"894","type":1,"lesId":"2","groupId":"","data":"{\"lesId\": \"111\",\"duration\": 60,\"title\": \"发起问答\", \"location\": \"11422,44552\",\"quesId\": 123,\"A\": 1, \"B\": 2,\"C\": 3,\"D\": 4}","createTime":"2017-08-29 20:03:15"}]}

12. 直播在线人数

12.1 上报在线人数

接口地址

/stats/reportOnlineLog

HTTP Content-Type

application/json

HTTP 请求方式

post

请求参数
参数 必选 类型 说明
RequestBody
userId 是 int 用户Id
organId 是 int 机构Id
directId 是 string 直播Id
total 是 int 总人数
detail 是 json 各端人数统计，例:{pc:5,ios:10,android:20}
lesId 否 int 课次Id
courseId 否 string 课程id
kBitrate 否 string 当前流量
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 状态码
data object 当前提交的内容

返回示例
{"success":true,"data":{"userId":2,"organId":12,"directId":"adjfaljfajfppjhkajhdk","total":41,"detail":{"pc":10,"ios":12,"android":19},"time":"2018-03-09 16:03:08","_id":"5aa23fbc2e40891ce136beaa"}}

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