查詢頻道提問記錄

更新時間：2022-09-02 18:08:07

介面描述

1、通过频道号，查询咨询提问记录
2、接口支持https协议
3、接口URL中的{channelId}为"频道号"

介面URL

http://api.polyv.net/live/v2/chat/{channelId}/getQuestion

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS以確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
begin	false	Integer	起始索引，從0開始
end	false	Integer	結束索引，-1表示不分頁

範例

http://api.polyv.net/live/v2/chat/2191569/getQuestion?appId=frlr1zazn3&sign=40763580D3C4C34CF268018E154944D3&end=1&begin=0&timestamp=1616636714152

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Array	提問記錄的列表資料【詳見data欄位說明】

data欄位說明

參數名	類型	說明
id	String	資訊id
content	String	內容
time	Long	時間，13位時間戳記
s_userId	String	提問者id
event	String	訊息類型 T_ANSWER：講師回答 S_QUESTION：學生提問
sourceType	String	觀眾來源
user	Object	發言人資訊【詳見user欄位說明】

user欄位說明

參數名	類型	說明
nick	String	發言人暱稱
pic	String	發言人大頭貼
userId	String	發言人id
sessionId	String	場次號
userType	String	發言人類型值
banned	Boolean	是否禁言（true/false）
channelId	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 testGetQuestionList() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String channelId = "2191569";
        String url = "http://api.polyv.net/live/v2/chat/"+channelId+"/getQuestion";
        Integer begin = 0;
        Integer end = 1;

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("begin",begin.toString());
        requestMap.put("end",end.toString());
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("测试查询频道提问记录接口返回值：{}",response);

}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [
    {
      "id": "ef523640-855c-11eb-ac86-91e249016089",
      "user": {
        "nick": "卉",
        "pic": "https://thirdwx.qlogo.cn/mmopen/vi_32/3lMXVJoLMLJibnkFuA23lyqj5MOQufhW5ATvHuB8byssutficHKU0u7OMx5OQgg9WNVuHf44AXfbAMMAZejuYFTg/132",
        "userId": "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A",
        "sessionId": null,
        "userType": "student",
        "banned": false,
        "channelId": null
      },
      "content": "很长的提问",
      "time": 1615791976356,
      "s_userId": null,
      "event": "S_QUESTION",
      "sourceType": null
    },
    {
      "id": "e9090520-855c-11eb-ac86-91e249016089",
      "user": {
        "nick": "卉",
        "pic": "https://thirdwx.qlogo.cn/mmopen/vi_32/3lMXVJoLMLJibnkFuA23lyqj5MOQufhW5ATvHuB8byssutficHKU0u7OMx5OQgg9WNVuHf44AXfbAMMAZejuYFTg/132",
        "userId": "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A",
        "sessionId": null,
        "userType": "student",
        "banned": false,
        "channelId": null
      },
      "content": "提问",
      "time": 1615791965810,
      "s_userId": null,
      "event": "S_QUESTION",
      "sourceType": null
    }
  ]
}

異常範例

{
  "code": 400,
  "status": "error",
  "message": "invalid signature.",
  "data": ""
}