Modify Callback Settings

Updated: 2022-12-02 10:02:53

API Description

1、修改用户回调设置
2、接口支持https协议

API URL

http://api.polyv.net/vod/v4/user/setting/callback/update

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls are subject to rate 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 never be stored or used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See Signature Generation Rules
callbackUrl	false	String	Callback URL. Leave empty to clear the setting.

Example

https://api.polyv.net/vod/v4/user/setting/callback/update?appId=frlr1zazn3&timestamp=1669907862000&sign=5CD43758EAAFF589DB5FFB071E1CCF29&callbackUrl=https://my.polyv.net/

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 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	Boolean	Returns true on successful request, returns empty on failed request

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error
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 integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 更新回调设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void updateCallbackSettingTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/vod/v4/user/setting/callback/update";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("callbackUrl", "https://my.polyv.net/testcallback");
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    url = HttpUtil.appendUrl(url, requestMap);
    
    String response = HttpUtil.postFormBody(url, null);
    log.info("测试更新回调设置：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "5399ad2d29ab48c88165d8ffa4f0b4a4.66.16699078252180075",
    "data": true,
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "error": {
        "code": 10003,
        "desc": "时间戳过期"
    },
    "success": false
}

VOD Server API