活动详情查询

查询活动详情

公共参数

公共请求参数

参数	类型	是否必填	最大长度	描述	示例值
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。通过 koubei.marketing.campaign.activity.create(活动创建接口)获取。	10000000000000000000000000000000
operator_id	String	可选	32	操作人id，必须和operator_type配对出现，不填时默认是商户	2088102147273384
operator_type	String	可选	32	操作人类型，不填默认为 MER（外部商户）。支持枚举值如下： * MER：外部商户。 * MER_OPERATOR：外部商户操作员。 * PROVIDER：外部服务商。 * PROVIDER_STAFF：外部服务商员工。	MER

公共响应参数

参数	类型	是否必填	最大长度	描述	示例值
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=

响应参数

参数	类型	是否必填	最大长度	描述	示例值
camp_detail	CampDetail	必填		活动详情

请求示例

java

php

http

响应示例

json

xml

{
    "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"
                        }
                    ]
                }
            ],
            "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",
                "sub_budget_dimension": "D:表示每天的预算;",
                "sub_value": "100:表示sub_dimension定义的纬度预算为100，若sub_dimension为D的话，则表示每天最多发放100张"
            },
            "constraint_info": {
                "user_win_count": "1",
                "cash_pool_id": "2017031100073001472700000GY7",
                "subsidy_percent": "95",
                "crowd_restriction_value": "2018012020075000000022612371,2018012020076000000022612371",
                "user_win_frequency": "D||3",
                "crowd_group_id": "12344556",
                "crowd_restriction": "NEW_MEMBER_PROM\r\nO:新会员\r\nSTUDENT：学生用户，仅对\r\nDIRECT_SEND类型下的代金券，折扣券活动有效",
                "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://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\""
                }
            ],
            "ext_info": "key:value"
        }
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

json

{
    "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	待运营关系校验错误	检查服务商和商户是否有代运营关系

活动详情查询

公共参数#

公共请求参数#

请求参数#

公共响应参数#

响应参数#

请求示例#

响应示例#

异常示例#

业务错误码#

公共参数

公共请求参数

请求参数

公共响应参数

响应参数

请求示例

响应示例

异常示例

业务错误码