设置频道是否应用通用设置

更新时间：2022-09-02 18:08:07

接口描述

1、接口用于设置〔是否应用通用设置〕，包括的功能有打赏设置，广告设置，观看条件设置，跑马灯，功能开关，播放限制，观看页的皮肤设置
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/common/update-global-enabled

在线API调用

请求方式

POST

接口约束

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

请求参数描述

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

GlobalEnabledType参数描述

功能类型	说明
auth	观看条件设置
switch	功能开关设置
marquee	跑马灯设置
restrict	播放限制设置
donate	打赏设置
advert	广告设置
callback	回调设置
player	播放器设置
watchtheme	观看页的皮肤设置

示例

http://api.polyv.net/live/v3/channel/common/update-global-enabled

表单参数：

globalEnabledType=auth&appId=frlr1zazn3&sign=79CA5DE1DF40A6E3232C46BF5BC6F180&channelId=1965681&enabled=N&timestamp=1621842159779

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	String	请求成功时，返回值是true，请求失败时，返回值是空

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(WebSettingTest.class);
/**
 * 设置频道是否应用通用设置
 * @throws IOException
 */
@Test
public void testUpdateGlobalEnabled() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/common/update-global-enabled";
    String channelId = "1965681";
    String globalEnabledType = "auth";
    String enabled  = "Y";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("globalEnabledType",globalEnabledType);
    requestMap.put("enabled",enabled);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试设置频道是否应用通用设置：{}",response);
    //do somethings

}

响应示例

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

成功示例

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

异常示例

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

直播服务端 API