Query All Check-in Records by Check-in ID

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

API Description

1、通过签到id查询签到记录（包括已签到与未签到记录）
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/chat/get-checkins

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls are subject to rate limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 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 not be stored directly on the client. 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
checkinId	true	String	Check-in ID, one ID per check-in session. This parameter is obtained from Query Channel Check-in Results

Example

http://api.polyv.net/live/v3/channel/chat/get-checkins?checkinId=db14ef80-81b8-11eb-b114-e7477b&appId=frlr1zazn3&sign=F0163ADFB54D9BB31BC8DD411252B1FD&channelId=2191569&timestamp=1621845214778

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See global error description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	Array	Check-in record data See data field description

Data Field Description

Parameter	Type	Description
accountId	String	Corresponding live account userId
checkinid	String	Check-in ID
nickname	String	Check-in participant nickname
checked	String	Y for checked in, N for not checked in
indate	String	Check-in date, yyyy-MM-dd format
id	Integer	Check-in record primary key
sessionId	String	Session ID
time	Long	Check-in timestamp
userid	String	Check-in participant ID
roomid	String	Room ID
param4	String	Custom parameter passed during external authorization or direct (standalone) authorization
param5	String	Custom parameter passed during external authorization or direct (standalone) authorization

Java Request Example

For quick integration of basic code, 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 packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(InteractionCheckinTest.class);
/**
 * 根据发起签到记录查询签到结果
 * @throws IOException
 */
@Test
public void testGetCheckinByCheckinId() 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/chat/get-checkins";
        String channelId = "2191569";
        String checkinId = "db14ef80-81b8-11eb-b114-e7477b";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("channelId",channelId);
        requestMap.put("checkinId",checkinId);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("测试根据发起签到记录查询签到结果接口返回值：{}",response);

}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [
    {
      "accountId": "1b448be323",
      "param5": "",
      "checkinid": "db14ef80-81b8-11eb-b114-e7477b",
      "nickname": "卉",
      "checked": "Y",
      "indate": "2021-03-10",
      "id": 48010860,
      "sessionId": "",
      "time": 1615391652916,
      "param4": "oi_ubswUnFt8QQFAAEJbKmd8W9BE",
      "userid": "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A",
      "roomid": "2191569"
    }
  ]
}

Error Example

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

Live Streaming Server API