4.1 券活动信息查询
请求URL:
测试环境: https://mkt-test.allinpay.com/mngapi/mng/actvtdetail
生产环境: https://mkt.allinpay.com/mngapi/mng/actvtdetail
请求path: /mngapi/mng/actvtdetail
请求入参:
|
参数 |
参数名 |
类型[长度] |
必填 |
描述 |
|
appid |
应用id |
String[10] |
是 |
基础营销平台分配,与报文头一致 |
|
opeid |
活动发起方id |
String[10] |
是 |
基础营销平台分配,与报文头一致 |
|
actid |
活动id |
String[10] |
是 |
|
返回参数:
|
参数 |
参数名 |
类型[长度] |
必填 |
描述 |
|
ret_code |
接口状态码 |
String(4) |
是 |
200-处理成功 详见附录 |
|
ret_msg |
接口错误信息 |
String |
是 |
|
|
result_code |
错误码 |
String(32) |
否 |
SUCCESS-调用成功 详见附录 |
|
result_msg |
错误信息 |
String |
否 |
|
|
appid |
应用id |
String[10] |
是 |
基础营销平台分配,与报文头一致 |
|
opeid |
运营方id |
String[10] |
是 |
基础营销平台分配 |
|
actid |
活动id |
String[10] |
是 |
|
|
branchid |
所属分公司 |
String[32] |
是 |
|
|
create_time |
创建时间 |
String[14] |
是 |
yyyyMMddHHmmss |
|
state |
状态 |
String[16] |
是 |
WAITCFM-待审核 FAILCFM-审核不通过 RUNNING-投放中 PAUSE-暂停投放 TERMINAL-终止投放 FINISHWO-终止核销 FINAL-完结 |
|
act_name |
活动名称 |
String[64] |
否 |
活动名称 |
|
act_banner |
活动banner |
String[128] |
否 |
|
|
act_desc |
活动描述 |
String[-] |
是 |
|
|
act_nature |
活动性质 |
String[10] |
是 |
MANJIAN-优惠券 STORE-礼品卡 TIMES-兑换卡 |
|
act_begin |
活动开始时间 |
String[14] |
是 |
yyyyMMddHHmmss |
|
act_end |
活动结束时间 |
String[14] |
是 |
yyyyMMddHHmmss |
|
funder_way |
预算分配方式 |
string |
是 |
ACTV-按活动预算 CPON-按券预算 |
|
actamt_plan |
预算金额 |
long |
是 |
单位：分，当按活动预算时，预算金额取该字段 |
|
actamt_make |
已发放金额 |
long |
是 |
单位：分,当按活动预算时，已发放金额取该字段 |
|
isconflict |
是否同活动券互斥 |
String[1] |
是 |
0-否 1-是，仅优惠券生效 |
|
make_chnl |
领取途径 |
string[10] |
否 |
wx：微信端 zfb：支付宝端 仅优惠券、礼品卡生效 |
|
actamt_plan_day |
单日预算金额上限 |
long |
否 |
单位：分 |
|
cptpl_list |
券模版列表 |
Array[Cptplinfo] |
否 |
券模版列表信息 |
其中券模版信息Cptplinfo的字段如下：
|
参数 |
参数名 |
类型[长度] |
必填 |
描述 |
|
tplid |
券模版id |
String[10] |
是 |
券模版id |
|
actid |
活动id |
String[10] |
是 |
|
|
cp_name |
券名称 |
String[64] |
是 |
券名称 |
|
cp_desc |
券描述 |
String[-] |
是 |
券描述 |
|
cp_nature |
券性质 |
String[4] |
是 |
SYS:平台券 CHL:渠道券 |
|
cp_type |
券类型 |
String[4] |
是 |
DJQ:优惠券 LPK:礼品卡 DHK:兑换卡 |
|
setamt_when_make |
礼品卡：面值类型 |
string[1] |
是 |
仅对礼品卡、兑换卡生效 |
|
cpamt |
券面额 |
long |
是 |
减免金额，单位：分 |
|
use_limitamt |
可用金额 |
long |
是 |
满多少金额可用，单位：分 |
|
use_limitamt_type |
可用金额类型 |
String[1] |
是 |
1:满多少金额可用 2:每满多少金额可用1张 |
|
valid_begin |
券可用时间 |
String[14] |
是 |
yyyyMMddHHmmss |
|
valid_end |
券可用时间 |
String[14] |
是 |
yyyyMMddHHmmss |
|
use_conflict |
是否排它使用 |
String[1] |
是 |
1：排他 0：不排他 仅优惠券、礼品卡生效 |
|
cp_state |
券状态 |
String[16] |
否 |
RUNNING：运行中 PAUSE：已暂停 |
|
valid_begindays |
投放后多少天生效 |
int |
否 |
|
|
valid_days |
有效期天数 |
int |
否 |
生效后有效天数 |
|
num_plan |
预算券数 |
int |
是 |
当按券预算时，预算券数取该字段 |
|
num_make |
已领券数 |
int |
是 |
当按券预算时，已领券数取该字段 |
|
use_limit_trxnum |
单笔可用张数 |
int |
是 |
默认1，-1代表不限制张数 |
|
user_limit |
用户可领取数量 |
int |
是 |
|
|
user_day_limit |
用户单日可领取数量 |
int |
是 |
|
|
limit_days_type |
可用日期类型 |
String[1] |
是 |
1-全部可用 2-指定日期时间段可用 3-指定周几可用 |
|
limit_days |
可用日期 |
String[-] |
否 |
如果为指定日期可用 yyyyMMdd-yyyyMMdd,yyyyMMdd-yyyyMMdd, 如果是指定周几可用 1,2,3 |
|
limit_times |
可用时间段 |
String[-] |
否 |
可用时间段 HHmmss-HHmmss,HHmmss-HHmmss 多个用逗号隔开，最多三个 |
|
act_conflict |
领用时排他 |
String[1] |
是 |
0-否 1-是 |
|
woer_type |
可核销主体类型 |
String[1] |
是 |
1-商户 2-代理商 3-门店 |
|
cp_single_amt |
单次实际金额 |
long |
否 |
仅兑换卡生效，兑换卡单次使用实际价格 |
|
cp_single_showamt |
单次展示金额 |
long |
否 |
仅兑换卡生效，兑换卡单次使用展示价格 |
|
make_num |
兑换次数 |
int |
否 |
仅兑换卡生效，当次数类型setamt_when_make=1时，兑换次数为单卡含兑换次数上限 |