上传创建人群

开发环境

POST

/v3/alipay/merchant/qipan/crowd/create

创建商家人群，商家可在支付宝端内基于人群进行精细化运营
注意:
商家人群的处理时效为T+1(当日调用接口，次日生效)

错误码

公共错误码

业务错误码

状态码	错误码	错误描述	解决方案
400	INVALID_PARAMETER	参数有误参数有误非法	检查输入参数
400	CROWD_ALREADY_EXIST	人群已存在，无法重复创建	调整参数，创建新的人群
400	SYSTEM_ERROR	系统繁忙	请联系技术支持
400	CROWD_NAME_EXIST	人群名称重复	请变更人群名称后重试
400	APPID_ERROR	用户列表中openId对应小程序不存在、状态不在线或非当前商家小程序	请检查用户列表中openId信息对应的appId是否正确
400	APPID_IS_BLANK	用户列表中openId对应appId未设置	请检查用户列表中openId信息对应的appId是否为空
400	CROWD_NUM_OVER_LIMIT	人群数量超过上限	将部分不再运营的人群进行失效后，即可创建人群
400	SYSTEM_ERROR	系统繁忙	请稍后重试

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/merchant/qipan/crowd/create' \
--header 'authorization: ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign' \
--header 'alipay-request-id: $requestid' \
--header 'Content-Type: application/json' \
--data-raw '{
	"crowd_name":"高日活人群",
	"external_crowd_code":"AB000472",
	"crowd_desc":"支付宝人群描述",
	"hidden":false,
	"user_list":[
		{
			"encrypt_identity_type":"SHA256_MOBILE",
			"encrypt_identity_id":"1b65694c20a7fd6235f8a8b5803781c44201aa050e1ebb27ea92271dxxxxxxxx",
			"alipay_app_id":"2021000000000000"
		}
	],
	"apply_channel_list":[
		"PAYMENT_RESULT",
		"XLIGHT"
	]
}'

响应示例

{
  "crowd_code": "121104814297xxxxxxx"
}

请求参数

Header 参数

authorization

string

必需

示例值:

ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign

alipay-request-id

string

必需

示例值:

$requestid

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

crowd_name

string

必需

人群名称最大长度为15个字符

external_crowd_code

string

必需

商户外部用户人群code 用于标识商家人群，需保证同一商户下crowd_code唯一

crowd_desc

string

支付宝人群描述

可选

hidden

boolean

可选

人群在支付宝棋盘站点是否可见,取值如下： true-支付宝站点不可见 false-支付宝站点可见，默认值使用说明：创建的人群后续需使用标签进行二次圈选，且本人群对商户不可见时可设置为true。

user_list

array [object {3}]

必需

人群包含的用户列表单次上传用户数上限为1000，若用户量过大可分批通过alipay.merchant.qipan.crowduser.add接口上传

encrypt_identity_type

string

可选

本字段用于标识上传用户信息的数据类型，具体取值请参照枚举值说明枚举值 sha256加密的手机号码: SHA256_MOBILE 支付宝openId: OPEN_ID sha256加密的idfa: SHA256_IDFA sha256加密的oaid: SHA256_OAID

encrypt_identity_id

string

可选

用户身份信息为手机号码时，加密方式如下： encrypt_identity_type=SHA256_MOBILE，encrypt_identity_id = sha256(手机号码) 用户身份信息为支付宝openId时，加密方式如下： encrypt_identity_type=OPEN_ID，encrypt_identity_id = 支付宝openId 用户身份信息为idfa时，加密方式如下： encrypt_identity_type=SHA256_IDFA，encrypt_identity_id = sha256(idfa) 用户身份信息为oaid时，加密方式如下： encrypt_identity_type=SHA256_OAID，encrypt_identity_id = sha256(oaid)

alipay_app_id

string

可选

支付宝小程序app_id，当encrypt_identity_type=OPEN_ID此值必传，且应传入openId对应的appId

apply_channel_list

array[string]

可选

安全应用范围，参考文档安全应用范围枚举未传值或传入渠道均非法时采用默认渠道，默认渠道：支付结果页AA、繁星激励。传入值时，以商户入参为准。

示例

返回响应

🟢200成功

application/json

Body

crowd_code

string

支付宝人群code

必需

修改于 2023-11-22 06:43:18

参考资料

人群中追加用户

上传创建人群

错误码#

公共错误码#

业务错误码#

请求参数

返回响应

错误码

公共错误码

业务错误码