跳到主要内容

查询企业员工

1. 接口描述​

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

查询企业员工列表

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ChannelDescribeEmployees。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
Limit是Integer指定每页多少条数据，单页最大20
Filters.N否Array of Filter查询过滤实名用户，Key为Status，Values为["IsVerified"]
根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
查询离职员工时，Key为Status，Values为["QuiteJob"]
Offset否Integer查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0,最大为20000

3. 输出参数​

参数名称类型描述
EmployeesArray of Staff员工数据列表
注意：此字段可能返回 null，表示取不到有效值。
OffsetInteger查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大20000
注意：此字段可能返回 null，表示取不到有效值。
LimitInteger指定每页多少条数据，单页最大20
TotalCountInteger符合条件的员工数量
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 查询员工​

不带过滤条件查询员工

输入示例​

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

{
    "Agent": {
        "ProxyOrganizationOpenId": "test",
        "ProxyOperator": {
            "OpenId": "test"
        },
        "AppId": "test"
    },
    "Filters": [
        {
            "Values": [
                ""
            ],
            "Key": ""
        }
    ],
    "Limit": "20",
    "Offset": "0"
}

输出示例​

{
    "Response": {
        "Employees": [
            {
                "CreatedOn": 1658114069,
                "Department": {
                    "DepartmentId": "dp-8a801d51****820e2aed8155f2",
                    "DepartmentName": "test企业"
                },
                "DisplayName": "test",
                "Email": "",
                "Mobile": "123testtest4567",
                "OpenId": "",
                "Roles": [
                    {
                        "RoleId": "ea4ab302****80dd388e6da6902",
                        "RoleName": "法人"
                    },
                    {
                        "RoleId": "4fcbf3624****df77e30ea6c63",
                        "RoleName": "超级管理员"
                    },
                    {
                        "RoleId": "9b7dcf74ab****b57c9fecf8e9",
                        "RoleName": "业务员"
                    },
                    {
                        "RoleId": "4dff1cea****6fc061010b",
                        "RoleName": "企业员工"
                    }
                ],
                "UserId": "yDRtvUUgygq****O4zjESsMBKpnZs",
                "Verified": true,
                "VerifiedOn": 1658114065,
                "QuiteJob": 0
            }
        ],
        "Limit": 20,
        "Offset": 0,
        "RequestId": "s16635***97576195",
        "TotalCount": 1
    }
}

5. 错误码​

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

错误码描述
AuthFailureCAM签名/鉴权错误。
FailedOperation操作失败。
InternalError.System系统错误。
InvalidParameter参数错误。
InvalidParameter.Application应用号不存在。
InvalidParameter.DepartUserId员工ID不正确。
InvalidParameter.OrganizationIdOrganizationId不合法。
InvalidParameter.ParamError参数错误。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
OperationDenied.UserNotInOrganization用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
ResourceUnavailable资源不可用。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。