活动领取咨询接口

通过此接口可以咨询用户是否可以领取该活动优惠券，决定是否对用户展示该活动信息。

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/marketing/activity/consult' \ --header 'Content-Type: application/json' \ --data-raw '{ "consult_activity_info_list": [ { "activity_id": "2016042700826004508401111111" } ], "merchant_access_mode": "AGENCY_MODE", "merchant_id": "2088102111111111", "open_id": "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5", "user_id": "2088xxxx" }'

{ "consult_result_info_list": [ { "activity_id": "2016042700826004508401111111", "consult_result_code": "ACTIVITY_NOT_START" } ], "open_id": "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5", "user_id": "2088xxxxx" }

请求参数

Body 参数application/json

consult_activity_info_list

array[object (ConsultActivityInfo) {1}]

可选

待咨询的活动信息列表

activity_id

string

活动id

可选

示例值:

2016042700826004508401111111

merchant_access_mode

string

商户接入模式

可选

示例值:

AGENCY_MODE

merchant_id

string

可选

商户PID,默认为当前接口调用商户。

示例值:

2088102111111111

open_id

string

可选

领券的支付宝用户openId

示例值:

074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5

user_id

string

领券的用户uid

可选

示例值:

2088xxxx

示例

返回响应

🟢200common response

application/json

Body

consult_result_info_list

array[object (ConsultActivityResultInfo) {2}]

可选

咨询后的活动结果信息

activity_id

string

活动id

可选

示例值:

2016042700826004508401111111

consult_result_code

string

可选

咨询结果码 SUCCESS：可以领取 COUNT_OVER_LIMIT：不可领取，次数超过限制 BUDGET_NOT_ENOUGH：不可领取，预算不足 ACTIVITY_NOT_START：活动未开始 ACTIVITY_NOT_PERMISSION：商户没有权限发放该活动 OTHER：不可领取，未知原因

示例值:

ACTIVITY_NOT_START

open_id

string

可选

领券的用户openId

示例值:

074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5

user_id

string

领券的用户uid

可选

示例值:

2088xxxxx

🔴500请求失败