Set Whether the Channel Applies Global Settings

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

API Description

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

API URL

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

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details: Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	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. All APIs must be called from the customer's own server to relay requests to the POLYV server for response data.` See details: Signature Generation Rules
channelId	true	String	Channel ID
globalEnabledType	true	String	Feature type See details: GlobalEnabledType Parameter Description
enabled	true	String	Feature switch, Y or N Y: Apply global settings N: Do not apply global settings

GlobalEnabledType Parameter Description

Feature Type	Description
auth	Viewing condition settings
switch	Feature switch settings
marquee	Marquee settings
restrict	Playback restriction settings
donate	Donation settings
advert	Ad settings
callback	Callback settings
player	Player settings
watchtheme	Watch page theme settings

Example

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

Form parameters:

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See details: Global Error Description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	String	Returns true on success, empty on failure

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

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

}

Response Example

For global error descriptions, see Global Error Description

Success Example

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

Error Example

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

Live Streaming Server API