1. 获取团队成员分页列表(按组织机构)
获取指定团队成员按组织机构的分页列表数据。你可以通过指定参数来获取递归(包含当前和子组织节点的成员)/非递归(仅当前组织节点)的成员列表数据。
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。
1.1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/platform/team/member/org/paged |
请求方法 | GET |
请求数据类型 | URL参数 |
响应数据类型 | JSON |
1.2. 请求数据
1.2.1. 请求头(request-header)
请求头除了默认的参数还需要添加如下请求头参数:
字段 | 描述 |
---|---|
auth-token | 接口访问凭据,你可以通过平台下发的appid和secret获取凭据 |
1.2.2. 请求参数(request-parameter)
字段 | 是否必传 | 描述 |
---|---|---|
teamId | 是 | 团队ID |
orgId | 是 | 组织机构ID |
includeSubOrg | 否 | 是否递归查询,默认(不传此字段)不递归查询。true = 递归查询,false = 不递归查询 |
pageNum | 是 | 页码,整数,从1开始 |
pageSize | 是 | 分页数据量,取值为1到100之间的整数 |
参数请求示例:
http://api.example.com/xxx?key=value
1.3. 响应数据
响应数据中 code, message, data 为默认字段,所有字段如下表所示:
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
code | number | 是 | 返回码 |
message | string | 是 | 返回消息 |
data | object | 是 | 返回数据 |
total | number | 是 | 总数据量 |
hasNext | boolean | 是 | 是否有下一页数据。true = 是; false = 否 |
pages | number | 是 | 总分页数 |
list | array | 是 | 当前分页载荷 |
userId | string | 是 | 用户ID |
memberId | string | 是 | 成员ID |
username | string | 是 | 用户名 |
phone | string | 是 | 手机号 |
avatar | string | 是 | 用户头像(有效时间20分钟) |
memberName | string | 是 | 团队成员名(用户在不同团队的团队成员名可以不同) |
orgId | string | 是 | 组织机构ID |
roleIds | array | 是 | 角色ID列表 |
响应数据结构如下所示:
{
"code" : 0,
"message" : "",
"data" : {
"total": 100,
"hasNext": true,
"pages": 10,
"list": [{
"userId": "XXX",
"memberId": "XXX",
"username": "XXX",
"phone": "XXX",
"avatar": "XXX",
"memberName": "XXX",
"orgId": "XXX",
"roleIds": ["XXX"]
}]
}
}
1.4. 错误码
当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。