保利威文档中心

幫助中心

取得頻道設定(頻道圖示、引導圖)

更新時間:2022-05-23 17:54:01

介面URL

https://api.polyv.net/live/v3/channel/setting/get

介面說明

1、接口用于获取频道设置
2、接口支持https

支援格式

JSON

請求方式

GET

請求次數限制

TRUE

請求參數

參數名 必填 類型 說明
appId string 管理員的appId
timestamp long 13位當前時間戳
sign string 簽名值
channelId string 頻道ID

響應成功JSON範例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "channelId": 10001,
        "coverImg": "http://www.polyv.net/1.png",
        "splashImg": "http://www.polyv.net/2.png",
        "splashEnabled": "Y"
    }
}

響應失敗JSON範例:

未輸入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正確

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

時間戳錯誤

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

簽名錯誤

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

欄位說明

參數名 說明
code 響應代碼,成功為200,失敗為400,簽名錯誤為401,異常錯誤500
status 成功為success,失敗為error
message 錯誤時為錯誤提示訊息
data 成功響應時為相關資訊
data.channelId 頻道ID
data.coverImg 頻道圖示
data.splashImg 頻道引導圖
data.splashEnabled 引導圖開關('Y' 或 'N')
联系客服,在线咨询