跳到主要内容

创建企业员工

1. 接口描述

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

创建员工,如需在此接口提醒员工实名,入参Employees的OpenId不传

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:CreateIntegrationEmployees。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,本接口不需要传递此参数。
OperatorUserInfo操作人信息,userId必填
Employees.NArray of Staff待创建员工的信息,Mobile和DisplayName必填
AgentAgent代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填

3. 输出参数

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

4. 示例

示例1 创建员工

创建员工

输入示例

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

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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