使用场景:
企业将自有系统中的优惠券模板或规则导入兔展平台
请求URL:外部三方提供
请求方式: POST
consumes :application/json
produces :application/json
目前支持两种发奖模式,可根据企业具体情况选择对接模式
发放券码:通过向用户发放权益券码,用户可根据拿到的券码到指定的应用场景兑换具体的权益
企业直发:企业接收到发奖通知后,自行完成权益的发放处理,后续通过回调接口通知兔展权益发放的结果和处理的订单号,兔展会将订单号在前端给用户展示
备注:企业直发的模式 参见 企业异步直发模式
请求参数
| 字段名 | 描述 | 类型 | 是否必填 |
|---|---|---|---|
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 | 是 |
| identities | 身份标识 | List<Object> | 是 |
appId | 作品id | String | 是 |
awardTime | 领奖时间 | String | 是 |
| instanceAppId | 自建应用appid | String | 是 |
| orgId | 企业id | String | 是 |
| thirdCompanyId | 开放平台登陆componyId | String | 非开放平台用户为空 |
identities字段定义:
身份识别标识:
| 字段名 | 描述 | 类型 | 是否必须 |
|---|---|---|---|
identityType | 标识类型 | String | |
| identityId | 标识Id | String | |
| fromTo | 标识来源 | String | |
| platform | 标识来源平台 | String | |
| openid | openid | String | 当 fromTo 为 gzh 时,openid有值 |
| unionid | unionid | String | 当 fromTo 为 gzh 时,unionid有值 |
jcappId | 系统集成Id | String | |
appid | 作品id | String |
请求实例
{
"prizeId": "684834095024443393",
"prizeNum": 1,
"activityId": "699634741598621696",
"activityName": "矫正器抽奖",
"takeChannel": "Lottery1",
"takeChannelName": "抽奖1",
"orderId": "demoData",
"openid": "o7kepwSlK_kGH2M9qELoP5rTWET0",
"phone": "17620395858",
"awardLevel": 1,
"appId":"f22f50-8229-482a-988b-a9b78f662aca",
"awardTime": "2021-11-23 17:02:58",
"ext": "json字符串",
"notifyId": "699639734053507072",
"instanceAppId": "Ipu_t60KoV-gTTtCSkFMWtrkTIA",
"orgId": "572d9b1a-aca5-40a9-ad6e-4d8deb6395c4",
"thirdCompanyId": "0707",
"identities": [
{
"appid": "00002a59-6596-4103-89b8-2545f297abf7",
"fromTo": "gzh",
"openid": "qwmpjkdhdsmkiiaghkd",
"unionid": "fjsdlkfjsldjflksdjfl"
}
]
}
响应参数:
| 字段名 | 描述 | 类型 | 是否必填 |
|---|---|---|---|
code | 结果返回码,200为正常,其余都为错误 | String | 是 |
msg | 结果描述 | String | 否 |
data | 结果 | Boolean | 是 |
data | |||
receiveWay | ASYN_RECEIVE: 异步发奖,不返回奖品详情 SYN_RECEIVE: 同步领奖,返回奖品详情 | String | ASYN_RECEIVE SYN_RECEIVE 三选一 |
prizeDetail | 具体的奖品详情 | object | receiveWay为SYN_RECEIVE时是必须的 |
prizeType | COUPON_PRIZE 卡券类型奖品 | String | COUPON_PRIZE 卡券 CARD 卡号卡密 THIRD_ORDER_ID 外部订单号 |
prizeDetail字段定义:
卡券奖品:
字段名 | 描述 | 类型 | 是否必须 |
|---|---|---|---|
couponCode | 卡券码 | String | 如果prizeType为 COUPON_PRIZE或 CARD 时,是必须的 |
| secreteCode | 卡密 | String | 如果prizeType为 CARD 时,是必须的 |
| thirdOrderId | 外部订单号 | String | 如果prizeType为 THIRD_ORDER_ID 时,是必须的 |
卡券奖品响应实例:
{
"code": 200,
"msg": "success",
"data": {
"receiveWay": "SYN_RECEIVE",
"prizeDetail": {
"couponCode": "demoData"
},
"prizeType": "COUPON_PRIZE"
}
}