> For the complete documentation index, see [llms.txt](https://polyv.gitbook.io/document/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://polyv.gitbook.io/document/docs/live/api/v-4/user/children/create.md).

# 新增子账号

### 接口描述

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

### 接口URL

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

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v4/user/children/create/README.md)

### 请求方式

```
POST
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

2、账号需要开通子账号功能

### 请求参数描述

| 参数名       | 必选   | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp | true | Long   | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign      | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |

### 请求体参数描述

| 参数名            | 必选    | 类型      | 说明                                                                                                                                              |
| -------------- | ----- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| childEmail     | true  | String  | 子账号登录邮箱                                                                                                                                         |
| childName      | true  | String  | 子账号用户名称，最大长度50个字符                                                                                                                               |
| password       | true  | String  | 子账号密码，长度8\~16位必须包含数字与字母                                                                                                                         |
| roleId         | true  | Integer | 角色ID【可通过[查询角色列表](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/v4/user/children/role/list/README.md)获取】              |
| organizationId | false | Integer | 组织ID，不传分配默认组织：总部【可通过[查询组织架构列表](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/v4/user/organization/list/README.md)获取】 |
| telephone      | false | String  | 手机号码                                                                                                                                            |
| description    | false | String  | 备注信息，最大长度100个字符                                                                                                                                 |

### 示例

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

请求体json参数：

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

### 响应参数描述

| 参数名       | 类型      | 说明                                       |
| --------- | ------- | ---------------------------------------- |
| code      | Integer | 响应状态码，200为成功返回，非200为失败                   |
| status    | String  | 响应结果，由业务决定，成功返回success，失败返回error         |
| success   | Boolean | 响应结果，由业务决定，成功返回true，失败返回false            |
| data      | Object  | 子账号信息【详见[data字段说明](#data参数描述)】           |
| error     | Object  | 状态码非200时的错误信息【详见[Error字段说明](#error参数描述)】 |
| requestId | String  | 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩 |

### Error参数描述

| 参数名  | 类型      | 说明                   |
| ---- | ------- | -------------------- |
| code | Integer | 错误代码，用于确定具体的错误原因     |
| desc | String  | 错误描述，与 error.code 对应 |

#### data参数描述

| 参数名              | 类型      | 说明                                               |
| ---------------- | ------- | ------------------------------------------------ |
| childUserId      | String  | 子账号用户Id                                          |
| childName        | String  | 子账号用户名                                           |
| childEmail       | String  | 子账号邮箱                                            |
| description      | String  | 描述                                               |
| telephone        | String  | 手机号码                                             |
| status           | String  | <p>状态<br>NORMAL：正常<br>FROZEN：冻结<br>DELETE：删除</p> |
| organizationId   | Integer | 所属用户组织架构ID                                       |
| organizationName | String  | 所属用户组织架构名称                                       |
| roleId           | Integer | 所属角色ID                                           |
| roleName         | String  | 所属角色名称                                           |
| createdTime      | Long    | 创建时间，13位毫秒级时间戳                                   |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
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
    
}
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

```json
{
    "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
}
```

异常示例

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