设置现金打赏

更新时间：2022-09-02 18:08:07

接口描述

1、设置频道或者全局现金打赏（带上频道号为设置频道现金打赏，不带频道号默认为全局现金打赏设置）
2、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

接口URL

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

在线API调用

请求方式

POST

接口约束

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

请求参数描述

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

请求体参数描述

参数名	必选	类型	说明
cashes	true	Double[]	现金打赏数额数组，数组的长度必须为6
cashMin	true	Double	现金打赏自定义最小金额
enabled	false	String	现金打赏开关，不传默认开启 N：关闭 Y：开启

示例

http://api.polyv.net/live/v3/channel/donate/update-cash?appId=frlr1zazn3&sign=7E9C8EF6BB4919EBC717AAF65EFB8B19&channelId=2149710&timestamp=1621844038326

请求体参数

{
    "cashes": [0.88, 6.66, 8.88, 18.11, 66.60, 88.80],
    "cashMin": 0.02,
    "enabled": "Y"
}

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	String	成功时为true，错误时为空

Java请求示例

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

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

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

/**
* 设置现金打赏
* @throws IOException
*/
@Test
public void testUpdateCash() 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/update-cash";
   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 body = "{\"cashes\":[0.88,6.66,8.88,18.11,66.60,88.80],\"cashMin\":0.02,\"enabled\":\"Y\"}";
   url = HttpUtil.appendUrl(url, requestMap);
   String response = HttpUtil.postJsonBody(url, body, null);
   log.info("测试设置现金打赏接口返回值：{}",response);
   //do somethings

}

响应示例

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

成功示例

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

异常示例

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

直播服务端 API