接口说明

请求URI

/audience/info/batchAdd

功能描述

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

注意事项

注意：旧地址 ~~/api/integrate/import/user/batchAdd~~ 即将废弃。自建应用权限 用户->用户资料

调用方式

HTTPS 调用


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

请求数据类型

[ "application/json" ]

响应数据类型

[ "application/json" ]

请求头参数

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

请求体参数

属性	类型	必填	说明
publicParams	Object	是	用户资料导入配置
└─isMatching	boolean	是	是否进行用户匹配(true, false)
└─matchingType	int32	否	匹配方式(1: 精准匹配, 2: 模糊匹配)
└─identifyWay	int32	否	模糊匹配必传->身份识别方式(1: 开放平台unionid>公众号openid>手机号>用户ID, 2: 用户ID>手机号>公众号openid>开放平台unionid)
└─accurateMatchType	string	否	精确匹配的应用类型(gzh: 公众号, workwechat: 企业微信, YOUZAN: 有赞, EZR: 驿客, contentminiapp: 小程序, contenthome: 小程序首页)
└─accurateMatchValue	string	否	精确匹配的应用ID
└─importMode	int32	是	导入方式(1: 完全导入, 2: 不完全导入)
data	Array	是	用户资料。导入数据，每次最大500条
└─identityType	string	否	精确匹配必填，身份识别类型(phone: 手机号码, id: 用户ID, openid: 公众号openid, unionid: 开放平台unionid)
└─thirdId	string	否	用户ID
└─openid	string	否	公众号openid
└─unionid	string	否	开放平台unionid
└─phone	string	否	手机
└─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":{
        "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"]
        }]
    }]
}

返回数据示例

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

错误码

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