跳到主要内容

创建企业部门

1. 接口描述

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

此接口(CreateIntegrationDepartment)用于创建企业的部门信息,支持绑定客户系统部门ID。

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:CreateIntegrationDepartment。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。
DeptNameString部门名称,最大长度为50个字符。
AgentAgent代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
ParentDeptIdString电子签父部门ID。
注:如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。
ParentDeptOpenIdString第三方平台中父部门ID。
注:如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。
DeptOpenIdString客户系统部门ID,最大长度为64个字符。
OrderNoInteger排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。

3. 输出参数

参数名称类型描述
DeptIdString电子签部门ID。建议开发者保存此部门ID,方便后续查询或修改部门信息。
RequestIdString唯一请求 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禁止此项操作。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062