koubei.marketing.campaign.activity.batchquery(口碑营销活动列表查询) 在线调试(沙箱环境)

查询活动列表

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
query_criterias Condition[] 必选 查询条件
field_name String 必填 32 字段名称,目前支持以下字段:
name: 活动名称
startTime: 开始时间
endTime: 结束时间
status:活动状态
status
field_value String 必填 64 对应于field_name的字段值,当field_name为status时,field_value支持STARTED、STARTING、MODIFYING、CLOSED、CLOSING、DISABLED几种值,用|分隔,代表查询这些状态中的活动,此时operator只能为IN,field_name为name时候value表示要查询的活动名,field_name为时间时,field_value为开始或结束时间,格式如2016-10-01 00:00:00 STARTING|STARTED
operator String 必填 16 操作符,EQUAL:等于,IN:范围。目前支持field_name=status且operator=IN,多个状态以"|"分隔 IN
page_number String 可选 8 页码,默认为1 1
operator_id String 可选 32 操作人id,必须和operator_type配对存在,不填时默认是商户 123212312
operator_type String 可选 32 操作人类型,有以下值可填:MER(外部商户),MER_OPERATOR(外部商户操作员),PROVIDER(外部服务商),PROVIDER_STAFF(外部服务商员工),默认不需要填这个字段,默认为MER MER
page_size String 可选 8 页大小,默认为20 20

响应参数

参数 类型 是否必填 最大长度 描述 示例值
total_number String 必填 8 总数量 10
camp_sets CampBaseDto 必填 活动列表
plan_status String 可选 32 招商状态,GOING招商中,ENDED招商结束,OFFLINE下架 GOING
audit_status String 可选 32 活动审核状态,AUDITING为审核中,REJECT为驳回,不返回为成功 AUDITTING
id String 必填 32 活动id 10000000000000000000000000100000
name String 必填 16 活动名称 消费送活动
type String 必填 16 活动类型.DIRECT_SEND:直发奖,CONSUME_SEND:消费送 CONSUME_SEND
auto_delay_flag String 可选 1 是否自动续期,Y为是,N为否,为空表示否 N
activity_orders ActivityOrderDTO[] 可选 2000 活动工单列表
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
status String 必填 8 活动状态,CREATED:草稿,ENABLED:生效,DISABLED:无效,STARTED:启动,CLOSED:停止,FINISHED:完成 CREATED
start_time Date 必填 20 启动时间 2016-12-12 12:00:00
end_time Date 必填 20 截至时间 2017-04-21 12:00:00

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiMarketingCampaignActivityBatchqueryRequest request = new KoubeiMarketingCampaignActivityBatchqueryRequest();
request.setBizContent("{" +
"      \"query_criterias\":[{" +
"        \"field_name\":\"status\"," +
"\"field_value\":\"STARTING|STARTED\"," +
"\"operator\":\"IN\"" +
"        }]," +
"\"page_number\":\"1\"," +
"\"operator_id\":\"123212312\"," +
"\"operator_type\":\"MER\"," +
"\"page_size\":\"20\"" +
"  }");
KoubeiMarketingCampaignActivityBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "koubei_marketing_campaign_activity_batchquery_response": {
        "code": "10000",
        "msg": "Success",
        "total_number": "10",
        "camp_sets": [
            {
                "plan_status": "GOING",
                "audit_status": "AUDITTING",
                "id": "10000000000000000000000000100000",
                "name": "消费送活动",
                "type": "CONSUME_SEND",
                "auto_delay_flag": "N",
                "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"
                    }
                ],
                "status": "CREATED",
                "start_time": "2016-12-12 12:00:00",
                "end_time": "2017-04-21 12:00:00"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

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