功能描述
用于查询指定群组的成员列表,支持按成员类型过滤和游标分页。
请求
请求示例
GET /api/v1/group/{LibraryId}/{GroupId}/member?access_token={AccessToken}&member_type={MemberType}&marker={Marker}&limit={Limit}
请求参数
请求参数 | 描述 | 类型 | 是否必选 |
LibraryId | 媒体库 ID | String | 是 |
GroupId | 群组 ID | String | 是 |
AccessToken | 访问令牌 | String | 是 |
MemberType | 过滤成员类型,取值: user / group;不传/空字符串则同时返回两类 | String | 否 |
Marker | 游标,不透明字符串,首次请求不传,后续原样回传上次响应的 nextMarker | String | 否 |
Limit | 每页数量,默认 20,最大 100,控制 groups + users 条数之和的上限 | Integer | 否 |
请求体
无
响应
响应码
获取成功,返回 HTTP 200 OK。
响应体
application/json
响应体示例:
{"nextMarker": "eyJzdGFnZSI6Imdyb3VwIiwibGFzdElkIjoxMjN9","contents": {"groups": [{"libraryId": "smhxxx","groupId": "a1b2c3d4e5f67890a1b2c3d4e5f67890","groupName": "研发部","description": "研发团队","parentGroupId": "0f1e2d3c4b5a69780f1e2d3c4b5a6978","creator": "admin_001","creationTime": "2024-01-01T10:00:00.000Z","modifyTime": "2024-01-01T10:00:00.000Z"}],"users": [{"libraryId": "smhxxx","userId": "user_001","nickName": "张三","userName": "zhangsan","countryCode": "+86","phone": "13800138000","email": "zhangsan@example.com","role": "user","status": "enabled","avatar": "https://example.com/avatar.jpg","description": "描述信息","userData": {},"creator": "admin_001","creationTime": "2024-01-01T10:00:00.000Z","modifyTime": "2024-01-01T10:00:00.000Z"}]}}
响应体字段说明:
节点名称(关键字) | 描述 | 类型 |
nextMarker | 下一页游标,最后一页为空字符串 "" | String |
contents | 成员内容 | Object |
contents.groups | 子群组成员列表;元素字段与"查询群组详情"响应一致 | Array |
contents.users | 用户成员列表;元素字段与"查询用户详情"响应一致 | Array |
错误码
错误码 | HTTP 状态码 | 说明 |
InvalidParameter | 400 | marker 与本次 member_type 不匹配,请从第一页重新拉取 |
GroupNotFound | 404 | 群组不存在 |