功能说明:通讯录变更同步接口是一种增量同步接口,每一次用户修改或者部门修改,都会有一个新的版本号,一个版本号包含N条被修改的数据。该接口只会返回通过json传过来的version版本的修改的消息,如果当前版本被迭代覆盖,没有修改的信息,会返回一个空的List
请求方式:GET(HTTPS)
请求地址:https://qwif.do1.com.cn/qwcgi/api/userAPI/getUserList.do?token=token&corpId=corpId
{ "currentPage":1, "version":1 }
参数 |
说明 |
类型 |
是否必须 |
备注 |
---|---|---|---|---|
token |
用于验证 |
String |
是 |
|
corpId |
公司唯一标识 |
String |
是 |
|
currentPage |
当前版本的页数 |
String |
是 |
|
version |
当前版本 |
String |
是 |
首次调用时,version填写0,currentPage填写1,表示初次调用该接口。 开发 者需要存储接口返回的version和currentPage。 版本号是0时,currentPage是1时,会返回1000条用户数据和全部的部门数据。 当version号是0,页数大于1时,只会 返回用户数据。 |
ApiGetUserListVO vo = new ApiGetUserListVO(); //当前版本的页数 vo.setCurrentPage("1"); /* 当前版本 首次调用时,version填写0,currentPage填写1,表示初次调用该接口。 开发 者需要存储接口返回的version和currentPage。 版本号是0时,currentPage是1时,会返回1000条用户数据和全部的部门数据。 当version号是0,页数大于1时,只会 返回用户数据。 */ vo.setVersion("0"); UserApi api = QwSdkUtil.getInter(UserApi.class); ApiGetUserListResultVO result = api.getUserList(QwSdkUtil.getCacheToken(),vo); System.out.println(JSONUtil.stringify(result));
{ "code":"0", "desc":"成功", "data":{ "currentPage":10, "totalPages":1, "version":1, "list":[ { "interfaceUser":{ "departmentId":"27ee14f0-c035-4b41-ba03-6a94c5ddfsdf", "email":"", "followTime": "2017-10-26 10:06:10", "gender":"", "headPic":"0", "mobile":"18899750798", "name":"testst", "organId":"b17efb43-292e-4cc9-ac5d-0b46bcdfdsf", "position":"", "qq":"", "tel":"", "userId":"d18cb5fc01b6430bab5ec85fdsfsdaf", "userStatus":"0", "weixinNum":"", "wxUserId":"testst", "birthday":"1999-10-10", "entryTime":"2018-12-12" }, "type":"1" }, { "interfaceUser":{ "departmentId":"4d42a76c-a270-4292-8f67-3bebfdscvcc,03bf77bb-4a96-4c1f-9525-d30e34a005a6", "email":"", "followTime": "2017-10-26 10:06:10", "gender":"2", "headPic":"0", "mobile":"18899750776", "name":"testlyx", "organId":"b17efb43-292e-4cc9-ac5d-0b46fdsfdsf", "position":"", "qq":"", "tel":"", "userId":"76f595a5c38b491283d5bfdsafsdf", "userStatus":"0", "weixinNum":"", "wxUserId":"877946153", "birthday":"1999-10-10", "entryTime":"2018-12-12" }, "type":"2" }, { "interfaceUser":{ "departmentId":"79a93ddb-cf77-4065-a85f-d7dvvbccc", "email":"", "followTime": "2017-10-26 10:06:10", "gender":"1", "headPic":"0", "mobile":"13560496896", "name":"test555", "organId":"b17efb43-292e-4cc9-ac5d-0b46dfsdfsd", "position":"", "qq":"", "tel":"", "userId":"7a3b26793aed49249a6800dfsdfsdf", "userStatus":"0", "weixinNum":"sy-cheng", "wxUserId":"chengsy", "birthday":"1999-10-10", "entryTime":"2018-12-12" }, "type":"3" }, { "type":"4", "userId":"59a67ab466274bcfa7e530dsfdsfd" }, { "type":"5", "userId":"51ad401ec1a64c6296035gfdgdfgf" }, { "interfaceDept":{ "departmentName":"test233", "deptFullName":"test213->test233", "id":"a80f03db-b7ee-494b-bcf5-6b226483fsdfsd", "orgId":"b17efb43-292e-4cc9-ac5d-0b46bc4rtret", "parentDepart":"d629b81e-68ee-4072-b123123", "permission":"2", "showOrder":1, "wxId":"200", "wxParentid":"174" }, "type":"6" }, { "interfaceDept":{ "departmentName":"test223", "deptFullName":"test213->test223", "id":"26918a26-440d-4a42-a2b6-cfd8d1a3ce1c", "orgId":"b17efb43-292e-4cc9-ac5d-0b46bdfdsfds", "parentDepart":"d629b81e-68ee-4072-b93c-02502a84c31b", "permission":"2", "showOrder":2, "wxId":"177", "wxParentid":"174" }, "type":"7" }, { "deId":"14e995bf-56f7-4df6-9254-a04ea74150a5", "type":"8" } ], "orgVesionRecent":11 } }
参数 |
说明 |
---|---|
currentPage |
当前版本的当前页 |
version |
当前版本号 |
totalPages |
当前版本的总页数 |
orgVesionRecent |
最新版本号 |
list参数 |
说明 |
---|---|
type |
1.用户新增(第一次调用接口,version为 0时,type全是1) 2.用户修改 3.用户复职 4.用户离职 5.用户删除 6.部门新增(第一次调用接口,version为 0时,type全是6) 7.部门修改 8.部门删除 |
interfaceUser |
用户信息,当type为1,2,3时设置 |
userId |
用户ID,当type为4,5时设置 |
interfaceDept |
部门信息,当type为6,7时设置 |
deId |
部门ID,当type为8时设置 |
参数 | 说明 |
---|---|
userId |
用户ID |
name |
用户名称 |
departmentId |
部门ID |
position |
职位 |
mobile |
手机号 |
gender |
性别(1,男;2,女) |
tel |
电话 |
email |
|
qq |
|
weixinNum |
微信号 |
organId |
组织编号 |
headPic |
用户头像 |
userStatus |
用户状态 |
followTime |
关注时间 |
wxUserId |
用户微信账号,发消息的目标对象使用此id |
birthday |
阳历生日 格式:yyyy-MM-dd |
entryTime |
入职时间 格式:yyyy-MM-dd |
interfaceDept参数 |
说明 |
---|---|
id |
部门ID |
departmentName |
部门名称 |
parentDepart |
父部门编号(顶级部门此字段为空) |
orgId |
组织编号 |
deptFullName |
部门全称“->”为层级分隔符 |
showOrder |
显示顺序 |
wxId |
微信编号 |
wxParentid |
微信父部门编号 |
permission |
可见权限: 1:全公司(可以看到全公司通讯录) 2:仅本部门(可以看到同一部门下所有子组织通讯录) 3:仅子部门(可以看到所在子部门及下属子组织通讯录) |