Query Channel Check-in Success Records

Updated: 2022-09-14 18:04:27

API Description

1、查询频道号下，某天或某场直播的签到记录（仅返回已签到记录）
2、接口支持https协议

API URL

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

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls are subject to rate 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 saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server and retrieve response data.` See Signature Generation Rules
channelId	true	String	Channel ID
page	false	Integer	Page number, default is 1
pageSize	false	Integer	Number of items per page, default is 20
date	false	String	Specified query date in yyyy-MM-dd format. Defaults to the current day's check-in records
sessionId	false	String	Session ID If sessionId is provided, date is ignored If sessionId is not provided, date is effective

Example

http://api.polyv.net/live/v3/channel/checkin/list?date=2021-03-10&appId=frlr1zazn3&sign=97E7B161075A9E52ABEBC202DD25E2E5&pageSize=20&page=1&sessionId=&channelId=2191569&timestamp=1621845152183

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 additional error details
data	Object	Paginated check-in record data See data field description

data Field Description

Parameter	Type	Description
pageNumber	Integer	Page number
totalPages	Integer	Total number of pages
pageSize	Integer	Number of items per page
contents	Array	Check-in record data See content field description

content Field Description

Parameter	Type	Description
id	Integer	Auto-increment primary key
indate	String	Check-in date in yyyy-MM-dd format
nickname	String	Nickname
userid	String	User ID
channelId	String	Channel ID
time	Long	Specific check-in timestamp
timeFormat	String	Formatted check-in date and time in yyyy-MM-dd HH:mm format
sessionId	String	Session ID
startTime	String	Live stream start time for the session If sessionId is not provided, startTime is empty If sessionId is provided, startTime is displayed
checkinid	String	Check-in ID, one ID per check-in session
param4	String	Custom parameter passed during external authorization or direct (independent) authorization
param5	String	Custom parameter passed during external authorization or direct (independent) authorization

Java Request Example

For quick integration of the basic code, please download the relevant dependency source code. Click here to download the 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(InteractionCheckinTest.class);
/**
 * 查询频道签到结果
 * @throws IOException
 */
@Test
public void testGetCheckinList() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String url = "https://api.polyv.net/live/v3/channel/checkin/list";
        Integer channelId = 2191569;
        Integer page = 1;
        Integer pageSize = 20;
        String date = "2021-03-10";
        String sessionId = "";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("channelId",channelId.toString());
        requestMap.put("page",page.toString());
        requestMap.put("pageSize",pageSize.toString());
        requestMap.put("date",date);
        requestMap.put("sessionId",sessionId);
        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": {
    "pageNumber": 1,
    "totalPages": 1,
    "pageSize": 20,
    "contents": [
      {
        "id": 48010860,
        "indate": "2021-03-10",
        "userid": "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A",
        "channelId": 2191569,
        "sessionId": "",
        "time": 1615391652916,
        "timeFormat": "2021-03-10 23:54",
        "startTime": "",
        "param4": "oi_ubswUnFt8QQFAAEJbKmd8W9BE",
        "param5": "",
        "nickname": "卉",
        "checkinid": "db14ef80-81b8-11eb-b114-e7477b"
      }
    ]
  }
}

Error Example

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

Live Streaming Server API