Modify Default Template Gift Donation Settings

API Description

1、修改直播模板礼物打赏设置，礼物打赏又分为现金支付和积分支付
2、（timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

API URL

http://api.polyv.net/live/v4/user/donate/gift/update

Online API Call

Request Method

POST

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate limits. See details

Request Parameter Description

Request Body Parameter Description

TemplateGiftDonate Parameter Description

GiftDonate Parameter Description

Example

http://api.polyv.net/live/v4/user/donate/gift/update?appId=frlr1zazn3&sign=ECDDF7902925D558426182348FE3925D&timestamp=1631091439270

Request body JSON parameters:

{
    "donateGiftEnabled": "Y",
    "giftDonate": {
        "cashPays": [
            {
                "img": "//s1.videocc.net/default-img/donate/666.png",
                "price": "666",
                "name": "现金礼物1",
                "enabled": "Y"
            }
        ],
        "pointUnit": "豆",
        "pointPays": [
            {
                "img": "//s1.videocc.net/default-img/donate/666.png",
                "price": "666",
                "name": "积分礼物1",
                "enabled": "Y"
            }
        ],
        "payWay": "CASH"
    }
}

Response Parameter Description

Error Parameter Description

Java Request Example

For quick integration of the base code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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

    @Test
    public void updateChannelDonate() 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/gift/update";
        
        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        
        Map<String, Object> jsonMap = new HashMap<>();
        jsonMap.put("donateGiftEnabled","Y");
        Map<String, Object> giftDonateMap = new HashMap<>();
        giftDonateMap.put("payWay","CASH");
        giftDonateMap.put("pointUnit","豆");
        List<Map<String,Object>> cashPaysList = new ArrayList<>();
        Map<String,Object> cash1 = new HashMap<>();
        cash1.put("name","现金礼物1");
        cash1.put("img","//s1.videocc.net/default-img/donate/666.png");
        cash1.put("price","666");
        cash1.put("enabled","Y");
        cashPaysList.add(cash1);
        giftDonateMap.put("cashPays",cashPaysList);
        List<Map<String,Object>> pointPaysList = new ArrayList<>();
        Map<String,Object> point1 = new HashMap<>();
        point1.put("name","积分礼物1");
        point1.put("img","//s1.videocc.net/default-img/donate/666.png");
        point1.put("price","666");
        point1.put("enabled","Y");
        pointPaysList.add(point1);
        giftDonateMap.put("pointPays",pointPaysList);
        jsonMap.put("giftDonate",giftDonateMap);
        
        url = HttpUtil.appendUrl(url,requestMap);
        
        String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap),null);
        
        log.info("测试修改直播模板礼物打赏设置，返回值：{}", response);
    }

Response Example

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "5d413aa5dc6b4cc1b79d4374aa5ac974.63.16310914532009701",
    "data": null,
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "4081dbac03e6441e8bdd301d8feee5a2.124.16360832547921601",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}