查詢報名觀看記錄

更新時間：2024-12-13 15:32:04

介面描述

1、查询报名观看记录
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/enroll/list

線上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	頻道號
viewerIds	false	String	觀眾ID列表用逗號分隔，上限20個

範例

http://api.polyv.net/live/v3/channel/enroll/list?appId=frlr1zazn3&sign=68A98C385C45853A5C273D2145575BC5&channelId=2453970&timestamp=1629969811503

回應參數描述

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

data欄位描述

參數名	類型	說明
auditEnabled	String	頻道報名審核開關 Y：開啟 N：關閉
list	Array	報名觀看記錄【詳見list欄位描述】

list欄位描述

參數名	類型	說明
viewerId	String	觀眾ID
mobile	String	手機號碼
createTime	Long	報名時間，13位毫秒級時間戳
hasWatched	String	是否已觀看 Y：是 N：否
promoteId	String	推廣渠道ID
promoteName	String	推廣渠道名稱
auditStatus	String	審核結果 W：未審核 P：已通過 F：已拒絕
fields	Array	報名資訊【詳見fields欄位描述】

fields欄位描述

參數名	類型	說明
name	String	報名資訊名稱
value	String	報名資訊值

Java請求範例

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

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTestLive.class);
/**
 * 查询报名观看记录
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void enrollTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/enroll/list";
    String channelId = "2453970";
    String viewerIds = "1,2,3";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("viewerIds", viewerIds);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询报名观看记录：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "auditEnabled": "N",
        "list": [{
            "viewerId": "1628213504323",
            "mobile": "133",
            "createTime": 1628213514000,
            "hasWatched": "N",
            "promoteId": null,
            "promoteName": null,
            "auditStatus": "P",
            "fields": [{
                "name": "邮箱",
                "value": ""
            }, {
                "name": "1518406",
                "value": "ces"
            }, {
                "name": "姓名",
                "value": "liiii"
            }, {
                "name": "手机号码",
                "value": "133"
            }]
        }]
    }
}

異常範例

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