获取分组列表

接口概述

• 功能：获取分组列表
• 请求方式：GET
• 请求地址：/api/contacts/teams/{team_id}/groups

请求参数

参数名	类型	必须	参数位置	描述	示例值
team_id	integer	是	uri	团队ID	30
page	integer	否	body	当前页码	1
per_page	integer	否	body	每页显示条数	10
remote_ids	array	否	body	-------	1
parent_id	integer	否	body	上级ID

响应参数

参数名	类型	描述
list	array[object]	分组列表
list[_].id	integer	分组ID
list[_].team_id	integer	团队ID
list[_].parent_id	integer	上级ID
list[_].source	integer
list[_].remote_id	string
list[_].name	string	分组名称
list[_].full_name	string
list[_].order	integer
list[_].is_valid	bool
list[_].created_at	datetime	修改时间
list[_].upd_at	datetime	修改时间
total	integer	总条数

响应示例

• 请求成功

{    "code": "OK",    "error": {        "type": ""    },    "data": {        "list": [            {                "id": 6033,                "team_id": 53,                "parent_id": 6031,                "source": 2,                "remote_id": "1202",                "name": "测试批量2",                "full_name": "",                "order": 1002,                "is_valid": true,                "created_at": "2021-06-24T18:24:45+08:00",                "upd_at": "2021-06-24T18:24:45+08:00"            },            {                "id": 6031,                "team_id": 53,                "parent_id": 0,                "source": 2,                "remote_id": "",                "name": "测试子组",                "full_name": "测试组/测试子组",                "order": 0,                "is_valid": true,                "created_at": "2021-06-24T17:59:03+08:00",                "updated_at": "2021-06-24T17:59:"            }        ],        "total": 2    },    "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	参数校验不通过