活动创建接口
koubei.marketing.campaign.activity.create(活动创建接口) 在线调试（沙箱环境）
公共参数
公共请求参数
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
| method | String | 是 | 128 | 接口名称 | koubei.marketing.campaign.activity.create |
| 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 |
| notify_url | String | 否 | 256 | 支付宝服务器主动通知商户服务器里指定的页面http/https路径。 | http://api.test.alipay.net/atinterface/receive_notify.htm |
| app_auth_token | String | 否 | 40 | 详见应用授权概述 | |
| biz_content | String | 是 | 请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档 |
请求参数
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| out_biz_no | String | 必选 | 32 | 外部批次ID，同一owner创建活动需要换out_biz_no，控制幂等 | 0000001 |
| operator_id | String | 可选 | 32 | 操作人id，必须和operator_type配对出现，不填时默认是商户 | 2088102146931393 |
| operator_type | String | 可选 | 32 | 操作人类型,有以下值可填：MER（外部商户），MER_OPERATOR（外部商户操作员），PROVIDER（外部服务商），PROVIDER_STAFF（外部服务商员工），默认不需要填这个字段，默认为MER | MER |
| name | String | 必选 | 32 | 活动名称 | 消费满10元送1元代金券 |
| start_time | Date | 必选 | 20 | 活动开始时间 | 2016-05-01 00:00:00 |
| end_time | Date | 必选 | 20 | 活动结束时间 | 2016-10-01 00:00:00 |
| type | String | 必选 | 20 | 活动类型，目前支持以下类型： CONSUME_SEND：消费送活动 DIRECT_SEND：直发奖活动 REAL_TIME_SEND：实时立减类活动 GUESS_SEND：口令送 RECHARGE_SEND：充值送 POINT_SEND：集点卡活动 | DIRECT_SEND |
| desc | String | 可选 | 32 | 活动详细说明 | 该活动是用于挽回流失用户的 |
| budget_info | BudgetInfo | 可选 | 活动预算（当活动类型为GUESS_SEND且营销工具PromoTool的数量大于1时，即口令随机送活动，活动预算为空，每张券的预算数量落在SendRule里的send_budget） | ||
| constraint_info | ConstraintInfo | 必选 | 活动限制信息 | ||
| auto_delay_flag | String | 可选 | 1 | 是否自动续期活动，默认为N,只有当对应营销工具券有效期为相对有效期时才能设置成Y | N |
| promo_tools | PromoTool[] | 必选 | 营销工具集 | ||
| publish_channels | PublishChannel[] | 可选 | 投放渠道集，当活动类型为DIRECT_SEND或者REAL_TIME_SEND时必填，当活动类型为CONSUME_SEND时必须为空，当活动类型为GUESS_SEND时，投放渠道只能有一个且type只能为MERCHANT_CROWD | ||
| recruit_tool | RecruitTool | 可选 | 招商工具信息 | ||
| ext_info | String | 可选 | 1024 | 活动的扩展信息，无需设置 | "key":"value" |
公共响应参数
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| 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= |
响应参数
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| audit_status | String | 选填 | 32 | 活动审批状态， 仅限服务商代商户创建活动时返回 AUDITING，审核中,REJECT为驳回，不返回表示通过 | AUDITTING |
| camp_id | String | 必填 | 32 | 活动ID | 1232433452 |
| camp_status | String | 必填 | 32 | 活动状态，目前返回以下状态， STARTING，活动启动中 STARTED，活动已启动 | STARTED |
请求示例
响应示例
异常示例
业务错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| REQ_VALIDATE_ERROR | 参数校验错误 | 修改参数重试 |
| CAMPAIGN_BIZ_VALIDATE_ERROR | 业务校验错误 | 根据具体错误提示修改参数重试 |
| BIZ_INVOKE_ERROR | 一些具体的错误，如“传入的门店不是该商户的门店”或者“券的延迟生效时间不是整数天”等 | 请根据错误信息修改入参 |
| NO_DATA_PERMISSION | 无该数据访问权限 | 检查商户是否有访问数据权限 |
| SHOP_VALIDATE_FAIL | 门店校验不通过 | 检查商户门店是否合法 |
| SYSTEM_EXCEPTION_ERROR | 系统异常 | 稍后重试 |
| OPERATOR_RELATION_INVALID | 待运营关系校验错误 | 检查服务商和商户是否有代运营关系 |
触发通知类型
| 通知类型 | 描述 | 默认开启 |
|---|---|---|
| koubei_receive_coupon_notify | 口碑用户用集点兑换奖品成功通知 | 1 |
| koubei_trade_pay_success_notify | 口碑集点卡活动门店，发生交易，支付或退款成功后，通知ISV根据活动规则赠送或扣减集点 | 1 |
触发通知示例
修改于 2023-11-27 07:44:52