# 创建部门
该接口用于向通讯录中创建部门。
只可在应用的通讯录权限范围内的部门下创建部门。若需要在根部门下创建子部门,则应用通讯录权限范围需要设置为“全部成员”。应用商店应用无权限调用此接口。
# 请求
基本 | |
---|---|
HTTP URL | https://hi-gw.weizhipin.com/open-apis/contact/departments |
HTTP Method | POST |
支持的应用类型 | 仅自建应用 |
权限要求 | 更新通讯录 |
字段权限要求 | 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 获取部门组织架构信息 以应用身份读取通讯录 获取部门基础信息 获取用户 user ID |
# 请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token "示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" |
Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
# 查询参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
user_id_type | string | 否 | 用户 ID 类型 示例值:"open_id" 可选值有: * open_id :标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。* union_id :标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。* user_id :标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。默认值: open_id 当值为 user_id ,字段权限要求: 获取用户 user ID |
client_token | string | 否 | 用于幂等判断是否为同一请求,避免重复创建。字符串类型,自行生成。 示例值:"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E" |
# 请求体
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
name | string | 是 | 部门名称 字段权限要求(满足任一): 获取部门基础信息 |
parent_department_id | string | 是 | 父部门的ID 字段权限要求(满足任一): 获取部门组织架构信息 |
department_id | string | 否 | 本部门的自定义部门ID 字段权限要求(满足任一): 获取部门基础信息 |
leader_user_id | string | 是 | 部门主管用户ID 字段权限要求(满足任一): 获取用户 user_id |
order | string | 否 | 部门的排序,即部门在其同级部门的展示顺序 |
# 请求体示例
{
"department_id": "aksufw",
"name": "开放平台部门测试",
"parent_department_id": "01",
"leader_user_id": "11111111392",
"order": 1
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 响应
# 响应体
名称 | 类型 | 描述 |
---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | - | - |
∟name | string | 部门名称 字段权限要求(满足任一): 获取部门基础信息 |
∟parent_department_id | string | 父部门的ID 字段权限要求(满足任一): 获取部门组织架构信息 |
∟department_id | string | 本部门的自定义部门ID 字段权限要求(满足任一): 获取部门基础信息 |
∟leader_user_id | string | 部门主管用户ID 字段权限要求(满足任一): 获取用户 user_id |
∟order | int | 部门的排序,即部门在其同级部门的展示顺序 |
∟member_count | int | 部门下用户的个数 |
∟status | object | 部门状态 字段权限要求(满足任一): 获取部门基础信息 |
∟ is_deleted | boolean | 是否已删除 |
# 响应体示例
{
"code": 0,
"traceId": "_Ao59UOIBLPCeAAu",
"data": [
{
"department_id": "0104",
"name": "公共资源",
"parent_department_id": "01",
"leader_user_id": "13637",
"order": 0,
"member_count": 4,
"status": {
"is_deleted": false
}
}
],
"msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18