乐享知识库接口文档

# 部门管理

# 创建部门

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/department/create

请求头

参数 是否必须 说明
Content-Type 是 固定值："application/json; charset=utf-8"
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 通讯录管理
频率限制 3000次/分钟

请求参数

{
  "id": 100,
  "name": "开发组",
  "parent_id": 1,
  "order": 1
}

请求参数说明

参数 必须 说明
id 否 部门id，32位整型，指定时必须大于1。若不指定该参数，将自动生成id
name 是 部门名称
parent_id 是 父部门id，乐享平台中默认创建的根部门id为1
order 否 在父部门中的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)

响应

200 Ok 状态码

{
  "code": 0,
  "msg": "ok",
  "data": {
    "id": 2
  }
}

响应参数说明

参数 说明
code 错误码
msg 对返回码的文本描述内容
data 返回数据
data.id 创建的部门id

错误码说明

错误码 说明
1003 参数错误（parent_id或name为空）
1004 父部门不能为空
1005 该部门名称已经存在
1007 部门层级不能超过15层
1008 指定的部门id已经存在
1009 部门id不合法

# 更新部门

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/department/edit

请求头

参数 是否必须 说明
Content-Type 是 固定值："application/json; charset=utf-8"
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 通讯录管理
频率限制 3000次/分钟

请求参数

如果非必须的字段未指定，则不更新该字段

{
  "id": 2, 
  "name": "开发组", 
  "order": 1, 
  "parent_id": 1
}

请求参数说明

参数 必须 说明
id 是 部门id
name 否 部门名称
order 否 在父部门中的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)
parent_id 否 父部门id

响应

200 Ok 状态码

{
  "data": {
    "id": 2,
    "name": "开发组",
    "parent_id": 1,
    "path": "/1/2",
    "order": 1,
    "children": []
  },
  "msg": "success",
  "code": 0
}

响应参数说明

参数 说明
code 错误码
msg 对返回码的文本描述内容

错误码说明

错误码 说明
1002 该部门不存在
1004 该部门名称已经存在
1006 order值不能为负数
1007 部门层级不能超过15级
1008 该父部门不存在
1009 父部门与子部门不能相同
1010 父部门不能为该部门的子部门

# 删除部门

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/department/delete

请求头

参数 是否必须 说明
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 通讯录管理
频率限制 3000次/分钟

请求参数说明

参数 必须 说明
id 是 部门id。不允许删除根部门；不能删除含有子部门、成员的部门

响应

200 Ok 状态码

{
  "code": 0,
  "msg": "ok"
}

响应参数说明

参数 说明
code 错误码
msg 对返回码的文本描述内容

错误码说明

错误码 说明
1003 参数错误（id为空）
1002 该部门不存在
1004 该部门下存在子部门，无法删除
1005 该部门下存在用户，无法删除
1006 该部门是根部门不能被删除

# 获取子部门

请求URL

GET https://lxapi.lexiangla.com/cgi-bin/v1/contact/department/index

请求头

参数 是否必须 说明
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 通讯录管理
频率限制 3000次/分钟

请求参数说明

参数 必须 默认值 说明
id 否 1 部门id
with_descendant 否 1 是否返回包含子部门下的成员，1表示包含；0表示不包含

响应

200 Ok 状态码

{
  "code": 0,
  "msg": "ok",
  "data": {
    "id": 1,
    "name": "根部门",
    "parent_id": 0,
    "path": "/1",
    "order": 12354,
    "children": [
      {
        "id": 2,
        "name": "根部门",
        "parent_id": 1,
        "path": "/1/2",
        "order": 12356,
        "children": []
      }
    ]
  }
}

响应参数说明

参数 说明
code 错误码
msg 对返回码的文本描述内容
data 返回数据
data.id 部门id
data.name 部门名称
data.parent_id 父部门id
data.path 组织路径
data.order 排序顺序
data.children 子部门列表

错误码说明

错误码 说明
3001 部门不存在

# 获取单个部门信息

请求URL

GET https://lxapi.lexiangla.com/cgi-bin/v1/contact/department/get

请求头

参数 是否必须 说明
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 通讯录管理
频率限制 3000次/分钟

请求参数说明

参数 必须 说明
id 是 部门id

响应

200 Ok 状态码

{
  "data": {
    "id": 1,
    "name": "根部门",
    "parent_id": 0,
    "path": "/1",
    "order": 200
  },
  "msg": "success",
  "code": 0
}

响应参数说明

参数 说明
code 错误码
msg 对返回码的文本描述内容
data 返回数据
data.id 部门id
data.name 部门名称
data.parent_id 父部门id
data.path 组织路径
data.order 排序顺序

错误码说明

错误码 说明
1002 部门不存在
1009 部门id不合法

# 获取所有部门信息

此接口仅创建异步导出任务，开发者需轮询任务状态直到任务完成后，可下载得到 json 文件，解密后可得到当前租户所有部门信息

请求URL

POST https://lxapi.lexiangla.com/cgi-bin/v1/contact/export/department

请求头

参数 是否必须 说明
Content-Type 是 固定值："application/json; charset=utf-8"
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 通讯录管理
频率限制 10次/分钟

请求参数

{
	"aeskey": "123456789012345678901234567890ab"
}

请求参数说明

参数 是否必须 默认值 说明
aeskey 是 无 加密密钥。生成的文件内容会使用此密钥经过AES-256-CBC加密，企业需使用此密钥解密内容
密钥必须32位长度，字符从a-z, A-Z, 0-9共62个字符中选取
参考文件解密

响应

200 Ok 状态码

{
  "data": {
    "job_id": "b8e809fe933c11ee997a56b4feeefxxx"
  },
  "msg": "success",
  "code": 0
}

响应参数说明

参数 说明
job_id 任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载json文件

文件解密内容示例

[
  {
    "id": 1,
    "name": "腾讯公司",
    "parent_id": 0,
    "path": "/1",
    "order": 1
  },
  {
    "id": 2,
    "name": "腾讯云",
    "parent_id": 1,
    "path": "/1/2",
    "order": 2
  }
]

参数说明

参数 说明
id 部门ID
name 姓名
parent_id 父部门id
order 在父部门中的次序值。order值大的排序靠前。
path 部门ID路径

← 平台集成 →