取得跑馬燈設定介面
更新時間:2022-09-02 18:08:07
介面URL
http://api.polyv.net/live/v3/channel/marquee/get
介面說明
1、接口用于获取频道或全局的跑马灯设置信息
2、接口支持https
3、不提交channelId 表示获取全局设置
4、提交channelId 且getActual="N" 表示获取频道本身的设置,不提交getActual 或者提交getActual = "Y" 表示获取频道实际生效的跑马灯设置
支援格式
JSON
請求方式
GET
請求參數
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | 是 | string | 管理員的appId |
| timestamp | 是 | long | 13位當前時間戳 |
| sign | 是 | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在客戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| userId | 是 | string | 使用者id |
| channelId | 否 | int | 頻道id,查詢全域設定值不用傳該值 |
| getActual | 否 | string(取值Y/N) | 僅在查詢頻道跑馬燈設定時生效,Y:取得頻道實際生效跑馬設定,N:取得頻道的跑馬燈設定 |
回應成功JSON範例:
{
"code": 200,
"status": "success",
"message": "",
"data": {
"globalSettingEnabled": null,
"marqueeRestrict": "N",
"marqueeType": "nickname",
"marquee": "",
"marqueeOpacity": 100,
"marqueeFontSize": 30,
"marqueeFontColor": "#000000",
"marqueeAutoZoomEnabled": "N"
}
}
回應失敗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.globalSettingEnabled | 頻道跑馬燈的全域設定開關,查詢全域設定時此欄位為null |
| data.marqueeRestrict | 跑馬燈開關,取值Y(開),N(關) |
| data.marqueeType | 跑馬燈類型,取值:fixed(固定值)、nickname(觀眾名稱)、diyurl(自訂url) |
| data.marquee | marqueeType=fixed 時,此欄位為跑馬燈內容,marqueeType=nickname 為空, marqueeType=diyurl 為使用者的url |
| data.marqueeOpacity | 跑馬燈不透明度,範圍是 0 ~ 100 |
| data.marqueeFontSize | 跑馬燈字體大小 |
| data.marqueeFontColor | 跑馬燈字體顏色,例如 #ffffff |
| data.marqueeAutoZoomEnabled | 是否開啟跑馬燈自適應縮放,值為 Y 或 N |
