# 查询频道打赏设置

### 接口描述

```
1、获取全局或当前生效的打赏设置
2、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v3/channel/donate/get
```

### 请求方式

```
GET
```

### 接口约束

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

### 请求参数描述

| 参数名       | 必选    | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ----- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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 | 频道号，不传为获取全局设置，否则为当前生效设置                                                                                                                                                                                   |

### 示例

```requestUrl
http://api.polyv.net/live/v3/channel/donate/get?appId=frlr1zazn3&sign=C2C75D35056DFC64E6678D705FFB1857&channelId=2149710&timestamp=1621844001298
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                                                |
| ------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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    | Object  | 打赏设置的详细信息 【详见[data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/web/page_interaction/donate_get.md?id=data%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】 |

#### data字段说明

| 参数名                  | 类型        | 说明                                                                                                                                                                               |
| -------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| globalSettingEnabled | String    | <p>是否应用全局设置，获取全局设置时，该值为null<br>Y：应用全局设置<br>N：应用频道设置</p>                                                                                                                          |
| donateCashEnabled    | String    | 现金打赏开关                                                                                                                                                                           |
| donateGoodEnabled    | String    | 道具打赏开关                                                                                                                                                                           |
| donateTips           | String    | 打赏提示                                                                                                                                                                             |
| cashMin              | Double    | 最低打赏金额                                                                                                                                                                           |
| cashes               | Double\[] | 打赏金额选项                                                                                                                                                                           |
| goods                | Array     | 打赏道具选项 【详见[goods字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/web/page_interaction/donate_get.md?id=goods%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】 |
| donatePointEnabled   | String    | 积分打赏开关                                                                                                                                                                           |
| pointUnit            | String    | 积分打赏单位                                                                                                                                                                           |

#### goods字段说明

| 参数名                                                                                                                                                                                       | 类型     | 说明            |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------------- |
| goodName                                                                                                                                                                                  | String | 道具选项名         |
| goodImg                                                                                                                                                                                   | String | 道具选项对应的图片     |
| goodPrice                                                                                                                                                                                 | Float  | 道具选项对应的价格，单位元 |
| goodEnabled                                                                                                                                                                               | String | 是否启用该道具       |
| ### 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 testDonateGet() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/donate/get";
    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 response = HttpUtil.get(url,requestMap);
    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": {
		"globalSettingEnabled": "Y",
		"donateCashEnabled": "Y",
		"donateGoodEnabled": "Y",
		"donateTips": "打赏",
		"cashMin": 0.01,
		"donatePointEnabled": "N",
		"pointUnit": null,
		"cashes": [0.88, 6.66, 8.88, 18.88, 66.60, 88.80],
		"goods": [{
			"goodName": "鲜花",
			"goodImg": "//s1.videocc.net/default-img/donate/flower.png",
			"goodPrice": 0.00,
			"goodEnabled": "Y"
		}, {
			"goodName": "咖啡",
			"goodImg": "//s1.videocc.net/default-img/donate/coffee.png",
			"goodPrice": 0.99,
			"goodEnabled": "Y"
		}, {
			"goodName": "点赞",
			"goodImg": "//s1.videocc.net/default-img/donate/like.png",
			"goodPrice": 1.99,
			"goodEnabled": "Y"
		}, {
			"goodName": "掌声",
			"goodImg": "//s1.videocc.net/default-img/donate/handclap.png",
			"goodPrice": 2.99,
			"goodEnabled": "Y"
		}, {
			"goodName": "666",
			"goodImg": "//s1.videocc.net/default-img/donate/666.png",
			"goodPrice": 6.66,
			"goodEnabled": "Y"
		}, {
			"goodName": "小星星",
			"goodImg": "//s1.videocc.net/default-img/donate/star.png",
			"goodPrice": 9.99,
			"goodEnabled": "Y"
		}, {
			"goodName": "钻石",
			"goodImg": "//s1.videocc.net/default-img/donate/diamond.png",
			"goodPrice": 19.99,
			"goodEnabled": "Y"
		}, {
			"goodName": "跑车",
			"goodImg": "//s1.videocc.net/default-img/donate/car.png",
			"goodPrice": 29.99,
			"goodEnabled": "Y"
		}, {
			"goodName": "火箭",
			"goodImg": "//s1.videocc.net/default-img/donate/rocket.png",
			"goodPrice": 66.66,
			"goodEnabled": "Y"
		}]
	}
}
```

异常示例

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