Query Global Channel Settings

Updated: 2022-09-20 18:07:26

API Description

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

API URL

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

Online API Call

Request Method

GET

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 details on obtaining keys
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 side. 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

Example

http://api.polyv.net/live/v4/user/global-setting/switch/get?appId=frlr1zazn3&sign=FE20403723E1AB1EC15DE30B70BE636D&timestamp=1657849513402

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by the business. 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 used for troubleshooting and debugging, not related to business logic
error	Object	Error information when status code is not 200 See Error field description
data	Object	See data field description

Error Parameter Description

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

data Parameter Description

Parameter	Type	Description
channelConcurrencesEnabled	String	Maximum concurrent online users modification switch Y: Enabled N: Disabled
timelyConvertEnabled	String	Auto-transfer switch Y: Enabled N: Disabled
donateEnabled	String	Donation switch Y: Enabled N: Disabled
rebirthAutoUploadEnabled	String	Remade courseware auto-upload switch Y: Enabled N: Disabled
rebirthAutoConvertEnabled	String	Remade courseware auto-remake switch Y: Enabled N: Disabled
pptCoveredEnabled	String	Remade courseware PPT fill switch Y: Enabled N: Disabled
coverImgType	String	Player cover image setting contain: Scale proportionally cover: Stretch

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, both contained in the downloaded file.

It is strongly recommended to use the Live Java SDK for API 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 queryGlobalSwitchTest() 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/get";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    
    log.info("测试查询全局开关设置成功：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "8acd0194a7b6459a8ab168fcf2b63153.66.16578495207221919",
    "data": {
        "channelConcurrencesEnabled": "Y",
        "timelyConvertEnabled": "N",
        "donateEnabled": "Y",
        "rebirthAutoUploadEnabled": "N",
        "rebirthAutoConvertEnabled": "N",
        "pptCoveredEnabled": "Y",
        "coverImgType": "cover"
    },
    "success": true
}

Error Example

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