查詢頻道答題卡列表

更新時間：2024-04-23 14:08:27

介面描述

1、获取频道的答题卡列表
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/interact/question/list-question

線上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	頻道號

範例

https://api.polyv.net/live/v3/channel/interact/question/list-question?appId=frlr1zazn3&sign=21914C8E80403BF527F6061DD79DAE47&channelId=1965681&timestamp=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": ""
}