商户可以创建运营活动
1.1 公共参数
1.1.1 公共请求参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | string | 是 | 32 | 支付宝分配给开发者的应用id | 2014072300007148 |
method | string | 是 | 128 | 接口名称 | koubei.marketing.campaign.activity.create |
format | string | 否 | 40 | 仅支持json | json |
charset | string | 是 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
sign_type | string | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持rsa2和rsa,推荐使用rsa2 | rsa2 |
sign | string | 是 | 344 | 商户请求参数的签名串,详见 | 详见示例 |
timestamp | string | 是 | 19 | 发送请求的时间,格式"yyyy-mm-dd hh:mm:ss" | 2014-07-24 03:07:50 |
version | string | 是 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
notify_url | string | 否 | 256 | 支付宝服务器主动通知商户服务器里指定的页面http/https路径。 | http://api.test.alipay.net/atinterface/receive_notify.htm |
app_auth_token | string | 否 | 40 | 详见 | |
biz_content | string | 是 | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
1.2 请求参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
out_biz_no | string | 必选 | 32 | 外部批次id,同一owner创建活动需要换out_biz_no,控制幂等 | 0000001 |
operator_id | string | 可选 | 32 | 操作人id,必须和operator_type配对出现,不填时默认是商户 | 2088102146931393 |
operator_type | string | 可选 | 32 | 操作人类型,有以下值可填:mer(外部商户),mer_operator(外部商户操作员),provider(外部服务商),provider_staff(外部服务商员工),默认不需要填这个字段,默认为mer | mer |
name | string | 必选 | 32 | 活动名称 | 消费满10元送1元代金券 |
start_time | date | 必选 | 20 | 活动开始时间 | 2016-05-01 00:00:00 |
end_time | date | 必选 | 20 | 活动结束时间 | 2016-10-01 00:00:00 |
type | string | 必选 | 20 | 活动类型,目前支持以下类型:
consume_send:消费送活动 direct_send:直发奖活动 real_time_send:实时立减类活动 guess_send:口令送 recharge_send:充值送 point_send:集点卡活动 |
direct_send |
desc | string | 可选 | 32 | 活动详细说明 | 该活动是用于挽回流失用户的 |
budget_info | budgetinfo | 可选 | 活动预算(当活动类型为guess_send且营销工具promotool的数量大于1时,即口令随机送活动,活动预算为空,每张券的预算数量落在sendrule里的send_budget) | ||
└budget_type | string | 必填 | 16 | 预算类型 | quantity |
└budget_total | string | 必填 | 64 | 预算数量 | 10258 |
└sub_budget_dimension | string | 可选 | 64 | 设置每天的预算,如每天的预算设置为100,即该活动一天最多发放100次 | d:表示每天的预算; |
└sub_value | string | 可选 | 64 | 用于控制子纬度的预算数量 | 100:表示sub_dimension定义的纬度预算为100,若sub_dimension为d的话,则表示每天最多发放100张 |
constraint_info | constraintinfo | 必选 | 活动限制信息 | ||
└user_win_count | string | 可选 | 20 | 活动期间用户能够参与的次数限制
如果不设置则不限制参与次数 |
1 |
└crowd_restriction_value | string | 可选 | 1024 | 根据crowd_restriction的值不同,设置相应的值,如果crowd_restriction是“member_card”,crowd_restriction_value就是关联会员卡模版id集合,用逗号拼接 | 2018012020075000000022612371,2018012020076000000022612371 |
└user_win_frequency | string | 可选 | 32 | 活动期间用户能够参与的频率限制
如果不设置则不限制参与频率 每日中奖1次: d||1 每周中奖2次: w||2 每月中奖3次: m||3 |
d||3 |
└crowd_group_id | string | 可选 | 32 | 人群规则组id
仅直发奖类型活动设置有效,通过调用营销活动人群组规则创建接口参数返回 |
12344556 |
└crowd_restriction | string | 可选 | 128 | 针对指定人群的约束条件 | new_member_prom o:新会员 student:学生用户,仅对 direct_send类型下的代金券,折扣券活动有效 |
└suit_shops | string[] | 必填 | 20000 | 活动适用的门店列表
仅品牌商发起的招商活动可为空 最多支持10w家门店 |
2015110600077000000002125023,2015110600077000000002125022 |
└min_cost | string | 可选 | 32 | 最低消费金额,单位元
仅在创建消费送礼包活动时设置 |
100 |
└item_ids | string[] | 可选 | 20000 | 单品码列表
仅在创建消费单品送活动时设置,最多设置500个单品码,由商户根据自己的商品管理自定义,一般为国标码 |
212313,221322 |
auto_delay_flag | string | 可选 | 1 | 是否自动续期活动,默认为n,只有当对应营销工具券有效期为相对有效期时才能设置成y | n |
promo_tools | promotool[] | 必选 | 营销工具集 | ||
└voucher | voucher | 可选 | 2048 | 券对象,当活动类型为point_send时为null,其他活动类型此字段必填 | |
└type | string | 必填 | 10 | 券类型,目前支持以下类型:
exchange:兑换券; money:代金券; reduceto:减至券; rate:折扣券; per_full_cut:每满减券 |
money |
└verify_mode | string | 可选 | 32 | 该字段仅在兑换券条件下(即券类型为exchange),用于设置兑换券的核销方式
user_click:用户自己点击券上的按钮核销 merchant_scan:商户通过app扫码核销 其他情况下此字段为空 |
merchant_scan |
└voucher_note | string | 可选 | 100 | 券的备注
用于收银系统识别指定券使用;如备注中传入“123”,券发出后核销时将在当面付接口将该值传回,供收银系统识别 |
券的备注 |
└desc_detail_list | voucherdescdetail[] | 可选 | 20000 | 券使用说明描述列表 | |
└title | string | 必填 | 2000 | 券说明的标题 | 温馨提示 |
└details | string[] | 可选 | 2000 | 具体描述信息列表 | 周一到周五可用 |
└images | string[] | 可选 | 2000 | 图片描述信息 | https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileids=ry7twkjvr26nz8oexrijvaaaacmaaqed&zoom=original |
└url | string | 可选 | 2000 | 券外部详情描述 | www.alipay.com |
└multi_use_mode | string | 可选 | 16 | 券叠加的属性,
仅全场券可设置该选项; no_multi:不可与其他全场券和单品券叠加; multi_use_with_single: 该全场优惠和单品优惠的叠加 ;multi_use_with_othe rs:该全场优惠和其他所有优惠都可以叠加 |
no_multi |
└rounding_rule | string | 可选 | 100 | 券核销时,抹零方式,目前支持: not_auto_rounding:不自动抹零 auto_rounding_yuan:自动抹零到元 auto_rounding_jiao:自动抹零到角 rounding_up_yuan:四舍五入到元 rounding_up_jiao:四舍五入到角 |
not_auto_rounding |
└name | string | 必填 | 32 | 名称 | 券的名称 |
└brand_name | string | 必填 | 20 | 券副标题 | 券副标题 |
└use_instructions | string[] | 必填 | 1024 | 券的使用说明
使用须知最多6条,且每条最多100字 |
券的使用说明 |
└logo | string | 必填 | 32 | 券logo文件id,调用图片上传接口alipay.offline.material.image.upload获得 | 1t8pp00at7eo9noajkmr3aaaacmaaqec |
└item_info | iteminfo | 可选 | 1024 | 单品信息
兑换券不允许设置单品信息 减至券必须设置单品信息 其他类型券可按需设置 |
|
└item_text | string | 必填 | 1024 | 单品券说明 | 单品券说明 |
└sku_min_consume | string | 可选 | 20 | 券适用sku的最低消费金额门槛
如券适用a,b两个sku,该字段设置的值为100,则订单中购买a,b两个sku的合计金额需大于100元才可用券 |
10 |
└item_name | string | 必填 | 1024 | 单品名称 | 单品名称 |
└item_imgs | string[] | 可选 | 1024 | 单品图片列表
单品图片不能超过3张 |
1t8pp00at7eo9noajkmr3aaaacmaaqec |
└item_link | string | 可选 | 1024 | 单品券详细介绍跳转链接 | www.taobao.com |
└original_price | string | 可选 | 64 | 单品的原价,单位元
必须为合法金额类型字符串,如9.99 |
28.88 |
└max_discount_num | string | 可选 | 32 | 单品券适用的商品列表中,每一个商品最高可享受优惠的件数;
如:券适用于a,b两种商品,该字段设置为1,则用券a,b两种商品每种最多只有一件可享受优惠; |
1 |
└min_consume_num | string | 可选 | 32 | 单品券适用商品列表中,每种商品享受优惠最低购买件数的门槛;
如:券适用于a,b两种商品,该字段设置为3,则a,b两种商品每种最少需要购买3件才可享受优惠; |
1 |
└item_ids | string[] | 可选 | 1024 | 券适用的单品码列表
最少配置1个单品码 最多配置500个单品码 |
0000123,0000124 |
└total_max_discount_num | string | 可选 | 20 | 如果一个单品券适用a,b,c三个单品,若设置了该字段为2,则在一笔交易中,a,b,c三个单品加起来最多只有俩件能够享受优惠 | 10 |
└voucher_img | string | 可选 | 1024 | 券图片文件id,调用上传图片接口alipay.offline.material.image.upload获得 | 1t8pp00at7eo9noajkmr3aaaacmaaqec |
└rate | string | 可选 | 10 | 折扣率
仅当券类型为折扣券时有效 有效折扣率取值范围0.11-0.99 仅允许保留小数点后两位 |
0.8 |
└max_amount | string | 可选 | 10 | 最高优惠金额,单位元
指用券最高可以优惠的金额 必须为合法金额类型字符串仅当券类型为折扣券(rate),每满减券(per_full_cut)有效 |
100 |
└worth_value | string | 可选 | 10 | 券面额,单位元必须为合法金额类型字符串券类型为代金券(money)、减至券(reduceto)、每满减券(per_full_cut)时必填
如: 代金券:10元代金券中的10为券面额; 每满减券:毎满100减10元,其中的10为券面额; 减至券:单品原价100,现价10元,其中10为券面额,单品减至券的券面额必须低于单品原价 |
10 |
└donate_flag | string | 可选 | 10 | 券是否可转赠,默认为可转赠 | true |
└validate_type | string | 必填 | 10 | 券有效期类型,目前支持以下类型:
relative:相对有效期 fixed:绝对有效期 |
fixed |
└start_time | date | 可选 | 32 | 券有效期的开始时间
仅在券有效期类型为绝对有效期时生效 |
2016-05-01 00:00:00 |
└end_time | date | 可选 | 32 | 券有效期的结束时间
仅在券有效期类型为绝对有效期时生效 必须晚于活动结束时间 |
2016-11-01 00:00:00 |
└relative_time | string | 可选 | 10 | 券相对有效期,单位天
仅在券有效期类型为相对有效期时生效 如,设5表示领券领取后5日内有效 |
1 |
└use_rule | userule | 必填 | 4096 | 券的使用规则信息 | |
└use_time | usetime[] | 可选 | 1024 | 券可用时间段 | |
└dimension | string | 可选 | 32 | 券可用时段时间维度,目前支持周(w) | w |
└values | string | 可选 | 64 | 券可用时间维度值
周维度的取值范围1-7(周一至周日),多个可用时段用逗号分隔 如"1,3,5",对应周一,周三,周五可用 |
1,3,5 |
└times | string | 可选 | 1024 | 券可用时间段
可用时间段起止时间用逗号分隔,多个时间段之间用^分隔 如, "16:00:00,20:00:00^21:00:00,22:00:00"表示16点至20点,21点至22点可用 时间段不可重叠 |
16:00:00,20:00:00^21:00:00,22:00:00 |
└pay_redirect_url | string | 可选 | 1024 | 券买单跳转链接 | https://mycar-parkingplatform.alipay-eco.com/pbizplatform/park/parking/staypaycarlist?entrance=1 |
└forbidden_time | forbbidentime | 可选 | 1024 | 券的不可用时间 | |
└days | string | 可选 | 1024 | 不可用日期区间,仅支持到天
不可用区间起止日期用逗号分隔,多个区间之间用^分隔 如"2016-05-01,2016-05-03^2016-10-01,2016-10-07"表示2016年5月1日至5月3日,10月1日至10月7日券不可用 |
2016-03-03,2016-03-08^2016-10-01,2016-10-01 |
└suit_shops | string[] | 必填 | 20000 | 券适用门店列表
仅品牌商发起的招商活动可为空 直发奖类型活动必须与活动适用门店一致 最多支持10w家门店 |
2015110600077000000002125023,2015110600077000000002125022 |
└min_consume | string | 可选 | 20 | 券核销的最低消费门槛,单位元 | 10 |
└ext_info | string | 可选 | 1024 | 扩展属性,无需设置 | \"key\":\"value\" |
└limit_rule | string | 可选 | 32 | 优惠券的使用支付渠道限制规
则, 不受支付渠道限制 :use_no_limit; 仅限口碑储值卡支付时可用 :use_on_current_pay_c hannel; 口碑储值卡支付时不可用 :not_allowed_use; 【备注】支付渠道限制不允许修改 |
use_no_limit |
└desc | string | 可选 | 1024 | 券详细说明
最多包含500个字符 |
券的详细说明 |
└display_config | displayconfig | 可选 | 1024 | 券的展示信息 | |
└slogan | string | 可选 | 1024 | 券的宣传语
含圈人的直领活动,且投放渠道选择了支付成功页或店铺的情况下必填 |
券的宣传语 |
└slogan_img | string | 可选 | 1024 | 券的宣传图片文件id
含圈人的直领活动,且投放渠道选择了店铺的情况下必填 |
1t8pp00at7eo9noajkmr3aaaacmaaqec |
└clause_terms | clauseterm[] | 可选 | 1024 | 券的说明条款 | |
└title | string | 可选 | 1024 | 说明title | 说明title |
└descriptions | string[] | 可选 | 1024 | 说明描述内容 | 说明描述内容 |
└effect_type | string | 必填 | 10 | 券生效的方式,目前支持以下方式
立即生效:immediately 延迟生效:delay 仅在券有效期类型为相对有效期时生效 |
immediately |
└delay_info | delayinfo | 可选 | 64 | 延迟生效信息 | |
└type | string | 必填 | 32 | 延迟类型,目前支持以下类型
absolutely:按绝对值延迟 byday:按天延迟 |
absolutely |
└value | string | 必填 | 32 | 延迟值,单位分钟
按绝对值延迟延迟24*60 (1天)表示,当日08:00:00领到的券要到隔日的08:00:00才能使用 按天延迟延迟24*60(1天)表示,当日08:00:00领到的券,隔日00:00:00点就可以用 |
1440 |
└ext_info | string | 可选 | 1024 | 券的扩展信息 | "key":"value" |
└available_amount | string | 可选 | 10 | 券剩余面额,单位元
券详情查询接口返回,可拆分券中的券详情展示用 |
100 |
└allow_split | boolean | 可选 | 4 | 是否允许拆分,券在核销的时候是否允许券的面额拆分使用。(仅限渠道类型为isv企业福利:isv_enterprise_benifit的场景使用) | false |
└status | string | 可选 | 16 | 单个营销工具的生效状态,当在招商部分券失效后会使用这个字段 | started |
└voucher_no | string | 可选 | 32 | 营销工具uid,创建营销活动时无需设置 | 2342343245234234 |
└point_card | pointcard | 可选 | 2048 | 集点卡工具,仅在活动类型为point_send时才有效且必填,其他活动类型此字段必须为null | |
└type | string | 必填 | 32 | 工具类型,目前支持:
集点卡:point_card |
point_card |
└name | string | 必填 | 32 | 工具的名称 | 集点卡 |
└desc | string | 可选 | 1024 | 工具的描述 | 集点卡的功能描述 |
└start_time | date | 必填 | 32 | 工具的有效期的起始时间 | 2016-05-01 00:00:00 |
└end_time | date | 必填 | 32 | 工具的有效期的结束时间(必须晚于活动的结束时间) | 2016-10-01 00:00:00 |
└logo | string | 可选 | 32 | 工具的logo文件id | 1t8pp00at7eo9noajkmr3aaaacmaaqec |
└send_rule | sendrule | 可选 | 1024 | 奖品发放的规则 | |
└min_cost | string | 可选 | 32 | 发券最低消费金额,单位元
活动类型为消费送且不是消费送礼包时设置 多营销工具之间不允许设置重复值 |
100 |
└send_num | string | 可选 | 32 | 发券数目
最少发1张券,最多发5张券 |
1 |
└send_budget | string | 可选 | 32 | 券的预算数量(仅对口令送随机抽奖有效,即当活动类型为guess_send,且营销工具promotool的个数大于1时,此字段必填,其余情况此字段必为空) | 1234 |
└allow_repeat_send | string | 可选 | 8 | 是否允许重复发奖:
true代表允许,false代表不允许 默认不设置,表明用户领取券后如果没有核销则不允许再次领取券 如果设置为true,表明如果用户领取券后没有核销,还可以继续领取该券 |
true |
publish_channels | publishchannel[] | 可选 | 投放渠道集,当活动类型为direct_send或者real_time_send时必填,当活动类型为consume_send时必须为空,当活动类型为guess_send时,投放渠道只能有一个且type只能为merchant_crowd | ||
└type | string | 必填 | 32 | 渠道类型,目前支持以下类型
qr_code:二维码投放 short_link:短连接投放 shop_detail:店铺页投放 payment_result:支付成功页 merchant_crowd:口令送 url_with_token:外部发奖活动,只有活动类型为direct_send时才支持 external:外部投放,口碑需要感知任何投放内容 |
shop_detail |
└name | string | 必填 | 32 | 渠道名称 | 投放到店铺 |
└config | string | 可选 | 1024 | 当type为merchant_crowd时,config需填入口令送的密码和图片,样例如下:"config":"{\"password\":\"口令送密码\",\"background_logo\":\"1t8pp00at7eo9noajkmr3aaaacmaaqec\"}" | "password":"口令送密码","background_logo":"1t8pp00at7eo9noajkmr3aaaacmaaqec" |
└ext_info | string | 可选 | 1024 | 扩展信息,无需配置 | "key":"value" |
recruit_tool | recruittool | 可选 | 招商工具信息 | ||
└start_time | date | 必填 | 32 | 招商开始时间 | 2016-06-06 12:00:00 |
└exclude_constraint_shops | boolean | 可选 | 5 | 如果这个值是true,那么活动的参与门店不需要招商 | true |
└end_time | date | 必填 | 32 | 招商结束时间 | 2016-06-06 12:00:00 |
└pid_shops | pidshopinfo[] | 必填 | 100000 | 招商pid和pid对应的门店列表(对于品牌商,此字段必填,活动和券的适用门店为空。对于商圈,此字段需为空,门店需要填在活动和券的适用门店上) | |
└pid | string | 必填 | 32 | 商户pid | 2088121232424234 |
└shop_ids | string[] | 可选 | 32 | pid下的门店列表 | 2015110600077000000002125023,2015110600077000000002125022 |
ext_info | string | 可选 | 1024 | 活动的扩展信息,无需设置 | \"key\":\"value\" |
1.3 公共响应参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | string | 是 | - | 网关返回码, | 40004 |
msg | string | 是 | - | 网关返回码描述, | business failed |
sub_code | string | 否 | - | 业务返回码,参见具体的api接口文档 | acq.trade_has_success |
sub_msg | string | 否 | - | 业务返回码描述,参见具体的api接口文档 | 交易已被支付 |
sign | string | 是 | - | 签名, | dzxh8eetuahoye3w1j poiphfdxoybfunn1lket/v7p4zjdyojwea6izs6hz0ydw5cp/viufub5i0/v5wens3oyr8zredqo6d futdlhdc efyckiqhbxizgngpdpdfp1pis7bdhhzrszhbrqb7o4k3dxc aanfauu4v6zdwczo= |
1.4 响应参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
audit_status | string | 选填 | 32 | 活动审批状态,
仅限服务商代商户创建活动时返回 auditing,审核中,reject为驳回,不返回表示通过 |
auditting |
camp_id | string | 必填 | 32 | 活动id | 1232433452 |
camp_status | string | 必填 | 32 | 活动状态,目前返回以下状态,
starting,活动启动中 started,活动已启动 |
started |
1.5 请求示例
alipayclient alipayclient = new defaultalipayclient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","gbk","alipay_public_key","rsa2");
koubeimarketingcampaignactivitycreaterequest request = new koubeimarketingcampaignactivitycreaterequest();
request.setbizcontent("{"
"\"out_biz_no\":\"0000001\","
"\"operator_id\":\"2088102146931393\","
"\"operator_type\":\"mer\","
"\"name\":\"消费满10元送1元代金券\","
"\"start_time\":\"2016-05-01 00:00:00\","
"\"end_time\":\"2016-10-01 00:00:00\","
"\"type\":\"direct_send\","
"\"desc\":\"该活动是用于挽回流失用户的\","
"\"budget_info\":{"
"\"budget_type\":\"quantity\","
"\"budget_total\":\"10258\","
"\"sub_budget_dimension\":\"d:表示每天的预算;\","
"\"sub_value\":\"100:表示sub_dimension定义的纬度预算为100,若sub_dimension为d的话,则表示每天最多发放100张\""
" },"
"\"constraint_info\":{"
"\"user_win_count\":\"1\","
"\"crowd_restriction_value\":\"2018012020075000000022612371,2018012020076000000022612371\","
"\"user_win_frequency\":\"d||3\","
"\"crowd_group_id\":\"12344556\","
"\"crowd_restriction\":\"new_member_prom"
"o:新会员"
"student:学生用户,仅对"
"direct_send类型下的代金券,折扣券活动有效\","
" \"suit_shops\":["
" \"2015110600077000000002125023\",\"2015110600077000000002125022\""
" ],"
"\"min_cost\":\"100\","
" \"item_ids\":["
" \"212313\",\"221322\""
" ]"
" },"
"\"auto_delay_flag\":\"n\","
" \"promo_tools\":[{"
" \"voucher\":{"
"\"type\":\"money\","
"\"verify_mode\":\"merchant_scan\","
"\"voucher_note\":\"券的备注\","
" \"desc_detail_list\":[{"
" \"title\":\"温馨提示\","
" \"details\":["
" \"周一到周五可用\""
" ],"
" \"images\":["
" \"https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileids=ry7twkjvr26nz8oexrijvaaaacmaaqed&zoom=original\""
" ],"
"\"url\":\"www.alipay.com\""
" }],"
"\"multi_use_mode\":\"no_multi\","
"\"rounding_rule\":\"not_auto_rounding\","
"\"name\":\"券的名称\","
"\"brand_name\":\"券副标题\","
" \"use_instructions\":["
" \"券的使用说明\""
" ],"
"\"logo\":\"1t8pp00at7eo9noajkmr3aaaacmaaqec\","
"\"item_info\":{"
"\"item_text\":\"单品券说明\","
"\"sku_min_consume\":\"10\","
"\"item_name\":\"单品名称\","
" \"item_imgs\":["
" \"1t8pp00at7eo9noajkmr3aaaacmaaqec\""
" ],"
"\"item_link\":\"www.taobao.com\","
"\"original_price\":\"28.88\","
"\"max_discount_num\":\"1\","
"\"min_consume_num\":\"1\","
" \"item_ids\":["
" \"0000123\",\"0000124\""
" ],"
"\"total_max_discount_num\":\"10\""
" },"
"\"voucher_img\":\"1t8pp00at7eo9noajkmr3aaaacmaaqec\","
"\"rate\":\"0.8\","
"\"max_amount\":\"100\","
"\"worth_value\":\"10\","
"\"donate_flag\":\"true\","
"\"validate_type\":\"fixed\","
"\"start_time\":\"2016-05-01 00:00:00\","
"\"end_time\":\"2016-11-01 00:00:00\","
"\"relative_time\":\"1\","
"\"use_rule\":{"
" \"use_time\":[{"
" \"dimension\":\"w\","
"\"values\":\"1,3,5\","
"\"times\":\"16:00:00,20:00:00^21:00:00,22:00:00\""
" }],"
"\"pay_redirect_url\":\"https://mycar-parkingplatform.alipay-eco.com/pbizplatform/park/parking/staypaycarlist?entrance=1\","
"\"forbidden_time\":{"
"\"days\":\"2016-03-03,2016-03-08^2016-10-01,2016-10-01\""
" },"
" \"suit_shops\":["
" \"2015110600077000000002125023\",\"2015110600077000000002125022\""
" ],"
"\"min_consume\":\"10\","
"\"ext_info\":\"\\\\\\\"key\\\\\\\":\\\\\\\"value\\\\\\\"\","
"\"limit_rule\":\"use_no_limit\""
" },"
"\"desc\":\"券的详细说明\","
"\"display_config\":{"
"\"slogan\":\"券的宣传语\","
"\"slogan_img\":\"1t8pp00at7eo9noajkmr3aaaacmaaqec\""
" },"
" \"clause_terms\":[{"
" \"title\":\"说明title\","
" \"descriptions\":["
" \"说明描述内容\""
" ]"
" }],"
"\"effect_type\":\"immediately\","
"\"delay_info\":{"
"\"type\":\"absolutely\","
"\"value\":\"1440\""
" },"
"\"ext_info\":\"\\\"key\\\":\\\"value\\\"\","
"\"available_amount\":\"100\","
"\"allow_split\":false"
" },"
"\"status\":\"started\","
"\"voucher_no\":\"2342343245234234\","
"\"point_card\":{"
"\"type\":\"point_card\","
"\"name\":\"集点卡\","
"\"desc\":\"集点卡的功能描述\","
"\"start_time\":\"2016-05-01 00:00:00\","
"\"end_time\":\"2016-10-01 00:00:00\","
"\"logo\":\"1t8pp00at7eo9noajkmr3aaaacmaaqec\""
" },"
"\"send_rule\":{"
"\"min_cost\":\"100\","
"\"send_num\":\"1\","
"\"send_budget\":\"1234\","
"\"allow_repeat_send\":\"true\""
" }"
" }],"
" \"publish_channels\":[{"
" \"type\":\"shop_detail\","
"\"name\":\"投放到店铺\","
"\"config\":\"\\\"password\\\":\\\"口令送密码\\\",\\\"background_logo\\\":\\\"1t8pp00at7eo9noajkmr3aaaacmaaqec\\\"\","
"\"ext_info\":\"\\\"key\\\":\\\"value\\\"\""
" }],"
"\"recruit_tool\":{"
"\"start_time\":\"2016-06-06 12:00:00\","
"\"exclude_constraint_shops\":true,"
"\"end_time\":\"2016-06-06 12:00:00\","
" \"pid_shops\":[{"
" \"pid\":\"2088121232424234\","
" \"shop_ids\":["
" \"2015110600077000000002125023\",\"2015110600077000000002125022\""
" ]"
" }]"
" },"
"\"ext_info\":\"\\\\\\\"key\\\\\\\":\\\\\\\"value\\\\\\\"\""
" }");
koubeimarketingcampaignactivitycreateresponse response = alipayclient.execute(request);
if(response.issuccess()){
system.out.println("调用成功");
} else {
system.out.println("调用失败");
}
1.6 响应示例
{
"koubei_marketing_campaign_activity_create_response": {
"code": "10000",
"msg": "success",
"audit_status": "auditting",
"camp_id": "1232433452",
"camp_status": "started"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
1.7 异常示例
{
"koubei_marketing_campaign_activity_create_response": {
"code": "20000",
"msg": "service currently unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
1.8 业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
req_validate_error | 参数校验错误 | 修改参数重试 |
campaign_biz_validate_error | 业务校验错误 | 根据具体错误提示修改参数重试 |
biz_invoke_error | 一些具体的错误,如“传入的门店不是该商户的门店”或者“券的延迟生效时间不是整数天”等 | 请根据错误信息修改入参 |
no_data_permission | 无该数据访问权限 | 检查商户是否有访问数据权限 |
shop_validate_fail | 门店校验不通过 | 检查商户门店是否合法 |
system_exception_error | 系统异常 | 稍后重试 |
operator_relation_invalid | 待运营关系校验错误 | 检查服务商和商户是否有代运营关系 |
1.9 触发通知类型
通知类型 | 描述 | 默认开启 |
---|---|---|
koubei_receive_coupon_notify | 口碑用户用集点兑换奖品成功通知 | 1 |
koubei_trade_pay_success_notify | 口碑集点卡活动门店,发生交易,支付或退款成功后,通知isv根据活动规则赠送或扣减集点 | 1 |
1.10 触发通知示例
https://www.merchant.com/receive_notify.htm?notify_type=trade_status_sync¬ify_id=91722adff935e8cfa58b3aabf4dead6ibe¬ify_time=2017-02-16 21:46:15&sign_type=rsa2&sign=wcot3d8kg71dtlkwn7r9pzuoxeabjwp8/fousxcuskxsovyxbpsaidpryscjhcjmaglncjokjqlj28/asl93jotw39fx6i07lxhnbpknezalwmvpdnqui01hzszf9v1i6ggzjbiad5lg8bzttxzoj87ub2i9guj3nr/nuc9vey=