使用场景:
企业将自有系统中的客户资料导入兔展平台,与兔展平台内的客户进行统一识别与匹配
接口地址 /api/integrate/audience/info/batchAdd
请求方式 POST
consumes ["application/json"]
produces ["application/json"]
接口描述 企业级接口,hearer必须携带X-Token
注意事项 旧地址
/api/integrate/import/user/batchAdd 即将废弃
#请求参数
###请求头参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
X-Token | 自建应用访问token | header | true | string |
###公共参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
publicParams | 导入配置 | body | true | object | 客户资料导入配置 |
data | 导入数据 | body | true | array | 客户资料 |
###客户资料导入配置
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
isMatching | 是否进行客户匹配(true, false) | body | true | boolean | |
matchingType | 匹配方式(1: 精准匹配, 2: 模糊匹配) | body | false | int | |
identifyWay | 模糊匹配 必传->身份识别方式(1: unionid>openid>手机号>客户ID, 2: 手机号>unionid>openid>客户ID) | body | false | int | |
importMode | 导入方式(1: 完全导入, 2: 不完全导入) | body | true | int |
###客户资料
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
identityId | 身份识别ID | body | false | string | |
identityType | 身份设别类型,若企业需要对现有客户追加一个身份类型,则使用此字段,若仅更新客户资料,可以不传此字段 | body | false | string | |
audienceUserId | 客户ID | body | false | string | |
openid | 微信openid | body | false | string | |
unionid | 微信unionid | body | false | string | |
phone | 手机 | body | false | string | |
realName | 真实姓名 | body | false | string | |
sex | 性别(男, 女) | body | false | string | |
address | 地址 | body | false | string | |
birthday | 生日 | body | false | string | |
remark | 备注 | body | false | string | |
tags | 运营标签,多个用","号隔开 | body | false | string | |
customFields | 自定义字段 | body | false | array | 自定义字段 |
###自定义字段
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
configId | 自定义字段ID,兔展平台获取,需要在"客户>字段管理->添加字段"中增加字段获取ID | body | false | int | |
configName | 自定义字段名称 | body | false | string | |
values | 自定义字段值,单选和复选即单选和多选的对应的选项值 | body | false | string[] |
###请求示例
{
"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 | 状态码 | body | true | string | |
errorCode | 异常码 | body | true | string | |
msg | 描述 | body | true | string |
###响应状态
状态码 | 说明 | schema |
---|---|---|
200 | OK | |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
###响应示例
{
"code": "200",
"errorCode": "SUCCESS",
"msg": "ok"
}