1.开始使用
1.1 获取 ACCESS_TOKEN
1.1.1 请求说明
HTTPS 请求方式: GET
请求地址: https://api.exmail.qq.com/cgi-bin/gettoken?corpid=id&corpsecret=secrect
参数说明
参数
必须
说明
corpid
是
企业 id
corpsecret
是
应用的凭证密钥
权限说明
每个应用有不同的 secret,代表了对应用的不同权限
1.1.2 返回结果
{
}
"access_token": "accesstoken000001",
"expires_in": 7200
参数
说明
access_token 获取到的凭证。长度为 64 至 512 个字节
expires_in
凭证的有效时间(秒)
1.1.3 出错返回示例
{
}
"errcode": 40001,
"errmsg": "invalid credential"
2.通讯录管理
2.1 部门管理
2.1.1 创建部门
2.1.1.1 请求说明
HTTPS 请求方式: POST
请求地址: https://api.exmail.qq.com/cgi-bin/department/create?access_token=ACCESS
_TOKEN
请求包结构体为:
{
}
"name": "IT",
"parentid": 1,
"order": 1
参数说明
参数
必须
说明
access_token 是
调用接口凭证
name
是
部门名称。长度限制为 1~64 个字节,字符不能包括\:*?"<>|
parentid
是
父部门 id。id 为 1 可表示根部门
order
否
在父部门中的次序值。order 值小的排序靠前。
权限说明
系统应用须拥有父部门的管理权限。
2.1.1.2 返回结果
{
"errcode": 0,
"errmsg": "created",
"id": 7404695801683274054
}
参数
说明
errcode
返回码
errmsg
对返回码的文本描述内容
id
创建的部门 id。id 为 64 位整型数
2.1.1.3 创建失败示例
{
}
"errcode": 60008,
"errmsg": "department existed"
2.1.2 更新部门
2.1.2.1 请求说明
HTTPS 请求方式: POST
请求地址: https://api.exmail.qq.com/cgi-bin/department/update?access_token=ACCESS
_TOKEN
请求包结构体为(如果非必须的字段未指定,则不更新该字段之前的设置值):
{
}
"id": 7404695801683274054,
"name": "IT",
"parentid": 1,
"order": 1
参数说明:
参数
必须
说明
access_token 是
调用接口凭证
id
name
是
否
部门 id
更新的部门名称。长度限制为 1~64 个字节,字
符不能包括\:*?"<>|。修改部门名称时指定该参
参数
必须
说明
数
父部门 id。id 为 1 可表示根部门
在父部门中的次序值。order 值小的排序靠前。
否
否
parentid
order
权限说明
系统应用须拥有指定部门的管理权限。
2.1.2.2 返回结果
{
}
"errcode": 0,
"errmsg": "updated"
参数
说明
errcode
返回码
errmsg
对返回码的文本描述内容
2.1.3 删除部门
2.1.3.1 请求说明
HTTPS 请求方式: GET
请求地址:
https://api.exmail.qq.com/cgi-bin/department/delete?access_token=ACCESS_TOKEN&id
=ID
参数说明:
参数
必须
说明
access_token 是
调用接口凭证
id
是
部门 id。(注:不能删除根部门;不能删除含有子
部门、成员的部门)
权限说明
系统应用须拥有指定部门的管理权限。
2.1.3.2 返回结果
{
}
"errcode": 0,
"errmsg": "deleted"
参数
说明
errcode
返回码
errmsg
对返回码的文本描述内容
2.1.4 获取部门列表
2.1.4.1 请求说明
HTTPS 请求方式: GET
请求地址: https://api.exmail.qq.com/cgi-bin/department/list?access_token=ACCESS_T
OKEN&id=ID
参数说明:
参数
必须
说明
access_token
是
调用接口凭证
id
否
部门 id。获取指定部门及其下的子部门。id 为 1 时
可获取根部门下的子部门。
权限说明
系统应用须拥有指定部门的查看权限。