修改跑马灯设置

接口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

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

暂无作用

Last updated

Was this helpful?