Modify Configuration Information

API Description

1、修改配置信息
2、接口支持https协议

API URL

https://api.polyv.net/live/v4/user/viewer-user-system/update-config

Online API Call

Request Method

POST

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls are subject to rate limits. See details

Request Parameter Description

Request Body Parameter Description

touristExternalHrefConfig Parameter Description

Example

https://api.polyv.net/live/v4/user/viewer-user-system/update-config?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

Request body JSON parameters:

{
    "mobileLoginEnabled": "Y",
    "wxWorkLoginEnabled": "N",
    "viewerWeixinAuthExpired": 30,
    "collectMobileEnabled": "Y",
    "guestModeEnabled": "Y",
    "touristExternalHrefEnabled": "Y",
    "touristExternalHrefConfig": {
        "mobileLink": "https://example.com/mobile",
        "pcLink": "https://example.com/pc",
        "jumpWay": "NEW_WINDOW"
    }
}

Response body JSON:

{
    "code": 200,
    "status": "success",
    "requestId": "97d9bc9c-c0d2-4639-acad-54b28335004c",
    "data": null,
    "success": true
}

Response Parameter Description

Error Parameter Description

Data Parameter Description

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 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 encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 修改配置信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void updateConfigTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    String url = "https://api.polyv.net/live/v4/user/viewer-user-system/update-config";
    //业务参数
    String mobileLoginEnabled = "Y";
    String wxWorkLoginEnabled = "N";
    Integer viewerWeixinAuthExpired = 30;
    String collectMobileEnabled = "Y";
    String guestModeEnabled = "Y";
    String touristExternalHrefEnabled = "Y";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("mobileLoginEnabled", mobileLoginEnabled);
    jsonMap.put("wxWorkLoginEnabled", wxWorkLoginEnabled);
    jsonMap.put("viewerWeixinAuthExpired", viewerWeixinAuthExpired);
    jsonMap.put("collectMobileEnabled", collectMobileEnabled);
    jsonMap.put("guestModeEnabled", guestModeEnabled);
    jsonMap.put("touristExternalHrefEnabled", touristExternalHrefEnabled);
    
    Map<String, Object> touristExternalHrefConfig = new HashMap<>();
    touristExternalHrefConfig.put("mobileLink", "https://example.com/mobile");
    touristExternalHrefConfig.put("pcLink", "https://example.com/pc");
    touristExternalHrefConfig.put("jumpWay", "NEW_WINDOW");
    jsonMap.put("touristExternalHrefConfig", touristExternalHrefConfig);
    
    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 error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "97d9bc9c-c0d2-4639-acad-54b28335004c",
    "data": null,
    "success": true
}

Error Example

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