Modify Global Channel Settings

Updated: 2024-11-25 16:50:39

API Description

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

API URL

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

Online API Call

Request Method

POST

API Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 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 through the customer's own server to relay requests to the POLYV server for response data.` [See Signature Generation Rules]

Request Body Parameter Description

Parameter	Required	Type	Description
channelConcurrencesEnabled	false	String	Maximum concurrent online users toggle Y: Enable N: Disable
timelyConvertEnabled	false	String	Auto-transfer toggle Y: Enable N: Disable
donateEnabled	false	String	Donation toggle Y: Enable N: Disable
rebirthAutoUploadEnabled	false	String	Remastered courseware auto-upload toggle Y: Enable N: Disable
rebirthAutoConvertEnabled	false	String	Remastered courseware auto-remaster toggle Y: Enable N: Disable
pptCoveredEnabled	false	String	Remastered courseware PPT full-screen toggle Y: Enable N: Disable
coverImgType	false	String	Player cover image setting contain: Scale proportionally cover: Stretch
testModeButtonEnabled	false	String	Test mode display toggle Y: Enable N: Disable

Example

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

Request Body Parameters:

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine basic response status
status	String	Response result, determined by business logic. Returns success on success, error on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only for troubleshooting and debugging, not for business logic
error	Object	Error information when status code is not 200 [See Error Field Description]
data	String	Returns null on success

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error cause
desc	String	Error description, corresponding to error.code

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code 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 functionality integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
    
}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

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

Error Example

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