跳到主要内容

更新企业员工信息

1. 接口描述

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

更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。 可进行批量操作,Employees中的userID与openID二选一必填

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:UpdateIntegrationEmployees。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息,UserId必填。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
Employees.NArray of Staff员工信息,不超过100个。
根据UserId或OpenId更新员工,必填一个,优先UserId。
可更新Mobile、DisplayName、Email和Department.DepartmentId字段,其他字段暂不支持
AgentAgent代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

3. 输出参数

参数名称类型描述
SuccessEmployeeDataArray of SuccessUpdateStaffData更新成功的用户列表
FailedEmployeeDataArray of FailedUpdateStaffData更新失败的用户列表
RequestIdString唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 更新员工信息

更新员工名称,手机号

输入示例

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

{
"Operator": {
"UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
},
"Employees": [
{
"UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
"DisplayName": "张三",
"Mobile": "18888888888",
"Email": "zhangsan@qq.com"
}
]
}

输出示例

{
"Response": {
"SuccessEmployeeData": [
{
"DisplayName": "张三",
"Mobile": "18888888888",
"UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
}
],
"FailedEmployeeData": [],
"RequestId": "s18mds3kjkld*****fssfsdfdsf"
}
}

示例2 错误示例:没有接口调用权限

如果 Operator 里面的 UserId 没有对应的组织架构权限,则会报错没有 API 权限

输入示例

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



{
"Operator": {
"UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
},
"Employees": [{
"UserId": "yDxbWUyKQDx7OZUuO4zjESvEkRMHc55R",
"DisplayName": "李四",
"Mobile": "15100000000",
"Email": "lisi@qq.com"
}

]

}

输出示例

{
"Response": {
"Error": {
"Code": "OperationDenied.NoApiAuth",
"Message": "没有API权限"
},
"RequestId": "s2df9ddsk*****kfjdsklfjs"
}
}

5. 错误码

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

错误码描述
AuthFailureCAM签名/鉴权错误。
FailedOperation操作失败。
InvalidParameter.ParamError参数错误。
OperationDenied.Forbid禁止此项操作。
OperationDenied.NoApiAuth没有API权限。