Query Channel Chat History

API Description

1、通过频道号，查询一段时间内的聊天记录
2、接口支持https协议

API URL

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

Online API Call

Request Method

GET

API Constraints

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

2. Time format is yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. If only a date is provided without a specific time, the start time defaults to 00:00:00 and the end time to 23:59:59 of that date.

Request Parameters

Example

http://api.polyv.net/live/v3/channel/chat/get-history-page?startDay=2020-03-10&appId=frlr1z1zn3&endDay=2021-03-10&sign=FD60256504E55BC4986B1BF9D207A997&pageSize=20&page=1&userType=&source=&channelId=1965681&roomId=&timestamp=1635478961187&status=

Response Parameters

data Field Description

contents Field Description

Description When content is in JSON Format

Distinguish message types based on msgType

When msgType is redpaper, it indicates a red packet:

When msgType is reward, it indicates a tip:

When msgType is chatImg, it indicates an image:

When msgType is custom, it indicates a custom message:

user Field Description

rewardUser Field Description

Java Request Example

For quick integration of 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 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(ChatMessageTest.class);

    /**
     * 查询频道聊天记录
     * @throws IOException
     */
    @Test
    public void testGetMessageList() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());
        
        //业务参数
        String url = "http://api.polyv.net/live/v3/channel/chat/get-history-page";
        String startDay = "2020-03-10";
        String endDay = "2021-03-10";
        String channelId = "1965681";
        Integer page = 1;
        Integer pageSize = 20;
        String userType = "";
        String status = "";
        String source = "";
        String roomId = "";
        
        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("startDay",startDay);
        requestMap.put("endDay",endDay);
        requestMap.put("channelId",channelId);
        requestMap.put("page",page.toString());
        requestMap.put("pageSize",pageSize.toString());
        requestMap.put("userType",userType);
        requestMap.put("status",status);
        requestMap.put("source",source);
        requestMap.put("roomId",roomId);
        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": {
        "pageNumber": 1,
        "pageSize": 20,
        "totalPages": 0,
        "totalItems": 0,
        "contents": [
            {
                "id": "874e2850-12bc-11eb-963f-578bb7bc5db5",
                "accountId": "",
                "clientIP": "",
                "content": "hello 大家好",
                "event": null,
                "image": "",
                "msgType": null,
                "quote": null,
                "sessionId": "fs9v9y4nxf",
                "roomId": "1965681",
                "channelId": 1965681,
                "time": 1603188649810,
                "userType": "",
                "status": "",
                "sourceType": "public",
                "user": {
                    "actor": null,
                    "banned": false,
                    "channelId": 1965681,
                    "clientIp": "",
                    "nickname": "thomas",
                    "pic": "http://s1.videocc.net/default-img/avatar/teacher.png",
                    "roomId": "1965681",
                    "sessionId": null,
                    "uid": "",
                    "userId": "1965681_reboot_0",
                    "userSource": null,
                    "userType": ""
                }
            }
        ]
    }
}

Error Example

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