Skip to content

获取历史抽奖列表

拥有此API的权限集
直播管理-查询

请求方式及url

  • 请求方式:POST

  • 请求头:Content-Type:application/json

  • 接口地址:https://api.xiaoe-tech.com/xe.alive.marketing.history.prize.list/1.0.0

  • 频率限制:10秒50次

接口调试

请求参数
响应结果
暂无响应数据

请求参数

参数名必选类型说明
access_tokenstring专属token
app_idstring应用ID
alive_idstring直播ID
prize_namestring抽奖名称(模糊查询,可不传)
pageint页码 min=1
page_sizeint每页条数 min=1,max=10

请求示例

JSON

{
    "access_token":"xxxx",
    "alive_id": "xxxx",
    "prize_name": "",
    "page": 1,
    "page_size": 5
}

返回参数

顶层返回参数

参数名必选类型说明备注
codeint返回码0-成功,其他值-失败
msgstring返回信息code=0时为"success";code≠0时返回具体错误信息
datajson对象核心返回数据-

data.list 数组元素参数

参数名必选类型说明备注
app_idstring应用ID-
prize_idstring抽奖唯一标识ID对应「添加直播抽奖」接口返回的prize_id
prize_namestring抽奖名称对应「添加直播抽奖」接口的prize_name
prize_pattenint抽奖模式2-组合条件模式(业务自定义枚举,以实际业务为准)
start_atstring抽奖开始时间null表示未设置,格式:YYYY-MM-DD HH:MM:SS
end_atstring抽奖结束时间null表示未设置,格式:YYYY-MM-DD HH:MM:SS
prize_statusint抽奖状态0-正常(业务自定义枚举,以实际业务为准)
prize_paramstring抽奖参数JSON字符串存储创建抽奖时的核心参与条件参数,结构同participant_condition
created_atstring抽奖创建时间格式:YYYY-MM-DD HH:MM:SS
exclude_winnersint是否排除已中奖用户0-不排除,1-排除(同「添加直播抽奖」接口)
prize_totalint奖品总数量该抽奖下所有奖项的奖品数量之和
participant_conditionjson对象参与条件继承「添加直播抽奖」接口的参与条件,新增扩展字段
participant_condition. alive_idstring直播ID
participant_condition. typeint参与条件类型:
2-在线,3-任意评论,4-指定评论,5-分享直播间,6-使用积分,7-下单任意金额,8-下单指定商品,9-指定等级会员
participant_condition. range_typeint范围类型0-默认
participant_condition. is_show_participantint0-不展示参与任务,1-展示
participant_condition. ext.contentstringtype对应的补充条件(如指定评论内容、指定商品ID等)
participant_condition. ext.integralstringtype=6(使用积分)时,参与抽奖所需的积分数值
participant_condition. combo_extarray组合条件扩展(type=-1时生效)数组内每个元素为子条件,包含type(子条件类型)、content(子条件补充内容)
bind_resourcesarray绑定的课程/商品奖品列表空数组表示未绑定,字段继承「添加直播抽奖」接口并新增扩展字段
bind_resources. prize_idstring抽奖ID-
bind_resources. prize_custom_titlestring奖项名称-
bind_resources. prize_typeint奖品类型2-课程/商品(同「添加直播抽奖」接口返回的prize_type)
bind_resources. prize_product_idstring奖品产品ID-
bind_resources. resource_idstring课程/商品资源ID-
bind_resources. resource_typeint课程/商品资源类型-
bind_resources. prize_numint该奖项奖品数量-
bind_resources. sku_idstring商品SKU-
bind_resources. sortint奖项展示序号-
bind_resources. expire_daysint奖品有效期天数-
bind_resources. prize_titlestring奖品标题-
bind_couponsarray绑定的优惠券奖品列表空数组表示未绑定
bind_pointsarray绑定的积分奖品列表空数组表示未绑定,字段继承「添加直播抽奖」接口并新增扩展字段
bind_points. prize_idstring抽奖ID-
bind_points. prize_custom_titlestring奖项名称-
bind_points. prize_typeint奖品类型5-积分(同「添加直播抽奖」接口返回的prize_type)
bind_points. prize_product_idstring奖品产品ID-
bind_points. prize_numint该奖项奖品数量-
bind_points. sortint奖项展示序号-
bind_points. expire_daysint奖品有效期天数-
bind_points. pointsstring该奖项积分数值-
bind_customsarray绑定的自定义奖品列表空数组表示未绑定
bind_promo_codesarray绑定的营销码券奖品列表空数组表示未绑定

返回示例

{
    "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"
}