知识点接口文档
1 获取知识点详情
请求地址 https://spark.bokecc.com/api/knowledge/get
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
userid | String | 是 | 用户id |
videoid | String | 是 | 视频id |
返回结果说明
参数 | 类型 | 说明 |
---|---|---|
name | String | 按钮名称 |
time_axis_status | int | 时间轴状态(0隐藏 1显示) |
pause_status | int | 知识点播放结束暂停状态(0不暂停 1暂停) |
category | List | 知识点分类信息 |
category说明:
参数 | 类型 | 说明 |
---|---|---|
name | String | 分类名称 |
children | List | 子分类信息 |
children说明:
参数 | 类型 | 说明 |
---|---|---|
name | String | 分类名称 |
start_time | int | 开始时间(单位为秒) |
end_time | int | 结束时间(单位为秒) |
返回结果示例
{
"name": "知识点",
"pause_status": 1,
"time_axis_status": 1,
"category": [
{
"name": "分类1",
"children": [
{
"end_time": 1,
"name": "1-1",
"start_time": 0
},
{
"end_time": 3,
"name": "1-2",
"start_time": 2
}
]
},
{
"name": "分类2",
"children": [
{
"end_time": 5,
"name": "2-1",
"start_time": 4
},
{
"end_time": 7,
"name": "2-2",
"start_time": 6
}
]
}
]
}
2. 删除知识点
请求地址 https://spark.bokecc.com/api/knowledge/delete
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
userid | String | 是 | 用户id |
videoid | String | 是 | 视频id |
返回结果示例
{
"result": "OK"
}
3. 新增或修改知识点
请求地址 https://spark.bokecc.com/api/knowledge/add
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
userid | String | 是 | 用户id |
videoid | String | 是 | 视频id |
name | String | 否 | 按钮名称(为空则按钮不可见) |
time_axis_status | int | 是 | 时间轴状态(0隐藏 1显示) |
pause_status | int | 是 | 知识点播放结束暂停状态(0不暂停 1暂停) |
category | String | 是 | 知识点分类(该字段数据类型为jsonArray),每个知识点最少一个分类,每个分类下最少有一个子分类。示例:[{"name": "分类1", "children": [{"end_time": 1,"name": "1-1","start_time": 0}]}] |
category说明:
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
name | String | 是 | 分类名称 |
children | List | 是 | 子分类信息 |
children说明:
参数 | 类型 | 必填 | 描述 |
---|---|---|---|
name | String | 是 | 分类名称 |
start_time | Long | 是 | 开始时间(单位为秒) |
end_time | int | 否 | 结束时间(单位为秒) |
返回结果示例
{
"result": "OK"
}