Modify Live Status Change Callback Settings

Updated: 2022-09-02 18:08:07

API Description

1、设置账号下频道直播状态改变通知回调地址的接口
3、接口URL中的{userId}为 直播账号ID
2、接口支持https协议

API URL

http://api.polyv.net/live/v2/user/{userId}/set-stream-callback

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls are subject to rate limits. See details
If the URL parameter is not submitted, the callback address will be empty, meaning the callback function is disabled. If the URL parameter is submitted, it must start with http:// or https://

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 for 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 and must never be saved 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
url	false	String	Callback URL. If not submitted, the callback function is disabled. If submitted, must start with http:// or https://

Example

http://api.polyv.net/live/v2/user/1b448be323/set-stream-callback

Form Parameters:

appId=frlr1zazn3&sign=277627ABC677A1D24172232E1C326358&callback=http%3A%2F%2Fwww.baidu.com&timestamp=1636447983489

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. See global error description
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides auxiliary error description
data	String	Returns an empty string for both success and failure

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. HttpUtil.java and LiveSignUtil.java from the test cases are included 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 pooling.

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
 * 修改直播状态回调
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testSetStreamCallback() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/live/v2/user/%s/set-stream-callback", userId);
    String callBack = "http://www.baidu.com";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("url", callBack);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改直播状态回调，返回值：{}", response);
    //do somethings

}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":"success"
}

Error Example

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

Live Streaming Server API