使用场景:
这是一个C端触发的接口。兔展平台发券后通知企业用户与券绑定关系。 兔展系统调用第三方的接口
接口地址 由第三方企业开发者或中间件开放接口并在自建应用中配置通知地址
请求方式 POST
consumes ["application/json"]
produces ["application/json"]
应用权限 优惠券->发券通知订阅
#请求参数
###公共参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
orgId | 企业ID | body | true | String | |
appInstanceId | 应用实例ID | body | true | String | |
noticeData | 通知数据 | body | true | array | 发券通知 |
nonce | 签名随机数 | string | true | String | 签名随机数 |
timestamp | 签名时间戳 | long | true | Long | 签名时间戳 |
signature | 签名 | string | true | String | 签名 |
instanceAppId | 自建应用appid | string | true | String | |
thirdCompanyId | 开放平台登陆componyId | string | 非开放平台用户为空 | String |
###发券通知
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
thirdCouponTplId | 第三方卡券模板ID | body | true | String | |
couponCode | 券CODE | body | true | String | |
thirdId | 客户ID | body | false | string | |
openids | 多应用身份标识 | body | false | array | 多应用身份标识 |
phone | 手机 | body | false | string |
###多应用身份标识
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 |
###请求示例
{
"appInstanceId": "778985290508406784",
"orgId": "928a852d-e749-45be-bc31-f8e23f07b7f4",
"noticeData": [
{
"phone": "18681452902",
"thirdCouponTplId": "SINGLE_LINE_COMMON_MIN_1.0815c",
"openids": [
{
"openid": "o2shHwg9VjkygpN6__rHOyQ5Y2lE",
"appid": "wxa1a8ae7a3acd6d38",
"fromTo": "gzh"
}
],
"openidDtos": [
{
"openid": "o2shHwg9VjkygpN6__rHOyQ5Y2lE",
"appid": "wxa1a8ae7a3acd6d38",
"fromTo": "gzh"
}
]
}
],
"couponCode": "77a794d7-26d2b29e7"
}
],
"nonce": "n14GvACT6Ed768TUlJHKwD2Ml2ej89n1",
"timestamp": 1625793771858 ,
"instanceAppId": "Ipu_t60KoV-gTTtCSkFMWtrkTIA",
"thirdCompanyId": "0707",
"signature": "1d11d6b2be2113fd42519be97421b1ad0ddcb1e5"
}
#响应参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
code | 状态码 | body | true | string | |
msg | 描述 | body | true | string |
###响应状态
状态码 | 说明 | schema |
---|---|---|
200 | OK | |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found | |
500 | FAIL |
###响应示例
{
"code": "200",
"errorCode": "SUCCESS",
"msg": "通讯成功"
}