# 设置礼物打赏

### 接口描述

```
1、设置礼物打赏-现金支付礼物（旧版后台为：道具打赏）
2、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v3/channel/donate/update-good
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v3/channel/donate/update-good/README.md)

### 请求方式

```
POST
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

2、仅支持设置礼物打赏-现金支付礼物，传入频道号为设置频道的道具打赏，不带频道号修改通用设置

### 请求参数描述

| 参数名       | 必选    | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ----- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true  | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp | true  | Long   | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign      | true  | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| channelId | false | String | 频道号，不传为修改通用设置（旧版后台通用设置）                                                                                                                                                                                   |

### 请求体参数描述

| 参数名     | 必选    | 类型     | 说明                                                                                                                                                                                                |
| ------- | ----- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| goods   | true  | Object | 打赏礼物对象数组，对象数量必须大于0小于10 【详见[goods字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/web/page_interaction/update_good.md?id=goods%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】 |
| enabled | false | String | <p>打赏开关，不传默认开启<br>Y：开启<br>N：关闭</p>                                                                                                                                                                |

#### goods字段说明

| 参数名         | 必选   | 类型     | 说明                                                          |
| ----------- | ---- | ------ | ----------------------------------------------------------- |
| goodName    | true | String | 礼物名称，不能超过5个字符                                               |
| goodImg     | true | String | 礼物图片，不能超过120个字符（图片地址可以使用下面json字符串中的默认地址，或者通过上传图片接口上传获取图片地址） |
| goodPrice   | true | Float  | 礼物打赏价格，单位元                                                  |
| goodEnabled | true | String | <p>礼物开关<br>Y：开启<br>N：关闭</p>                                 |

### 示例

```requestUrl
http://api.polyv.net/live/v3/channel/donate/update-good?appId=frlr1zazn3&sign=3ADDD49DB62A77BFDC0CA62585A24011&channelId=2149710&timestamp=1621844081667
```

请求体参数

```json
{
    "enabled": "Y",
	"goods": [{
		"goodName": "鲜花333",
		"goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/01-flower.png",
		"goodPrice": 0,
		"goodEnabled": "Y"
	}, {
		"goodName": "咖啡",
		"goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/02-coffee.png",
		"goodPrice": 0.99,
		"goodEnabled": "Y"
	}, {
		"goodName": "点赞",
		"goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/03-good.png",
		"goodPrice": 1.99,
		"goodEnabled": "Y"
	}, {
		"goodName": "掌声",
		"goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/04-applaud.png",
		"goodPrice": 2.99,
		"goodEnabled": "Y"
	}, {
		"goodName": "666",
		"goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/05-666.png",
		"goodPrice": 6.66,
		"goodEnabled": "Y"
	}, {
		"goodName": "小星星",
		"goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/06-star.png",
		"goodPrice": 9.99,
		"goodEnabled": "Y"
	}, {
		"goodName": "钻石",
		"goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/07-diamond.png",
		"goodPrice": 19.99,
		"goodEnabled": "Y"
	}, {
		"goodName": "跑车",
		"goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/08-car.png",
		"goodPrice": 29.99,
		"goodEnabled": "Y"
	}, {
		"goodName": "火箭233",
		"goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/09-rocket.png",
		"goodPrice": 66.66,
		"goodEnabled": "Y"
	}]
}
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                               |
| ------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- |
| code    | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)】 |
| status  | String  | 响应状态文本信息                                                                                                                         |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                                |
| data    | String  | 成功时为true，错误时为空                                                                                                                   |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
private static final Logger log = LoggerFactory.getLogger(PageInteractionTest.class);
/**
 * 设置道具打赏
 * @throws IOException
 */
@Test
public void testUpdateGood() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String channelId = "2149710";
    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String url = "http://api.polyv.net/live/v3/channel/donate/update-good";
    //拼接url
    url = HttpUtil.appendUrl(url, requestMap);
    String body = "{\"enabled\": \"Y\",\"goods\":[{\"goodName\":\"鲜花333\",\"goodImg\":\"//livestatic.videocc.net/uploaded/images/webapp/channel/donate/01-flower.png\",\"goodPrice\":0,\"goodEnabled\":\"Y\"},{\"goodName\":\"咖啡\",\"goodImg\":\"//livestatic.videocc.net/uploaded/images/webapp/channel/donate/02-coffee.png\",\"goodPrice\":0.99,\"goodEnabled\":\"Y\"},{\"goodName\":\"点赞\",\"goodImg\":\"//livestatic.videocc.net/uploaded/images/webapp/channel/donate/03-good.png\",\"goodPrice\":1.99,\"goodEnabled\":\"Y\"},{\"goodName\":\"掌声\",\"goodImg\":\"//livestatic.videocc.net/uploaded/images/webapp/channel/donate/04-applaud.png\",\"goodPrice\":2.99,\"goodEnabled\":\"Y\"},{\"goodName\":\"666\",\"goodImg\":\"//livestatic.videocc.net/uploaded/images/webapp/channel/donate/05-666.png\",\"goodPrice\":6.66,\"goodEnabled\":\"Y\"},{\"goodName\":\"小星星\",\"goodImg\":\"//livestatic.videocc.net/uploaded/images/webapp/channel/donate/06-star.png\",\"goodPrice\":9.99,\"goodEnabled\":\"Y\"},{\"goodName\":\"钻石\",\"goodImg\":\"//livestatic.videocc.net/uploaded/images/webapp/channel/donate/07-diamond.png\",\"goodPrice\":19.99,\"goodEnabled\":\"Y\"},{\"goodName\":\"跑车\",\"goodImg\":\"//livestatic.videocc.net/uploaded/images/webapp/channel/donate/08-car.png\",\"goodPrice\":29.99,\"goodEnabled\":\"Y\"},{\"goodName\":\"火箭233\",\"goodImg\":\"//livestatic.videocc.net/uploaded/images/webapp/channel/donate/09-rocket.png\",\"goodPrice\":66.66,\"goodEnabled\":\"Y\"}]}";
    String response = HttpUtil.postJsonBody(url,body,null);
    log.info("测试设置道具打赏接口返回值：{}",response);
    //do somethings
}

```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

```json
{
	"code": 200,
	"status": "success",
	"message": "",
	"data": true
}
```

异常示例

```json
{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
```
