使用场景：
这是一个C端触发的接口。券码获取，调用外部三方系统制作（生成）券码。
接口地址 由第三方企业开发者或中间件开放接口并在自建应用中配置券码获取接口
请求方式 POST
consumes ["application/json"]
produces ["application/json"]
应用权限 优惠券->券码获取
请求参数
公共参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| orgId | 企业ID | body | true | String | |
| appInstanceId | 应用实例ID | body | true | String | |
activityId | 活动id，对应玩法组件id | body | true | String | |
| callbackData | 回调参数 | body | true | List | |
| nonce | 签名随机数 | body | true | String | 签名随机数 |
| timestamp | 签名时间戳 | body | true | Long | 签名时间戳 |
| signature | 签名 | body | true | String | 签名 |
| instanceAppId | 自建应用appid | String | true | String | |
| thirdCompanyId | 开放平台登陆componyId | String | 非开放平台用户为空 | String | |
thirdUid | 开放平台登陆uid | String | 非开放平台用户为空 | String |
发券通知
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| thirdCouponTplId | 第三方卡券模板ID | body | true | String | |
| thirdId | 客户ID | body | false | string | |
| phone | 手机 | body | false | string | |
openidDtos | 身份识别标识集合 | body | true | array | 身份识别标识集合 |
身份识别标识集合
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| unionid | 微信unionid | body | false | String | |
| openid | 应用身份标识 | body | true | String | |
| fromTo | 应用类型(contentminiapp:小程序, workwechat:企业微信外部联系人, gzh:公众号, workwechatgroup:客户群) | body | true | string | |
| appid | 应用id | body | false | string | |
jcappid | 兔展系统集成-自建应用ID（是一串数字，非自建应用的应用ID（一窜字母字符串）） | body | false | number（64） | |
identityType | 身份识别类型(phone: 手机号码, id: 第三方用户ID, openid: 公众号openid, unionid: 开放平台unionid) | body | false | string | |
identityId | 身份识别类型ID, identityType 字段对应的value值 | body | false | string |
请求示例
|
响应参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| code | 状态码 | body | true | string | |
| msg | 描述 | body | true | string | |
| data | 返回内容 | body |
data实体
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| callbackSuccessData | 成功数据 | List |
成功实体
参数名称 | 参数说明 | 数据类型 | 是否必须 | schema | |
|---|---|---|---|---|---|
| couponCode | 券CODE | String | true | 返回券码不能超过32位 | |
| thirdCouponTplId | 第三方卡券模板ID | String | false | ||
| thirdId | 第三方客户ID | String | false | 四种身份匹配必须传一种 | |
| openid | 公众号openid | String | false | ||
| unionid | 开放平台unionid | String | false | ||
phone | 手机号 | String | false | ||
| validateType | 卡券码领取时效类型 | Integer | false | 1:时间区间, 2:按领取后有效天数, 3:永久有效 不传以券模板数据为准 | |
| startTime | 卡券有效开始时间 | Long | false | validateType=1必填 | |
| endTime | 卡券有效结束时间 | Long | false | validateType=1必填 | |
| awardAfterDay | 领取后有效天数 | Interger | false | validateType=2必填 |
响应状态
状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | FAIL |
响应示例
|