使用场景:
企业将自有系统中的优惠券模板或规则导入兔展平台
请求方式 POST
consumes :application/json
produces :application/json
接口描述:用户领取奖品,发奖品有三种方式:如下
1:同步返回奖品数据
2:异步发奖
2.1:异步通知的时候返回奖品数据
2.2:异步通知的时候不返回奖品数据,需新增一个查询用户中奖数据接口
3:企业自行发奖
备注:2和3两种发奖方式需要定制开发,现阶段只支持同步发奖
请求参数
| 字段名 | 描述 | 类型 | 是否必填 |
|---|---|---|---|
prizeId | 第三方奖品id | String | 是 |
prizeNum | 奖品数量 | Integer | 是 |
activityId | 活动id | String | 否 |
activityName | 活动名称 | String | 否 |
takeChannel | 领取渠道 | String | 否 |
takeChannelName | 领取渠道名称 | String | 否 |
orderId | 订单id | String | 否 |
openid | openid 微信平台id | String | 否 |
phone | 用户电话号码 | String | 否 |
awardLevel | 奖品等级 | String | 是 |
ext | 冗余字段 | String | 否 |
notifyId | 通知id | String | 是 |
请求实例
{
"prizeId": "684834095024443393",
"prizeNum": 1,
"activityId": "699634741598621696",
"activityName": "矫正器抽奖",
"takeChannel": "Lottery1",
"takeChannelName": "抽奖1",
"orderId": "demoData",
"openid": "o7kepwSlK_kGH2M9qELoP5rTWET0",
"phone": "17620395858",
"awardLevel": 1,
"ext": {
"key1": "value1",
"key2": "value2"
},
"notifyId": "699639734053507072"
}
请求参数:
| 字段名 | 描述 | 类型 | 是否必填 |
|---|---|---|---|
code | 结果返回码,200为正常,其余都为错误 | String | 是 |
msg | 结果描述 | String | 否 |
data | 结果 | Boolean | 是 |
data | |||
receiveWay | ASYN_RECEIVE: 异步发奖,不返回奖品详情 SYN_RECEIVE: 同步领奖,返回奖品详情 THIRD_REAWARD: 企业自行发奖 | String | ASYN_RECEIVE SYN_RECEIVE THIRD_REAWAR 三选一 |
prizeDetail | 具体的奖品详情 | String | receiveWay为SYN_RECEIVE时是必须的 |
prizeType | COUPON_PRIZE 卡券类型奖品 | String | COUPON_PRIZE |
prizeDetail字段定义:
卡券奖品:
| 字段名 | 描述 | 类型 | 是否必须 |
|---|---|---|---|
couponCode | 卡券码 | String | 如果prizeType为COUPON_PRIZE时,是必须的 |
卡券奖品响应实例:
{
"code": 200,
"msg": "success",
"data": {
"receiveWay": "SYN_RECEIVE",
"prizeDetail": {
"couponCode": "demoData"
},
"prizeType": "COUPON_PRIZE"
}
}