根據人員取得觀看時長變化資料

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

介面描述

1、根据人员获取观看时长变化数据
2、接口支持https协议

介面URL

請求方式

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	true	String	場次Id
viewerId	true	String	學員觀眾Id

範例

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗
status	String	回應結果，由業務決定，成功返回success，失敗返回error
success	Boolean	回應結果，由業務決定，成功返回true，失敗返回false
data	Object	成功回應時返回分發列表資訊【詳見Data欄位說明】
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
requestId	String	請求ID，每次請求生成的唯一的UUID，僅可用於排查、除錯，不應與業務掛鉤

Error參數說明

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與 error.code 對應

Data參數說明

參數名	類型	說明
viewerId	String	學員觀眾Id
channelId	String	頻道號
sessionId	String	場次號
shouldStudyTime	Integer	應學時長
grandTotalTime	Integer	已學時長
studyStatus	String	學習狀態，如果學習時長不低於90%，則學習狀態為已完成 Y：已完成 N：未完成

Java請求範例

快速接入基礎代碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "",
    "data": {
        "viewerId": "",
        "channelId": "",
        "sessionId": "",
        "shouldStudyTime": 0,
        "grandTotalTime": 0,
        "studyStatus": "N"
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "error": {
        "code": 10003,
        "desc": "时间戳过期"
    },
    "success": false
}