Polyv Help Center

Help Center

API for Viewers to Send Points as Tips

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

API URL

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

API Description

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

Response Format

JSON

Request Method

POST

Request Parameters

Parameter Required Type Description
token Yes string Credential for the API request
channelId Yes int Channel ID
viewerId Yes string Viewer ID
goodId Yes int ID of the tip item
goodNum No int Quantity of tips, default is 1
nickname No string Viewer nickname
avartar No string Viewer avatar

Successful Response JSON Example:

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

Failed Response JSON Examples:

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": ""
}
{
    "code": 400,
    "status": "error",
    "message": "param should not be empty: goodId",
    "data": ""
}

Unauthorized 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 viewer's available points balance

Java Request Example

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