天天红包接口说明文档

版本	作者	日期	描述
v1.0.0	张中建	2017-12-06	为方便前端、移动端与后台的联调，特制定本规范；如有变更请及时通知
v1.0.0	张中建	2017-12-07	完成天天红包用户分享，查看领奖记录、开奖接口
v1.0.1	张中建	2017-12-13	避免关键字将分享信息下的abstract改为detail
v1.0.2	张中建	2017-12-15	查询开奖记录增加openId

---

统一说明

1. 目前需要约定有的wap和app，特定义device来加以区别当前请求，合理的值为wap或app
2. 所有的响应都有以下2个key

{
  code: 9999,      //所有请求都会有该key存在 9999代表成功
  msg: "success" //非正常请求时需要将该消息弹出提示用户
}

---

1.用户分享

接口地址

/${device}/user/share

业务参数说明

名称	类型	是否必须	参数说明
uId	int	Y	登录成功后端用户返回的用户标识 大于0 小于999999 否则报非法请求 eg:9527

返回结果

{
    uId:9527,
    sign:"4b38d99d2b63e54873143342b121d9c4,
    share:"y",
    shareInfo:{
      title:"加金调料包，每天领一包，收益节节高！给你的钱包充能！",
      detail:"快和你的小伙伴一起来瓜分百万红包吧！",
      img:"http://www.jfcaifu.com",
      url:"http://www.jfcaifu.com/activity/redpacket.html",
      forward:{
        friends :"y",
        moments :"n",
        sina:"y"
       }
    }
}

返回字段说明

名称	类型	字段说明
uId	int	请求分享接口的用户标识
addr	String	分享出去的链接地址
sign	String	对分享地址MD5的唯一标识，开奖时需要将该值回传验证
share	char	该值为y，表示需要分享
shareInfo	String	对share的详细说明
title	String	分享标题
detail	String	对某一功能的摘要说明
img	String	分享图片对应地址
url	String	分享出去的链接
forward	String	转发平台 friends 朋友圈 moments 朋友圈 sina 新浪 为y前端需要显示相应的平台

---

2.获奖记录

接口地址

/${device}/user/records

请求方式

POST

业务参数说明

名称	类型	是否必须	参数说明
uId	int	N	用户标识 eg:9527
tele	String	N	本次要查询领取记录的手机号 与 sign 二选一
page	int	N	查看领取记录当前页码 默认为：1
sign	String	N	当查看某个红包的领取记录时需要传该值 与 tele 二选一
openId	String	Y	用户在点击红包链接时后台返回给前端的一个用户标识

返回结果

{
    uId: 9527,
    total:11,
    records:[ {
       id: 9527, 
       serial:"51ec6f59dbcb2084fcb47f8e2a04c5e3",
       avatar:"http://wx.qlogo.cn/mmopen/JcDicrZBlREhnNXZRudod9Pmib",
       nickname:"咩咩羊",
       amount: 100.00,
       amtTxt:"100.00元现金券",
       category: 2, 
       cateText: "现金券",
       status: 1,
       remark: "投资15天及以上产品满5000元可用", 
       startDate: "2017-08-05", 
       endDate: "2017-12-03",
       createdDate:"2017-10-08  11:11:11"
  }]
  ……
}

返回字段说明

名称	类型	字段说明
uId	int	用户标识 eg:9527
tele	String	联系方式
total	int	后台计算出用户的领取红包的总页数 前端需要根据该值判断允许滑动的最大次数
records	List	用户领取的奖励集，前端需要考虑为空的情况 ，避免闪退
id	int	领取奖励的唯一标识，当点击使用时需要将该值传回后端
serial	String	领取红包的序列号
avatar	String	微信返回的用户头像地址
nickname	String	微信返回的用户昵称
amount	BigDecimal	当前领取的奖励面值 eg:现金100.00 红包 78.00 加息券：3.7
amtTxt	String	后端组装完整的面值说明，需要就取不需要忽略
category	int	1 现金 2红包券 3全程加息券
cateText	String	对category的中文解释 前端直接取该值即可
status	int	所领取奖励当前的一个状态 0初始化 1未使用(已同步) 2已使用 3已过期（失效）
remark	String	奖励的使用范围说明
startDate	String	奖励的生效日期 eg：2017-12-12
endDate	String	奖励的失效日期 eg：2017-12-19
createdDate	String	奖励获得时间 eg：2017-12-12 12:12:12

---

3.领取红包

接口地址

/${device}/open/red_packet

请求方式

POST

业务参数说明

名称	类型	是否必须	参数说明
tele	String	Y	用户填写有效的11位联系方式，前后端都要正则验证合法性
sign	int	Y	用户访问分享链携带的标识
uId	int	N	用户标识 eg:9527

返回结果

{
    uId:9527,
    tele:"138767676767"
    msg: "红包已领取 | 活动已结束 | 每人每天只能领取一个红包哟贪心会长胖哒~"
    records:"[{
       id: 1314, 
       avatar:"http://wx.qlogo.cn/mmopen/JcDicrZBlREhnNXZRudod9Pmib",
       nickname:"咩咩羊",
       amount: 100.00,
       amtTxt:"100.00元现金券",
       category: 2, 
       cateText: "现金券",
       status: 1,
       remark: "投资15天及以上产品满5000元可用", 
       startDate: "2017-12-12", 
       endDate: "2017-12-19",
       createdDate:"2017-12-12 12:13:14"
    }]"
    ……
}

返回字段说明

名称	类型	字段说明
uId	int	用户标识 只有后台能识别出用户且在金蜂系统存在的情况下才有 eg：9527
tele	String	当前领取人填写的手机号
msg	String	后端根据领取逻辑返回的一个提示信息 直接弹出给用户展示即可
records	List	当前红包的领取情况 参考领取记录records解释

---

唯有完美的团队才能造就我完美的个人，团结就是力量