Modify Anchor Status

Updated: 2024-11-18 17:57:00

API Description

1、修改直播状态
2、接口支持https协议

API URL

https://api.polyv.net/live/v4/channel/anchor/update-status

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 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. It must never be stored 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

Request Body Parameter Description

Parameter	Required	Type	Description
anchorId	true	Long	Anchor ID
status	true	Integer	Status: 0-Disabled, 1-Enabled \| Cannot be disabled if associated with a channel or default template

Example

https://api.polyv.net/live/v4/channel/anchor/update-status?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

Request body JSON parameters:

{
    "anchorId":1,
    "status": 1
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure
status	String	Response result, determined by business logic, returns success on success, error on failure
success	Boolean	Response result, determined by business logic, returns true on success, false on failure
data	Object	Tag data [See Data Field Description](#Data Parameter Description)
error	Object	Error information when status code is non-200 See Error Field Description
requestId	String	Request ID, a unique UUID generated for each request, used only for troubleshooting and debugging, should not be tied to business logic

Data Parameter Description

Parameter	Type	Description

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error cause
desc	String	Error description, corresponds to error.code

Java Request Example

For quick integration of the base code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source code project. The HttpUtil.java and LiveSignUtil.java in the test cases are included in the download file.

It is strongly recommended to use the Live Java SDK to complete 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 updateChannelAnchorStatusTest() 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/channel/anchor/update-status";
    Long anchorId = 1L;
    Integer status = 1;
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("anchorId", anchorId);
    jsonMap.put("status", status);
    
    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 global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "78de516b69364aeabe7d080e7228cc5c.77.16705507903976231",
    "success": true,
}

Error Example

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

Live Streaming Server API