获取飞书子账号信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取飞书子账号信息

最近更新时间：2024.09.19 11:34:08首次发布时间：2024.09.19 11:34:08

您可通过此接口获取用户类型为飞书成员的子账号信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetLarkSubAccountInfo`	接口名称。当前 API 的名称为 `GetLarkSubAccountInfo`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
UnionId	String	是	`on_xxxxxxxxxx`	飞书子账号。您可在企业直播控制台的账户中心 > 权限管理 > 用户管理页面，获取子账号。

返回参数

参数	类型	示例值	描述
Name	String	`小王`	飞书子账号昵称。
EmployeeNo	String	`123`	飞书子账号工号。说明仅在您已向企业直播技术支持申请获取工号后，该参数才有值。
Departments	Array of LarkDepartment	`-`	飞书子账号所属的部门信息。

LarkDepartment

参数	类型	示例值	描述
DepartmentId	String	`fghtr234`	部门 ID。
Name	String	`教研部门`	部门名称。
SubDepartment	Object of LarkDepartment	`-`	子部门信息。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetLarkSubAccountInfo&Version=2023-08-01&UnionId=on_xxxxxxxxxx

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetLarkSubAccountInfo",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1656067132
    },
    "Result": {
        "Name": "小王",
        "EmployeeNo": "123",
        "Departments": [
            {
                "DepartmentId": "fghtr234",
                "Name": "教研部门",
                "SubDepartment": {
                    "DepartmentId": "fghsd6534",
                    "Name": "语文"
                }
            }
        ]
    }
}

错误码

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