获取云端联系人列表
1.接口说明
搜索联系人列表
2.接口URL
https://open.e.189.cn/api/oauth2/pim/searchLinkman.do
3.支持格式
json
4.HTTP请求方式
POST
5.请求参数
| 字段标识 | 说明 | 数据类型 | 长度(字节) | 可空 |
|---|---|---|---|---|
| clientId | 申请应用时分配的appId | String | 60 | N |
| timeStamp | 时间戳，毫秒 | Long | 18 | N |
| accessToken | 授权获得的accesstoken | String | 100 | N |
| clientIp | 客户端的ip | String | 60 | Y |
| version | 版本号 | String | 10 | N |
| pageNo | 页码，默认1 | Integer | Y | |
| pageSize | 每页数量，默认20 | Integer | Y | |
| groupUuid | 用户组Uuid | String | Y | |
| sortName | 排序方式，name:按联系人姓名排序; pinyinAll:按全拼排序; createTime：按创建时间排序;默认为pinyinAll | String | Y | |
| sortOrder | 排序方式，desc:降序;asc:升序 | String | Y | |
| type | 用户类型，all：所有联系人；hasPhone ：手机联系人; hasEmail ：邮箱联系人；默认为all | String | Y | |
| hasVcard | 是否包含vcard，true：返回Vcard对象信息，false：不返回；默认为false | boolean | Y | |
| keyword | 关键字，支持姓名、号码、邮箱查询 | String | Y | |
| pinyinFirst | 首字母，数字填“#” | String | Y | |
| callback | Json回调函数 | String | Y |
6.请求样例
POST https://open.e.189.cn/api/oauth2/pim/searchLinkman.do? clientId=13&timeStamp=3423565432462523&accessToken=e2ecaf99ae2343039f6945d8d5c61144 &clientIp=1.1.1.1&version=v1.1& pageNo=&pageSize=&groupUuid=&sortName=&sortOrder=& type=&hasVcard=&keyword=&pinyinFirst=&callback=
7.返回参数
| 字段标识 | 说明 | 数据类型 | 长度(字节) | 可空 |
|---|---|---|---|---|
| rows | 用户信息列表 | List<Linkman> | Y | |
| total | 元素总数，匹配的元素总数 | Long | Y | |
| versionNo | 云通讯录版本号，服务端特定账号的联系人数据最后的更新版本号 | Integer | Y | |
| versionTime | 云通讯录版本号最后修改时间，时间格式：yyyy-MM-dd HH:mm:ss | Date | Y | |
| msg | 错误返回信息，UTF-8编码。 | String | 256 | Y |
| result | 0 表示获取成功，小于0表示获取失败，-100表示用户未登录或登录状态已过期 | Integer | 4 | N |
8.返回样例
正确返回示例：
Content-type: text/html; charset=utf-8
{
"msg": "成功",
"result": 0,
"rows": [{
"comeFrom": 0,
"createTime": "2014-11-13 00:00:00",
"email": "test@189.cn",
"groupMap": null,
"iconUrl": "",
"matchedTagValue": null,
"mobile": "18912345678",
"modifyTime": "2014-11-13 00:00:00",
"name": "张三",
"pinyinAll": "zhangsan",
"pinyinSimple": "zhs",
"userId": 0,
"uuid": "bea9d567-bd3c-473d-9dcb-32edcd91179a",
"vcard": null
}],
"total": 1,
"versionNo": 1,
"versionTime": "2014-11-13 00:00:00"
}
错误返回示例：
Content-type: text/html; charset=utf-8
{
"result": -1,
"msg": "获取信息失败"
}
9.其它
附录：Linkman
|
字段标识 |
数据类型 | 说明 |
|---|---|---|
| uuid | String | 联系人UUID |
| userId | Long | 用户Id |
| iconUrl | String | 头像，主要用于显示 |
| name | String | 姓名，主要用于显示 |
| pinyinSimple | String | 拼音简写 |
| pinyinAll | String | 全拼 |
| mobile | String | 常用手机，主要用于显示 |
| String | 常用邮箱，主要用于显示 | |
| matchedTagValue | String | 匹配到的标签值，主要用于显示 |
| Vcard | Vcard | Vcard |
| createTime | Date | 创建时间 |
| modifyTime | Date | 修改时间 |
使用范例