Add Sub-account

API Description

1、新增子账号
2、（timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

API URL

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

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 account must have the sub-account feature enabled.

Request Parameter Description

Request Body Parameter Description

Example

https://api.polyv.net/live/v4/user/children/create?appId=frlr1zazn3&timestamp=1670488960000&sign=A737C1816DF14B364D98670679CC8A11

Request body JSON parameters:

{
    "childEmail": "lisi@qq.com",
    "password": "6hqnXCjJ46rujnMC",
    "childName": "李四",
    "description":"负责测试组人员的技能和业务培训，提升团队的测试能力",
    "roleId": 1310,
    "telephone": 12300000000,
    "organizationId":2679
}

Response Parameter Description

Error Parameter Description

data Parameter Description

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click to download source code. After downloading, add it to your own source 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 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 final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 新增子账号
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void createUserChildrenTest() 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/create";
    String childEmail = "lisi@qq.com";
    String childName = "李四";
    String password = "6hqnXCjJ46rujnMC";
    String roleId = "1310";
    String organizationId = "2679";
    String telephone = "12300000000";
    String description = "负责测试组人员的技能和业务培训，提升团队的测试能力";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("childEmail", childEmail);
    jsonMap.put("childName", childName);
    jsonMap.put("password", password);
    jsonMap.put("roleId", roleId);
    jsonMap.put("organizationId", organizationId);
    jsonMap.put("telephone", telephone);
    jsonMap.put("description", description);
    
    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

See Global Error Description for system-wide error explanations.

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "78de516b69364aeabe7d080e7228cc5c.83.16704899516650761",
    "data": {
        "childUserId": "895522b7862a",
        "childName": "李四",
        "childEmail": "lisi@qq.com",
        "description": "负责测试组人员的技能和业务培训，提升团队的测试能力",
        "telephone": "17600001234",
        "status": "NORMAL",
        "organizationId": 12300000000,
        "organizationName": "测试部门",
        "roleId": 1310,
        "roleName": "直播测试员",
        "createdTime": 1670489951730
    },
    "success": true
}

Error Example

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