接口说明
请求URI
/audience/info/batchAdd
功能描述
企业将自有系统中的用户资料导入营销平台，与营销平台内的用户进行统一识别与匹配
注意事项
**接口地址** `注意： 旧地址 /api/integrate/import/user/batchAdd`batchAdd 即将废弃。自建应用权限 用户->用户资料
调用方式
HTTPS 调用
POST https://integrate.rabbitpre.com/api/open/audience/info/batchAdd
请求数据类型
**请求方式** `POST`**consumes** `[ "application/json" ]`**produces** `
响应数据类型
[ "*application/*json" ]`**接口描述** `企业级接口，hearer必须携带X-Token`
**请求参数**
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
| X-ComponentToken | 第三方平台访问token（第三方平台） | header | false | string | |
| dto | dto | body | true | API导入 | API导入 |
...
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
| data | API导入公共参数 | body | false |array | API导入用户信息 |
| publicParams | API导入公共参数 | body | false |API导入客户档案配置参数 | API导入客户档案配置参数 |
**API导入用户信息**
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
| address | 地址 | body | false |string | |
| birthday | 生日 | body | false |string | |
| identityId | 身份识别Id | body | false |string | |
| identityType | 身份设别类型，若企业需要对现有客户追加一个身份类型，则使用此字段，若仅更新客户资料，可以不传此字段 | body | false |string | |
| industry | 行业 | body | false |string | |
| openid | 微信openid | body | false |string | |
| payFeature | 消费特点 | body | false |string | |
| phone | 手机 | body | false |string | |
| realName | 真实姓名 | body | false |string | |
| remark | 备注 | body | false |string | |
| sex | 性别 男 /女 | body | false |string | |
| tags | 运营标签，多个用,号隔开 | body | false |string | |
| unionid | 微信unionid | body | false |string | |
| userType | 用户类型 | body | false |string | |
**API导入客户档案配置参数**
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| ------------ | -------------------------------- |-----------|--------|----|--- |
| identifyWay | 模糊匹配 必传->身份识别方式 1.unionid>openid>手机号、 2.手机号>unionid>openid | body | false |integer(int32) | |
| importMode | 匹配结果处理，1 完全导入 2 不完全导入 | body | true |integer(int32) | |
| isMatching | 是否进行客户匹配：true or false | body | true |boolean | |
| matchingType | 匹配方式 1, "精准匹配" 2, "模糊匹配" | body | false |integer(int32) | |
**响应状态**
| 状态码 | 说明 | schema |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK |ApiResponse«API导入处理结果信息» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
...
| 参数名称 | 参数说明 | 类型 | schema |
| ------------ | -------------------|-------|----------- |
| code | | string | |
| data | | API导入处理结果信息 | API导入处理结果信息 |
| errorCode | | string | |
| msg | | string | |
...
请求头参数
属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
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 |
| 参数名称 | 参数说明 | 类型 | schema |
| ------------ | ------------------|--------|----------- |
| errorData | 数据格式错误部分 | array | API导入错误部分 |
| importFailNum | 导入失败数量 | integer(int32) | |
| importSuccessNum | 导入成功数量 | integer(int32) | |
| message | 提示信息 | string | |
| status | 任务状态,-1：失败 0: 进行中 1：成功 | integer(int32) | |
**API导入错误部分**
| 参数名称 | 参数说明 | 类型 | schema |
| ------------ | ------------------|--------|----------- |
| address | 地址 | string | |
| birthday | 生日 | string(date-time) | |
| errorMsg | 错误内容 | string | |
| identityid | 身份标识 | string | |
| industry | 行业 | string | |
| openid | 微信openid | string | |
| payFeature | 消费特点 | string | |
| phone | 手机号码 | string | |
| realName | 真实姓名 | string | |
| remark | 备注 | string | |
| sex | 性别 1男 2女 | integer(int32) | |
| tags | 运营标签，多个用,号隔开 | string | |
| unionid | 微信unionid | string | |
| userType | 用户类型 | string | |
...