请求方式: GET (HTTPS)
请求地址: https://open.welink.huaweicloud.com/api/contact/v3/departments/list
认证方式: access_token,请参考获取access_token
请求头部:
x-wlk-Authorization: access_token
请求参数:
参数 | 必填 | 说明 |
---|---|---|
deptCode | 是 | 部门编码,示例:0 |
recursiveflag | 是 | 0 :查询下级部门信息 1 :查询递归获取所有子部门 |
offset | 是 | 当前页,默认值是1 |
limit | 是 | 每页数量,默认值是100,最大限制每页100 |
遍历说明: 1.由于初级部门编码一般为0,因此可设置deptCode=0,recursiveflag=0,获取一层组织编码(注意一级部门不支持直接遍历)。如得到一层部门编码为deptCode:1000; 2.查询1000的下一层部门,可设置deptCode=1000, recursiveflag=0; 3.如果需要查询1000下的所有部门,设置deptCode=1000, recursiveflag=1。
请求示例:
curl -H 'x-wlk-Authorization: access_token' https://open.welink.huaweicloud.com/api/contact/v2/departments/list?deptCode=0&recursiveflag=0&offset=1&limit=100
响应格式说明
返回结果:
{
"code": "0",
"message": "OK",
"offset": 100,
"limit": 25,
"totalCount": 327,
"departmentInfo": [
{
"deptCode": "1",
"deptNameCn": "产品销售部",
"deptNameEn": "Sales Dept",
"fatherCode": "0",
"deptLevel": "2",
"orderNo": 1,
"hasChildDept": 1,
"corpDeptCode": ""
},
{
"deptCode": "2",
"deptNameCn": "产品研发部",
"deptNameEn": "Products Dept",
"fatherCode": "0",
"deptLevel": "2",
"orderNo": 2,
"hasChildDept": 0,
"corpDeptCode": ""
}
]
}
返回参数说明:
参数 | 说明 |
---|---|
code | 数据正常返回“0”,如果发生错误,会返回对应的错误码。 |
message | 返回信息,包括接口请求发生错误时的详细信息。 |
totalCount | 当前部门下所有部门数,如果当前部门为0级,仅能获取下一级的所有部门。 |
deptCode | 部门编码,如1。 |
deptNameCn | 部门名称中文。 |
deptNameEn | 部门名称英文。 |
fatherCode | 上一个层级部门编码。 |
deptLevel | 组织层级编码,如XX公司是组织层级是0,XX公司->研发部 则研发部层级是1。 |
orderNo | 部门排序,该字段在部门维护时设定的,如果不维护则默认为1000。 |
hasChildDept | 当前部门是否有子级部门,0表示没有子级部门,1表示有子级部门。 |
corpDeptCode | 客户侧部门唯一编码。 |
错误码说明:
错误码 | 说明 |
---|---|
0 | OK |
47000 | 无权限 |
47001 | 当前登陆用户信息获取失败 |
47002 | 部门编码为空 |
47003 | 参数为空 |
47004 | 参数不对 |
47007 | 当前登陆者是非法用户或个人详情已失效 |
47008 | 参数校验不通过 |
47009 | 提交失败 |
47012 | 无数据 |
47013 | 查询数量限制 |
47100 | 待处理 |
47101 | Token格式错误 |
47102 | 无权限 |
47103 | Token过期 |
47104 | 处理中 |
47105 | 秘书账号未创建 |
47106 | 上级部门未创建 |
500 | 系统错误 |