查询频道答题卡列表
更新时间:2024-04-23 14:08:27
接口描述
1、获取频道的答题卡列表
2、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/interact/question/list-question
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | true | String | 频道号 |
示例
https://api.polyv.net/live/v3/channel/interact/question/list-question?appId=frlr1zazn3&sign=21914C8E80403BF527F6061DD79DAE47&channelId=1965681×tamp=1621843841035
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | Object | 成功响应时为答题卡列表信息 【详见data字段说明】 |
data字段说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| templateId | String | 默认题库模板ID |
| list | Array | 查询的结果列表 【详见Question字段说明】 |
Question字段说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| questionId | String | 答题卡ID |
| channelId | String | 频道号 |
| userId | String | 用户ID |
| name | String | 答题卡名称 |
| type | String | 类型:R单选, C多选, S评分, V投票 |
| itemType | Integer | 类型: 0答题卡, 1问答 |
| answer | String | 答案 |
| option1 - option15 | String | 答题卡选项 |
| tips1 - tips5 | String | 评分类型提示信息 |
| status | String | 状态:draft草稿, send已发送, delete已删除 |
| times | Integer | 答题卡发送次数 |
| createdTime | Long | 创建时间,13位毫秒级时间戳 |
| lastModified | Long | 答题卡最后修改时间,13位毫秒级时间戳 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(LiveInteractionTest.class);
/**
* 查询频道答题卡列表
* @throws IOException
*/
@Test
public void testListQuestion() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId=super.appId;
String appSecret=super.appSecret;
String timestamp=String.valueOf(System.currentTimeMillis());
//业务参数
String channelId = "4760542";
String url = "http://api.polyv.net/live/v3/channel/interact/question/list-question";
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("channelId",channelId);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url,requestMap);
log.info("测试查询频答题卡列表接口返回值:{}",response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": {
"templateId": "gv0jmmcqdh",
"list": [
{
"questionId": "gv0l1fu5ox",
"channelId": 4760542,
"userId": "cf7f07e096",
"name": "API题目",
"type": "R",
"option1": "正确",
"option2": "错误1",
"option3": null,
"option4": null,
"option5": null,
"createdTime": null,
"lastModified": 1712461149000,
"answer": "A",
"note": null,
"templateId": "gv0jmmcqdh",
"status": "send",
"times": 1,
"tips1": null,
"tips2": null,
"tips3": null,
"tips4": null,
"tips5": null,
"required": null,
"scoreEnabled": null,
"option6": null,
"option7": null,
"option8": null,
"option9": null,
"option10": null,
"score": null,
"itemType": 0,
"option11": null,
"option12": null,
"option13": null,
"option14": null,
"option15": null
}
]
}
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
