Query All Chat Records

API Description

1、查询账号下频道聊天记录
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/user/chat/get-speak-list

Request Method

GET

API Constraints

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

2. Do not pass the cursor parameter for the first query. Use the cursor returned from the previous query for subsequent queries until the returned list has no data.

Request Parameters

Example

https://api.polyv.net/live/v3/user/chat/get-speak-list?cursor=6_2&size=3&appId=frlr1zazn3&sign=C63541E7ACE179314B087FB218925FBC&userId=1b448be323&timestamp=1634284501527

Response Parameters

data Field Description

list Field Description

User Information JSON Field Description

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

    /**
     * 测试查询频道连麦详情数据
     * @throws IOException
     */
    @Test
    public void test() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String userId = super.userId;
        String timestamp = String.valueOf(System.currentTimeMillis());
        //业务参数
        String url = "https://api.polyv.net/live/v3/user/chat/get-speak-list";
        
        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        
        requestMap.put("userId",userId);
        requestMap.put("cursor","6_2");
        requestMap.put("size","3");
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("测试查询所有聊天记录，当前页查询成功，返回值：{}",response);
        //do somethings
    }

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "size": 3,
        "cursor": "7_3",
        "list": [
            {
                "id": "f14e71f0-0fb5-11ec-912a-f7bfa2a37ef8",
                "roomId": "2523307",
                "content": "1",
                "user": "{\"banned\":false,\"channelId\":\"2523307\",\"clientIp\":\"175.10.232.110\",\"customize\":0,\"nick\":\"a\",\"pic\":\"https://liveimages.videocc.net/defaultImg/avatar/viewer.png\",\"roomId\":\"2523307\",\"uid\":\"nhycNjFyZxSXuVz0AKNW\",\"userId\":\"1631003162428\",\"userType\":\"slice\"}",
                "image": "",
                "time": 1631003465350,
                "clientIP": "",
                "msgType": null,
                "userType": "slice",
                "sessionId": null,
                "quote": null,
                "accountId": "1b448be323"
            },
            {
                "id": "f202a6c0-0fb5-11ec-912a-f7bfa2a37ef8",
                "roomId": "2523307",
                "content": "2",
                "user": "{\"banned\":false,\"channelId\":\"2523307\",\"clientIp\":\"175.10.232.110\",\"customize\":0,\"nick\":\"a\",\"pic\":\"https://liveimages.videocc.net/defaultImg/avatar/viewer.png\",\"roomId\":\"2523307\",\"uid\":\"nhycNjFyZxSXuVz0AKNW\",\"userId\":\"1631003162428\",\"userType\":\"slice\"}",
                "image": "",
                "time": 1631003466531,
                "clientIP": "",
                "msgType": null,
                "userType": "slice",
                "sessionId": null,
                "quote": null,
                "accountId": "1b448be323"
            },
            {
                "id": "f39331d0-0fb5-11ec-912a-f7bfa2a37ef8",
                "roomId": "2523307",
                "content": "35",
                "user": "{\"banned\":false,\"channelId\":\"2523307\",\"clientIp\":\"175.10.232.110\",\"customize\":0,\"nick\":\"a\",\"pic\":\"https://liveimages.videocc.net/defaultImg/avatar/viewer.png\",\"roomId\":\"2523307\",\"uid\":\"nhycNjFyZxSXuVz0AKNW\",\"userId\":\"1631003162428\",\"userType\":\"slice\"}",
                "image": "",
                "time": 1631003469156,
                "clientIP": "",
                "msgType": null,
                "userType": "slice",
                "sessionId": null,
                "quote": null,
                "accountId": "1b448be323"
            }
        ]
    }
}

Error Example

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