查詢頻道打賞設定(新版後台)

更新時間：2023-03-15 10:54:26

介面描述

1、查询频道打赏设置，包括现金打赏、礼物打赏，礼物打赏又分为现金支付和积分支付
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/donate/get

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號

範例

http://api.polyv.net/live/v4/channel/donate/get?appId=frlr1zazn3&sign=16DC042339E27BAD00452D004C1FA9CA&channelId=2523307&timestamp=1631064094801

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗
status	String	回應結果，由業務決定，成功返回success，失敗返回error
success	Boolean	回應結果，由業務決定，成功返回true，失敗返回false
data	Object	成功回應時返回頻道詳細資訊【詳見data欄位說明】
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
requestId	String	請求ID，每次請求產生的唯一UUID，僅可用於排查、除錯，不應該和業務掛鉤

Error參數描述

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與 error.code 對應

data參數描述

參數名	類型	說明
donateCashEnabled	String	現金紅包打賞開關，Y：開啟，N：關閉
cashDonate	Object	現金紅包【詳見TemplateCashDonateBO欄位說明】
donateGiftEnabled	String	禮物打賞開關，Y：開啟，N：關閉
giftDonate	Object	禮物打賞（現金支付或積分支付）【詳見TemplateGiftDonateBO欄位說明】

TemplateCashDonateBO參數描述

參數名	類型	說明
cashs	Array	固定打賞金額，陣列長度在1-6，最小值0.01，最大值9999.99
cashMin	Float	自訂打賞金額-最低金額，最小值0.01，最大值9999.99

TemplateGiftDonateBO參數描述

參數名	類型	說明
payWay	String	支付方式，CASH：現金支付，POINT：積分支付
cashUnit	String	現金單位
pointUnit	String	積分單位
cashPays	Array	現金支付列表【詳見GiftDonate欄位說明】
pointPays	Array	積分支付列表【詳見GiftDonate欄位說明】

GiftDonate參數描述

參數名	類型	說明
name	String	禮物名稱
img	String	禮物圖片位址
price	Float	禮物價格
enabled	String	開關，Y：開啟，N：關閉

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

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

@Test
public void testGetDonate() 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/channel/donate/get";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", "2523307");
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url,requestMap);
    
    log.info("测试查询频道打赏设置，返回值：{}", response);
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "5d413aa5dc6b4cc1b79d4374aa5ac974.67.16310640996487509",
    "data": {
        "donateCashEnabled": "N",
        "donateGiftEnabled": "N",
        "cashDonate": {
            "cashs": [
                0.88,
                6.66,
                8.88,
                18.88,
                66.6,
                88.8
            ],
            "cashMin": 0.01
        },
        "giftDonate": {
            "payWay": null,
            "cashUnit": "元",
            "pointUnit": "点",
            "cashPays": [
                {
                    "name": "666",
                    "img": "//s1.videocc.net/default-img/donate/666.png",
                    "price": 6.66,
                    "sequence": 0,
                    "enabled": "Y"
                },
                {
                    "name": "掌声",
                    "img": "//s1.videocc.net/default-img/donate/handclap.png",
                    "price": 88.99,
                    "sequence": 0,
                    "enabled": "Y"
                },
                {
                    "name": "点赞",
                    "img": "//s1.videocc.net/default-img/donate/like.png",
                    "price": 1.99,
                    "sequence": 0,
                    "enabled": "Y"
                },
                {
                    "name": "小星星",
                    "img": "//s1.videocc.net/default-img/donate/star.png",
                    "price": 9.99,
                    "sequence": 0,
                    "enabled": "N"
                },
                {
                    "name": "钻石",
                    "img": "//s1.videocc.net/default-img/donate/diamond.png",
                    "price": 19.99,
                    "sequence": 0,
                    "enabled": "N"
                },
                {
                    "name": "跑车",
                    "img": "//s1.videocc.net/default-img/donate/car.png",
                    "price": 29.99,
                    "sequence": 0,
                    "enabled": "N"
                },
                {
                    "name": "火箭",
                    "img": "//s1.videocc.net/default-img/donate/rocket.png",
                    "price": 66.66,
                    "sequence": 0,
                    "enabled": "N"
                }
            ],
            "pointPays": [
                {
                    "name": "咖啡",
                    "img": "//s1.videocc.net/default-img/donate/coffee.png",
                    "price": 5,
                    "sequence": 1,
                    "enabled": "Y"
                },
                {
                    "name": "鲜花",
                    "img": "//s1.videocc.net/default-img/donate/flower.png",
                    "price": 0,
                    "sequence": 2,
                    "enabled": "Y"
                },
                {
                    "name": "点赞",
                    "img": "//s1.videocc.net/default-img/donate/like.png",
                    "price": 10,
                    "sequence": 3,
                    "enabled": "Y"
                },
                {
                    "name": "掌声",
                    "img": "//s1.videocc.net/default-img/donate/handclap.png",
                    "price": 15,
                    "sequence": 4,
                    "enabled": "Y"
                },
                {
                    "name": "666",
                    "img": "//s1.videocc.net/default-img/donate/666.png",
                    "price": 20,
                    "sequence": 5,
                    "enabled": "Y"
                },
                {
                    "name": "小星星",
                    "img": "//s1.videocc.net/default-img/donate/star.png",
                    "price": 25,
                    "sequence": 6,
                    "enabled": "Y"
                },
                {
                    "name": "钻石",
                    "img": "//s1.videocc.net/default-img/donate/diamond.png",
                    "price": 30,
                    "sequence": 7,
                    "enabled": "Y"
                },
                {
                    "name": "烟火",
                    "img": "//s1.videocc.net/default-img/donate/fireworks.png",
                    "price": 35,
                    "sequence": 8,
                    "enabled": "Y"
                },
                {
                    "name": "金蛋",
                    "img": "//s1.videocc.net/default-img/donate/golden-egg.png",
                    "price": 40,
                    "sequence": 9,
                    "enabled": "Y"
                },
                {
                    "name": "奖杯",
                    "img": "//s1.videocc.net/default-img/donate/cup.png",
                    "price": 45,
                    "sequence": 10,
                    "enabled": "Y"
                },
                {
                    "name": "跑车",
                    "img": "//s1.videocc.net/default-img/donate/car.png",
                    "price": 50,
                    "sequence": 11,
                    "enabled": "Y"
                },
                {
                    "name": "皇冠",
                    "img": "//s1.videocc.net/default-img/donate/crown.png",
                    "price": 60,
                    "sequence": 12,
                    "enabled": "Y"
                },
                {
                    "name": "别墅",
                    "img": "//s1.videocc.net/default-img/donate/house.png",
                    "price": 65,
                    "sequence": 13,
                    "enabled": "Y"
                },
                {
                    "name": "游艇",
                    "img": "//s1.videocc.net/default-img/donate/yacht.png",
                    "price": 70,
                    "sequence": 14,
                    "enabled": "Y"
                },
                {
                    "name": "飞机",
                    "img": "//s1.videocc.net/default-img/donate/plane.png",
                    "price": 88,
                    "sequence": 15,
                    "enabled": "Y"
                },
                {
                    "name": "火箭",
                    "img": "//s1.videocc.net/default-img/donate/rocket.png",
                    "price": 100,
                    "sequence": 16,
                    "enabled": "Y"
                }
            ]
        }
    },
    "success": true
}

異常範例

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