查询企业员工列表

1. 接口描述

接口请求域名： ess.tencentcloudapi.com 。

查询企业员工列表，每次返回的数据量最大为20

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeIntegrationEmployees。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，本接口不需要传递此参数。
Operator	是	UserInfo	操作人信息，userId必填
Limit	是	Integer	返回最大数量，最大为20
Agent	否	Agent	代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
Filters.N	否	Array of Filter	查询过滤实名用户，Key为Status，Values为["IsVerified"] 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
Offset	否	Integer	偏移量，默认为0，最大为20000

3. 输出参数

参数名称	类型	描述
Employees	Array of Staff	员工数据列表注意：此字段可能返回 null，表示取不到有效值。
Offset	Integer	偏移量，默认为0，最大为20000 注意：此字段可能返回 null，表示取不到有效值。
Limit	Integer	返回最大数量，最大为20
TotalCount	Integer	符合条件的员工数量
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询员工列表

查询员工列表

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntegrationEmployees
<公共请求参数>

{
    "Operator": {
        "UserId": "11234********************678901"
    },
    "Filters": [
        {
            "Key": "Status",
            "Values": [
                "IsVerified"
            ]
        }
    ],
    "Limit": 20,
    "Offset": 0
}

输出示例

{
    "Response": {
        "Employees": [
            {
                "CreatedOn": 1658114069,
                "Department": {
                    "DepartmentId": "dp**********************155f2",
                    "DepartmentName": "**企业"
                },
                "DisplayName": "**",
                "Email": "",
                "Mobile": "123****4567",
                "OpenId": "",
                "Roles": [
                    {
                        "RoleId": "ea4ab3******************a6902",
                        "RoleName": "法人"
                    },
                    {
                        "RoleId": "4fcbf3******************ea6c63",
                        "RoleName": "超级管理员"
                    },
                    {
                        "RoleId": "9b7d******************cf8e9",
                        "RoleName": "业务员"
                    },
                    {
                        "RoleId": "4dff1******************10b",
                        "RoleName": "企业员工"
                    }
                ],
                "UserId": "yDRt******************BKpnZs",
                "Verified": true,
                "VerifiedOn": 1658114065
            }
        ],
        "Limit": 20,
        "Offset": 0,
        "RequestId": "s1663******************195",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
InternalError.System	系统错误，请稍后重试。
InvalidParameter.InvalidChannel	Channel不正确。
InvalidParameter.InvalidLimit	参数Limit不正确。
InvalidParameter.InvalidOffset	参数Offset不正确。
InvalidParameter.InvalidOperatorId	操作人ID不正确。
InvalidParameter.InvalidOrganizationId	机构ID不正确。
InvalidParameter.ParamError	参数错误。
InvalidParameterValue.Mask	需要屏蔽的告警。
OperationDenied.Forbid	禁止此项操作。
OperationDenied.NoIdentityVerify	未通过个人实名认证。
OperationDenied.NoLogin	用户未登录,请先登录后再操作。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 查询员工列表​

输入示例​

输出示例​

5. 开发者资源​

腾讯云 API 平台​

API Inspector​

SDK​

命令行工具​

6. 错误码​