Get User Message Count by Channel ID and Session ID

Updated: 2023-04-23 10:35:06

API Description

1、根据频道id和场次id获取用户发言次数统计
2、搭配富德定制化开播端使用
3、接口支持https协议

API URL

http://api.polyv.net/live/v4/chat/get-group-login-times

Request Method

GET

API Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details
channelId	true	String	Channel ID
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 used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See signature generation rules
timestamp	true	String	Current 13-digit millisecond timestamp, valid for 3 minutes

Example

http://api.polyv.net/live/v4/chat/get-group-login-times?appId=frlr1zazn3&sign=D3FF70E76C06B7F741C406D23E35AFF0&channelId=1965681&timestamp=1682217131813

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
data	Array	Successful response data See Data parameter description
error	Object	Error information when status code is not 200 See Error parameter description
requestId	String	Request ID, a unique UUID generated for each request, only for troubleshooting and debugging, not to be tied to business logic
status	String	Response result, determined by business logic: returns success on success, error on failure
success	Boolean	Whether the response is successful

Data Parameter Description

Parameter	Type	Description
id	String	Branch company ID
name	String	Branch company name
total	Integer	Number of logged-in users

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error cause
desc	String	Error description, corresponding to error.code

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, 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(getClass());
/**
* 根据频道id和场次id获取用户发言次数统计
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void chatGetGroupLoginTimesTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/chat/get-group-login-times";
    String channelId = "1965681";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("channelId", channelId);
    requestMap.put("timestamp", timestamp);

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);

    log.info("测试根据频道id和场次id获取用户发言次数统计成功：{}", response);
    //do somethings

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "628a84ad211344b8b15ec06a722fa793.71.16822171085604901",
    "data": [
        {
            "id": "a112",
            "name": "test",
            "total": 10000
        }
    ],
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API