修改跑马灯设置
接口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
暂无作用
Last updated
Was this helpful?