创建企业员工

1. 接口描述

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

此接口（CreateIntegrationEmployees）用于创建企业员工。创建的员工初始化为未实名，如下图所示。

支持以下场景

• 新增员工的手机号、OpenId不能与已加入员工重复， 不管已加入员工的手机号、OpenId是否已经实名
• 若通过手机号发现员工已经创建且信息一致（名字，openId等），则不会重复创建，但会发送短信或者生成链接提醒员工实名。
• jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。

短信的样式

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 H5端添加企业员工

企业员工未认证， 在H5端， 用户通过生成链接嵌入到小程序，进行加入，实名

输入示例

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

{
    "Operator": {
        "UserId": "yDwf3UUckps8dvypUEfH3DjwIpMfa0uw"
    },
    "Employees": [
        {
            "DisplayName": "典子谦",
            "Mobile": "13200000000",
            "OpenId": "n9527"
        }
    ],
    "InvitationNotifyType": "H5",
    "JumpUrl": "https://www.qq.com"
}

输出示例

{
    "Response": {
        "CreateEmployeeResult": {
            "FailedEmployeeData": [],
            "SuccessEmployeeData": [
                {
                    "DisplayName": "典子谦",
                    "Mobile": "13200000000",
                    "Note": "",
                    "UserId": "yDCNCUUckpv0ox66UC7yFOvFzax82lgp",
                    "Url": "https://test.essurl.cn/TxHxUBCx0G",
                    "WeworkOpenId": ""
                }
            ]
        },
        "RequestId": "e01a9584-4b91-45dd-9a7b-46d32c4099fd"
    }
}

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

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

输入示例

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

{
    "Operator": {
        "UserId": "yDwf3UUckps8dvypUEfH3DjwIpMfa0uw"
    },
    "Employees": [
        {
            "WeworkOpenId": "woed0SCQAAAtPx1SMU17ThB-QC7F"
        }
    ]
}

输出示例

{
    "Response": {
        "CreateEmployeeResult": {
            "FailedEmployeeData": [],
            "SuccessEmployeeData": [
                {
                    "DisplayName": "",
                    "Mobile": "",
                    "Note": "",
                    "UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
                    "WeworkOpenId": "woed0SCQAAAtPx1SMU17ThB-QC7F"
                }
            ]
        },
        "RequestId": "s1695125479063466836"
    }
}

示例3 创建员工-非企微员工

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

输入示例

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

{
    "Operator": {
        "UserId": "yyDxVwUyKQWho8CUuO4zjEyQOAgwvr4ZyN"
    },
    "Employees": [
        {
            "DisplayName": "张三",
            "Mobile": "18560000000"
        }
    ]
}

输出示例

{
    "Response": {
        "CreateEmployeeResult": {
            "FailedEmployeeData": [],
            "SuccessEmployeeData": [
                {
                    "DisplayName": "张三",
                    "Mobile": "18560000000",
                    "Note": "",
                    "UserId": "yDRS4UUgygqdcjjhUuO4zjEBpXdcsHWw"
                }
            ]
        },
        "RequestId": "s1695125479063466836"
    }
}

示例4 错误示例-入参不合法

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

输入示例

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

{
    "Operator": {
        "UserId": "yyDxVwUyKQWho8CUuO4zjEyQOAgwvr4ZyN"
    },
    "Employees": [
        {
            "DisplayName": "张三（广东）",
            "Mobile": "18560000000",
            "OpenId": "open123"
        }
    ]
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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