私域营销
通过此接口可以咨询用户是否可以领取该活动优惠券，决定是否对用户展示该活动信息。
公共请求参数
业务请求参数
consult_activity_info_list｜待咨询的活动信息必选consultactivityinfo[]
【描述】待咨询的活动信息列表
activity_id｜活动 id必选string(128)
【描述】活动id
【示例值】201623213214325423
merchant_access_mode｜商户接入模式必选string(32)
【描述】商户接入模式
【枚举值】
商户自接入模式: self_mode
服务商代接入模式: agency_mode
【注意事项】选择服务商代接入模式需配合 app_auth_token 代调用使用
【示例值】self_mode
以下参数 二选一 传入
user_id｜用户uidstring(16)
【描述】领券的用户uid
新商户建议使用open_id替代该字段。对于新商户，user_id字段未来计划逐步回收，存量商户可继续使用。如使用open_id，请确认 应用-开发配置-openid配置管理 已启用。无该配置项，可查看openid配置申请。
【示例值】2088xxxx
open_id｜支付宝用户openidstring(128)
【描述】领券的用户openid 详情可查看 openid简介
【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
merchant_id｜商户pid可选string(32)
【描述】商户pid,默认为当前接口调用商户
【注意事项】接口调用者必须有商户代运营权限。
【示例值】2088102111111111
常见请求示例
单个活动查询
多个活动查询
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.marketing.activity.consult&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'app_auth_token=${app_auth_token}' \
-f 'biz_content={
"consult_activity_info_list":[
{
"activity_id":"2023092800826004156025466103"
}
],
"merchant_access_mode":"self_mode",
"user_id":"2088022830116984",
"open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5"
}' 说明：本示例仅供参考。
公共响应参数
业务响应参数
consult_result_info_list｜咨询后的活动结果信息必选consultactivityresultinfo[]
【描述】咨询后的活动结果信息
activity_id｜活动 id必选string(128)
【描述】活动id
【示例值】201632453456645
consult_result_code｜结果code必选string(64)
【描述】咨询结果码
【枚举值】
可以领取: success
不可领取，次数超过限制: count_over_limit
不可领取，预算不足: budget_not_enough
【示例值】activity_not_start
以下参数 二选一
user_id｜领券的用户uidstring(16)
【描述】领券的用户uid
新商户建议使用open_id替代该字段。对于新商户，user_id字段未来计划逐步回收，存量商户可继续使用。如使用open_id，请确认 应用-开发配置-openid配置管理 已启用。无该配置项，可查看openid配置申请。
【示例值】2088xxxxx
open_id｜用户openidstring(128)
【描述】领券的用户openid 详情可查看 openid简介
【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
响应示例
正常示例
异常示例
{
"alipay_marketing_activity_consult_response": {
"code": "10000",
"msg": "success",
"user_id": "2088xxxxx",
"open_id": "074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
"consult_result_info_list": [
{
"activity_id": "201632453456645",
"consult_result_code": "activity_not_start"
}
]
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}说明：本示例仅供参考。
公共错误码
业务错误码
| 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
|---|---|---|
| system_error | 系统繁忙 | 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试 |
| invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息，修改参数后进行重试 |
| biz_error | 业务异常商户没有代运营授权 | 服务商必须有对应商户的代运营授权。 |