查询课程列表
| 拥有此API的权限集 |
|---|
| 商品管理-查询 |
请求方式及url
- 请求方式：
POST - 请求头：
Content-Type:application/json - 接口地址：
https://api.xiaoe-tech.com/xe.course.course.list/1.0.0 - 频率限制：
10秒100次
在线调试工具
请求
响应
请求参数
| 参数名 | 必选 | 类型 | 说明 | |
|---|---|---|---|---|
| access_token | 是 | string | 专属token | |
| search_content | 否 | string | 课程名字模糊搜索 | '' |
| order_by | 否 | string | 是否需要根据创建时间排序（是：modify，否：''） | '' |
| order_type | 否 | int | 排序类型（1:降序，2：升序） | 1 |
| page_index | 否 | int | 当前页 | 1 |
| page_size | 否 | int | 每页条数（1~50条） | 10 |
| sale_status | 否 | int | 上架状态(-1：全部 0 ：下架 1：上架2：待上架) | -1 |
| created_source | 否 | int | 课程创建来源（0：全部，1：课程，2：圈子） | 1 |
| tags | 否 | array | 商品分组id数组 | [] |
请求示例
{
"access_token" : "",
"search_content" : "",
"order_by" : "modify",
"order_type" : 1,
"page_index" : 1,
"page_size" : 10,
"sale_status" : -1,
"tags":[
"10002",
"10003",
"10004"
],
"created_source" : 1
}
返回参数
| 参数名 | 类型 | 说明 | |
|---|---|---|---|
| code | 是 | int | 状态码，返回为0即响应成功 |
| msg | 是 | string | 请求结果描述，返回success即响应成功 |
| data | 是 | object | 请求结果 |
请求结果data
| 参数名 | 类型 | 说明 |
|---|---|---|
| list | array | 结果集 |
| total | int | 结果集总数 |
结果集 list
| 参数名 | 类型 | 说明 |
|---|---|---|
| resource_id | string | 课程id |
| resource_type | int | 资源种类（此接口返回必定是50，表示鹅课程） |
| title | string | 课程名称 |
| img_url | string | 课程封面图 |
| img_url_compressed | string | 课程封面压缩图 |
| user_count | int | 用户数 |
| resource_cnt | int | 内容数 |
| interactive_cnt | int | 互动数 |
| last_updated_at | timestamp | 最新修改时间 |
| curriculum_time | timestamp | 开课时间 |
| curriculum_end_time | timestamp | 开课结束时间 |
| created_source | int | 创建来源 1-课程 2-圈子 |
| price | int | 商品价格 |
| line_price | int | 划线价格 |
| is_free | int | 是否免费（0-收费 1-免费） |
| is_public | int | 是否公开售卖(0-不公开 1-公开) |
| is_password | int | 是否加密（0-不加密 1--加密) |
| is_stop_sell | int | 是否停售：0否 1是 |
| is_display | int | 是否显示：0否(隐藏状态) 1是(显示状态) |
| sell_type | int | 售卖方式：1 = 独立售卖，2 = 关联售卖（商品放入专栏/会员/训练营中售卖） |
| sale_at | timestamp | 上架时间 |
| sale_status | int | 上架状态： 0下架 1上架 2（定时上架还未上架阶段）待上架 |
| can_sold_start | timestamp | 可售开始时间 |
| can_sold_end | timestamp | 可售结束时间 |
| goods_type | int | 商品种类（1免费2付费3加密4指派5非单卖） |
| is_ban | int | 商品是否被封禁：0 = 否，1 = 是 |
| position | int | 在列表中所在的位置 |
| is_join_market_act | boolean | 是否参与营销活动 |
| created_by_resource_info | object | 创建来源的信息 |
| period | object | 有效期 |
创建来源的信息 created_by_resource_info
| 参数名 | 类型 | 说明 |
|---|---|---|
| resource_id | string | 创建来源资源id |
| resource_type | int | 创建来源资源种类 |
| title | string | 创建来源资源名称 |
有效期 period
| 参数名 | 类型 | 说明 |
|---|---|---|
| period_type | int | 有效期的种类（-1永久有效，大于等于0是真实有效期） |
| period_value | int | 有效期的值（单位是s） |
返回示例
{
"code": 0,
"msg":"success",
"data": {
"list":[
{
"resource_id" : "course_2XtBNQNHUtKEuHi5fiNNyqJBObE",
"resource_type":50,
"title":"xxxxxx",
"img_url":"",
"img_url_compressed":"",
"user_count":1,
"resource_cnt":10,
"interactive_cnt":0,
"last_updated_at":"2023-12-20 17:35:22",
"curriculum_time":"0000-00-00 00:00:00",
"curriculum_end_time":"0000-00-00 00:00:00",
"created_source":1,
"price":0,
"line_price":0,
"is_free":1,
"is_public":1,
"is_password":0,
"is_stop_sell":0,
"is_display":1,
"sell_type":1,
"sale_at":"2023-11-08 18:14:14",
"sale_status":1,
"can_sold_start":"0000-00-00 00:00:00",
"can_sold_end":"0000-00-00 00:00:00",
"goods_type":1,
"is_ban":0,
"position":1,
"is_join_market_act":"false",
"created_by_resource_info":{
"resource_id":"",
"resource_type":0,
"title":"xxxx"
},
"period":{
"period_type":0,
"period_value":-1
}
},
{
"resource_id" : "course_2adadaduHi5fiNNyqJBObE",
"resource_type":50,
"title":"xxxxxx",
"img_url":"",
"img_url_compressed":"",
"user_count":1,
"resource_cnt":10,
"interactive_cnt":0,
"last_updated_at":"2023-11-20 17:35:22",
"curriculum_time":"0000-00-00 00:00:00",
"curriculum_end_time":"0000-00-00 00:00:00",
"created_source":1,
"price":0,
"line_price":0,
"is_free":1,
"is_public":1,
"is_password":0,
"is_stop_sell":0,
"is_display":1,
"sell_type":1,
"sale_at":"2023-11-08 18:14:14",
"sale_status":1,
"can_sold_start":"0000-00-00 00:00:00",
"can_sold_end":"0000-00-00 00:00:00",
"goods_type":1,
"is_ban":0,
"position":1,
"is_join_market_act":"false",
"created_by_resource_info":{
"resource_id":"",
"resource_type":0,
"title":"xxxx"
},
"period":{
"period_type":0,
"period_value":-1
}
}
],
"total": 0
}
}