使用场景：企业将自有系统中的客户导入兔展平台，与兔展平台内的客户进行统一识别与匹配
| Markdown |
|---|
**接口地址** `/api/integrate/import/user/batchAdd` |
...
**请求方式** `POST` |
...
**consumes** `["application/json"]` |
...
**produces** `["*/*"]` |
...
**接口描述** `企业级接口，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导入客户档案配置参数 | |
...
** |
...
导入用户信息** |
...
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 | | |
...
** |
...
导入用户与存量用户匹配规则参数** |
...
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 | |
...
| 参数名称 | 参数说明 | 类型 | 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 | |
...
|
|