保利威文档中心

帮助中心

查询频道答题卡结果

更新时间:2022-09-02 18:08:07

接口描述

1、通过频道号,查询答题卡答题结果列表
2、接口支持https协议
3、参数场次号、查询时间同时存在多个时,按参数优先级从小到大,选其中一个参数作为查询条件

接口URL

http://api.polyv.net/live/v3/channel/question/answer-records

在线API调用

请求方式

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 频道号
sessionId false String 场次号,优先级1
startDate false String 查询的开始时间,优先级2,格式是:yyyy-MM-dd,默认查最近7天数据
endDate false String 查询的结束时间,优先级2,格式是:yyyy-MM-dd,默认查最近7天数据

示例

http://api.polyv.net/live/v3/channel/question/answer-records?endDate=&appId=frlr1zazn3&sign=D0163266BDD894AC11D310082B84F75C&channelId=2191569&startDate=&timestamp=1621845243688

响应参数描述

参数名 类型 说明
code Integer 响应状态码,200为成功返回,非200为失败【详见全局错误说明
status String 响应状态文本信息
message String 响应描述信息,当code为400或者500的时候,辅助描述错误原因
data Array 答题结果的列表数据 【详见data字段说明

data字段说明

参数名 类型 说明
questionId String 题目id
answer String 题目的答案
questionTitle String 题目
times Integer 第几次发送题目,用于区分相同题目重复发送的情况
sendTime Long 答题卡发送时间,时间戳
endTime Long 答题卡关闭时间,时间戳
total Integer 答题人数
correctCount Integer 回答正确的数量
interactStatus String 直播场次互动操作状态
timestamp Long 服务器时间
rightUser String[] 答对用户列表
faultUser String[] 答错用户列表
type String 题目类型
R:单选
C:多选
V:投票
S:评分
itemType Integer 答题类型
1:问答
0:答题卡
options Array 题目选项信息列表 【详见option字段说明
records Array 答题的用户列表 【详见record字段说明

option字段说明

参数名 类型 说明
title String 选项标题
count Integer 选择该选项的人数
percent String 选择该选项的人数百分比

record字段说明

参数名 类型 说明
viewerId String 答题的用户id
nickname String 答题的用户昵称
answer String 答题的用户提交的答案
avatar String 答题的用户头像
correct Boolean 答题的用户提交的答案是否正确
false:不正确
true:正确
submitTime Long 答题的用户提交时间,13位毫秒级时间戳
param4 String 用户自定义字段
param5 String 用户自定义字段

Java请求示例

快速接入基础代码请下载相关依赖源码点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(InteractionQuestionTest.class);
/**
 * 查询频道答题卡结果
 * @throws IOException
 */
@Test
public void testGetAnswerList() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String url = "https://api.polyv.net/live/v3/channel/question/answer-records";
        String channelId = "2191569";
        String startDate = "";
        String endDate = "";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("channelId",channelId);
        requestMap.put("startDate",startDate);
        requestMap.put("endDate",endDate);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("测试查询频道答题卡结果接口返回值:{}",response);

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [
    {
      "questionId": "fwly4r487r",
      "answer": "AB",
      "questionTitle": "快速问答",
      "times": 1,
      "sendTime": 1637308945000,
      "endTime": 1637308954000,
      "total": 2,
      "correctCount": 0,
      "interactStatus": null,
      "options": [
        {
          "title": "A",
          "count": 1,
          "percent": "50.00%"
        },
        {
          "title": "B",
          "count": 1,
          "percent": "50.00%"
        }
      ],
      "records": [
        {
          "viewerId": "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A",
          "nickname": "卉",
          "answer": "B",
          "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/3lMXVJoLMLJibnkFuA23lyqj5MOQufhW5ATvHuB8byssutficHKU0u7OMx5OQgg9WNVuHf44AXfbAMMAZejuYFTg/132",
          "correct": false,
          "submitTime": 1615394824000
        },
        {
          "viewerId": "1615394262720",
          "nickname": "周鑫",
          "answer": "A",
          "avatar": "https://liveimages.videocc.net/defaultImg/avatar/viewer.png",
          "correct": false,
          "submitTime": 1615394833000
        }
      ],
      "timestamp": null,
      "rightUser": [ ],
      "faultUser": [ ],
      "type": "R",
      "itemType": 1
    },
    {
      "questionId": "fwlx0ahwe9",
      "answer": "AB",
      "questionTitle": "快速问答",
      "times": 1, 
      "sendTime": 1637308945000,
      "endTime": 1637308954000,
      "total": 3,
      "correctCount": 0,
      "interactStatus": null,
      "options": [
        {
          "title": "A",
          "count": 1,
          "percent": "33.00%"
        },
        {
          "title": "B",
          "count": 2,
          "percent": "67.00%"
        }
      ],
      "records": [
        {
          "viewerId": "1615394262720",
          "nickname": "上海观众/10812",
          "answer": "A",
          "avatar": "https://liveimages.videocc.net/defaultImg/avatar/viewer.png",
          "correct": false,
          "submitTime": 1615394304000
        },
        {
          "viewerId": "ovtl9tyK6dqob_cgewjRnQ1tSB4U",
          "nickname": "周鑫",
          "answer": "B",
          "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/DYAIOgq83epTUL7QR3hCkMDQOrBk7vcxZibiahB9SnPk6oUiadmZyOCxIOQiciajE4U2Xf78kpLnicCbzAnr1aMUWotA/132",
          "correct": false,
          "submitTime": 1615392378000
        },
        {
          "viewerId": "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A",
          "nickname": "卉",
          "answer": "B",
          "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/3lMXVJoLMLJibnkFuA23lyqj5MOQufhW5ATvHuB8byssutficHKU0u7OMx5OQgg9WNVuHf44AXfbAMMAZejuYFTg/132",
          "correct": false,
          "submitTime": 1615392461000
        }
      ],
      "timestamp": null,
      "rightUser": [ ],
      "faultUser": [ ],
      "type": "R",
      "itemType": 1
    }
  ]
}

异常示例

{
  "code": 400,
  "status": "error",
  "message": "invalid signature.",
  "data": ""
}
联系客服,在线咨询