口碑营销活动列表查询
公共参数
公共请求参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
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[] | 必选 | 查询条件 | ||
page_number | String | 可选 | 8 | 页码,默认为1 | 1 |
operator_id | String | 可选 | 32 | 操作人id,必须和operator_type配对存在,不填时默认是商户 | 123212312 |
operator_type | String | 可选 | 32 | 操作人类型,不填默认为 MER(外部商户)。支持枚举值如下: * MER:外部商户。 * MER_OPERATOR:外部商户操作员。 * PROVIDER:外部服务商。 * PROVIDER_STAFF:外部服务商员工。 | MER |
page_size | String | 可选 | 8 | 页大小,默认为20 | 20 |
公共响应参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
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= |
响应参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
total_number | String | 必填 | 8 | 总数量 | 10 |
camp_sets | CampBaseDto | 必填 | 活动列表 |
请求示例
响应示例
{
"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"
}
]
}
],
"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 | 待运营关系校验错误 | 检查服务商和商户是否有代运营关系 |
修改于 2023-11-27 07:46:20