创建企业部门
1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
此接口（CreateIntegrationDepartment）用于创建企业的部门信息，支持绑定客户系统部门ID。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateIntegrationDepartment。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-11。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得组织架构管理权限，并具备接口传入的相应资源的数据权限。 |
| DeptName | 是 | String | 部门名称，最大长度为50个字符。 |
| Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 |
| ParentDeptId | 否 | String | 电子签父部门ID。 注： 如果同时指定了ParentDeptId与ParentDeptOpenId参数，系统将优先使用ParentDeptId。当二者都未指定时，创建的新部门将自动填充至根节点部门下。 |
| ParentDeptOpenId | 否 | String | 第三方平台中父部门ID。 注： 如果同时指定了ParentDeptId与ParentDeptOpenId参数，系统将优先使用ParentDeptId。当二者都未指定时，创建的新部门将自动填充至根节点部门下。 |
| DeptOpenId | 否 | String | 客户系统部门ID，最大长度为64个字符。 |
| OrderNo | 否 | Integer | 排序号，支持设置的数值范围为1~30000。同一父部门下，排序号越大，部门顺序越靠前。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DeptId | String | 电子签部门ID。建议开发者保存此部门ID，方便后续查询或修改部门信息。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建部门
创建部门，指定父部门ID，部门被创建至父部门节点下。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIntegrationDepartment
<公共请求参数>
{
"Operator": {
"UserId": "yDwgKUUc************QZDRuD"
},
"DeptName": "运营部",
"ParentDeptId": "yDwgIUUckp1g**********E8xOm12b9",
"DeptOpenId": "open_dept2",
"OrderNo": 1
}
输出示例
{
"Response": {
"DeptId": "yDwgIUUckp1g********E8xOm1567",
"RequestId": "s1679*****21175"
}
}
示例2 错误示例-参数不合法
调用此接口时，需要按照入参描述进行相应的设置，以确保参数的合法性。如果参数设置不合法，接口将返回错误信息。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIntegrationDepartment
<公共请求参数>
{
"Operator": {
"UserId": "yDwgKUUc************QZDRuD"
},
"DeptName": "运营部11111111111111111111111111111111111111111111111111111",
"ParentDeptId": "yDwgIUUckp1g**********E8xOm12b9",
"DeptOpenId": "open_dept2",
"OrderNo": 1
}
输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameter.ParamError",
"Message": "部门名称请控制在50个字符以内"
},
"RequestId": "914axxxx-xxxx-xxxx-xxxx-xxxxxxxx70123"
}
}
示例3 创建部门-不指定父部门ID
创建部门，不指定父部门ID，部门被创建至根部门节点下。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIntegrationDepartment
<公共请求参数>
{
"Operator": {
"UserId": "yDwgKUUc************QZDRuD"
},
"DeptName": "运营部",
"DeptOpenId": "open_dept2",
"OrderNo": 1
}
输出示例
{
"Response": {
"DeptId": "yDwgIUUckp1g********E8xOm1567",
"RequestId": "s1679*****21175"
}
}
示例4 创建部门-同时指定第三方平台与电子签父部门ID
创建部门，同时指定第三方平台与电子签父部门ID，系统优先使用电子签平台部门ID。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIntegrationDepartment
<公共请求参数>
{
"Operator": {
"UserId": "yDwgKUUc************QZDRuD"
},
"DeptName": "运营部",
"ParentDeptId": "yDwgIUUckp1g**********E8xOm12b9",
"ParentDeptOpenId": "dept_1",
"DeptOpenId": "open_dept2",
"OrderNo": 1
}
输出示例
{
"Response": {
"DeptId": "yDwgIUUckp1g********E8xOm1567",
"RequestId": "s1679*****21175"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError.System | 系统错误，请稍后重试。 |
| InvalidParameter.DataExists | 数据已存在。 |
| InvalidParameter.DataNotFound | 数据不存在。 |
| InvalidParameter.ParamError | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.UserId | 缺少用户id，请检查后重试。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.Forbid | 禁止此项操作。 |