获取训练营pro学员列表
拥有此API的权限集 |
---|
用户管理-查询 |
请求方式及url
- 请求方式:
POST
- 请求头:
Content-Type:application/json
- 接口地址:
https://api.xiaoe-tech.com/xe.course.camp_pro.user.list/1.0.0
- 频率限制:
10秒2000次
在线调试工具
请求
响应
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
access_token | 是 | string | 专属token |
course_id | 是 | string | 新课程、训练营pro 资源id |
page | 是 | string | 页码 |
page_size | 是 | string | 页大小 |
is_encryption_phone | 是 | string | 手机号是否加密,默认为 true 加密 |
请求示例
{
"access_token":"xxx",
"course_id":"course_xxx",
"page":1,
"page_size":10
}
返回参数
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码:0-成功,其他为错误 |
msg | string | 对返回码的文本描述内容 |
data.user_list | array | 学员列表数据 |
data.course_id | string | 资源ID |
data.total | int | 列表总数 |
data.user_list
学员列表数据
参数名 | 类型 | 说明 |
---|---|---|
user_id | string | 用户 id |
wx_nickname | string | 微信昵称 |
wx_avatar | string | 微信头像 |
phone | string | 手机号(保密状态) |
is_seal | int | 是否封禁或者拉黑(0: 否 1:是) |
comment_name | string | 备注名 |
end_at_str | string | 到期时间 |
auth_state | int | 权益状态(0:无权益 1:有权益) |
finish_count | int | 任务完成数 |
finish_rate | string | 任务完成率 |
required_course_finish_rate | string | 必修任务完成率 |
progress | string | 课程完成状态 |
subscribe_source | string | 加入来源 |
subscribe_time | string | 加入时间 |
返回示例
{
"code": 0,
"msg": "success",
"data": {
"course_id": "course_xxx",
"total": 1,
"user_list": [
{
"auth_state": 1,
"collection_info": [],
"comment_name": "",
"end_at_str": "长期有效",
"finish_count": 0,
"finish_rate": "0.0%",
"is_seal": 0,
"phone": "136****7543",
"progress": "未开始",
"required_course_finish_rate": "0.0%",
"subscribe_source": "购买",
"subscribe_time": "2023-08-25 19:57:08",
"user_id": "u_xxx",
"wx_avatar": "http://xxx.png",
"wx_nickname": "Ling_"
}
]
}
}