Query Registration Viewing Records

Updated: 2024-12-13 15:32:04

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must never be used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` [See Signature Generation Rules]
channelId	true	String	Channel ID
viewerIds	false	String	Comma-separated list of viewer IDs, up to 20

Example

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure [See Global Error Description]
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides auxiliary error reason
data	Object	Returns registration viewing records on success [See data Field Description]

data Field Description

Parameter	Type	Description
auditEnabled	String	Channel registration audit switch Y: Enabled N: Disabled
list	Array	Registration viewing records [See list Field Description]

list Field Description

Parameter	Type	Description
viewerId	String	Viewer ID
mobile	String	Phone number
createTime	Long	Registration time, 13-digit millisecond timestamp
hasWatched	String	Whether watched Y: Yes N: No
promoteId	String	Promotion channel ID
promoteName	String	Promotion channel name
auditStatus	String	Audit result W: Not audited P: Approved F: Rejected
fields	Array	Registration information [See fields Field Description]

fields Field Description

Parameter	Type	Description
name	String	Registration information field name
value	String	Registration information field value

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source code project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "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"
            }]
        }]
    }
}

Error Example

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