跳到主要内容

更新企业员工信息

1. 接口描述​

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

更新员工信息(姓名，手机号，邮件)，用户实名后无法更改姓名与手机号

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：UpdateIntegrationEmployees。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，本接口不需要传递此参数。
Operator是UserInfo操作人信息
Employees.N是Array of Staff员工信息
Agent否Agent代理相关应用信息，如集团主企业代子企业操作的场景中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": "abc",
        "Channel": "abc",
        "OpenId": "abc",
        "ClientIp": "abc",
        "ProxyIp": "abc"
    },
    "Agent": {
        "AppId": "abc",
        "ProxyAppId": "abc",
        "ProxyOrganizationId": "abc",
        "ProxyOperator": "abc"
    },
    "Employees": [
        {
            "UserId": "abc",
            "DisplayName": "abc",
            "Mobile": "abc",
            "Email": "abc"
        }
    ]
}

输出示例​

{
    "Response": {
        "SuccessEmployeeData": [
            {
                "DisplayName": "abc",
                "Mobile": "abc",
                "UserId": "abc"
            }
        ],
        "FailedEmployeeData": [],
        "RequestId": "abc"
    }
}

5. 开发者资源​

腾讯云 API 平台​

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector​

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK​

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具​

6. 错误码​

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

错误码描述
AuthFailureCAM签名/鉴权错误。
FailedOperation操作失败。
InvalidParameter.ParamError参数错误。