腾讯乐享接口文档

# 部门管理

# 创建部门

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/contact/department/create?access_token=ACCESS_TOKEN

请求包体：

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

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
name 是 部门名称，长度为1~32个字符，字符不能包括:?”<>｜
parent_id 是 父部门id，乐享平台中默认创建的根部门id为1。当此parent_id不存在时，会创建到根部门下
order 否 在父部门中的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)
id 否 部门id，32位整型，指定时必须大于1。若不指定该参数，将自动生成id

返回结果：

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

参数说明：

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

错误码说明（请求包体参数错误）：

CODE 说明
1001 部门名包含非法字符
1003 参数错误（parent_id或name为空）
1004 父部门不能为空
1005 该部门名称已经存在
1006 服务错误，创建部门失败
1007 部门层级不能超过15层
1008 指定的部门id已经存在
1009 部门id不合法
1400 该乐享不允许增删成员/部门

# 更新部门

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/contact/department/edit?access_token=ACCESS_TOKEN

请求包体（如果非必须的字段未指定，则不更新该字段）：

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

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
id 是 部门id
name 否 部门名称，长度为1~32个字符，字符不能包括:?”<>｜
order 否 在父部门中的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)
parent_id 否 父部门id

返回结果：

{
  "data": {
    "id": 2, 
    "name": "开发组", 
    "parent_id": "1", 
    "order": 1
  }, 
  "msg": "success", 
  "code": 0
}

参数说明：

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

错误码说明（请求包体参数错误）：

CODE 说明
1001 部门名包含非法字符或部门名称大于32个字符
1002 该部门不存在
1003 参数错误
1004 该部门名称已经存在
1005 修改失败
1006 order值不能为负数
1007 部门层级不能超过15级
1008 该父部门不存在
1009 父部门与子部门不能相同
1010 父部门不能为该部门的子部门
1401 该乐享不允许修改任何部门字段

# 删除部门

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/contact/department/delete?access_token=ACCESS_TOKEN&id={id}

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
id 是 部门id。不允许删除根部门；不能删除含有子部门、成员的部门

返回结果：

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

参数说明：

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

错误码说明（请求包体参数错误）：

CODE 说明
1003 参数错误（id为空）
1002 该部门不存在
1004 该部门下存在子部门，无法删除
1005 该部门下存在用户，无法删除
1006 该部门是根部门不能被删除
1400 该乐享不允许增删成员/部门

# 部门列表

请求方式：GET（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/contact/department/index?access_token=ACCESS_TOKEN&id={id}&with_descendant=1 参数说明：

参数 必须 说明
access_token 是 调用接口凭证
id 否 部门id，默认值是根部门1
with_descendant 否 是否递归获取，0：否，1：是，默认1

返回结果：

{
    "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 子部门

错误码说明（请求入参错误）：

CODE 说明
3001 部门不存在

# 获取单个部门信息

请求方式：GET（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/contact/department/get?access_token=ACCESS_TOKEN&id={id} 参数说明：

参数 必须 说明
access_token 是 调用接口凭证
id 是 部门id

返回结果：

{
    "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 排序顺序

错误码说明（请求入参错误）：

CODE 说明
1002 部门不存在
1009 部门id不合法

# 创建部门列表导出任务

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/contact/export/department?access_token={access_token}

请求包体：

{
	"encoding_aeskey": "dG9kYXkreWVzdGVyZGF5K3RvbW9ycm93KzEyMzQ1xxx"
}

encoding_aeskey：明文由开发者自定义，Base64编码后的加密密钥。长度固定为43，从a-z, A-Z, 0-9共62个字符中选取，是AESKey的Base64编码。解码后即为32字节长的AESKey。加密方式采用AES-256-CBC方式，数据采用PKCS#7填充至32字节的倍数；IV初始向量大小为16字节，取AESKey前16字节，详见：https://datatracker.ietf.org/doc/html/rfc2315

AESKey=Base64_Decode(encoding_aeskey + “=”)

参数说明：

参数 是否必须 默认值 说明
access_token 是 无 调用接口凭证
encoding_aeskey 是 无 密钥

返回结果：

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

参数说明：

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

← 标签管理 →