You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/子账号/查询子账号
查询子账号
最近更新时间：2024.11.27 10:47:15首次发布时间：2024.11.27 10:47:15
我的收藏

调用 GetSubAccount 接口，根据账号查询子账号。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetSubAccount接口名称。当前 API 的名称为 GetSubAccount。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。
NameString是on_2222222222222子账号的账号，是子账号的唯一标识。您可通过调用 ListSubAccounts 接口获取账号。

返回参数

参数类型示例值描述

Type

Integer

3

子账号的类型。取值如下：

  • 1：邮箱
  • 2：手机号
  • 3：飞书成员
  • 6：自定义

Name

String

on_222222222222

子账号的账号，是子账号的唯一标识。
参数值根据 Type 取值的不同而不同。

  • 当 Type 取值为 1 时，参数值为邮箱。
  • 当 Type 取值为 2 时，参数值为以 +86 开头的手机号。
  • 当 Type 取值为 3 时，参数值为企业直播侧的飞书用户 union_id。
  • 当 Type 取值为 6 时，参数值为火山引擎 IAM 用户的用户名。
NickNameString小明子账号的昵称。
OrganizationIdLong184****1234子账号所属组织的 ID。
OrganizationNameString组织 A子账号所属组织的名称。
RolesArray of Roles-子账号所属的角色列表。

Roles

参数类型示例值描述
IdLong188****1234角色 ID。
NameString默认子账号角色名称。

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=GetSubAccount&Version=2023-08-01&Name=on_2222222222222

返回示例

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

错误码

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