Name

QQ::exmail::department

DESCRIPTION

通讯录管理->管理部门

FUNCTION

create(access_token, hash);

创建部门

SYNOPSIS

https://exmail.qq.com/qy_mng_logic/doc#10008

请求说明

请求包结构体为:

{
   "name": "广州研发中心",
   "parentid": 1,
   "order": 0
}

参数说明

参数	            必须	说明
access_token	是	调用接口凭证
name	        是	部门名称。长度限制为1~64个字节,字符不能包括\:*?"<>|
parentid	    是	父部门id。id为1可表示根部门
order	        否	在父部门中的次序值。order值小的排序靠前,1-10000为保留值,若使用保留值,将被强制重置为0。

权限说明

系统应用须拥有父部门的管理权限。

RETURN 返回结果

{
   "errcode": 0,
   "errmsg": "created",
   "id": 2
}

RETURN 参数说明

参数	    说明
errcode	返回码
errmsg	对返回码的文本描述内容
id	    创建的部门id。id为64位整型数

update(access_token, hash);

更新部门

SYNOPSIS

https://exmail.qq.com/qy_mng_logic/doc#10009

请求说明:

请求包结构体为(如果非必须的字段未指定,则不更新该字段之前的设置值):

{
   "id": 2,
   "name": "广州研发中心",
   "parentid": 1,
   "order": 0
}

参数说明:

参数	            必须	说明
access_token	是	调用接口凭证
id	            是	部门id
name	        否	更新的部门名称。长度限制为1~64个字节,字符不能包括\:*?"<>|。修改部门名称时指定该参数
parentid	    否	父部门id。id为1可表示根部门
order	        否	在父部门中的次序值。order值小的排序靠前,1-10000为保留值,若使用保留值,将被强制重置为0。

权限说明

系统应用须拥有指定部门的管理权限。

RETURN 返回结果

{
   "errcode": 0,
   "errmsg": "updated"
}

RETURN 参数说明

参数	    说明
errcode	返回码
errmsg	对返回码的文本描述内容

delete(access_token, id);

删除部门

SYNOPSIS

https://exmail.qq.com/qy_mng_logic/doc#10010

请求说明:

参数说明:

参数	            必须	说明
access_token	是	调用接口凭证
id	            是	部门id。(注:不能删除根部门;不能删除含有子部门、成员的部门)

权限说明

系统应用须拥有指定部门的管理权限。

RETURN 返回结果

{
   "errcode": 0,
   "errmsg": "deleted"
}

RETURN 参数说明

参数	    说明
errcode	返回码
errmsg	对返回码的文本描述内容

list(access_token, id);

获取部门列表

SYNOPSIS

https://exmail.qq.com/qy_mng_logic/doc#10011

参数说明:

参数	            必须	说明
access_token	是	调用接口凭证
id	            否	部门id。获取指定部门及其下的子部门。id为1时可获取根部门下的子部门。

权限说明

系统应用须拥有指定部门的查看权限。

RETURN 返回结果

{
   "errcode": 0,
   "errmsg": "ok",
   "department": [{
           "id": 2,
           "name": "广州研发中心",
           "parentid": 1,
           "order": 10
       },
       {
           "id": 3
           "name": "邮箱产品部",
           "parentid": 2,
           "order": 40
       }
    ]
}

RETURN 参数说明

参数	        说明
errcode	    返回码
errmsg	    对返回码的文本描述内容
department	部门列表数据。以部门的order字段从小到大排列
id	        部门id
name	    部门名称
parentid	父部门id。
order	    在父部门中的次序值。order值小的排序靠前

search(access_token, hash);

查找部门

SYNOPSIS

https://exmail.qq.com/qy_mng_logic/doc#10012

请求说明:

请求包结构体为:

{
   "name": "邮箱产品部",
   "fuzzy": 0,
}

参数说明:

参数	            必须	说明
access_token	是	调用接口凭证
name	        否	查找的部门名字,必须合法
fuzzy	        否	1/0:是否模糊匹配

权限说明

系统应用须拥有指定部门的查看权限。

RETURN 返回结果

{
   "errcode": 0,
   "errmsg": "ok",
   "department": [
       {
           "id": 3
           "name": "邮箱产品部",
           "parentid": 2,
           "order": 40,
           "path":"广州研发中心/邮箱产品部"
       },
       {
           "id": 10
           "name": "邮箱产品部",
           "parentid": 6,
           "order": 40,
           "path":"深圳研发中心/邮箱产品部"
       }
   ]
}

RETURN 参数说明

参数	        说明
errcode	    返回码
errmsg	    对返回码的文本描述内容
department	部门列表数据。以部门的order字段从小到大排列
id	        部门id
name	    部门名称
parentid	父部门id。根部门为0
order	    在父部门中的次序值。order值小的排序靠前。
path	    部门路径,部门用’/ ’作分割符