答题器接口文档
1. 创建答题器
(1)请求地址:https://spark.bokecc.com/api/clicker/create
(2)请求参数
参数 | 说明 |
---|---|
userid | 用户id,不可为空 |
videoid | 视频id,不可为空 |
showtime | 问题出现的时间(取值需在视频的有效时间内),单位:s,不可为空 |
isjump | 本问题是否可跳过(0:不可跳过;1:可跳过),不可为空 |
answers | 答题器选项内容及正确选项,不可为空(数据类型为jsonArray,数量为2-8个,示例:[{"content": "A", "isright":0}, …..]) |
answers字段中包含的字段以及含义:
参数 | 说明 |
---|---|
content | 答案的内容长度不能超过2,不能为空 |
isright | 对应的答案是否是正确答案(0:不是;1是),不能为空 |
(3)返回数据
{
"result" : "OK",
"clickerid : "8395FBC2E22C76D2"
}
2. 删除答题器
(1)请求地址:https://spark.bokecc.com/api/clicker/delete
(2)请求参数
参数 | 说明 |
---|---|
userid | 用户 id,不可为空 |
videoid | 视频 id,不可为空 |
clickerid | 答题器 id,不可为空 |
(2)返回数据
{
"result" : "OK"
}
3. 获取一个答题器详情
(1)请求地址:https://spark.bokecc.com/api/clicker/get
(2)请求参数
参数 | 说明 |
---|---|
userid | 用户 id,不可为空 |
clickerid | 答题器 id,不可为空 |
(3)返回数据
参数说明
参数 | 说明 |
---|---|
id | 问题 id |
answers | 问题的答案以及是否正确,(示例:[{"content": "A", "isright":0}, …..]) |
isjump | 是否可跳过(0:不可跳过;1:可跳过) |
showtime | 问题出现的时间,单位:s |
answers字段中包含的字段以及含义:
参数 | 说明 |
---|---|
content | 答案的内容 |
isright | 对应的答案是否是正确答案0:不是;1是 |
参数格式
```
{
"result": "OK",
"clicker": {
"id": "8395FBC2E22C76D2",
"isjump": 0,
"showtime": 30,
"answers": [{
"content": "A",
"isright": 0
},
......
]
}
}
```
4. 获取一个视频所有答题器
(1)请求地址:https://spark.bokecc.com/api/clicker/list (2)请求参数:
参数 | 说明 |
---|---|
userid | 用户 id,不可为空 |
videoid | 视频 id,不可为空 |
(3)返回数据 参数说明:
参数 | 说明 |
---|---|
id | 问题 id |
answers | 问题的答案以及是否正确,(示例:[{"content": "A", "isright":0}, …..]) |
isjump | 是否可跳过(0:不可跳过;1:可跳过) |
showtime | 问题出现的时间,单位:s |
answers字段中包含的字段以及含义:
参数 | 说明 |
---|---|
content | 答案的内容 |
isright | 对应的答案是否是正确答案0:不是;1是 |
参数格式:
{
"result": "OK",
"clickers": [{
"id": "1111",
"isjump": 0,
"showtime": 30,
"answers": [{
"content": "A、答案一",
"isright": 0
}
......
]
},
{
"id": "2222",
"isjump": 0,
"showtime": 30,
"answers": [{
"content": "A、一",
"isright": 0
}
......
]
}
......
]
}
5. 修改答题器
(1)请求地址 https://spark.bokecc.com/api/clicker/update
(2)请求参数
参数 | 说明 |
---|---|
userid | 用户id,不可为空 |
videoid | 视频id,不可为空 |
clickerid | 问题id,不可为空 |
showtime | 问题出现的时间(取值需在视频的有效时间内),单位:s,不可为空 |
isjump | 本问题是否可跳过(0:不可跳过;1:可跳过),不可为空 |
answers | 答题器答案内容及正确选项,(数据类型为jsonArray,数量为2-8个,示例:[{"content": "A", "isright":0}, …..]) 注:此字段如果为空,则不会对员答案进行修改。如果不为空,则会全量覆盖原答案,并将统计数据归零 |
answers字段中包含的字段以及含义:
参数 | 说明 |
---|---|
content | 答案的内容长度不能超过2,不能为空 |
isright | 对应的答案是否是正确答案(0:不是;1是),不可为空 |
(3)返回数据
{
"result" : "OK"
}