設定現金打賞

更新時間：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": ""
}