使用场景:

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


接口地址 /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导入数据bodytruearray客户资料

###客户资料导入配置

参数名称参数说明请求类型是否必须数据类型schema
isMatching是否进行客户匹配(true, false)bodytrueboolean
matchingType匹配方式(1: 精准匹配, 2: 模糊匹配)bodyfalseint
identifyWay模糊匹配 必传->身份识别方式(1: unionid>openid>手机号>客户ID, 2: 手机号>unionid>openid>客户ID)bodyfalseint
importMode导入方式(1: 完全导入, 2: 不完全导入)bodytrueint

###客户资料

参数名称参数说明请求类型是否必须数据类型schema
identityId身份识别IDbodyfalsestring
identityType身份设别类型,若企业需要对现有客户追加一个身份类型,则使用此字段,若仅更新客户资料,可以不传此字段bodyfalsestring
audienceUserId客户IDbodyfalsestring
openid微信openidbodyfalsestring
unionid微信unionidbodyfalsestring
phone手机bodyfalsestring
realName真实姓名bodyfalsestring
sex性别(男, 女)bodyfalsestring
address地址bodyfalsestring
birthday生日bodyfalsestring
remark备注bodyfalsestring
tags运营标签,多个用","号隔开bodyfalsestring
customFields自定义字段bodyfalsearray自定义字段

###自定义字段

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

###请求示例

{
	"publicParams":{
		"isMatching":true,
		"matchingType":1,
		"importMode":1
	},
	"data":[{
		"identityId":"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

###响应状态

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

###响应示例

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


  • 无标签