上传创建人群接口 -凯发app官方网站

产品地图

支付产品

私域产品

公域产品

营销产品

商家券 2.0

商家会员卡

红包

棋盘密云

产品介绍

接入指南

api 列表

接口上传人群

上传创建人群接口

标签圈选创建人群

管理人群

数据洞察

灰黑产人群接口

公共请求参数

参数	类型	是否必选	最大长度	描述	示例值
app_id	string	必选	32	支付宝分配给开发者的应用id	2014072300007148
method	string	必选	128	接口名称	alipay.merchant.qipan.crowd.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	必选	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	必选		请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

业务请求参数

crowd_name｜人群名称必选string[1,15]

【描述】人群名称最大长度为15个字符

【示例值】高日活人群

external_crowd_code｜商户外部人群code必选string[1,128]

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

【示例值】ab000472

user_list｜人群用户列表必选array[1,1000]

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

encrypt_identity_type｜加密身份类型必选string[1,64]

【描述】本字段用于标识上传用户信息的数据类型，具体取值请参照枚举值说明

【枚举值】

sha256加密的手机号码: sha256_mobile

支付宝openid: open_id

sha256加密的idfa: sha256_idfa

【示例值】sha256_mobile

encrypt_identity_id｜加密身份id必选string[1,128]

【描述】用户身份信息为手机号码时，加密方式如下： 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)

【示例值】1b65694c20a7fd6235f8a8b5803781c44201aa050e1ebb27ea92271dxxxxxxxx

alipay_app_id｜支付宝小程序app_id可选string[1,128]

【描述】支付宝小程序app_id，当encrypt_identity_type=open_id此值必传，且应传入openid对应的appid

【示例值】2021000000000000

crowd_desc｜支付宝人群描述可选string[1,256]

【描述】支付宝人群描述

【示例值】支付宝人群描述

hidden｜人群在棋盘站点是否不可见可选boolean

【描述】人群在支付宝棋盘站点是否可见,取值如下：

true-支付宝站点不可见

false-支付宝站点可见，默认值

使用说明：创建的人群后续需使用标签进行二次圈选，且本人群对商户不可见时可设置为true。

【示例值】false

apply_channel_list｜安全应用范围可选array[1,1000]

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

【示例值】["payment_result", "xlight"]

参数中文名	参数英文名	类型	是否必选	长度/取值	描述	示例值
人群名称	crowd_name	string	必选	长度范围：[1,15]	人群名称最大长度为15个字符	高日活人群
商户外部人群code	external_crowd_code	string	必选	长度范围：[1,128]	商户外部用户人群code 用于标识商家人群，需保证同一商户下crowd_code唯一	ab000472
支付宝人群描述	crowd_desc	string	可选	长度范围：[1,256]	支付宝人群描述	支付宝人群描述
人群在棋盘站点是否不可见	hidden	boolean	可选	-	人群在支付宝棋盘站点是否可见,取值如下： true-支付宝站点不可见 false-支付宝站点可见，默认值使用说明：创建的人群后续需使用标签进行二次圈选，且本人群对商户不可见时可设置为true。	false
人群用户列表	user_list	qipanmerchantcrowduser[]	必选	列表范围：[1,1000]	人群包含的用户列表单次上传用户数上限为1000，若用户量过大可分批通过alipay.merchant.qipan.crowduser.add接口上传
安全应用范围	apply_channel_list	string[]	可选	长度范围：[0,1024] 列表范围：[1,1000]	安全应用范围，参考文档未传值或传入渠道均非法时采用默认渠道，默认渠道：支付结果页aa、繁星激励。传入值时，以商户入参为准。	["payment_result", "xlight"]

常见请求示例

推荐示例

默认示例

curljavac#php

curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.merchant.qipan.crowd.create&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
 -f 'biz_content={
	"hidden":false,
	"crowd_name":"高日活人群",
	"user_list":[
		{
			"alipay_app_id":"2021000000000000",
			"encrypt_identity_type":"sha256_mobile",
			"encrypt_identity_id":"1b65694c20a7fd6235f8a8b5803781c44201aa050e1ebb27ea92271dxxxxxxxx"
		}
	],
	"external_crowd_code":"ab000472"
}'

说明：本示例仅供参考。

公共响应参数

参数	类型	是否必选	最大长度	描述	示例值
code	string	必选	-	网关返回码,	40004
msg	string	必选	-	网关返回码描述,	business failed
sub_code	string	可选	-	业务返回码，参见具体的api接口文档	acq.trade_has_success
sub_msg	string	可选	-	业务返回码描述，参见具体的api接口文档	交易已被支付
sign	string	必选	-	签名,	dzxh8eetuahoye3w1j poiphfdxoybfunn1lket/v7p4zjdyojwea6izs6hz0ydw5cp/viufub5i0/v5wens3oyr8zredqo6d futdlhdc efyckiqhbxizgngpdpdfp1pis7bdhhzrszhbrqb7o4k3dxc aanfauu4v6zdwczo=

业务响应参数

crowd_code｜支付宝人群code必选string(128)

【描述】支付宝人群code

【示例值】121104814297xxxxxxx

参数中文名	参数英文名	类型	是否必选	最大长度	描述	示例值
支付宝人群code	crowd_code	string	必选	128	支付宝人群code	121104814297xxxxxxx

响应示例

正常示例

异常示例

{
    "alipay_merchant_qipan_crowd_create_response": {
        "code": "10000",
        "msg": "success",
        "crowd_code": "121104814297xxxxxxx"
    },
    "sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}