移除企业员工
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
该接口(DeleteIntegrationEmployees)用于移除企业员工,同时可选择是否进行离职交接。
- 如果不设置交接人的ReceiveUserId或ReceiveOpenId,则该员工将被直接移除而不进行交接操作。
- 如果设置了ReceiveUserId或ReceiveOpenId,该员工未处理的合同将会被系统交接给设置的交接人,然后再对该员工进行离职操作。
注:1. 超管或法人身份的员工不能被删除。2. 员工存在待处理合同且无人交接时不能被删除。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DeleteIntegrationEmployees。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Operator | 是 | UserInfo | 执行本接口操作的员工信息。使用此接口时,必须填写UserId。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
Employees.N | 是 | Array of Staff | 待移除员工的信息。应符合以下规则:
|
Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DeleteEmployeeResult | DeleteStaffsResult | 员工删除结果。包含成功数据与失败数据。
|
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 删除员工
删除员工,不设置交接人,员工将被直接移除。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteIntegrationEmployees
<公共请求参数>
{
"Operator": {
"UserId": "y**********************************N"
},
"Employees": [
{
"OpenId": "open123"
}
]
}
输出示例
{
"Response": {
"DeleteEmployeeResult": {
"FailedEmployeeData": [],
"SuccessEmployeeData": [
{
"DisplayName": "张三",
"Mobile": "13500000000",
"UserId": "yDRt******************BKpnZs"
}
]
},
"RequestId": "ee79xxxx-xxxx-xxxx-xxxx-xxxx69233c6c"
}
}
示例2 删除员工,并设置交接人
被删除员工存在待处理合同,且设置了交接人ReceiveUserId,调用此接口时,会先进行合同交接,然后删除员工。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteIntegrationEmployees
<公共请求参数>
{
"Operator": {
"UserId": "yDxb******************MHc55R"
},
"Employees": [
{
"OpenId": "open123",
"ReceiveUserId": "yDRC******************vjoimj"
}
]
}
输出示例
{
"Response": {
"DeleteEmployeeResult": {
"FailedEmployeeData": [],
"SuccessEmployeeData": [
{
"DisplayName": "张三",
"Mobile": "13500000000",
"UserId": "yDRt******************BKpnZs"
}
]
},
"RequestId": "ee79xxxx-xxxx-xxxx-xxxx-xxxx69233c6c"
}
}
示例3 错误示例-员工不属于当前企业
调用此接口时,若出现异常删除失败,员工信息及原因将会被返回。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteIntegrationEmployees
<公共请求参数>
{
"Operator": {
"UserId": "yDxb******************MHc55R"
},
"Employees": [
{
"UserId": "yDRt******************BKpnZs"
}
]
}
输出示例
{
"Response": {
"DeleteEmployeeResult": {
"FailedEmployeeData": [
{
"OpenId": "",
"Reason": "员工不属于当前企业",
"UserId": "yDRt******************BKpnZs"
}
],
"SuccessEmployeeData": []
},
"RequestId": "ee79xxxx-xxxx-xxxx-xxxx-xxxx69233c6c"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError.System | 系统错误,请稍后重试。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidChannel | Channel不正确。 |
InvalidParameter.InvalidOperatorId | 操作人ID不正确。 |
InvalidParameter.InvalidOrganizationId | 机构ID不正确。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |