koubei.catering.crowdgroup.condition.set(口碑智慧餐厅精准营销用户人群分组操作接口) 在线调试(沙箱环境)

用于isv创建,更新,修改,删除用户分组规则

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
operation String 必选 100 智慧餐厅用户规则操作创建,删除,查询,更新枚举(CREATE("CREATE", "创建"),DELETE("DELETE", "删除"),RETRIEVE("RETRIEVE", "查询"), UPDATE("UPDATE", "修改")) CREATE
shop_id String 必选 100 门店id 2018032400077000000048031040
crowd_group_id String 必选 100 isv创建的用户分组id fufangzhaitest01
condition_model_list ConditionItemPattern[] 可选 人群规则(创建,更新的时候必填)
logical_operator String 必填 100 智慧餐厅用户规则操作符,EQ表示相等,GT表示大于,GTEQ表示大于等于,LT表示小于,LTEQ表示小于等于 EQ
period String 可选 100 描述周期字段;30,60,90,180,365;周期字段创建规则:消费金额,消费笔数,笔单价,领券数,核销券数时必填 30
operation_value String 必填 100 操作对应的值; 值>0 100
operator_rule String 必填 100 人群规则项:目前共支持九种标记规则,分别是:用户在商家下的交易金额(30,60,90,180,365)TRADE_AMT(单位:YUAN) 、用户在商家下的交易笔数(30,60,90,180,365)TRADE_CNT(单位:COUNT), 用户在商家下的笔单价(30,60,90,180,365)PCT_AMT(单位:YUAN), 用户在商家下的领券量(30,60,90,180,365)APPLY_VOUCHER_CNT((单位:TICKET), 用户在商家下的核券量(30,60,90,180,365) VERIFY_VOUCHER_CNT(单位:TICKET) 、用户在商家下的最后一次消费距离当前天数 LAST_PAY_DATE(单位:DAY)、用户在商家下最后一次交易金额 LAST_PAY_AMT(单位:YUAN)、用户家庭位置距离该PID下最近门店的距离HOME_SHOP_DIS((单位:KM)、用户工作位置距离该PID下最近门店的距离WORK_SHOP_DIS(单位:KM) TRADE_AMT
rule_unit String 必填 100 单位描述,DAY("DAY", "天"), KM("KM", "千米"), COUNT("COUNT","笔数") TICKET("TICKET","券") YUAN("YUAN","元") DAY
describe String 可选 100 针对用户分组的描述(创建和更新时必填) 爱这家天
operator_id String 必选 100 创建规则人的id号 2088222807744402
operator_type String 可选 100 智慧餐厅操作人类型,包括("MER", "外部商户"),("MER_OPERATOR", "外部操作员"),("PROVIDER", "外部服务商"),("PROVIDER_STAFF", "外部服务商员工");不传时默认是MER MER

响应参数

参数 类型 是否必填 最大长度 描述 示例值
crowd_group_id String 必填 100 isv创建的用户分组id wufangzhangtest01
condition_model_list ConditionItemPattern 选填 创建成功返回isv创建的分组规则列表
logical_operator String 必填 100 智慧餐厅用户规则操作符,EQ表示相等,GT表示大于,GTEQ表示大于等于,LT表示小于,LTEQ表示小于等于 EQ
period String 可选 100 描述周期字段;30,60,90,180,365;周期字段创建规则:消费金额,消费笔数,笔单价,领券数,核销券数时必填 30
operation_value String 必填 100 操作对应的值; 值>0 100
operator_rule String 必填 100 人群规则项:目前共支持九种标记规则,分别是:用户在商家下的交易金额(30,60,90,180,365)TRADE_AMT(单位:YUAN) 、用户在商家下的交易笔数(30,60,90,180,365)TRADE_CNT(单位:COUNT), 用户在商家下的笔单价(30,60,90,180,365)PCT_AMT(单位:YUAN), 用户在商家下的领券量(30,60,90,180,365)APPLY_VOUCHER_CNT((单位:TICKET), 用户在商家下的核券量(30,60,90,180,365) VERIFY_VOUCHER_CNT(单位:TICKET) 、用户在商家下的最后一次消费距离当前天数 LAST_PAY_DATE(单位:DAY)、用户在商家下最后一次交易金额 LAST_PAY_AMT(单位:YUAN)、用户家庭位置距离该PID下最近门店的距离HOME_SHOP_DIS((单位:KM)、用户工作位置距离该PID下最近门店的距离WORK_SHOP_DIS(单位:KM) TRADE_AMT
rule_unit String 必填 100 单位描述,DAY("DAY", "天"), KM("KM", "千米"), COUNT("COUNT","笔数") TICKET("TICKET","券") YUAN("YUAN","元") DAY
status String 必填 100 创建状态: success fail success

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiCateringCrowdgroupConditionSetRequest request = new KoubeiCateringCrowdgroupConditionSetRequest();
request.setBizContent("{" +
"\"operation\":\"CREATE\"," +
"\"shop_id\":\"2018032400077000000048031040\"," +
"\"crowd_group_id\":\"fufangzhaitest01\"," +
"      \"condition_model_list\":[{" +
"        \"logical_operator\":\"EQ\"," +
"\"period\":\"30\"," +
"\"operation_value\":\"100\"," +
"\"operator_rule\":\"TRADE_AMT\"," +
"\"rule_unit\":\"DAY\"" +
"        }]," +
"\"describe\":\"爱这家天\"," +
"\"operator_id\":\"2088222807744402\"," +
"\"operator_type\":\"MER\"" +
"  }");
KoubeiCateringCrowdgroupConditionSetResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "koubei_catering_crowdgroup_condition_set_response": {
        "code": "10000",
        "msg": "Success",
        "crowd_group_id": "wufangzhangtest01",
        "condition_model_list": [
            {
                "logical_operator": "EQ",
                "period": "30",
                "operation_value": "100",
                "operator_rule": "TRADE_AMT",
                "rule_unit": "DAY"
            }
        ],
        "status": "success"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAMETER 参数有误 检查入参
SYSTEM_ERROR 系统繁忙 稍后再试
PARAM_EMPTY 参数为空 确认入参
onlineServer