接口说明

请求URI

/audience/info/v2/batchAdd

功能描述

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

注意事项

自建应用权限 用户->用户资料。

身份类型在工作台中“用户”→“身份类型管理”中配置，需要在运营后台开通。

旧地址 ~~/api/integrate/import/user/batchAdd~~ 即将废弃
旧地址 ~~/api/integrate/audience/info/batchAdd~~ 即将废弃

调用方式

HTTPS 调用


POST https://integrate.rabbitpre.com/api/open/audience/info/v2/batchAdd

请求数据类型

[ "application/json" ]

响应数据类型

[ "application/json" ]

请求头参数

属性	类型	必填	说明
X-Token	string	是	自建应用访问token

请求体参数

属性	类型	必填	说明
publicParams	Object	是	用户资料导入配置
└─matchingType	int32	否	匹配方式(1: 精准匹配, 2: 模糊匹配)
└─importMode	int32	是	导入方式(1: 完全导入, 2: 不完全导入)
data	Array	是	用户资料。导入数据，每次最大500条
└─identities			注意：系统预设的用户身份包括微信openid、微信unionid、企业微信客户id和手机号，自定义的用户身份在导入前需要先创建。
└─identityValue	string	是	用户身份值
└─identityType	string	是	用户身份类型，如openid（微信openid）、 unionid（微信openid）、phone（手机号）等
└─platform	string	否	平台类型，枚举值——gzh（微信公众号）、contentminiapp（微信小程序）、workwechat（企业微信-第三方应用）、 selfbuilt（企业微信-自建应用）、YOUZAN（有赞）、EZR（驿客）、RP_LSY（零售云）、EXTERNAL（自建应用）
~~└─appid~~	~~string~~	否	~~应用id，如公众号appid、小程序appid、自建应用id等~~
└─mpid	string	否	应用id，如公众号appid、小程序appid、自建应用id等
└─isWeChatEcosystem	boolean	否	是否微信或企微生态下（传了~~appid~~ mpid必须传此参数）
└─realName	string	否	真实姓名
└─sex	string	否	性别(男, 女)
└─address	string	否	地址
└─birthday	string	否	生日
└─remark	string	否	备注
└─customFields	Array	否	自定义字段
└─configId	int64	否	自定义字段ID，营销平台获取，需要在”用户>字段管理->添加字段“中增加字段获取ID
└─configName	string	否	自定义字段名称
└─values	string[]	否	自定义字段值，单选和复选即单选和多选的对应的选项值

返回参数

属性	类型	说明
属性	类型	说明
code	string	响应状态码。200-请求成功， 100100-appid、secret错误， 100200-token错误，100300-授权code错误
data	long	导入批次ID，用来查询导入结果，查询数据导入结果
errorCode	string	错误码
msg	string	消息提示

调用示例

示例说明: HTTPS调用

请求数据示例

{
    "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"]
        }]
    }]
}

返回数据示例

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

错误码

错误码	错误码取值	解决方案
200	Success
401	Unauthorized
403	Forbidden
404	Not Found

接口地址 /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	自建应用访问token	header	true	string

###公共参数

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

###用户资料导入配置

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

###用户资料

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

###用户身份 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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~~ | mpid | 应用id，如公众号appid、小程序appid、自建应用id等 | body | false | String | isWeChatEcosystem | 是否微信或企微生态下（传了 ~~appid~~ mpid必须传此参数） | body | false | Boolean

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

###自定义字段

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

###请求示例

{
	"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"]
		}]
	}]
}

#响应参数

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

###响应状态

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

###响应示例

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

页面树结构

用户资料导入v2