alipay.marketing.campaign.drawcamp.trigger (营销抽奖活动触发抽奖)

营销抽奖活动触发抽奖

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.marketing.campaign.drawcamp.trigger
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 256 商户请求参数的签名串,详见签名 详见示例
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
user_id String 可选 200 支付宝用户uid:支付宝用户唯一标识。该参数用于已知支付宝账号的活动触发。user_id、login_id、bind_mobile三个参数至少有一个非空。 2088102164186692
login_id String 可选 150 用户登录账号名:邮箱或手机号。已知支付宝账号的活动触发调用中,user_id与login_id至少有一个非空,都非空时,以user_id为准。 username@gmail.com
camp_id String 必须 64 活动id,获取方式:调用方通过活动创建接口alipay.marketing.campaign.drawcamp.create 生成;联系支付宝运营同学获取(适用于支付宝平台活动,由合作伙伴调用触发) 3217382
bind_mobile String 可选 15 用户参与活动的手机号(如果是用户直接输入手机号的活动形式,该项必填,作为识别用户的依据) 13812341234
camp_source Number 可选 5 请求来源,目前支持:1微信 2 微博 3虾米 4淘宝 5天猫 1
json_ua String 可选 2048 rds嵌入页面的js收集的用户行为数据 1111111111111111
channel_info String 可选 200 渠道来源参数,记录调用方level 1~n级渠道来源信息,用于业务数据统计和分析 {level1:mapp,level2:hz}
client_ip String 可选 30 客户端ip 111.111.111.111

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
trigger_result Boolean 必填 5 是否中奖结果状态,如果为true时返回的结果中的其他字段非空,否则返回的其他字段为空 true
prize_id String 选填 64 奖品id 4324324
prize_name String 选填 200 奖品名称 立减
camp_log_id String 选填 64 活动流水id 20160505000123873823
camp_id String 选填 64 活动id 3217382
prize_flag String 选填 64 奖品唯一标识 74189237488923892
extend_field String 选填 1000 拓展字段, 常用key有: prize_amount(奖品金额,单位为元); prize_type(奖品类型); mobile_send_flag(拉新活动发放凭证标识,标识为true且接口返回错误码CERTIFICATE_SEND_SUCCESS时,表示新用户发凭证成功,引导用户使用该手机号注册支付宝账号); errorMsg(错误信息描述); errorMsgType(错误信息类型,包括:CAMP_NOT_VALID--活动未生效,FREQ_OR_COUNT_LIMIT--频率或次数超限,RULE_NOT_PASS--规则未通过,NOT_WIN--未中奖); ruleErrorCode(规则验证不通过的错误码,值为AE0111709606 且返回的errorMsg为“00005000-规则中心规则不通过”时,表示用户已领取过奖品) {"key1":"value1","key2":"value2"}
display_name String 选填 100 logonId的脱敏显示 138****1234

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingCampaignDrawcampTriggerRequest request = new AlipayMarketingCampaignDrawcampTriggerRequest();
request.setBizContent("{" +
"\"user_id\":\"2088102164186692\"," +
"\"login_id\":\"username@gmail.com\"," +
"\"camp_id\":\"3217382\"," +
"\"bind_mobile\":\"13812341234\"," +
"\"camp_source\":1," +
"\"json_ua\":\"1111111111111111\"," +
"\"channel_info\":\"{level1:mapp,level2:hz}\"," +
"\"client_ip\":\"111.111.111.111\"" +
"}");
AlipayMarketingCampaignDrawcampTriggerResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_marketing_campaign_drawcamp_trigger_response":{
		"msg":"Success",
		"code":"10000",
		"prize_id":"4324324",
		"camp_log_id":"20160505000123873823",
		"extend_field":"{\"key1\":\"value1\",\"key2\":\"value2\"}",
		"camp_id":"3217382",
		"prize_flag":"74189237488923892",
		"display_name":"138****1234",
		"trigger_result":true,
		"prize_name":"立减"
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
BIZ_CONTENT_IS_EMPTY 入参不合法,biz_content字段为空 在请求体中填充biz_content字段
BIZ_CONTENT_FORMAT_ERROR 入参不合法,biz_content字段格式错误 修改biz_content字段格式,符合json的格式
UNKNOW_SYSTEM_ERROR 系统繁忙,请稍后再试 请稍后再试
CAMP_ID_IS_EMPTY 入参不合法,camp_id字段为空 请填写camp_id字段
CAMP_IS_NOT_EXIST 非法的入参,活动不存在,请稍后再试 请检查活动ID后重试
CAMP_IS_NOT_OPEN 非法的入参,活动未开启,请稍后再试 活动未开启,请开启活动后再试
USER_ID_ILLEGAL 入参不合法,user_id不合法 user_id为空或者不合法,请修改为正确的值
CAMP_OPERATOR_ILLEGAL 非法的入参,活动创建人与调用者不一致 请确认活动的权限后再尝试
MOBILE_NOT_LOGON 手机号未注册 提示用户用该手机号注册
MOBILE_ILLEGAL 手机号不合法 填写合法的手机号
CERTIFICATE_QUERY_FAILED 活动关联的凭证查询失败 查看活动配置
CERTIFICATE_SEND_FAILED 拉新凭证发放失败 检查凭证发送流程
CERTIFICATE_SEND_SUCCESS 拉新凭证发放成功 此错误码表示根据拉新用户的手机号发放凭证成功,可根据具体业务需求对用户进行后续引导

公共错误码

返回
顶部