离职企业员工
1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
该接口（DeleteIntegrationEmployees）用于离职本企业员工，同时可选择是否进行离职交接。
- 如果该员工没有未处理的合同，可不设置交接人的ReceiveUserId或ReceiveOpenId进行离职操作。
- 如果该员工有未处理的合同，需要设置ReceiveUserId或ReceiveOpenId表示交接的负责人，交接后员工会进行离职操作。
未处理的合同包括以下：
- 待签署的合同（包括顺序签署还没有轮到的合同，此类合同某些情况可能不会出现在用户的列表中）。
- 待填写的合同。
- 待解除的合同等。
注：
- 超管或法人身份的员工不能被离职， 需要在控制台或小程序更换法人和超管后进行离职删除。
- 员工存在待处理合同时必须交接后才能离职无人交接时不能被离职删除。
- 未实名的员工可以直接离职，不用交接合同
默认接口请求频率限制：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 | 待离职员工的信息最多不超过100个。应符合以下规则： 1. UserId和OpenId不可同时为空，必须填写其中一个，优先使用UserId。 2. 若需要进行离职交接，交接人信息ReceiveUserId和ReceiveOpenId不可同时为空，必须填写其中一个，优先使用ReceiveUserId。 |
| Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DeleteEmployeeResult | DeleteStaffsResult | 员工删除结果。包含成功数据与失败数据。
|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 删除员工（员工有待处理的合同）
被删除员工存在待处理合同，且设置了交接人ReceiveUserId，调用此接口时，会先进行合同交接，然后删除员工。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteIntegrationEmployees
<公共请求参数>
{
"Operator": {
"UserId": "yDCNLUUckptelvkwUy06roXCPebdVqZt"
},
"Employees": [
{
"UserId": "yDCVKUUckpwsohygUEX7r4kvwy4jPAGW",
"ReceiveUserId": "yDCNLUUckptelvkwUy06roXCPebdVqZt"
}
]
}
输出示例
{
"Response": {
"DeleteEmployeeResult": {
"SuccessEmployeeData": [
{
"DisplayName": "典子谦",
"Mobile": "17300000000",
"UserId": "yDCVKUUckpwsohygUEX7r4kvwy4jPAGW"
}
],
"FailedEmployeeData": []
},
"RequestId": "f053ae01-9715-45e6-ad79-6d8a9a674fd7"
}
}
示例2 删除员工（员工没有待处理的合同）
删除员工，不设置交接人（员工没有待处理的合同），员工将被直接移除。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteIntegrationEmployees
<公共请求参数>
{
"Operator": {
"UserId": "yDxbTUyKQWPt6NUuO4zjEuyFAyOX2v9C"
},
"Employees": [
{
"OpenId": "n9527"
}
]
}
输出示例
{
"Response": {
"DeleteEmployeeResult": {
"FailedEmployeeData": [],
"SuccessEmployeeData": [
{
"DisplayName": "张三",
"Mobile": "13500000000",
"UserId": "yDCNCUUckpv0ox66UC7yFOvFzax82lgp"
}
]
},
"RequestId": "ee7969233c6c"
}
}
示例3 错误示例-如果没有设置交接人删除有处理合同的员工
调用此接口时，若出现异常删除失败，员工信息及原因将会被返回。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteIntegrationEmployees
<公共请求参数>
{
"Operator": {
"UserId": "yDCNLUUckptelvkwUy06roXCPebdVqZt"
},
"Employees": [
{
"UserId": "yDCVKUUckpwsohygUEX7r4kvwy4jPAGW"
}
]
}
输出示例
{
"Response": {
"DeleteEmployeeResult": {
"SuccessEmployeeData": [],
"FailedEmployeeData": [
{
"UserId": "yDCVKUUckpwsohygUEX7r4kvwy4jPAGW",
"OpenId": "",
"Reason": "删除用户存在处理中的合同 ，需要指定交接人"
}
]
},
"RequestId": "857544a1-9d6c-4304-8bf1-268163521060"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError.System | 系统错误，请稍后重试。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidChannel | Channel不正确。 |
| InvalidParameter.InvalidOperatorId | 操作人ID不正确。 |
| InvalidParameter.InvalidOrganizationId | 机构ID不正确。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |