Modify Default Template - Viewing Conditions

API Description

1、修改默认模板-观看条件
2、（timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

API URL

http://api.polyv.net/live/v4/global/auth/update

Online API Call

Request Method

POST

API Constraints

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

2. The first element in the request body array is the primary viewing condition, and the second is the secondary viewing condition. Both must be provided.

Request Parameter Description

Request Body Parameter Description

InfoFields Parameter Description

Example

http://api.polyv.net/live/v4/global/auth/update?appId=frlr1zazn3&sign=E864B4E2758C70EC88851094F5041991&timestamp=1680502739391

Request body JSON parameters:

[
    {
        "customKey": "12121212",
        "authEnabled": "Y",
        "customUri": "http://baidu.com",
        "authType": "custom"
    },
    {
        "whiteListEntryText": "白名单入口文本",
        "privacyParam": "隐私声明数据",
        "authEnabled": "Y",
        "privacyParamEnabled": "Y",
        "authType": "phone",
        "authTips": "123"
    }
]

Response Parameter Description

Error Parameter Description

Java Request Example

For quick integration of the base 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 included in the download 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(getClass());
/**
 * 修改默认模板-观看条件
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void authUpdateTest() 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/global/auth/update";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    List<Map<String, Object>> authList = new ArrayList<>();
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("authType","custom");
    jsonMap.put("authEnabled","Y");
    jsonMap.put("customKey","12121212");
    jsonMap.put("authType","custom");
    jsonMap.put("customUri","http://baidu.com");
    authList.add(jsonMap);
    jsonMap = new HashMap<>();
    jsonMap.put("authType","phone");
    jsonMap.put("authEnabled","Y");
    jsonMap.put("whiteListEntryText","白名单入口文本");
    jsonMap.put("authTips","123");
    jsonMap.put("privacyParamEnabled","Y");
    jsonMap.put("privacyParam","隐私声明数据");
    authList.add(jsonMap);
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(authList), null);
    
    log.info("测试修改默认模板-观看条件成功：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
  "code": 200,
  "status": "success",
  "requestId": "66d3d82b356e457098bbe15a659a322f.6025.16805027480479129",
  "data": null,
  "success": true
}

Error Example

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