该接口用于获取活动奖品(商品)列表。
接口请求
请求地址 | https://open.rrx.cn/api/v1/activityPrize/getList | |
请求方式 | GET | |
参数名称 | 是否必须 | 说明 |
app_key | 是 | 人人秀平台分配的AppKey |
time_stamp | 是 | 1970-01-01开始的时间戳，精确到毫秒 |
sign | 是 | 根据签名算法所得，如何计算签名 |
activity_guid | 是 | 互动ID ，如何获取互动ID |
接口响应
返回JSON格式结果 Content-type: application/json | ||
{"result":0,"msg":"","data":{rows:[]}} | ||
参与名称 | 类型 | 说明 |
result | int(2) | 0表示成功，1表示失败 |
msg | string(100) | 失败时，返回的错误描述 |
data | obj | 成功时，返回数据 {rows:[]} ，详见 data 参数说明 |
data参数说明
参数名称 | 是否必须 | 类型 | 说明 |
rows | 是 | obj | 奖品(商品)列表，详见rows参数说明 |
rows参数说明
参数名称 | 是否必须 | 类型 | 说明 |
activity_info | 是 | obj | 活动信息，详见 activity_info参数说明 |
product_id | 是 | int(11) | 奖品(商品)id |
product_name | 是 | string(60) | 奖品(商品)名称 |
product_type | 是 | int(11) | 奖品(商品)类型 枚举：1：实物；2：红包；5：优惠券；6：积分；7：自有奖品；8：礼品；12：商品；13：活动报名；15：表单；16：预约；17：微信卡劵 |
product_code | 是 | string(10) | type=7时，自有标识码（仅自有奖品时有值，用于开发者识别要自有奖品） |
product_links | 否 | obj | type=7时，自有奖品自定义跳转链接 ，详见product_links参数说明 |
product_points | 否 | int(11) | type=6，积分奖品，积分分值 |
product_redpack | 否 | obj | type=2，红包奖品，详见product_redpack参数说明 |
product_send_type | 否 | int(110) | 配送方式，1：直接领取；2：快递发货；3：线下核销 |
total_qty | 否 | int(11) | 总数量 |
stock_qty | 否 | int(11) | 剩余数量 |
product_ext | 是 | obj | 奖品具体配置信息，详见product_ext参数说明 |
prize_pool | 否 | string(20) | 奖池名称，开启多奖池时有值 |
product_links参数说明
参数名称 | 是否必须 | 类型 | 说明 |
type | 是 | int(2) | 自有奖品类型，1：跳转链接；2：跳转小程序 |
links | 否 | string(60) | type=1，必传，跳转的自定义链接 |
appid | 否 | string(20) | type=2，必传，跳转的小程序APPID |
path | 否 | string(60) | type=2，可传，跳转的小程序页面路径，默认首页 |
product_redpack参数说明
参数名称 | 是否必须 | 类型 | 说明 |
redpack_type | 否 | int(11) | 红包类型枚举，1：固定金额；2：随机金额 |
redpack_amount | 否 | float(2) | 选择固定金额时，必须，金额范围（0.1 ~ 200）,小于1元红包需单独按需开启 |
redpack_min_amount | 否 | float(2) | 选择随机金额时，必须，单笔随机的最小金额,金额范围（0.1~200） |
redpack_max_amount | 否 | float(2) | 选择随机金额时，必须，单笔随机的最大金额,必须大于最小金额，金额范围（0.1~200） |
redpack_total_amount | 否 | float(2) | 选择随机金额时，必传，该奖品总发放金额 |
product_ext参数说明
参数名称 | 是否必须 | 类型 | 说明 |
prize_auth | 是 | int(11) | 奖品授权类型，1：抽奖奖品；2:领奖奖品；3：排行榜奖品 |
prize_count | 否 | int(11) | 该奖品设置的数量 |
prize_win_rate | 否 | float(2) | 该奖品中奖概率（0.01~100），所有奖品总概率不超过100 |
is_consolation | 否 | int(11) | 是否为安慰奖，（抽奖奖品时有值）， |
get_task_num | 否 | int(11) | 领取要求（对应活动奖品条件：目标人数、兑换条件、助力人数、签到天数等） |
get_task_type | 否 | int(11) | 日历抽奖玩法，任务类型，1：连续签到；2：累计签到 |
top_num | 否 | int(11) | 该奖品发奖排行榜开始排名值 （排行榜奖品时有值） |
end_num | 否 | int(11) | 该奖品发奖排行榜结束排名值 （排行榜奖品时有值） |
activity_info参数说明
参数名称 | 是否必须 | 类型 | 说明 |
title | 是 | string(60) | 自有奖品类型，1：跳转链接；2：跳转小程序 |
activity_name | 是 | string(100) | 互动名称 |
activity_category | 是 | string(10) | 互动类型名称 |
user_name | 是 | string(20) | 活动创建人 |
请求示例
{
"app_key": "96c84928b1dce057d110ea3b3880fc83",
"time_stamp":"1543999047492",
"sign ":"051BF3517D40AB9D7D6B45EF6E4EB7F9",
"activity_guid": "f2f219309b5c1a021fc019b3b557b9f8",
}
返回值示例，json格式 Content-type: application/json
{
"result": 0,
"data": {
"rows": [
{
"activity_info": {
"title": "未命名活动",
"activity_name": "抽奖",
"user_name": "张三"
},
"product_id": "10001",
"product_name": "商品1",
"product_image_url": "https://qn-file.rrxiu.net/prize_icon_v2.png",
"product_type": 1,
"total_qty ": 10,
"stock_qty": 10,
"product_ext": {
"prize_auth": 1,
"prize_count": 1,
"prize_win_rate": 100,
}
}]
},
"msg": "ok"
}
相关文档
