通讯录对接文档
更新时间: 2020-01-02
1.应用方获取通讯录部门信息
服务器访问方式:http协议GET 及POST方法
Json协议
-
- 接口地址
http://v1.chaoxing.com/inter/getChildDepts?access_token=&openid=&expires_time=&state= &appid=&pid=
参数名 |
参数说明 |
access_token |
【必传】平台给予的授权接口调用凭证(上述接口中获取到直接原封传输即可,但传递过程中必须进行URLEncoder转译) |
openid |
【必传】用户唯一标识(上述接口中获取到直接原封传输即可) |
state |
【必传】上述接口中获取到的state参数直接原封传输即可 |
expires_time |
【必传】平台给予的凭证超时时间点(上述接口中获取到直接原封传输即可) |
appid |
【必传】平台给予的授权应用的唯一标识 |
pid |
【非必传】部门父id(为空时默认查询单位下第一层的部门信息) |
-
- 返回信息说明
正确返回:
{
"status":true为获取成功,
"msg": "查询成功",
"depts": [{
"category": "Z01", //部门排序权值
"children": [],
"createtime": 1553584970842, //创建时间
"creatorid": 22329933, //部门创建人唯一标识
"custom": 0, //0单位通讯录 1自建 2自建根部门
"fid": 68920, //所属单位fid
"id": 316711, //部门唯一标识
"level": 1, //部门所属层级
"name": "默认部门", //部门名称
"open": 0, //是否是公开部门,1为是,0为否,如果是,那么这个 部门本单位所有人可见
"pid": -1, //部门父级唯一id
"ppath": "00000001KOF", //部门路径
"privilege": 0, //是否是特权部门,1为是,0为否,如果是,那么这个 部门下人可以看到所有部门
"rootdept": 316711, //所在根部门唯一标识
"usercount": 1 //部门下的用户数
}]
}
遇错返回:
{
"status": false为获取失败,
"msg": 错误说明
}
2.应用方创建通讯录部门信息
- 通讯方式
服务器访问方式:http协议GET 及POST方法
-
- 协议格式
Json协议
-
- 接口地址
http://v1.chaoxing.com/inter/createDept?access_token=&openid=&expires_time=&state= &appid=&name=&pid=&privilege=&open=
参数名 |
参数说明 |
access_token |
【必传】平台给予的授权接口调用凭证(上述接口中获取到直接原封传输即可,但传递过程中必须进行URLEncoder转译) |
openid |
【必传】用户唯一标识(上述接口中获取到直接原封传输即可) |
state |
【必传】上述接口中获取到的state参数直接原封传输即可 |
expires_time |
【必传】平台给予的凭证超时时间点(上述接口中获取到直接原封传输即可) |
appid |
【必传】平台给予的授权应用的唯一标识 |
name |
【必传】应用名称(get请求要进行URLEncoder编码) |
pid |
【非必传】此部门的上级部门的id,如果要建的这个部门就是根部门,那么此参数传-1或不传 |
privilege |
【非必传】是否是特权部门。默认为0 ( 1为是,0为否,如果是,那么这个部门下人可以看到所有部门) |
open |
【非必传】是否是公开部门。默认为0(1为是,0为否,如果是那么这个部门本单位所有人可见) |
-
- 返回信息说明
正确返回:
{
"status":true成功,
"msg": "创建成功",
}
遇错返回:
{
"status": false失败,
"msg": 错误说明
}
3.应用方修改通讯录部门信息
- 通讯方式
服务器访问方式:http协议GET 及POST方法
-
- 协议格式
Json协议
-
- 接口地址
http://v1.chaoxing.com/inter/updateDept?access_token=&openid=&expires_time=&state= &appid=&name=&deptid=&category=&privilege=&open=
参数名 |
参数说明 |
access_token |
【必传】平台给予的授权接口调用凭证(上述接口中获取到直接原封传输即可,但传递过程中必须进行URLEncoder转译) |
openid |
【必传】用户唯一标识(上述接口中获取到直接原封传输即可) |
state |
【必传】上述接口中获取到的state参数直接原封传输即可 |
expires_time |
【必传】平台给予的凭证超时时间点(上述接口中获取到直接原封传输即可) |
appid |
【必传】平台给予的授权应用的唯一标识 |
name |
【必传】应用名称(get请求要进行URLEncoder编码) |
deptid |
【必传】要修改的部门的id |
category |
【非必传】根据英文字母和数字的排序字段 |
privilege |
【非必传】是否是特权部门。默认为0 ( 1为是,0为否,如果是,那么这个部门下人可以看到所有部门) |
open |
【非必传】是否是公开部门。默认为0(1为是,0为否,如果是那么这个部门本单位所有人可见) |
-
- 返回信息说明
正确返回:
{
"status":true成功,
"msg": "修改成功",
}
遇错返回:
{
"status": false失败,
"msg": 错误说明
}
4.应用方删除通讯录部门信息
- 通讯方式
服务器访问方式:http协议GET 及POST方法
-
- 协议格式
Json协议
-
- 接口地址
http://v1.chaoxing.com/inter/updateDept?access_token=&openid=&expires_time=&state= &appid=&deptid=
参数名 |
参数说明 |
access_token |
【必传】平台给予的授权接口调用凭证(上述接口中获取到直接原封传输即可,但传递过程中必须进行URLEncoder转译) |
openid |
【必传】用户唯一标识(上述接口中获取到直接原封传输即可) |
state |
【必传】上述接口中获取到的state参数直接原封传输即可 |
expires_time |
【必传】平台给予的凭证超时时间点(上述接口中获取到直接原封传输即可) |
appid |
【必传】平台给予的授权应用的唯一标识 |
deptid |
【必传】要删除的部门的id |
-
- 返回信息说明
正确返回:
{
"status":true成功,
"msg": "删除成功",
}
遇错返回:
{
"status": false失败,
"msg": 错误说明
}