koubei.marketing.campaign.activity.query(活动详情查询) 在线调试(沙箱环境)

查询活动详情

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 koubei.marketing.campaign.activity.query
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
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
camp_id String 必选 32 活动id 10000000000000000000000000000000
operator_id String 可选 32 操作人id,必须和operator_type配对出现,不填时默认是商户 2088102147273384
operator_type String 可选 32 操作人类型,有以下值可填:MER(外部商户),MER_OPERATOR(外部商户操作员),PROVIDER(外部服务商),PROVIDER_STAFF(外部服务商员工),默认不需要填这个字段,默认为MER MER

响应参数

参数 类型 是否必填 最大长度 描述 示例值
camp_detail CampDetail 必填 活动详情
type String 必填 16 活动类型.DIRECT_SEND:直发奖,CONSUME_SEND:消费送 CONSUME_SEND
recruit_info RecruitInfo 可选 1024 招商信息
plan_id String 必填 32 招商方案id 12345566
exclude_constraint_shops Boolean 可选 5 是否参与门店参与了招商 true
start_time Date 必填 32 招商开始时间 2016-06-06 12:00:00
end_time Date 必填 32 招商结束时间 2016-06-06 12:00:00
status String 必填 32 招商状态 FINISH
activity_orders ActivityOrderDTO[] 必填 3000 活动工单列表
order_id String 必填 100 订单号 20160603000000000012811000155745
order_status String 必填 32 INIT:初始化;DOING:处理中;SUCCESS:成功;FAIL:失败 DOING
audit_status String 必填 32 INIT:初始化;AUDITING:审核中;REJECT:审核驳回;PASS:审核通过;CANCEL:审核撤销;FAIL:审核失败 AUDITING
order_type String 必填 32 CAMPAIGN_CREATE_ORDER:创建工单;CAMPAIGN_ENABLE_ORDER:生效工单;CAMPAIGN_START_ORDER:启动工单;CAMPAIGN_CLOSE_ORDER:关闭工单;CAMPAIGN_FINISH_ORDER:结束工单;CAMPAIGN_DELETE_ORDER:删除工单;CAMPAIGN_MODIFY_ORDER:修改工单 CAMPAIGN_CREATE_ORDER
activity_audit_list ActivityAuditDTO[] 可选 2000 工单中的审核信息
audit_id String 必填 100 审核id 12334
audit_status String 必填 32 INIT:初始化;AUDITING:审核中;REJECT:审核驳回;PASS:审核通过;CANCEL:审核撤销;FAIL:审核失败 AUDITING
reason String 可选 1000 审核通过或者审核驳回的原因 审核驳回
operation_time Date 可选 32 操作时间 2016-01-01 10:00:00
creator_id String 必填 32 操作人id 17023
creator_type String 必填 32 同活动中的角色列表 SALES
creator_id String 必填 255 活动各阶段操作发起人id,比如order_type=CAMPAIGN_CREATE_ORDER,那么这个id就是活动创建人的id。 1
creator_type String 必填 255 活动工单创建人类型,PROVIDER:服务商;PROVIDER_STAFF:服务商员工;SALES:BD人员;MER:商户 MER
id String 必填 32 活动id 10000000000000000000000000000000
name String 必填 16 活动名称 消费送
audit_status String 可选 32 活动子状态,如审核中 AUDITTING
status String 必填 8 活动状态,CREATED:草稿,ENABLED:生效,DISABLED:无效,STARTED:启动,CLOSED:停止,FINISHED:完成 CREATED
start_time Date 必填 20 活动开始时间 2016-12-12 12:00:00
auto_delay_flag String 可选 1 是否自动续期该活动,Y表示是,N表示否,默认为N N
end_time Date 必填 20 活动结束时间 2016-12-12 12:00:00
desc String 可选 64 活动描述 生日转享
budget_info BudgetInfo 必填 512 预算信息
budget_type String 必填 16 预算类型 QUANTITY
budget_total String 必填 64 预算数量 10258
constraint_info ConstraintInfo 必填 10240 活动约束信息
user_win_count String 可选 20 活动期间用户能够参与的次数限制
如果不设置则不限制参与次数
1
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_PROMO
suit_shops String[] 必填 20000 活动适用的门店列表
仅品牌商发起的招商活动可为空
最多支持10w家门店
2015110600077000000002125023,2015110600077000000002125022
min_cost String 可选 32 最低消费金额,单位元
仅在创建消费送礼包活动时设置
100
item_ids String[] 可选 20000 单品码列表
仅在创建消费单品送活动时设置,最多设置500个单品码,由商户根据自己的商品管理自定义,一般为国标码
212313,221322
promo_tools PromoTool[] 必填 10240 营销工具
voucher Voucher 可选 2048 券对象,当活动类型为POINT_SEND时为null,其他活动类型此字段必填
type String 必填 10 券类型,目前支持以下类型:
EXCHANGE:兑换券
MONEY:代金券
REDUCETO:减至券
RATE:折扣券
COUPON:红包
MONEY
verify_mode String 可选 32 该字段仅在兑换券条件下(即券类型为EXCHANGE),用于设置兑换券的核销方式
USER_CLICK:用户自己点击券上的按钮核销
MERCHANT_SCAN:商户通过APP扫码核销
其他情况下此字段为空
MERCHANT_SCAN
voucher_note String 可选 100 券的备注 券的备注
desc_detail_list VoucherDescDetail[] 可选 20000 券使用说明描述列表
title String 必填 2000 券说明的标题 温馨提示
details String[] 可选 2000 具体描述信息列表 周一到周五可用
images String[] 可选 2000 图片描述信息 https://dl.django.t.taobao.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_OTHERS:全场和其他所有优惠都可以叠加 NO_MULTI
name String 必填 32 名称 券的名称
brand_name String 可选 32 券副标题 券副标题
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 单品券说明 单品券说明
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 最高优惠商品件数 1
min_consume_num String 可选 32 最低购买商品件数 1
item_ids String[] 可选 1024 券适用的单品码列表
最少配置1个单品码
最多配置500个单品码
0000123,0000124
voucher_img String 可选 1024 券图片文件ID,调用上传图片接口alipay.offline.material.image.upload获得 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC
rate String 可选 10 折扣率
仅当券类型为折扣券时有效
有效折扣率取值范围0.11-0.99
仅允许保留小数点后两位
0.8
max_amount String 可选 10 最高优惠金额,单位元
必须为合法金额类型字符串
仅当券类型为DISOUNT有效
100
worth_value String 可选 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_CHANNEL;
储值卡支付时不可用: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"
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[] 必填 1024 投放渠道信息
type String 必填 32 渠道类型,目前支持以下类型:
QR_CODE:二维码投放;
SHORT_LINK:短连接投放;
SHOP_DETAIL:店铺页投放;
PAYMENT_RESULT:支付成功页;
MERCHANT_CROWD:口令送;
URL_WITH_TOKEN:外部发奖活动,只有活动类型为DIRECT_SEND时才支持;
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"
ext_info String 可选 1024 扩展参数 key:value

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiMarketingCampaignActivityQueryRequest request = new KoubeiMarketingCampaignActivityQueryRequest();
request.setBizContent("{" +
"\"camp_id\":\"10000000000000000000000000000000\"," +
"\"operator_id\":\"2088102147273384\"," +
"\"operator_type\":\"MER\"" +
"  }");
KoubeiMarketingCampaignActivityQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "koubei_marketing_campaign_activity_query_response": {
        "code": "10000",
        "msg": "Success",
        "camp_detail": {
            "type": "CONSUME_SEND",
            "recruit_info": {
                "plan_id": "12345566",
                "exclude_constraint_shops": true,
                "start_time": "2016-06-06 12:00:00",
                "end_time": "2016-06-06 12:00:00",
                "status": "FINISH"
            },
            "activity_orders": [
                {
                    "order_id": "20160603000000000012811000155745",
                    "order_status": "DOING",
                    "audit_status": "AUDITING",
                    "order_type": "CAMPAIGN_CREATE_ORDER",
                    "activity_audit_list": [
                        {
                            "audit_id": "12334",
                            "audit_status": "AUDITING",
                            "reason": "审核驳回",
                            "operation_time": "2016-01-01 10:00:00",
                            "creator_id": "17023",
                            "creator_type": "SALES"
                        }
                    ],
                    "creator_id": "1",
                    "creator_type": "MER"
                }
            ],
            "id": "10000000000000000000000000000000",
            "name": "消费送",
            "audit_status": "AUDITTING",
            "status": "CREATED",
            "start_time": "2016-12-12 12:00:00",
            "auto_delay_flag": "N",
            "end_time": "2016-12-12 12:00:00",
            "desc": "生日转享",
            "budget_info": {
                "budget_type": "QUANTITY",
                "budget_total": "10258"
            },
            "constraint_info": {
                "user_win_count": "1",
                "user_win_frequency": "D||3",
                "crowd_group_id": "12344556",
                "crowd_restriction": "NEW_MEMBER_PROMO",
                "suit_shops": [
                    "2015110600077000000002125023",
                    "2015110600077000000002125022"
                ],
                "min_cost": "100",
                "item_ids": [
                    "212313",
                    "221322"
                ]
            },
            "promo_tools": [
                {
                    "voucher": {
                        "type": "MONEY",
                        "verify_mode": "MERCHANT_SCAN",
                        "voucher_note": "券的备注",
                        "desc_detail_list": [
                            {
                                "title": "温馨提示",
                                "details": [
                                    "周一到周五可用"
                                ],
                                "images": [
                                    "https://dl.django.t.taobao.com/rest/1.0/image?fileIds=RY7twkJVR26nz8OeXRIjvAAAACMAAQED&zoom=original"
                                ],
                                "url": "www.alipay.com"
                            }
                        ],
                        "multi_use_mode": "NO_MULTI",
                        "name": "券的名称",
                        "brand_name": "券副标题",
                        "use_instructions": [
                            "券的使用说明"
                        ],
                        "logo": "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC",
                        "item_info": {
                            "item_text": "单品券说明",
                            "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"
                            ]
                        },
                        "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\""
                    },
                    "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\""
                }
            ],
            "ext_info": "key:value"
        }
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "koubei_marketing_campaign_activity_query_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
INVALIDARGUMENTS 参数错误 检查输入参数
NO_DATA_PERMISSION 无该数据访问权限 检查商户是否有访问数据权限
OPERATOR_RELATION_INVALID 待运营关系校验错误 检查服务商和商户是否有代运营关系
onlineServer