跳到主要内容

按分组获取成员列表

重要提示

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

接口概述

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

请求参数

参数名类型必须参数位置描述示例值
team_idintegeruri团队ID30
group_idintegeruri分组ID30
pageintegerqueryString当前页码1
per_pageintegerqueryString每页显示条数10
rolesarrayqueryString通讯录管理角色(与团队角色不同)[1,2,3]

响应参数

参数名类型描述
totalinteger总条数
listarray[object]成员列表
list[_].user_idinteger(uint64)成员编辑者ID
list[_].respondent_idinteger(uint64)成员回答者ID
list[_].namestring成员昵称
list[_].avatarstring成员头像
list[_].roleinteger通讯录管理角色
list[_].group_full_namestring所在组完整路径
list[_].group_idint所在组ID

响应示例

{
"code": "OK",
"error": {
"type": ""
},
"data": {
"total":1,
"list": [
{
"user_id": 60000208205,
"respondent_id": 60000208206,
"name": "张三",
"avatar": "https://wesurvey.com/xxx/xxx.png",
"role": 0,
"group_full_name":"某团队/一级组/二级组/三级组",
"group_id":67
}
]
},
"request_id": "d84e884b-3bc5-419d-9cc0-d6d6d14e68b6"
}
  • 请求失败
{
"code": "PermissionDenied",
"error": {
"type": "claim_error"
},
"data": {},
"request_id": "5ffeb778-6046-42b2-b6f7-0c79ebc82288"
}

错误码

error.type 错误代码错误描述
invalid_argument参数错误
claim_error无权限