按分组获取成员列表
接口概述
- 功能:按分组获取成员列表
- 请求方式:GET
- 请求地址:/api/contacts/teams/{team_id}/groups/{group_id}/users?appid={appid}&access_token={access_token}&page={1}&per_page={10}
请求参数
参数名 | 类型 | 必须 | 参数位置 | 描述 | 示例值 |
---|---|---|---|---|---|
team_id | integer | 是 | uri | 团队ID | 30 |
group_id | integer | 是 | uri | 分组ID | 30 |
page | integer | 否 | queryString | 当前页码 | 1 |
per_page | integer | 否 | queryString | 每页显示条数 | 10 |
roles | array | 否 | queryString | 通讯录管理角色(与团队角色不同) | [1,2,3] |
响应参数
参数名 | 类型 | 描述 |
---|---|---|
total | integer | 总条数 |
list | array[object] | 成员列表 |
list[_].user_id | integer(uint64) | 成员编辑者ID |
list[_].respondent_id | integer(uint64) | 成员回答者ID |
list[_].name | string | 成员昵称 |
list[_].avatar | string | 成员头像 |
list[_].role | integer | 通讯录管理角色 |
list[_].group_full_name | string | 所在组完整路径 |
list[_].group_id | int | 所在组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 | 无权限 |