一、新增视频问答信息
通过该接口可以为视频新增一条问答信息, 地址为:
https://spark.bokecc.com/api/question/create
需要传递以下参数:
参数 | 说明 |
---|---|
userid | 用户 id,不可为空 |
videoid | 视频 id,不可为空 |
content | 问答题目,不可为空(80字以内) |
explaininfo | 问题的解答,150字以内 |
answers | 问题的答案以及是否正确,不可为空,(该字段数据类型为jsonArray,最少2个最多8个选项,从上到下对应A-H,示例:[{“content”: “A、答案一”, “isright”:0}, …..]) |
showtime | 问题出现的时间(取值需在视频的有效时间内),单位:s,不可为空 |
isjump | 本问题是否可跳过,不可为空(0:不可跳过;1:可跳过) |
keepplay | 答错后是否可继续播放,不可为空(0:不可继续播放;1:可以) |
backtime | 回看时间点,单位:s,默认值-1 代表没有设置回看时间, (keepplay为0时,必填) |
answers字段中包含的字段以及含义:
参数 | 说明 |
---|---|
content | 答案的内容,格式为大写字母A-H和中文下顿号、开头,如:”A、答案一”,50字以内 |
isright | 对应的答案是否是正确答案0:不是;1是 |
返回信息如下:
{
“questionid” “8395FBC2E22C76D2”
}
特别说明:
1.keepplay 为0时, 必须设置backtime回看时间, 用户答对了可选择回看知识点或者继续播放;用户答错了只能选择回看知识点. 2.keepplay 为1时, backtime为可选值, 当backtime没有值时,用户无论是否答对只能选择继续播放, 当backtime有值时,无论用户是否答对都可选择回看知识点和继续播放.
二、修改视频题目相关信息
通过该接口可以修改视频的一条问答信息, 地址为: https://spark.bokecc.com/api/question/update
需要传递一下参数:
参数 | 说明 |
---|---|
userid | 用户 id,不可为空 |
videoid | 视频 id,不可为空 |
questionid | 问题 id, 不可为空 |
content | 问答题目(80字以内) |
explaininfo | 问题的解答,150字以内 |
answers | 问题的答案以及是否正确,最少2个,最多8个选项,从上到下对应A-H(示例:[{“content”: “A、答案一”, “isright”:0}, …..]) |
showtime | 问题出现的时间(取值需在视频的有效时间内),单位:s |
isjump | 是否可跳过(0:不可跳过;1:可跳过) |
keepplay | 答错后是否可继续播放(0:不可继续播放;1:可以继续播放) |
backtime | 回看时间点,单位:s(如需设置成不需要回看时间可设置成 -1, keepplay为0时必填) |
answers字段中包含的字段以及含义: |参数|说明| |---|---| |content |答案的内容,格式为大写字母A-H和中文下顿号、开头,如:”A、答案一”,50字以内| |isright |对应的答案是否是正确答案0:不是;1是|
返回信息如下:
{
“result” : ”OK”
}
特别说明:
answers 如果有值,会覆盖以前的答案。
keepplay 为0时, 必须设置backtime回看时间, 用户答对了可选择回看知识点或者继续播放;用户答错了只能选择回看知识点. keepplay 为1时, backtime为可选值,当backtime没有值时,用户无论是否答对只能选择继续播放, 当backtime有值时,无论用户是否答对都可选择回看知识点和继续播放.
三、 删除视频问答信息
通过该接口可以删除一个视频的一个问题和相关的答案信息, 地址为:
https://spark.bokecc.com/api/question/delete
需要传递以下参数:
参数 | 说明 |
---|---|
userid | 用户 id,不可为空 |
videoid | 视频 id,不可为空 |
questionid | 问题 id, 不可为空 |
返回信息如下:
{
“result” : ”OK”
}
四、 获取一个问答信息详情
通过该接口可以获取一个视频问答相关的详细信息,目前共两个版本,最新版本为V2.
a.比v1版新增返回答案的id, 地址为:
https://spark.bokecc.com/api/question/get/v2
需要传递以下参数:
参数 | 说明 |
---|---|
userid | 用户 id,不可为空 |
videoid | 视频 id,不可为空 |
questionid | 问题 id, 不可为空 |
返回字段question中各字段含义如下
参数 | 说明 |
---|---|
id | 问题 id |
content | 问答题目 |
explaininfo | 问题的解答 |
answers | 问题的答案以及是否正确,(示例:[{“content”: “A、答案一”, “isright”:0}, …..]) |
isjump | 是否可跳过(0:不可跳过;1:可跳过) |
showtime | 问题出现的时间,单位:s |
keepplay | 答错后是否可继续播放(0:不可继续播放;1:可以继续播放) |
backtime | 回看时间点, 单位:s , -1代表没有设置回看时间 |
返回信息如下:
{
“result” : ”OK” “question” :
{
“id”: “8395FBC2E22C76D2”,
“showtime” 90,
“content” : “问题一”,
“explaininfo” : “问题解释”,
“isjump”:0,
“backtime”: 30,
“keepplay” : 1,
“answers”:
[
{
“content”:”A、答案一”,
“isright”:0
}
……
]
}
}
b. 地址为:https://spark.bokecc.com/api/question/get
需要传递以下参数:
参数 | 说明 |
---|---|
userid | 用户 id,不可为空 |
videoid | 视频 id,不可为空 |
questionid | 问题 id, 不可为空 |
返回字段question中各字段含义如下
参数 | 说明 |
---|---|
id | 问题 id |
content | 问答题目 |
explaininfo | 问题的解答 |
answers | 问题的答案以及是否正确,(示例:[{“content”: “A、答案一”, “isright”:0}, …..]) |
isjump | 是否可跳过(0:不可跳过;1:可跳过) |
showtime | 问题出现的时间,单位:s |
keepplay | 答错后是否可继续播放(0:不可继续播放;1:可以继续播放) |
backtime | 回看时间点, 单位:s , -1代表没有设置回看时间 |
返回信息如下
{
“result” : ”OK”
“question” : {
“id”: “8395FBC2E22C76D2”,
“showtime” 90,
“content” : “问题一”,
“explaininfo” : “问题解释”,
“isjump”:0,
“backtime”: 30,
“keepplay” : 1,
“answers”:[
{
“content”:”A、答案一”,
“isright”:0
}
……
]
}
}
五、 获取一个视频问答信息列表
通过该接口可以获取一个视频的问答信息列表, 地址为:
https://spark.bokecc.com/api/question/list
需要传递以下参数:
参数 | 说明 |
---|---|
userid | 用户 id,不可为空 |
videoid | 视频 id,不可为空 |
返回字段questions中各字段含义如下:
参数 | 说明 |
---|---|
id | 问题 id |
content | 问答题目 |
showtime | 问题出现的时间, 单位:s |
返回信息如下:
{
“result” : ”OK”
“questions” :
[
{
“id”: “8395FBC2E22C76D2”,
“content” : “问题一”,
“showtime” 90
},
……
]
}
六、获取用户视频问答答题记录.
通过该接口可以获取一个用户一段时间的答题记录, 地址为 https://spark.bokecc.com/api/question/records
需要传递以下参数:
参数 | 说明 |
---|---|
userid | 用户 id,不可为空 |
hour | 查询小时时间字符串,不可为空,格式:yyyyMMddHH |
pagenum | 分页页码,可选.默认1. |
pagesize | 分页页面大小,可选. 默认100,最大100. |
返回字段questions中各字段含义如下:
参数 | 说明 |
---|---|
count | 该时间段的答题记录总数 |
data | 查询到的当前分页数据集 |
time | 小时时间字符串,格式yyyy-MM-dd HH:mm:ss |
videoid | 视频id |
questionid | 问题id |
answers | 本次答题的选择结果,即是选择项的ID列表 |
isright | 答题是否正确, 0:错误, 1:正确 |
返回信息如下:
{
“result” : ”OK”,
“count” :10,
“records” :[
{
“time": "2019-09-26 15:00:00",
"videoid": "07E369A1381B09D03F35109F9F77F2A8",
"questionid": "B8CC25C32AE2E8E9",
"answers": "691EB544CA0EDCE7",
"isright": 0
},
……
]
}