觀眾進行積分打賞的介面

更新時間：2022-05-23 17:54:01

介面URL

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

介面說明

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

回傳結果格式

JSON

請求方式

POST

請求參數

參數名	必選	類型	說明
token	是	string	介面請求的憑證
channelId	是	int	頻道號
viewerId	是	string	觀眾ID
goodId	是	int	打賞的ID
goodNum	否	int	打賞的數量，預設為1
nickname	否	string	觀眾暱稱
avartar	否	string	觀眾頭像

回應成功JSON範例：

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

回應失敗JSON範例：

token過期了

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

非法的token

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

必填參數不能為空

{
    "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": ""
}

非法的存取

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

欄位說明

參數名	說明
code	回應代碼，成功為200，失敗為400，簽名錯誤為403，異常錯誤500
status	成功為success，失敗為error
message	錯誤時為錯誤提示訊息
data	int，回傳觀眾對應的可用積分數

Java請求範例

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);
    }