Modify Marquee Settings

Updated: 2022-09-02 18:08:07

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

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

JSON

POST

Parameter Name	Required	Type	Description
appId	Yes	string	Admin's appId
timestamp	Yes	long	13-digit current timestamp
sign	Yes	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
userId	Yes	string	User ID
channelId	No	int	Channel ID. Do not pass this value when modifying global settings.
marqueeRestrict	Yes	string	Marquee toggle. Values: Y (on), N (off)
marqueeType	Yes	string	Marquee type. Values: fixed (fixed value), nickname (viewer name), diyurl (custom URL)
marquee	No	string	When marqueeType is fixed or diyurl, this field cannot be empty. When marqueeType is nickname, this field is empty.
marqueeOpacity	Yes	int	Marquee opacity, range 0 ~ 100
marqueeFontSize	No	int	Marquee font size
marqueeFontColor	Yes	string	Marquee font color, e.g., #ffffff
marqueeAutoZoomEnabled	No	string	Whether to enable marquee auto-scaling. Values: Y or N

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

No appId entered

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

Incorrect appId

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

Timestamp error

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

User ID error

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

Signature error

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

Parameter Name	Description
code	Response code. 200 for success, 400 for failure, 403 for signature error, 500 for exception error
status	success for success, error for failure
message	Error prompt message when an error occurs
data	Currently has no function

POLYV Help Center