保利威文档中心

幫助中心

獲取觀眾積分打賞的積分

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

介面URL

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

介面說明

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

回傳結果格式

JSON

請求方式

GET

請求參數

參數名 必選 類型 說明
token string 介面請求的憑證
channelId int 頻道號
viewerId string 觀眾ID
nickname string 觀眾暱稱,做urlencode

響應成功JSON範例:

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

響應失敗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,
    "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/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);
    }
联系客服,在线咨询