文档中心 > API类目 > 生活号(原服务窗)API

alipay.open.public.matchuser.label.create (用户打标接口)

开发者可以使用此接口向匹配到的用户添加指定标签值,每个用户每个标签只能有一个标签值,当向同一个用户添加多个标签值时,最新的标签值会覆盖之前的标签值

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
matchers Matcher [] 必须 - 支付宝用户匹配器列表,最多传入10条
  • └ user_id
  • String
  • 可选
  • 32
  • 支付宝用户id,2088开头16位长度的字符串,与mobile_no、identity_card不能同时为空
  • 2088657487321235
  • └ mobile_no
  • String
  • 可选
  • 32
  • 手机号码,与user_id、identity_card不能同时为空
  • 15912341234
  • └ identity_card
  • String
  • 可选
  • 32
  • 身份证号码,与user_id、mobile_no不能同时为空
  • 421081180009761536
label_id String 必须 32 标签id,调用创建标签接口会返回label_id 10000
label_value String 必须 30 标签值,由开发者自主指定,标签值类型要满足创建标签接口中data_type参数的限定。 浙江

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
error_count Number 必填 10 用户打标失败数量 1
error_matchers ErrorMatcher [] 选填 - 出错的匹配器列表
  • matcher
  • Matcher
  • 必填
  • 1024
  • 用户打标接口出错的匹配器
  • └ user_id
  • String
  • 选填
  • 32
  • 支付宝用户id,2088开头16位长度的字符串,与mobile_no、identity_card不能同时为空
  • 2088657487321235
  • └ mobile_no
  • String
  • 选填
  • 32
  • 手机号码,与user_id、identity_card不能同时为空
  • 15912341234
  • └ identity_card
  • String
  • 选填
  • 32
  • 身份证号码,与user_id、mobile_no不能同时为空
  • 421081180009761536
  • └ error_msg
  • String
  • 必填
  • 64
  • 失败原因
  • 手机号码不合法

请求示例

  • 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");
AlipayOpenPublicMatchuserLabelCreateRequest request = new AlipayOpenPublicMatchuserLabelCreateRequest();
request.setBizContent("{" +
"      \"matchers\":[{" +
"        \"user_id\":\"2088657487321235\"," +
"\"mobile_no\":\"15912341234\"," +
"\"identity_card\":\"421081180009761536\"" +
"        }]," +
"\"label_id\":\"10000\"," +
"\"label_value\":\"浙江\"" +
"  }");
AlipayOpenPublicMatchuserLabelCreateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_open_public_matchuser_label_create_response":{
		"msg":"Success",
		"error_matchers":[
			{
				"error_msg":"手机号码不合法",
				"matcher":{
					"user_id":"2088657487321235",
					"mobile_no":"15912341234",
					"identity_card":"421081180009761536"
				}
			}
		],
		"code":"10000",
		"error_count":1
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
ILLEGAL_BIZ_PARAMS 无效的业务参数 请检查参数,传入正确的参数
MSG_MATCHER_INVALID 无效的匹配器matcher 匹配器matcher不能为空
LABEL_ID_IS_EMPTY 标签id不能为空 请传入标签id
LABEL_VALUE_IS_EMPTY 标签值不能为空 请传入标签值
LABEL_VALUE_TOO_LONG 标签值过长 标签值长度不能超过30
MATCHER_PARAMS_IS_EMPTY 匹配器matcher中参数不能同时为空 匹配器matcher中参数不能同时为空
MOBILE_NO_INVALID 无效的手机号码 请传入正确的手机号码
IDENTITY_CARD_INVALID 无效的身份证号码 请传入正确的身份证号码
LABEL_NOT_EXISTS 应用没有这个标签 请传入正确的标签id
DATA_TYPE_INVALID 数据类型不合法 数据类型不合法
NOT_MATCHED_ACCOUNT 未匹配到对应的支付宝账号 未匹配到对应的支付宝账号
OPEN_ID_IS_ILLEGAL 用户id无效 传入的用户id无效

公共错误码

返回
顶部