修改直播倒计时设置
接口描述
1、接口用于修改频道的倒计时设置
2、接口URL中的{channelId}为频道号
3、接口支持https协议
接口URL
http://api.polyv.net/live/v2/channelSetting/{channelId}/set-countdown
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、预约功能开启需设置正确的直播时间才生效
请求参数描述
参数名
必选
类型
说明
timestamp
true
Long
当前13位毫秒级时间戳,3分钟内有效
sign
true
String
签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据
【详见签名生成规则】
bookingEnabled
false
String
预约观看开关,Y或N,默认不改变原来状态 Y:开启 N:关闭
startTime
false
String
直播开始时间,如果不传该值,表示不显示直播时间和倒计时,格式:yyyy-MM-dd HH:mm:ss
示例
http://api.polyv.net/live/v2/channelSetting/1958888/set-countdown
表单参数:
bookingEnabled=Y&appId=frlr1zazn3&sign=A4B3677AD1F0675FB792A50E3B20D7AB&startTime=2021-3-15+15%3A01%3A00×tamp=1621840695352
响应参数描述
参数名
类型
说明
status
String
响应状态文本信息
message
String
响应描述信息,当code为400或者500的时候,辅助描述错误原因
data
String
请求成功时为空,请求失败时为空
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(WebInfoTest.class);
/**
* 修改直播倒计时设置
* @throws IOException
*/
@Test
public void testSetCountdown() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId=super.appId;
String appSecret=super.appSecret;
String userId = super.userId;
String timestamp=String.valueOf(System.currentTimeMillis());
//业务参数
String url = String.format("http://api.polyv.net/live/v2/channelSetting/%s/set-countdown", "1958888");
String bookingEnabled = "Y";
String startTime = "2021-3-15 15:01:00";
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("bookingEnabled",bookingEnabled);
requestMap.put("startTime",startTime);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.postFormBody(url,requestMap);
log.info("测试修改直播倒计时设置:{}",response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code":200,
"status":"success",
"message":"",
"data":""
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
Last updated
Was this helpful?