修改配置資訊

介面描述

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

介面URL

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

線上API呼叫

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

請求體參數描述

touristExternalHrefConfig參數描述

範例

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

請求體json參數：

{
    "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"
    }
}

回應體json:

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

回應參數描述

Error參數描述

Data參數描述

Java請求範例

快速接入基礎代碼請下載相關依賴原始碼， 點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

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
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

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

異常範例

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