保利威文档中心

幫助中心

修改頻道禮物打賞設定

更新時間:2023-04-04 09:31:23

介面說明

1、修改频道礼物打赏设置,礼物打赏又分为现金支付和积分支付
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/donate/gift/update

線上API呼叫

請求方式

POST

介面限制

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

請求參數說明

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

請求體參數說明

參數名 必填 類型 說明
donateGiftEnabled true String 禮物打賞開關,Y:開啟,N:關閉
giftDonate false Object 禮物【詳見TemplateGiftDonate欄位說明

TemplateGiftDonate參數說明

參數名 必填 類型 說明
payWay false String 支付方式,CASH:現金支付,POINT:積分支付
pointUnit false String 積分單位
cashPays false Array 現金支付列表,陣列長度為1-18【詳見GiftDonate欄位說明
pointPays false Array 積分支付列表,陣列長度為1-16【詳見GiftDonate欄位說明

GiftDonate參數說明

參數名 必填 類型 說明
name false String 禮物名稱
enabled false String 開關,Y:開啟,N:關閉,預設為N
imgType false String 禮物類型 STATIC-靜態禮物 DYNAMIC-動態禮物,預設為靜態禮物
img false String 禮物圖片位址,禮物類型為STATIC時必填
dynamicImg false String 動效縮圖,PNG格式、圖片尺寸500 x 500p,禮物類型為DYNAMIC時必填
dynamicFile false String 動效檔案,檔案類型為SVGA格式,禮物類型為DYNAMIC時必填
price false Float 禮物價格,預設0.01

範例

http://api.polyv.net/live/v4/channel/donate/gift/update?appId=frlr1zazn3&sign=4B959FF84D977786673626B21F2E8EE3&channelId=2523307&timestamp=1631090638818

請求體json參數:

{
    "donateGiftEnabled": "Y",
    "giftDonate": {
        "cashPays": [
            {
                "img": "//s1.videocc.net/default-img/donate/666.png",
                "price": "666",
                "name": "现金礼物1",
                "enabled": "Y"
            }
        ],
        "pointUnit": "豆",
        "pointPays": [
            {
                "img": "//s1.videocc.net/default-img/donate/666.png",
                "price": "666",
                "name": "积分礼物1",
                "enabled": "Y"
            }
        ],
        "payWay": "CASH"
    }
}

回應參數說明

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

Error參數說明

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

Java請求範例

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

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

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

    @Test
    public void testUpdateDonate() 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/gift/update";
        
        //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));
        
        Map<String, Object> jsonMap = new HashMap<>();
        jsonMap.put("donateGiftEnabled","Y");
        Map<String, Object> giftDonateMap = new HashMap<>();
        giftDonateMap.put("payWay","CASH");
        giftDonateMap.put("pointUnit","豆");
        List<Map<String,Object>> cashPaysList = new ArrayList<>();
        Map<String,Object> cash1 = new HashMap<>();
        cash1.put("name","现金礼物1");
        cash1.put("img","//s1.videocc.net/default-img/donate/666.png");
        cash1.put("price","666");
        cash1.put("enabled","Y");
        cashPaysList.add(cash1);
        giftDonateMap.put("cashPays",cashPaysList);
        List<Map<String,Object>> pointPaysList = new ArrayList<>();
        Map<String,Object> point1 = new HashMap<>();
        point1.put("name","积分礼物1");
        point1.put("img","//s1.videocc.net/default-img/donate/666.png");
        point1.put("price","666");
        point1.put("enabled","Y");
        pointPaysList.add(point1);
        giftDonateMap.put("pointPays",pointPaysList);
        jsonMap.put("giftDonate",giftDonateMap);
        
        url = HttpUtil.appendUrl(url,requestMap);
        
        String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap),null);
        
        log.info("测试修改频道礼物打赏设置,返回值:{}", response);
    }

回應範例

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "dc7ae621ef8e4f4a8e4976833f1dbbd4.69.16309852981551185",
    "data": null,
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "4081dbac03e6441e8bdd301d8feee5a2.124.16360827277211321",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询