Appearance

获取直播抽奖详情 ​

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

请求方式及url ​

  • 请求方式：POST
  • 请求头：Content-Type:application/json
  • 接口地址：https://api.xiaoe-tech.com/xe.alive.marketing.prize.get/1.0.0
  • 频率限制：10秒50次

接口调试

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

请求参数 ​

参数名必选类型说明
access_token是string专属token
alive_id是string直播ID
prize_id是string抽奖ID

请求示例 ​

json
{
    "access_token": "xe_xxxxx",
    "alive_id": "l_xxxxx",
    "prize_id": "prize_xxxxx"
}

返回参数 ​

参数名必选类型说明备注
code是int返回码0-成功，其他失败
msg是string返回信息...
data是json对象返回值...

data 对象 ​

参数名类型说明
app_idstring店铺ID
prize_idstring抽奖ID
prize_namestring抽奖名称
start_atstring开始时间
end_atstring结束时间
prize_pattenint抽奖模式
prize_statusint抽奖状态
prize_paramstring抽奖参数JSON字符串
exclude_winnersint是否可重复中奖：0-可重复中奖 1-不可重复中奖
is_deletedint是否删除：0-否 1-是
set_user_idstring设置用户ID
draw_user_idstring开奖用户ID
participate_typeint参与类型
particant_conditionobject参与条件
bind_customsarray自定义奖品列表
bind_pointsarray积分奖品列表
set_nicknamestring设置者昵称
draw_nicknamestring开奖者昵称

particant_condition 对象 ​

参数名类型说明
alive_idstring直播ID
typeint参与条件类型：2-在线，3-任意评论，4-指定评论，5-分享直播间，6-使用积分，7-下单任意金额，8-下单指定商品，9-指定等级会员
range_typeint范围类型
extobject扩展信息
is_show_participantstring是否展示参与任务：0-不展示 1-展示

ext 对象 ​

参数名类型说明
integralstring积分数量
contentstring补充条件内容

bind_customs 数组元素 ​

参数名类型说明
prize_idstring抽奖ID
prize_custom_titlestring奖项名称
prize_typeint奖品类型：1-自定义奖品
prize_product_idstring产品ID
prize_numint奖品数量
prize_valueobject奖品值配置
sortint序号
expire_daysint过期天数
prize_titlestring奖品标题

prize_value 对象（自定义奖品配置） ​

参数名类型说明
prize_titlestring奖品标题
prize_imageobject奖品图片配置
contact_informationobject联系方式配置

prize_image 对象 ​

参数名类型说明
is_defaultstring是否使用默认图片：0-否 1-是
imagestring奖品图片URL

contact_information 对象 ​

参数名类型说明
is_wx_numberstring是否显示微信号：0-否 1-是
wx_numberstring微信号
is_qrcodestring是否显示二维码：0-否 1-是
qrcodestring二维码图片URL

bind_points 数组元素 ​

参数名类型说明
prize_idstring抽奖ID
prize_custom_titlestring奖项名称
prize_typeint奖品类型：5-积分
prize_product_idstring产品ID
prize_numint奖品数量
sortint序号
expire_daysint过期天数
pointsstring积分数值

返回示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "app_id": "app_xxxxxx",
        "prize_id": "prize_xxxxx",
        "prize_name": "1",
        "start_at": null,
        "end_at": null,
        "prize_patten": 2,
        "prize_status": 0,
        "prize_param": "{\"alive_id\":\"l_xxxxx\",\"type\":2,\"range_type\":0,\"ext\":{\"integral\":\"1\",\"content\":\"\"},\"is_show_participant\":\"0\"}",
        "exclude_winners": 0,
        "is_deleted": 0,
        "set_user_id": null,
        "draw_user_id": null,
        "participate_type": 2,
        "particant_condition": {
            "alive_id": "l_xxxxx",
            "type": 2,
            "range_type": 0,
            "ext": {
                "integral": "1",
                "content": ""
            },
            "is_show_participant": "0"
        },
        "bind_customs": [
            {
                "prize_id": "prize_xxxxx",
                "prize_custom_title": "名称",
                "prize_type": 1,
                "prize_product_id": "prize_prd_xxxxx",
                "prize_num": 1,
                "prize_value": {
                    "prize_title": "1",
                    "prize_image": {
                        "is_default": "1",
                        "image": "https://example.com/image/prize.png"
                    },
                    "contact_information": {
                        "is_wx_number": "0",
                        "wx_number": "",
                        "is_qrcode": "1",
                        "qrcode": "https://example.com/image/qrcode.png"
                    }
                },
                "sort": 1,
                "expire_days": 15,
                "prize_title": "1"
            },
            {
                "prize_id": "prize_xxxxx",
                "prize_custom_title": "名称",
                "prize_type": 1,
                "prize_product_id": "prize_prd_xxxxx",
                "prize_num": 1,
                "prize_value": {
                    "prize_title": "自定义商品2",
                    "prize_image": {
                        "is_default": "1",
                        "image": "https://example.com/image/prize.png"
                    },
                    "contact_information": {
                        "is_wx_number": "0",
                        "wx_number": "",
                        "is_qrcode": "1",
                        "qrcode": "https://example.com/image/qrcode.png"
                    }
                },
                "sort": 3,
                "expire_days": 15,
                "prize_title": "自定义商品2"
            }
        ],
        "bind_points": [
            {
                "prize_id": "prize_xxxxx",
                "prize_custom_title": "名称",
                "prize_type": 5,
                "prize_product_id": "prize_prd_xxxxx",
                "prize_num": 1,
                "sort": 2,
                "expire_days": 15,
                "points": "1"
            }
        ],
        "set_nickname": "-",
        "draw_nickname": ""
    },
    "forward_url": "",
    "bizCode": 0,
    "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}