获取子账号列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取子账号列表

最近更新时间：2024.11.27 10:47:15首次发布时间：2024.11.27 10:47:15

调用 ListSubAccounts 接口获取子账号列表，包含子账号的类型、账号、昵称、组织和角色等信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=ListSubAccounts&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListSubAccounts`	接口名称。当前 API 的名称为 `ListSubAccounts`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
PageNumber	Integer	否	`1`	分页查询页码。默认值为 `1`。取值大于等于 `1`。
PageSize	Integer	否	`10`	分页查询数量。默认值为 `10`。取值范围为 [1,100]。
KeyWord	String	否	`A`	子账号的昵称或账号。支持模糊搜索，大小写不敏感。例如，该参数取值为 `A`，则返回`账号 A`、`abc@example.com` 等昵称或账号的子账号。

返回参数

参数	类型	示例值	描述
TotalCount	Long	`1`	查询结果总数。
SubAccounts	Array of SubAccounts	`-`	子账号列表。

SubAccounts

参数	类型	示例值	描述
Type	Integer	`3`	子账号的类型。取值如下： `1`：邮箱 `2`：手机号 `3`：飞书成员 `6`：自定义
Name	String	`on_222222222222`	子账号的账号，是子账号的唯一标识。参数值根据 `Type` 取值的不同而不同。当 `Type` 取值为 `1` 时，参数值为邮箱。当 `Type` 取值为 `2` 时，参数值为以 +86 开头的手机号。当 `Type` 取值为 `3` 时，参数值为企业直播侧的飞书用户 `union_id`。当 `Type` 取值为 `6` 时，参数值为火山引擎 IAM 用户的用户名。
NickName	String	`账号 A`	子账号的昵称。
OrganizationId	Long	`184****1234`	子账号所属组织的 ID。
OrganizationName	String	`组织 A`	子账号所属组织的名称。
Roles	Array of Roles	`-`	子账号所属的角色列表。

Roles

参数类型示例值描述

Id Long 188****1234 角色 ID。

Name String 默认子账号 角色名称。

参数	类型	示例值	描述
Id	Long	`188****1234`	角色 ID。
Name	String	`默认子账号`	角色名称。
Type	Integer	`2`	角色类型。取值如下： `0`：UTC+8 2023-02-16 17:59:22 及之前创建的非超管和默认子账号的角色 `1`：超管 `2`：默认子账号 `3`：审核管理员 `4`：自定义角色 `5`：助理 `6`：数据 `7`：运营说明取值 `1`、`2`、`3`、`5`、`6`、`7` 为系统内置角色。

Type

Integer

2

角色类型。取值如下：

0：UTC+8 2023-02-16 17:59:22 及之前创建的非超管和默认子账号的角色
1：超管
2：默认子账号
3：审核管理员
4：自定义角色
5：助理
6：数据
7：运营

说明

取值 1、2、3、5、6、7 为系统内置角色。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListSubAccounts&Version=2023-08-01&PageNumber=1&PageSize=10&KeyWord=A

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListSubAccounts",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "TotalCount": 1,
        "SubAccounts": [
            {
                "Name": "on_222222222222",
                "NickName": "账号 A",
                "OrganizationId": 184****1234,
                "Type": 3,
                "Roles": [
                    {
                        "Id": 188****1234,
                        "Name": "默认子账号",
                        "Type": 2
                    }
                ],
                "OrganizationName": "组织 A"
            }
        ]
    }
}

错误码

访问公共错误码和错误码获取详细信息。