文档中心 > API类目 > 历史接口

alipay.platform.userid.get (根据OpenId获取UserId)

2016年1月1日起,支付宝用于唯一标识用户的OpenId由于业务原因计划于2016年9月份废弃,之前记录过openid的商家可用本接口,将openid转为用户的userid,各个接口目前已同步返回用户的openid和userid,方便商家过渡。

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
open_ids String [] 必须 6400 openId的列表 20881017798171549451807262713691,20881017798171549451807262713691

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
dict String 必填 13400 id字典,key为openId,value为userId {"20881024598281958648689631813682":"2088102011745823","20881017798171549451807262713691":"2088102118109919"}

请求示例

  • 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");
AlipayPlatformUseridGetRequest request = new AlipayPlatformUseridGetRequest();
request.setBizContent("{" +
"      \"open_ids\":[" +
"        \"20881017798171549451807262713691\",\"20881017798171549451807262713691\"" +
"      ]" +
"  }");
AlipayPlatformUseridGetResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_platform_userid_get_response":{
		"msg":"Success",
		"code":"10000",
		"dict":"{\"20881024598281958648689631813682\":\"2088102011745823\",\"20881017798171549451807262713691\":\"2088102118109919\"}"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
XML_JSON_ERROR 解析XML/JSON出错 入参格式有误,非json
ILLEGAL_PARAMS 无效的参数 入参openId列表为空,请增加
MAX_SIZE_LIMIT 超过列表最大条数限制 最大查询个数为100个,请不要超过该限制
SYSTEM_ERROR 系统错误 检查请求参数,刷新重试

公共错误码

返回
顶部