查询默认模板打赏设置

接口描述

1、查询直播模板打赏设置，包括现金打赏、礼物打赏，礼物打赏又分为现金支付和积分支付
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/user/donate/get

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

示例

http://api.polyv.net/live/v4/user/donate/get?appId=frlr1zazn3&sign=0EEE910FFD45B0DCD4A71D490DEB83D6&timestamp=1631091211556

响应参数描述

Error参数描述

data参数描述

TemplateCashDonateBO参数描述

TemplateGiftDonateBO参数描述

GiftDonate参数描述

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

    private static final Logger log = LoggerFactory.getLogger(UserDonateTest.class);

    @Test
    public void getUserDonate() 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/user/donate/get";
        
        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        
        String response = HttpUtil.get(url,requestMap);
        
        log.info("测试查询直播模板打赏设置，返回值：{}", response);
    }

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "4b38eabb79824a409e7fd149f03425d7.73.16708091734594439",
    "data": {
        "donateCashEnabled": "Y",
        "donateGiftEnabled": "Y",
        "cashDonate": {
            "cashs": [
                0.81,
                6.62,
                8.83,
                18.84,
                66.65,
                88.86
            ],
            "cashMin": 0.02
        },
        "giftDonate": {
            "payWay": "POINT",
            "cashUnit": null,
            "pointUnit": "polyv积分",
            "cashPays": [
                {
                    "name": "金手指",
                    "img": "",
                    "dynamicImg": "//liveimages.videocc.net/uploaded/images/2022/12/gg94fabgsb.png",
                    "dynamicFile": "https://liveimages.videocc.net/uploaded/files/1b448be323/2022/12/gg932fa78u.svga",
                    "price": 1.11,
                    "sequence": 0,
                    "enabled": "Y",
                    "unit": null,
                    "imgType": "DYNAMIC"
                },
                {
                    "name": "红玫瑰",
                    "img": "//liveimages.videocc.net/uploaded/images/2021/11/g41in083xo.png",
                    "dynamicImg": null,
                    "dynamicFile": null,
                    "price": 6.66,
                    "sequence": 1,
                    "enabled": "Y",
                    "unit": null,
                    "imgType": null
                }
            ],
            "pointPays": [
                {
                    "name": "666",
                    "img": "//s1.videocc.net/default-img/donate/666.png",
                    "dynamicImg": null,
                    "dynamicFile": null,
                    "price": 12.88,
                    "sequence": 0,
                    "enabled": "Y",
                    "unit": null,
                    "imgType": null
                },
                {
                    "name": "恭喜发财",
                    "img": "https://liveimages.videocc.net/uploaded/images/2021/11/g4b3010gmm.gif",
                    "dynamicImg": null,
                    "dynamicFile": null,
                    "price": 66.88,
                    "sequence": 1,
                    "enabled": "Y",
                    "unit": null,
                    "imgType": null
                }
            ]
        }
    },
    "success": true
}

异常示例

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