使用场景:

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



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

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

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

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

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

身份类型在工作台中"用户"->"身份类型管理"中配置,需要在运营后台开通

#请求参数


###请求头参数

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

###公共参数

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

###用户资料导入配置

参数名称参数说明请求类型是否必须数据类型schema
matchingType匹配方式(1: 精准匹配, 2: 模糊匹配)bodyfalseint
importMode导入方式(1: 完全导入, 2: 不完全导入)bodytrueint

###用户资料

参数名称参数说明请求类型是否必须数据类型schema
identities用户身份 必填bodytruearray用户身份
realName真实姓名bodyfalsestring
sex性别(男, 女)bodyfalsestring
address地址bodyfalsestring
birthday生日bodyfalsestring
remark备注bodyfalsestring
customFields自定义字段bodyfalsearray自定义字段

###用户身份 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | identityValue | 用户身份值 | body | true | String | identityType | 用户身份类型,如openid(微信openid)、 unionid(微信openid)、phone(手机号)等 | body | true | String | platform | 平台类型,枚举值——gzh(微信公众号)、contentminiapp(微信小程序)、workwechat(企业微信-第三方应用)、selfbuilt(企业微信-自建应用)、YOUZAN(有赞)、EZR(驿客)、RP_LSY(零售云)、EXTERNAL(自建应用)| body | false | String | appid | 应用id,如公众号appid、小程序appid、自建应用id等 | body | false | String | isWeChatEcosystem | 是否微信生态(传了appid必须传此参数) | body | false | Boolean

注意:系统预设的用户身份包括微信openid、微信unionid、企业微信客户id和手机号,自定义的用户身份在导入前需要先创建。

###自定义字段

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

###请求示例

{
	"publicParams":{
		"matchingType":1,
		"importMode":1
	},
	"data":[{
		"identities": [{
			"identityValue": "18888888888",
			"identityType": "phone"
		}],
		"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
}


  • 无标签