保利威文档中心

幫助中心

修改跑馬燈設定

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

介面URL

http://api.polyv.net/live/v3/channel/marquee/update

介面說明

1、接口用于修改频道或全局的跑马灯设置信息
2、接口支持https
3、不提交channelId 表示修改全局设置
4、提交channelId 表示修改频道的跑马灯设置

支援格式

JSON

請求方式

POST

請求參數

參數名 必選 類型 說明
appId string 管理員的appId
timestamp long 13位當前時間戳
sign String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
userId string 用戶id
channelId int 頻道id,修改全域設定時不用傳該值
marqueeRestrict string 跑馬燈開關,取值Y(開),N(關)
marqueeType string 跑馬燈類型,取值:fixed(固定值)、nickname(觀眾名稱)、diyurl(自訂url)
marquee string marqueeType為固定值或者自訂url 時,此欄位不能為空,marqueeType=nickname 此欄位為空
marqueeOpacity int 跑馬燈不透明度,範圍是 0 ~ 100
marqueeFontSize int 跑馬燈字型大小
marqueeFontColor string 跑馬燈字型顏色,例如 #ffffff
marqueeAutoZoomEnabled string 是否開啟跑馬燈自適應縮放,值為 Y 或 N

回應成功JSON範例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": ""
}

回應失敗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": ""
}

用戶ID錯誤

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

簽名錯誤

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

欄位說明

參數名 說明
code 回應代碼,成功為200,失敗為400,簽名錯誤為403,異常錯誤500
status 成功為success,失敗為error
message 錯誤時為錯誤提示訊息
data 暫無作用
联系客服,在线咨询