参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | koubei.marketing.campaign.activity.modify |
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 |
operator_id | String | 可选 | 32 | 操作人id,必须和operator_type配对出现,不填时默认是商户 | 2088102146931393 |
operator_type | String | 可选 | 32 | 操作人类型,不填默认为 MER(外部商户)。支持枚举值如下: * MER:外部商户。 * MER_OPERATOR:外部商户操作员。 * PROVIDER:外部服务商。 * PROVIDER_STAFF:外部服务商员工。 | MER |
camp_id | String | 必选 | 32 | 活动id,通过 koubei.marketing.campaign.activity.create(活动创建接口)获取。 | 20160525000000000616016000151382 |
name | String | 必选 | 32 | 活动名称。 注意:本参数不允许修改,必须与 koubei.marketing.campaign.activity.query(活动详情查询)接口查询结果保持一致。 | 消费满10元送1元代金券 |
start_time | Date | 必选 | 20 | 活动开始时间,格式为"yyyy-MM-dd HH:mm:ss"。 注意:本参数不允许修改,必须与 koubei.marketing.campaign.activity.query(活动详情查询)接口查询结果保持一致。 | 2016-05-01 00:00:00 |
end_time | Date | 必选 | 20 | 活动结束时间,格式为"yyyy-MM-dd HH:mm:ss"。 注意:活动结束时间只允许延长 | 2016-10-01 00:00:00 |
type | String | 必选 | 20 | 活动类型。 注意:本参数不允许修改,必须与 koubei.marketing.campaign.activity.query(活动详情查询)接口查询结果保持一致。 | CONSUME_SEND |
desc | String | 可选 | 32 | 活动详细说明。 注意:本参数不允许修改,必须与 koubei.marketing.campaign.activity.query(活动详情查询)接口查询结果保持一致。 | 该活动是用于挽回流失用户的 |
budget_info | BudgetInfo | 可选 | 活动预算 | ||
auto_delay_flag | String | 可选 | 1 | 是否自动续期活动,仅当活动下券的有效期均为相对有效期时才能设置成Y | N |
constraint_info | ConstraintInfo | 必选 | 活动限制信息 | ||
promo_tools | PromoTool[] | 必选 | 营销工具集 | ||
publish_channels | PublishChannel[] | 可选 | 投放渠道集,当活动类型为DIRECT_SEND或者REAL_TIME_SEND时必填,为CONSUME_SEND时必须为空 | ||
recruit_tool | RecruitTool | 可选 | 招商工具 | ||
ext_info | String | 可选 | 1024 | 活动的扩展信息 | "" |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
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_status | String | 选填 | 32 | 活动状态 | STARTED |
audit_status | String | 选填 | 32 | 活动子状态,如审核中 | AUDITTING |
{
"koubei_marketing_campaign_activity_modify_response": {
"code": "10000",
"msg": "Success",
"camp_status": "STARTED",
"audit_status": "AUDITTING"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
{
"koubei_marketing_campaign_activity_modify_response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
错误码 | 错误描述 | 解决方案 |
---|---|---|
INVALID_PARAMETER | 参数有误。 | 修改参数重试 |
NO_DATA_PERMISSION | 无该数据访问权限 | 检查商户是否有访问数据权限 |
CAMPAIGN_NOT_EXIST | 活动不存在 | 检查活动ID是否正确 |
SYSTEM_EXCEPTION_ERROR | 系统异常 | 稍后重试 |
OPERATOR_RELATION_INVALID | 代运营关系校验错误 | 检查服务商和商户是否有代运营关系 |
BIZ_ERROR | 业务异常。业务异常。 | 具体内容错误由api给出 |