调用 CreateSubAccount 接口创建子账号，从而实现子账号的权限管理和资源隔离。
注意事项
请求频率：单用户请求频率限制为 10 次/秒。
请求说明
- 请求方式：POST
- 请求地址：https://livesaas.volcengineapi.com/?Action=CreateSubAccount&Version=2023-08-01
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateSubAccount | 接口名称。当前 API 的名称为 CreateSubAccount。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Type | Integer | 是 |
| 子账号的类型。取值如下：
|
Name | String | 是 |
| 子账号的账号，是子账号的唯一标识。长度为 1 到 64 个字符。支持以下字符：
说明 仅手机号支持加号（+）。 参数值根据
|
NickName | String | 是 |
| 子账号的昵称。长度为 1 到 16 个字符。支持以下字符：
说明 当 |
| OrganizationId | Long | 否 | 184****1234 | 子账号所属组织的 ID。默认子账号不属于任何组织。您可通过调用 ListSubAccountOrganizations 接口获取 ID。 |
RoleIds | Array of Long | 否 |
| 子账号所属角色的 ID。不传该参数，则默认设置为默认子账号角色。您可通过调用 ListSubAccountRoles 接口获取 ID。 说明 每个子账号最多可被赋予 100 个角色。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Status | Boolean | true | 子账号是否创建成功。成功返回 true。 |
| VolcLiveLarkUserUnionId | String | on_22222222222222222 | 当 Type 取值为 3 时，企业直播会将您传入的 Name（飞书用户的 union_id）转换为企业直播侧该飞书用户的 union_id 进行记录存储，并返回该值供您后续使用。 |
请求示例
POST https://livesaas.volcengineapi.com/?Action=CreateSubAccount&Version=2023-08-01 { "NickName": "小明", "Name": "on_1111111111111111", "Type": 3 }
返回示例
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "CreateSubAccount", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "Status": true, "VolcLiveLarkUserUnionId": "on_22222222222222222" } }
错误码
下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 403 | OperationDenied.ReachLimit | Operation is denied because the number of sub accounts has reached the maximum limit. | 子账号数量已达上限。可通过调用 DeleteSubAccount 接口删除部分子账号后重试。 |
403 | OperationDenied.LarkBotNotPermitted | Operation is denied because lark bot does not have access to the user. | 创建飞书成员类型的子账号时，火山引擎企业直播飞书应用无该飞书用户的通讯录权限。
|
