获取联系人列表
接口概述#
- 功能：获取联系人列表
- 请求方式：GET
- 请求地址：/api/contact/
请求参数#
| 参数名 | 类型 | 必须 | 参数位置 | 描述 | 示例值 |
|---|---|---|---|---|---|
| group_id | integer | 否 | queryString | 分组ID（为0时获取所有联系人） | 1 |
| owner_user_id | integer | 是 | queryString | 团队ID | 60000022655 |
| owner_user_type | integer | 是 | queryString | 分组所属帐号类型 1=团队，2=个人用户 | 1 |
| include_internal | bool | 否 | queryString | 是否包含团队通讯录成员 | true |
| page | integer | 否 | queryString | 当前页码 | 1 |
| per_page | integer | 否 | queryString | 每页显示条数 | 10 |
响应参数#
| 参数名 | 类型 | 描述 |
|---|---|---|
| total | integer | 联系人数量 |
| list | array[object] | 联系人列表 |
| list[_].id | integer | 联系人ID |
响应示例#
- 请求成功
{ "code": "OK", "error": { "type": "" }, "data": { "total": 4, "list": [ { "id": 200258, "owner_user_id": 60002245150, "name": "Sen@Shenzhen", "gender": null, "born": "", "country": "中国", "province": "北京", "city": "北京", "district": "东城区", "education": null, "industry": "", "industry_class": "", "identity": "", "career": "", "email": "", "phone": "185****0913", "status": 0, "creator_user_id": 50000012518, "created_at": "2022-04-28 14:50:42", "updated_at": "2022-04-28 14:51:45", "avatar": "", "role": 0, "group_id": 0 }, { "id": 200259, "owner_user_id": 60002245150, "name": "Sen@Hangzhou", "gender": null, "born": "", "country": "", "province": "", "city": "", "district": "", "education": null, "industry": "", "industry_class": "", "identity": "", "career": "", "email": "", "phone": "137****1760", "status": 0, "creator_user_id": 50000012518, "created_at": "2022-04-28 14:50:56", "updated_at": "2022-04-28 14:50:56", "avatar": "", "role": 0, "group_id": 0 } ] }, "request_id": "cb4e532d-1be0-42fd-983e-f8c69eba943f"}- 请求失败
{ "code": "PermissionDenied", "error": { "type": "claim_error" }, "data": {}, "request_id": "5ffeb778-6046-42b2-b6f7-0c79ebc82288"}错误码#
| error.type 错误代码 | 错误描述 |
|---|---|
| claim_error | 无权限 |
| invalid_argument | 参数校验不通过 |