获取分组列表

接口概述

• 功能：获取分组列表
• 请求方式：GET
• 请求地址：/api/contact/groups?appid={appid}&access_token={access_token}&owner_user_id={60000022655}&owner_user_type={1}

请求参数

参数名	类型	必须	参数位置	描述	示例值
owner_user_id	integer	是	queryString	团队ID	60000022655
owner_user_type	integer	是	queryString	分组所属帐号类型 1=团队，2=个人用户	1
include_internal	bool	否	queryString	是否包含团队通讯录成员	true
root_id	integer	否	queryString	上级ID	1

响应参数

参数名	类型	描述
groups_tree	array[object]	分组列表
groups_tree[_].id	integer	分组ID
groups_tree[_].group_id	integer	分组ID（id)
groups_tree[_].user_id	integer	创建人用户id
groups_tree[_].order	integer	排序（数值越大越靠后）
groups_tree[_].internal_group_id	integer	该分组存在于团队通讯录中的id（为0表示不存在于团队通讯录）
groups_tree[_].name	string	分组名称
groups_tree[_].full_name	string	分组名称（包含上级分组名称）
groups_tree[_].children	array[object]	子级分组
groups_tree[_].user_cnt	interge	该分组下联系人的数量

响应示例

• 请求成功

{
    "code": "OK",
    "error": {
        "type": ""
    },
    "data": {
    "groups_tree": [
      {
        "id": 101004,
        "group_id": 101004,
        "user_id": 0,
        "order": 0,
        "parent_id": 0,
        "internal_group_id": 0,
        "name": "默认分组",
        "full_name": "默认分组",
        "children": [],
        "user_cnt": 4
      },
      {
        "id": 2789447,
        "group_id": 2789447,
        "user_id": 0,
        "order": 0,
        "parent_id": 0,
        "internal_group_id": 0,
        "name": "东三省",
        "full_name": "东三省",
        "children": [],
        "user_cnt": 1
      }
    ]
  },
    "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	参数校验不通过