Appearance
获取历史抽奖列表
| 拥有此API的权限集 |
|---|
| 直播管理-查询 |
请求方式及url
请求方式:
POST请求头:
Content-Type:application/json接口地址:
https://api.xiaoe-tech.com/xe.alive.marketing.history.prize.list/1.0.0频率限制:
10秒50次
接口调试
请求参数
响应结果
暂无响应数据
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 专属token |
| app_id | 是 | string | 应用ID |
| alive_id | 是 | string | 直播ID |
| prize_name | 否 | string | 抽奖名称(模糊查询,可不传) |
| page | 是 | int | 页码 min=1 |
| page_size | 是 | int | 每页条数 min=1,max=10 |
请求示例
JSON
{
"access_token":"xxxx",
"alive_id": "xxxx",
"prize_name": "",
"page": 1,
"page_size": 5
}返回参数
顶层返回参数
| 参数名 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|
| code | 是 | int | 返回码 | 0-成功,其他值-失败 |
| msg | 是 | string | 返回信息 | code=0时为"success";code≠0时返回具体错误信息 |
| data | 是 | json对象 | 核心返回数据 | - |
data.list 数组元素参数
| 参数名 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|
| app_id | 是 | string | 应用ID | - |
| prize_id | 是 | string | 抽奖唯一标识ID | 对应「添加直播抽奖」接口返回的prize_id |
| prize_name | 是 | string | 抽奖名称 | 对应「添加直播抽奖」接口的prize_name |
| prize_patten | 是 | int | 抽奖模式 | 2-组合条件模式(业务自定义枚举,以实际业务为准) |
| start_at | 否 | string | 抽奖开始时间 | null表示未设置,格式:YYYY-MM-DD HH:MM:SS |
| end_at | 否 | string | 抽奖结束时间 | null表示未设置,格式:YYYY-MM-DD HH:MM:SS |
| prize_status | 是 | int | 抽奖状态 | 0-正常(业务自定义枚举,以实际业务为准) |
| prize_param | 是 | string | 抽奖参数JSON字符串 | 存储创建抽奖时的核心参与条件参数,结构同participant_condition |
| created_at | 是 | string | 抽奖创建时间 | 格式:YYYY-MM-DD HH:MM:SS |
| exclude_winners | 是 | int | 是否排除已中奖用户 | 0-不排除,1-排除(同「添加直播抽奖」接口) |
| prize_total | 是 | int | 奖品总数量 | 该抽奖下所有奖项的奖品数量之和 |
| participant_condition | 是 | json对象 | 参与条件 | 继承「添加直播抽奖」接口的参与条件,新增扩展字段 |
| participant_condition. alive_id | 是 | string | 直播ID | |
| participant_condition. type | 是 | int | 参与条件类型: 2-在线,3-任意评论,4-指定评论,5-分享直播间,6-使用积分,7-下单任意金额,8-下单指定商品,9-指定等级会员 | |
| participant_condition. range_type | 是 | int | 范围类型 | 0-默认 |
| participant_condition. is_show_participant | 是 | int | 0-不展示参与任务,1-展示 | |
| participant_condition. ext.content | 否 | string | type对应的补充条件(如指定评论内容、指定商品ID等) | |
| participant_condition. ext.integral | 否 | string | type=6(使用积分)时,参与抽奖所需的积分数值 | |
| participant_condition. combo_ext | 否 | array | 组合条件扩展(type=-1时生效) | 数组内每个元素为子条件,包含type(子条件类型)、content(子条件补充内容) |
| bind_resources | 是 | array | 绑定的课程/商品奖品列表 | 空数组表示未绑定,字段继承「添加直播抽奖」接口并新增扩展字段 |
| bind_resources. prize_id | 是 | string | 抽奖ID | - |
| bind_resources. prize_custom_title | 是 | string | 奖项名称 | - |
| bind_resources. prize_type | 是 | int | 奖品类型 | 2-课程/商品(同「添加直播抽奖」接口返回的prize_type) |
| bind_resources. prize_product_id | 是 | string | 奖品产品ID | - |
| bind_resources. resource_id | 是 | string | 课程/商品资源ID | - |
| bind_resources. resource_type | 是 | int | 课程/商品资源类型 | - |
| bind_resources. prize_num | 是 | int | 该奖项奖品数量 | - |
| bind_resources. sku_id | 否 | string | 商品SKU | - |
| bind_resources. sort | 是 | int | 奖项展示序号 | - |
| bind_resources. expire_days | 是 | int | 奖品有效期天数 | - |
| bind_resources. prize_title | 是 | string | 奖品标题 | - |
| bind_coupons | 是 | array | 绑定的优惠券奖品列表 | 空数组表示未绑定 |
| bind_points | 是 | array | 绑定的积分奖品列表 | 空数组表示未绑定,字段继承「添加直播抽奖」接口并新增扩展字段 |
| bind_points. prize_id | 是 | string | 抽奖ID | - |
| bind_points. prize_custom_title | 是 | string | 奖项名称 | - |
| bind_points. prize_type | 是 | int | 奖品类型 | 5-积分(同「添加直播抽奖」接口返回的prize_type) |
| bind_points. prize_product_id | 是 | string | 奖品产品ID | - |
| bind_points. prize_num | 是 | int | 该奖项奖品数量 | - |
| bind_points. sort | 是 | int | 奖项展示序号 | - |
| bind_points. expire_days | 是 | int | 奖品有效期天数 | - |
| bind_points. points | 是 | string | 该奖项积分数值 | - |
| bind_customs | 是 | array | 绑定的自定义奖品列表 | 空数组表示未绑定 |
| bind_promo_codes | 是 | array | 绑定的营销码券奖品列表 | 空数组表示未绑定 |
返回示例
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"app_id": "xxxxxx",
"prize_id": "prize_xxxxxxxxxxx",
"prize_name": "测试3",
"prize_patten": 2,
"start_at": null,
"end_at": null,
"prize_status": 2,
"prize_param": "{"alive_id":"l_xxxxxxxxxx","type":2,"range_type":0,"ext":{"integral":"1"},"is_show_participant":"0"}",
"created_at": "2026-01-21 16:16:22",
"exclude_winners": 0,
"prize_total": 1,
"participant_condition": {
"alive_id": "l_xxxxxxxxxx",
"type": 2,
"range_type": 0,
"ext": {
"integral": "1"
},
"is_show_participant": "0"
},
"bind_resources": [
],
"bind_coupons": [
],
"bind_points": [
{
"prize_id": "prize_xxxxxxxxxxx",
"prize_custom_title": "1",
"prize_type": 5,
"prize_product_id": "prize_prd_d0grWVF1hLal5FnkmkXKbkQ7UT",
"prize_num": 1,
"sort": 1,
"expire_days": 15,
"points": "1"
}
],
"bind_customs": [
],
"bind_promo_codes": [
]
},
{
"app_id": "xxxxxx",
"prize_id": "prize_xxxxxxxx3",
"prize_name": "测试3",
"prize_patten": 2,
"start_at": null,
"end_at": null,
"prize_status": 2,
"prize_param": "{"alive_id":"l_xxxxxxxxxx","type":2,"range_type":0,"ext":{"integral":"1"},"is_show_participant":"0"}",
"created_at": "2026-01-21 16:14:05",
"exclude_winners": 0,
"prize_total": 1,
"participant_condition": {
"alive_id": "l_xxxxxxxxxx",
"type": 2,
"range_type": 0,
"ext": {
"integral": "1"
},
"is_show_participant": "0"
},
"bind_resources": [
],
"bind_coupons": [
],
"bind_points": [
{
"prize_id": "prize_xxxxxxxx3",
"prize_custom_title": "1",
"prize_type": 5,
"prize_product_id": "prize_prd_kkZ2b3KfgAEIo0kTLJsQx6PKnz",
"prize_num": 1,
"sort": 1,
"expire_days": 15,
"points": "1"
}
],
"bind_customs": [
],
"bind_promo_codes": [
]
}
],
"total": 382,
"member_switch": 1,
"point_switch": 1
},
"forward_url": "",
"bizCode": 0,
"requestId": "20260121175042-15-6970a172bfb52"
}