Polyv Help Center

Help Center

Get Viewer Points from Points Tipping

Updated: 2022-05-23 17:54:01

Interface URL

https://api.polyv.net/live/v3/channel/donate/point/get

Interface Description

1、接口用于获取观众积分打赏的积分
2、接口支持https

Return Result Format

JSON

Request Method

GET

Request Parameters

Parameter Required Type Description
token Yes string Credential for the API request
channelId Yes int Channel ID
viewerId Yes string Viewer ID
nickname No string Viewer nickname, URL-encoded

Successful Response JSON Example:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data":  100
}

Failed Response JSON Example:

Token expired

{
    "code": 400,
    "status": "error",
    "message": "token expired",
    "data": ""
}

Invalid token

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

Required parameters cannot be empty

{
    "code": 400,
    "status": "error",
    "message": "param should not be empty: viewerId",
    "data": ""
}
{
    "code": 400,
    "status": "error",
    "message": "param should not be empty: channelId",
    "data": ""
}

Invalid access

{
    "code": 400,
    "data": "",
    "message": "forbidden",
    "status": "error"
}

Field Description

Parameter Description
code Response code: 200 for success, 400 for failure, 403 for signature error, 500 for server error
status "success" for success, "error" for failure
message Error message when an error occurs
data int, returns the available points for the corresponding viewer

Java Request Example

public static void test() {
        String url = "https://api.polyv.net/live/v3/channel/donate/point/get";
        String token = "xxxxxxxxx";
        String viewerId = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        int channelId = 10001;
        Map<String, String> params = new HashMap<>();
        params.put("channelId", channelId);
        params.put("viewerId", viewerId);
        params.put("token", token);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
    }
联系客服,在线咨询