> For the complete documentation index, see [llms.txt](https://polyv.gitbook.io/document/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://polyv.gitbook.io/document/docs/live/api/live-interaction/get_checkin_by_sessionid.md).

# 查询频道发起的签到记录

### 接口描述

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

### 接口URL

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

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v3/channel/chat/checkin-by-sessionId/README.md)

### 请求方式

```
GET
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

### 请求参数描述

| 参数名       | 必选   | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp | true | Long   | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign      | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| channelId | true | String | 频道号                                                                                                                                                                                                       |
| sessionId | true | String | 场次号，该参数获取自【[查询频道场次信息](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/channel/playback/get_channel_sessions.md)】                                                                 |

### 示例

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

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                        |
| ------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| code    | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)】                          |
| status  | String  | 响应状态文本信息                                                                                                                                                  |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                                                         |
| data    | Array   | 签到记录的数据 【详见[data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/live_interaction/get_checkin_by_sessionid.md?id=data字段说明)】 |

#### data字段说明

| 参数名        | 类型     | 说明            |
| ---------- | ------ | ------------- |
| sessionId  | String | 场次号           |
| roomid     | String | 房间号           |
| checkinid  | String | 签到id，一场签到一个id |
| createtime | String | 签到时间          |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
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);

}


```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

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

```

异常示例

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