跳到主要内容

创建企业员工

1. 接口描述​

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

此接口（CreateIntegrationEmployees）用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建，则不会重新创建，但会发送短信提醒员工实名。另外，此接口还支持通过企微组织架构的openid 创建员工（将WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内），该场景下，员工会接收到提醒实名的企微消息。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：CreateIntegrationEmployees。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，此参数为可选参数。
Operator是UserInfo执行本接口操作的员工信息。使用此接口时，必须填写userId。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
Employees.N是Array of Staff待创建员工的信息，最多不超过20个。
其中入参Mobile和DisplayName必填，OpenId、Email和Department.DepartmentId选填，其他字段暂不支持设置。
在创建企微企业员工场景下，只需传入WeworkOpenId，无需再传其他信息。
Agent否Agent代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数​

参数名称类型描述
CreateEmployeeResultCreateStaffResult创建员工的结果。包含创建成功的数据与创建失败数据。
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 创建员工-企微员工​

创建企微企业员工，只需传入WeworkOpenId参数即可。

输入示例​

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

{
    "Operator": {
        "UserId": "y**********************************N"
    },
    "Employees": [
        {
            "WeworkOpenId": "f****f"
        }
    ]
}

输出示例​

{
    "Response": {
        "CreateEmployeeResult": {
            "FailedEmployeeData": [],
            "SuccessEmployeeData": [
                {
                    "DisplayName": "",
                    "Mobile": "",
                    "Note": "",
                    "UserId": "yDRGJ******wG5veA",
                    "WeworkOpenId": "f****f"
                }
            ]
        },
        "RequestId": "s166*************073"
    }
}

示例2 创建员工-非企微员工​

创建非企微企业的员工，传入必填参数即可。

输入示例​

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

{
    "Operator": {
        "UserId": "y**********************************N"
    },
    "Employees": [
        {
            "DisplayName": "张三",
            "Mobile": "13545***901",
            "OpenId": "open123"
        }
    ]
}

输出示例​

{
    "Response": {
        "CreateEmployeeResult": {
            "FailedEmployeeData": [],
            "SuccessEmployeeData": [
                {
                    "DisplayName": "张三",
                    "Mobile": "13545***901",
                    "Note": "",
                    "UserId": "*******"
                }
            ]
        },
        "RequestId": "s166*************073"
    }
}

示例3 错误示例-入参不合法​

调用此接口时，需要按照入参描述进行相应的设置，以确保参数的合法性。如果参数设置不正确，会返回创建失败结果及原因。

输入示例​

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

{
    "Operator": {
        "UserId": "y**********************************N"
    },
    "Employees": [
        {
            "DisplayName": "张三（广东）",
            "Mobile": "1***********7",
            "OpenId": "open123"
        }
    ]
}

输出示例​

{
    "Response": {
        "CreateEmployeeResult": {
            "FailedEmployeeData": [
                {
                    "DisplayName": "张三（广东）",
                    "Mobile": "1***********7",
                    "Reason": "参数错误,姓名不符合规范,请修改后重试",
                    "WeworkOpenId": ""
                }
            ],
            "SuccessEmployeeData": []
        },
        "RequestId": "s166*************073"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError.System系统错误，请稍后重试。
InvalidParameter参数错误。
InvalidParameter.InvalidChannelChannel不正确。
InvalidParameter.InvalidOperatorId操作人ID不正确。
InvalidParameter.InvalidOrganizationId机构ID不正确。
MissingParameter缺少参数错误。
OperationDenied.Forbid禁止此项操作。
OperationDenied.NoIdentityVerify未通过个人实名认证。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。