查询默认模板打赏设置

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

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

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】

示例

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

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	响应结果，由业务决定，成功返回true，失败返回false
data	Object	成功响应时返回频道详细信息【详见data字段说明】
error	Object	状态码非200时的错误信息【详见Error字段说明】
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

data参数描述

参数名	类型	说明
donateCashEnabled	String	现金红包打赏开关，Y：开启，N：关闭
cashDonate	Object	现金红包【详见TemplateCashDonateBO字段说明】
donateGiftEnabled	String	礼物打赏开关，Y：开启，N：关闭
giftDonate	Object	礼物打赏（现金支付或积分支付）【详见TemplateGiftDonateBO字段说明】

TemplateCashDonateBO参数描述

参数名	类型	说明
cashs	Array	固定打赏金额，数组长度在1-6，最小值0.01，最大值9999.99
cashMin	Float	自定义打赏金额-最低金额，最小值0.01，最大值9999.99

TemplateGiftDonateBO参数描述

参数名	类型	说明
payWay	String	支付方式，CASH：现金支付，POINT：积分支付
cashUnit	String	现金单位
pointUnit	String	积分单位
cashPays	Array	现金支付列表【详见GiftDonate字段说明】
pointPays	Array	积分支付列表【详见GiftDonate字段说明】

GiftDonate参数描述

参数名	类型	说明
name	String	礼物名称
img	String	礼物图片地址
dynamicImg	String	动效缩略图
dynamicFile	String	动效文件
price	Float	礼物价格
sequence	Integer	礼物顺序
enabled	String	开关，Y：开启，N：关闭
unit	String	单位
imgType	String	单位 STATIC-静态图片 DYNAMIC-动态图片

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
}