取得帳號積分打賞設定

更新時間：2022-09-02 18:08:07

介面URL

http://api.polyv.net/live/v3/channel/donate/get-point-setting

介面說明

1、取得帳號通用設定的積分打賞設定，若提交channelId，介面同時回傳頻道的積分打賞開關設定
2、頻道的積分打賞開關生效的前提為通用設定的積分打賞也同時為開
3、支援https

支援格式

JSON

請求方式

GET

請求參數

參數名	必選	類型	說明
appId	是	string	帳號應用下的appId
timestamp	是	string	目前時間的毫秒級時間戳（13位）
sign	是	String	簽名，為32位大寫的MD5值，`生成簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名生成規則】
channelId	否	int	是否需要查詢頻道的設定

操作成功回應範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "userId": "edvf2fpec9",
        "donatePointEnabled": "N",
        "channelDonatePointEnabled": null,
        "queryPointUrl": null,
        "updatePointUrl": null,
        "requestFailTips": "积分异常，请稍后重试",
        "pointNotEnoughTips": "积分不足，无法打赏",
        "pointUnit": "点",
        "goods": [
            {
                "goodName": "鲜花",
                "goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/01-flower.png",
                "goodPrice": 0.00,
                "goodEnabled": "Y"
            },
            {
                "goodName": "咖啡",
                "goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/02-coffee.png",
                "goodPrice": 5.00,
                "goodEnabled": "Y"
            },
            {
                "goodName": "点赞",
                "goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/03-good.png",
                "goodPrice": 10.00,
                "goodEnabled": "Y"
            },
            {
                "goodName": "掌声",
                "goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/04-applaud.png",
                "goodPrice": 15.00,
                "goodEnabled": "Y"
            },
            {
                "goodName": "666",
                "goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/05-666.png",
                "goodPrice": 20.00,
                "goodEnabled": "Y"
            },
            {
                "goodName": "小星星",
                "goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/06-star.png",
                "goodPrice": 25.00,
                "goodEnabled": "Y"
            },
            {
                "goodName": "钻石",
                "goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/07-diamond.png",
                "goodPrice": 30.00,
                "goodEnabled": "Y"
            },
            {
                "goodName": "跑车",
                "goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/08-car.png",
                "goodPrice": 50.00,
                "goodEnabled": "Y"
            },
            {
                "goodName": "火箭",
                "goodImg": "//livestatic.videocc.net/uploaded/images/webapp/channel/donate/09-rocket.png",
                "goodPrice": 100.00,
                "goodEnabled": "Y"
            }
        ]
    }
}

操作失敗回應範例

簽名錯誤

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

回應欄位說明

名稱	類型	說明
code	string	回應代碼，成功為200，失敗為400，簽名錯誤為403，異常錯誤500
status	string	成功為success，失敗為error
message	string	錯誤時為錯誤提示訊息
data	object	成功回應資料
donatePointEnabled	string	積分打賞設定開關，取值Y/N
channelDonatePointEnabled	string	頻道的積分打賞設定開關，取值Y/N/null，僅當donatePointEnabled=Y 和channelDonatePointEnabled = Y 時表示頻道啟用積分打賞設定
queryPointUrl	string	取得觀眾積分介面
updatePointUrl	string	更新觀眾積分介面
requestFailTips	string	介面請求失敗錯誤提示
pointNotEnoughTips	string	打賞積分不足提示
pointUnit	string	積分的單位
goods	object[]	積分打賞道具列表
goods[].goodName	string	道具名稱
goods[].goodImg	string	道具圖片
goods[].goodPrice	float	道具價格
goods[].goodEnabled	string	道具的開關，取值Y/N

php請求範例

<?php
//引用config.php
include 'config.php';

$params = array(
    'appId' => $appId,
    'timestamp' => $timestamp
);

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;

//接口请求url
$url = "`https://api.polyv.net/live/v3/channel/donate/get-point-setting?appId=".$appId."&sign=".$sign."&timestamp=".$timestamp;
//输出接口请求结果
echo file_get_contents($url);
?>