修改全局频道设置

更新时间：2024-11-25 16:50:39

接口描述

1、修改全局频道设置
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/user/global-setting/switch/update

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】

请求体参数描述

参数名	必选	类型	说明
channelConcurrencesEnabled	false	String	最高同时在线人数修改开关 Y：开启 N：关闭
timelyConvertEnabled	false	String	自动转存开关 Y：开启 N：关闭
donateEnabled	false	String	打赏开关 Y：开启 N：关闭
rebirthAutoUploadEnabled	false	String	重制课件自动转存开关 Y：开启 N：关闭
rebirthAutoConvertEnabled	false	String	重制课件自动重制开关 Y：开启 N：关闭
pptCoveredEnabled	false	String	重制课件PPT铺满开关 Y：开启 N：关闭
coverImgType	false	String	播放器封面设置 contain：等比例缩放 cover：拉伸
testModeButtonEnabled	false	String	测试模式显示开关 Y：开启 N：关闭

示例

http://api.polyv.net/live/v4/user/global-setting/switch/update?appId=frlr1zazn3&sign=180298E3290BFC58F966376CA00C00E5&timestamp=1657851131670

请求体参数：

{
    "channelConcurrencesEnabled": "N",
    "coverImgType": "contain",
    "timelyConvertEnabled": "N"
}

响应参数描述

参数名	类型	说明
code	Integer	状态码，与 http 状态码相同，用于确定基本的响应状态
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	是否成功响应
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error	Object	状态码非200时的错误信息【详见Error字段描述】
data	String	成功返回null

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

Java请求示例

快速接入基础代码请下载相关依赖源码，点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(UserTest.class);
/**
 * 修改全局开关设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void updateGlobalSwitchTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/user/global-setting/switch/update";
    String channelConcurrencesEnabled = "N";
    String timelyConvertEnabled = "N";
    String coverImgType = "contain";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("channelConcurrencesEnabled", channelConcurrencesEnabled);
    jsonMap.put("timelyConvertEnabled", timelyConvertEnabled);
    jsonMap.put("coverImgType", coverImgType);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试修改全局开关设置成功：{}", response);
    //do somethings
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "343700d174f24698a0f2292034b037c7.62.16578511349466765",
    "data": null,
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

直播服务端 API