1. 接口描述
接口请求域名： essbasic.tencentcloudapi.com 。
获取企业员工信息, 可以获取员工的名字,OpenId,UserId和简述的角色等信息，支持设置过滤条件以筛选员工查询结果。
注:通过企业员工新增或离职接口增加的新员工或者离职的员工也会在列表中。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ChannelDescribeEmployees。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-26。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 是 | Agent | 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
第三方平台子客企业和员工必须已经经过实名认证 |
| Limit | 是 | Integer | 指定分页每页返回的数据条数，单页最大支持 20。 示例值：10 |
| Filters.N | 否 | Array of Filter | 查询的关键字段，支持Key-Values查询。可选键值如下：
注: 同名字的Key的过滤条件会冲突, 只能填写一个 |
| Offset | 否 | Integer | 指定分页返回第几页的数据，如果不传默认返回第一页。 页码从 0 开始，即首页为 0，最大20000。 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Employees | Array of Staff | 员工信息列表。 |
| Offset | Integer | 偏移量，默认为0，最大20000。关于Offset的更进一步介绍请参考 API 简介中的相关小节。示例值：0 |
| Limit | Integer | 指定分页每页返回的数据条数，单页最大支持 20。 示例值：10 |
| TotalCount | Integer | 符合条件的员工数量。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询已实名员工列表
Filter参数Key设置为"Status",Values设置为"IsVerified"表示查询已实名员工
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelDescribeEmployees
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"Filters": [
{
"Key": "Status",
"Values": [
"IsVerified"
]
}
],
"Offset": 0,
"Limit": 20
}输出示例
{
"Response": {
"Employees": [
{
"UserId": "yDSLNUUckpossi8fUy98I4ESq4EmlpEd",
"DisplayName": "张三",
"Mobile": "18888888888",
"Email": "",
"OpenId": "n02468",
"Roles": [
{
"RoleId": "yDSLOUUckpojqpkmUEJmzYK68ctIyPFp",
"RoleName": "业务员"
}
],
"Department": {
"DepartmentId": "",
"DepartmentName": ""
},
"Verified": true,
"CreatedOn": 1699087891,
"VerifiedOn": 1699088080,
"QuiteJob": 0
},
{
"UserId": "yDwi0UUckpohyi32UEdhBFEEbigdd0Dd",
"DisplayName": "李四",
"Mobile": "15100000000",
"Email": "",
"OpenId": "n123456",
"Roles": [
{
"RoleId": "69997f600a7c8e9accc71f4241a8a091",
"RoleName": "超级管理员"
}
],
"Department": {
"DepartmentId": "",
"DepartmentName": ""
},
"Verified": true,
"CreatedOn": 1698814301,
"VerifiedOn": 1698814443,
"QuiteJob": 0
}
],
"Offset": 0,
"Limit": 20,
"TotalCount": 2,
"RequestId": "e0461ce0-455c-410b-873b-f33de95f281f"
}
}示例2 查询某几个员工列表
Filter参数Key设置为"StaffOpenId",Values设置为员工的OpenId列表
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelDescribeEmployees
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"Filters": [
{
"Key": "StaffOpenId",
"Values": [
"n02468",
"n123456"
]
}
],
"Offset": 0,
"Limit": 20
}输出示例
{
"Response": {
"Employees": [
{
"UserId": "",
"DisplayName": "张三",
"Mobile": "18888888888",
"Email": "",
"OpenId": "n02468",
"Roles": [],
"Department": {
"DepartmentId": "",
"DepartmentName": ""
},
"Verified": false,
"CreatedOn": 1699095474,
"VerifiedOn": 0,
"QuiteJob": 0
},
{
"UserId": "",
"DisplayName": "李四",
"Mobile": "15100000000",
"Email": "",
"OpenId": "n123456",
"Roles": [],
"Department": {
"DepartmentId": "",
"DepartmentName": ""
},
"Verified": false,
"CreatedOn": 1699095486,
"VerifiedOn": 0,
"QuiteJob": 1
}
],
"Offset": 0,
"Limit": 20,
"TotalCount": 2,
"RequestId": "4ab55898-527c-47d1-a2bd-79b81471b563"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError.System | 系统错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.Application | 应用号不存在。 |
| InvalidParameter.DepartUserId | 员工ID不正确。 |
| InvalidParameter.OrganizationId | OrganizationId不合法。 |
| InvalidParameter.ParamError | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.OrganizationClosing | 企业已经注销中 |
| OperationDenied.UserNotInOrganization | 用户不归属于当前企业，无法操作，请检查后重试。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.Application | 应用号不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |
