Query Check-in Records Initiated by a Channel

Updated: 2025-10-10 11:23:46

API Description

1、通过直播场次id，查询签到发起记录
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/chat/checkin-by-sessionId

Online API Call

Request Method

GET

API Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details: 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 not be stored or used directly on the client side. All APIs must be relayed through the customer's own server to call the POLYV server for response data.` See details: Signature Generation Rules
channelId	true	String	Channel ID
sessionId	true	String	Session ID, obtained from Query Channel Session Information

Example

http://api.polyv.net/live/v3/channel/chat/checkin-by-sessionId?appId=frlr1zazn3&sign=B47C2E7B6EC0C17F62A6E47D62635006&sessionId=fwly13xczv&channelId=2191569&timestamp=1621845186924

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See details: 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 details: data field description

data Field Description

Parameter	Type	Description
sessionId	String	Session ID
roomid	String	Room ID
checkinid	String	Check-in ID, one ID per session check-in
createtime	String	Check-in time
forceCheckInEnabled	String	Whether forced check-in is enabled
isPlayback	String	0: Check-in not during playback, 1: Check-in during playback

Java Request Example

For quick integration of the basic code, download the relevant dependency source code. Click to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the download 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 testGetCheckinBySessionId() 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/checkin-by-sessionId";
        String channelId = "2191569";
        String sessionId = "fwly13xczv";

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

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [
    {
      "createtime": "2021-03-11 00:43:59",
      "checkinid": "d0476a90-81bf-11eb-b114-e7477b",
      "sessionId": "fwly13xczv",
      "roomid": "2191569"
    },
    {
      "createtime": "2021-03-11 00:44:51",
      "checkinid": "eed2a150-81bf-11eb-b114-e7477b",
      "sessionId": "fwly13xczv",
      "roomid": "2191569"
    }
  ]
}

Error Example

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

Live Streaming Server API