alipay.user.invite.award.receive (支付宝用户拉新领奖接口)

外部合作方调用此接口,用户手机号作为入参,判断用户新老,发放对应的凭证并返回抽奖结果,用户登录后领取奖品。

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.user.invite.award.receive
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
mobile String 可选 16 用户扫码抽奖输入的手机号,手机号和用户ID必须有一个非空,如果两者都有,则优先取user_id的值作为后续发奖的用户账号 18657111111
user_id String 可选 16 蚂蚁统一会员ID,手机号和用户ID必须有一个非空,如果两者都有,则优先取user_id的值作为后续发奖的用户账号 2088302210623933
out_biz_code String 可选 16 外部业务方代码 WHH
out_biz_no String 可选 128 外部业务号 2017053021342134

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
biz_result_code String 必填 32 业务处理结果码(NEW_ALREADY_AWARD:新用户凭证已发放、
NEW_AWARD_SUCESS:新用户凭证发放成功、OLD_AWARD_SUCCESS:老用户凭证成功、OLD_AWARD_OVER_LIMIT:老用户凭证发放次数超过上限、ACTIVITY_CLOSE:活动已结束、ACTIVITY_PAUSE:活动临时暂停)
NEW_AWARD_SUCESS
biz_result_desc String 必填 32 业务结果码对应的中文描述,见业务结果码描述 新用户凭证发放成功
mobile String 必填 16 用户输入的手机号回传 18657111111
alipay_account_no String 必填 128 支付宝老用户手机号绑定的脱敏后的账户名 ,多个账号用英文","分割 a62****133@126.com
user_attr String 必填 16 用户新老属性(NEW:新用户,OLD:老用户) NEW
ext_info String 选填 1024 扩展信息 {"key1":"value1","key2":"value2"}

请求示例

  • 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");
AlipayUserInviteAwardReceiveRequest request = new AlipayUserInviteAwardReceiveRequest();
request.setBizContent("{" +
"\"mobile\":\"18657111111\"," +
"\"user_id\":\"2088302210623933\"," +
"\"out_biz_code\":\"WHH\"," +
"\"out_biz_no\":\"2017053021342134\"" +
"  }");
AlipayUserInviteAwardReceiveResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_user_invite_award_receive_response":{
		"msg":"Success",
		"user_attr":"NEW",
		"code":"10000",
		"mobile":"18657111111",
		"biz_result_code":"NEW_AWARD_SUCESS",
		"ext_info":"{\"key1\":\"value1\",\"key2\":\"value2\"}",
		"biz_result_desc":"新用户凭证发放成功",
		"alipay_account_no":"a62****133@126.com"
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统繁忙 系统异常,重试接口
INVALID_PARAMETER 参数有误 接口入参不合法,如手机号为空、手机号格式不正确。修正入参后重试接口

公共错误码

返回
顶部