使用场景:

企业将自有系统中的用户资料导入营销平台,与营销平台内的用户进行统一识别与匹配


接口地址 /api/integrate/audience/info/batchAdd

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

接口描述 企业级接口,hearer必须携带X-Token

应用权限 用户->用户资料

注意事项 旧地址 /api/integrate/import/user/batchAdd 即将废弃

#请求参数


###请求头参数

参数名称参数说明请求类型是否必须数据类型schema
X-Token自建应用访问tokenheadertruestring

###公共参数

参数名称参数说明请求类型是否必须数据类型schema
publicParams导入配置bodytrueobject用户资料导入配置
data导入数据,每次最大500条bodytruearray用户资料

###用户资料导入配置

参数名称参数说明请求类型是否必须数据类型schema
isMatching是否进行用户匹配(true, false)bodytrueboolean
matchingType匹配方式(1: 精准匹配, 2: 模糊匹配)bodyfalseint
identifyWay模糊匹配 必传->身份识别方式(1: 开放平台unionid>公众号openid>手机号>用户ID, 2: 用户ID>手机号>公众号openid>开放平台unionid)bodyfalseint
accurateMatchType精确匹配的应用类型(gzh: 公众号, workwechat: 企业微信, YOUZAN: 有赞, EZR: 驿客, contentminiapp: 小程序, contenthome: 小程序首页)bodyfalseString
accurateMatchValue精确匹配的应用IDbodyfalseString
importMode导入方式(1: 完全导入, 2: 不完全导入)bodytrueint

###用户资料

参数名称参数说明请求类型是否必须数据类型schema
identityType精确匹配 必填,身份识别类型(phone: 手机号码, id: 用户ID, openid: 公众号openid, unionid: 开放平台unionid)bodyfalsestring
thirdId用户IDbodyfalsestring
openid公众号openidbodyfalsestring
unionid开放平台unionidbodyfalsestring
phone手机bodyfalsestring
realName真实姓名bodyfalsestring
sex性别(男, 女)bodyfalsestring
address地址bodyfalsestring
birthday生日bodyfalsestring
remark备注bodyfalsestring
customFields自定义字段bodyfalsearray自定义字段

###自定义字段

参数名称参数说明请求类型是否必须数据类型schema
configId自定义字段ID,营销平台获取,需要在"用户>字段管理->添加字段"中增加字段获取IDbodyfalseint
configName自定义字段名称bodyfalsestring
values自定义字段值,单选和复选即单选和多选的对应的选项值bodyfalsestring[]

###请求示例

{
	"publicParams":{
		"isMatching":true,
		"matchingType":1,
		"importMode":1
	},
	"data":[{
		"identityType":"uid",
		"thirdId":"1",
		"customFields":[{
			"configId":1,
			"configName":"属性1",
			"values":["p1-1","p1-2"]
		},{
			"configId":2,
			"configName":"属性2",
			"values":["p2-1","p2-2"]
		}]
	}]
}

#响应参数


参数名称参数说明请求类型是否必须数据类型schema
code状态码bodytruestring
errorCode异常码bodytruestring
msg描述bodytruestring
data导入批次ID,用来查询导入结果,查询数据导入结果bodytruelong

###响应状态

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

###响应示例

{
    "code": "200",
    "errorCode": "SUCCESS",
    "msg": "ok",
    "data": 15314513451345123
}


  • 无标签