Delete Sub-account

Updated: 2022-12-09 10:19:57

API Description

1、通过子账号登录邮箱删除子账号
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/user/children/delete

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
The account must have the sub-account feature enabled.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details in 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 not be stored 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 details in Signature Generation Rules
childEmail	true	String	Sub-account email

Example

http://api.polyv.net/live/v4/user/children/delete?childEmail=lisi%40qq.com&appId=frlr1zazn3&sign=E49EF082DDF34F157B75E5B8CAC47EE5&timestamp=1670550289513

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: success returns "success", failure returns "error"
success	Boolean	Response result, determined by business logic: success returns true, failure returns false
data	Boolean	Returns true on success
error	Object	Error information when status code is non-200 See details in Error Field Description
requestId	String	Request ID, a unique UUID generated for each request, used only for debugging and troubleshooting, not for business logic

Error Parameter Description

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

Java Request Example

For quick integration of the 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, both contained 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 pools.

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 删除子账号
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void deleteUserChildrenTest() 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/user/children/delete";
    String childEmail = "lisi@qq.com";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("childEmail", childEmail);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    url = MapUtil.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": "78de516b69364aeabe7d080e7228cc5c.80.16704904879100865",
    "data": true,
    "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