# 查询好友列表
```
POST https://qw-openapi-tx.dustess.com/open-integration-api/friend/v1/queryPageList?accessToken=
```
**接口限制**：每分钟调用300次；
**请求header**
| 字段 | 值 |
| ------------ | ---------------- |
| Content-Type | application/json |
**Params:**
| 字段 | 类型 | 描述 | 是否必须 |
| ----------- | -------- | ----------- | -------- |
| accessToken | `String` | accessToken | true |
**请求参数**
| 请求参数名 | 类型 | 说明 | 是否必须 |
| -------------- | -------- | --------------------------------------------------------------------------- | -------- |
| uid | `String` | 员工编号 | false |
| externalUserId | `String` | 外部联系人id | false |
| unionId | `String` | unionId | false |
| startTime | `String` | 开始时间,格式：yyyy-mm-dd,不传默认查询最近90天的数据,查询最大时间跨度为90天） | false |
| endTime | `String` | 结束时间,格式：yyyy-mm-dd,不传默认查询最近90天的数据,查询最大时间跨度为90天 | false |
| page | `Int` | 页码,不传默认第一页 | false |
| pageSize | `Int` | 每页显示记录数（单页最大500），不传默认500 | false |
**请求参数示例**
`json` - Request-Example:
```json
{
"uid": "3638",
"externalUserId": "",
"unionId": "",
"startTime": "",
"endTime": "",
"page": 1,
"pageSize": 500
}
```
**成功响应**
| 响应参数名 | 类型 | 说明 |
| ------------------------------------------ | ---------- | ----------------------------------------------------------------------- |
| code | `Int` | 响应码，0:成功 |
| msg | `String` | 消息提示 |
| success | `Bool` | 成功标识 |
| data | `Object` | 响应码 |
| data.count | `Int` | 查询数量 |
| data.list | `Object[]` | 好友列表 |
| data.list.id | `Int` | 好友关系id |
| data.list.userId | `String` | 员工id |
| data.list.qwUserId | `String` | 企微员工id |
| data.list.tags | `String[]` | 好友标签id列表 |
| data.list.ruleTags | `String[]` | 规则组标签id列表 |
| data.list.remark | `String` | 好友备注 |
| data.list.description | `String` | 好友描述 |
| data.list.corpRemark | `String` | 企业备注 |
| data.list.mobiles | `String[]` | 手机号列表 |
| data.list.status | `String` | 好友状态 1:正常 2:被外部联系人删除 3:已删除外部联系人 |
| data.list.deleteTs | `Int` | 删除时间戳，当状态为3时返回 |
| data.list.addWayId | `Int` | 添加方式id |
| data.list.addWayName | `String` | 添加方式名称 |
| data.list.addTs | `Int` | 添加好友时间戳 |
| data.list.sourceId | `String` | 来源id |
| data.list.contact | `Object` | 关联联系人 |
| data.list.contact.id | `String` | 联系人ID |
| data.list.contact.remark | `String` | 联系人备注 |
| data.list.contact.contactBindTs | `Int` | 好友联系人绑定时间戳 |
| data.list.externalContact | `Object` | 外部联系人 |
| data.list.externalContact.qwExternalUserID | `String` | 外部联系人ID |
| data.list.externalContact.type | `Int` | 外部联系人类型 1-个微，2-企微 |
| data.list.externalContact.name | `String` | 外部联系人昵称 |
| data.list.externalContact.unionID | `String` | unionId |
| data.list.externalContact.corpName | `String` | 非备注客户企业名称 (如: 企微联系人企业名称) |
| data.list.qwExternalUserState | `String` | 好友渠道标识，如：通过投放活码、获客助手成为好友时即可获取到唯一state值 |
**成功响应示例**
```json
{
"success": true,
"code": 0,
"msg": "",
"data": {
"count": 3,
"list": [{
"id": 90867628012208129,
"contact": {
"id": "",
"remark": "",
"contactBindTs": 0
},
"userId": "3638",
"externalContact": {
"qwExternalUserID": "wmMXXWDQAAdt9mjsjGHPcqywteirWW7A",
"type": 2,
"name": "改称?%20tn!['[\u0026{~?and名字特别长",
"unionID": "owx_AwNTIfnYgJecZc2xD0ATrWSY",
"corpName": ""
},
"tags": ["etMXXWDQAApi3SNpHonihvOE0JbhAeyg", "etMXXWDQAAagYrERBi3_2HQ7resBZR6w", "etMXXWDQAApH_r3oQc6FXJExesVH0KpA"],
"ruleTags": [],
"remark": "龚仕诚2备注",
"description": "好友测试描述",
"mobiles": ["14726134593"],
"status": 1,
"addWayId": 0,
"addWayName": "未知来源",
"addTs": 1670320527,
"sourceId": ""
}, {
"id": 90867270380683265,
"contact": {
"id": "26646f2f-6fbc-11ed-868d-62bf080acb5b",
"remark": "移除后",
"contactBindTs": 1670320447
},
"userId": "3638",
"externalContact": {
"qwExternalUserID": "wmMXXWDQAA9qAfAMwOWsmEPnJlYmG3Lg",
"type": 2,
"name": "有说有笑",
"unionID": "owx_AwADUU_Fv8LU-pKSX6yqNkJY",
"corpName": ""
},
"tags": [],
"ruleTags": [],
"remark": "有说有笑",
"description": "",
"mobiles": null,
"status": 1,
"addWayId": 0,
"addWayName": "未知来源",
"addTs": 1670320439,
"sourceId": ""
}, {
"id": 90859442127503361,
"contact": {
"id": "edd3930c-d584-11eb-b40e-9a387f062700",
"remark": "low",
"contactBindTs": 1670318582
},
"userId": "3638",
"externalContact": {
"qwExternalUserID": "wmMXXWDQAA0OGWok5fthGXcuB1RF0yvA",
"type": 2,
"name": "silence",
"unionID": "owx_AwIOMYl5ncOxX-uvUoMjBQps",
"corpName": ""
},
"tags": ["etMXXWDQAARwliWT5BjXRYGFioWQ3N5Q", "etMXXWDQAA1JMOJHRQeEoW1X81watBQQ", "etMXXWDQAA0xg95Sn8YAd9rdpFjNp2dw", "etMXXWDQAA3HQRP2z6kjNj6abyAiIAOw", "etMXXWDQAAj4lkATC5vi7feQNFJ-JY2A", "etMXXWDQAAzjqfUycyQt5hTZGGowFaCw", "etMXXWDQAAAY6yFRMuz1wb4IN5-jGttQ"],
"ruleTags": [],
"remark": "silence",
"description": "",
"mobiles": null,
"status": 1,
"addWayId": 0,
"addWayName": "未知来源",
"addTs": 1670318575,
"sourceId": "00101f"
}]
}
}
```
**错误响应示例**
```json
{
"success": false,
"code": 10001,
"msg": "system unknown error",
"data": {
"count": 0,
"list": []
}
}
```