保利威文档中心

幫助中心

查詢頻道答題卡結果

更新時間: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": ""
}
联系客服,在线咨询