koubei.marketing.campaign.activity.offline(活动下架接口) 在线调试(沙箱环境)

商户可以下架活动

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
out_biz_no String 必选 32 外部批次ID,每次需传入不同的值 0000001
camp_id String 必选 32 活动Id 001221324334
reason String 可选 1024 下架原因 下架原因
ext_info String 可选 1024 下架活动的扩展信息,不需要设置 ""
operator_id String 可选 32 操作人id,与operator_type必须配对存在,当不填的时候默认是商户 123344565
operator_type String 可选 32 操作人类型,有以下值可填:MER(外部商户),MER_OPERATOR(外部商户操作员),PROVIDER(外部服务商),PROVIDER_STAFF(外部服务商员工),默认不需要填这个字段,默认为MER MER

响应参数

参数 类型 是否必填 最大长度 描述 示例值
camp_status String 必填 32 活动状态 CLOSED
audit_status String 选填 32 活动子状态,如审核中 AUDITTING

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiMarketingCampaignActivityOfflineRequest request = new KoubeiMarketingCampaignActivityOfflineRequest();
request.setBizContent("{" +
"\"out_biz_no\":\"0000001\"," +
"\"camp_id\":\"001221324334\"," +
"\"reason\":\"下架原因\"," +
"\"ext_info\":\"\\\"\\\"\"," +
"\"operator_id\":\"123344565\"," +
"\"operator_type\":\"MER\"" +
"}");
KoubeiMarketingCampaignActivityOfflineResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "koubei_marketing_campaign_activity_offline_response": {
        "code": "10000",
        "msg": "Success",
        "camp_status": "CLOSED",
        "audit_status": "AUDITTING"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
REQ_VALIDATE_ERROR 参数校验错误 修改参数重试
SYSTEM_EXCEPTION_ERROR 系统异常 重试
BIZ_INVOKE_ERROR 一些具体的错误,如“传入的门店不是该商户的门店”或者“券的延迟生效时间不是整数天”等 请根据错误信息修改入参
NO_DATA_PERMISSION 无该数据访问权限 检查商户是否有访问数据权限
CAMPAIGN_NOT_EXIST 活动不存在 检查活动ID是否正确
OPERATOR_RELATION_INVALID 待运营关系校验错误 检查服务商和商户是否有代运营关系
onlineServer