Skip to main content
Version: latest

获取分组列表

重要提示

该功能为 尊享版 付费功能,如未升级,请先 升级 后再使用

接口概述#

  • 功能:获取分组列表
  • 请求方式:GET
  • 请求地址:/api/contacts/teams/{team_id}/groups?appid={appid}&access_token={access_token}&page={1}&per_page={10}

请求参数#

参数名类型必须参数位置描述示例值
team_idintegeruri团队ID30
pageintegerquerySring当前页码1
per_pageintegerquerySring每页显示条数10
remote_idsarrayquerySring-------1
parent_idintegerquerySring上级ID

响应参数#

参数名类型描述
listarray[object]分组列表
list[_].idinteger分组ID
list[_].team_idinteger团队ID
list[_].parent_idinteger上级ID
list[_].sourceinteger
list[_].remote_idstring
list[_].namestring分组名称
list[_].full_namestring
list[_].orderinteger
list[_].is_validbool
list[_].created_atdatetime修改时间
list[_].upd_atdatetime修改时间
totalinteger总条数

响应示例#

  • 请求成功
{    "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参数校验不通过