...
{
"code"
:
"200"
,
"errorCode"
:
"SUCCESS"
,
"msg"
:
"ok"
,
"data"
:
15314513451345123
}
错误码
错误码 | 错误码取值 | 解决方案 |
---|---|---|
200 | Success | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
Markdown |
---|
**接口地址** `/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和手机号,自定义的用户身份在导入前需要先创建。
###自定义字段
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| ------ | ------ | ------ | ------ | ------ | ------ |
| configId | 自定义字段ID,兔展平台获取,需要在"用户>字段管理->添加字段"中增加字段获取ID | body | false | int | |
| configName | 自定义字段名称 | body | false | string | |
| values | 自定义字段值,单选和复选即单选和多选的对应的选项值 | body | false | string[] | |
###请求示例
```json
{
"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"]
}]
}]
}
```
#响应参数
***
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| ------ | ------ | ------ | ------ | ------ | ------ |
| code | 状态码 | body | true | string | |
| errorCode | 异常码 | body | true | string | |
| msg | 描述 | body | true | string | |
| data | 导入批次ID,用来查询导入结果,[查询数据导入结果](http://wiki.tuzhanai.com/pages/viewpage.action?pageId=43342458) | body | true | long | |
###响应状态
| 状态码 | 说明 | schema |
| ------ | ------ | ------ |
| 200 | OK | |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
###响应示例
```json
{
"code": "200",
"errorCode": "SUCCESS",
"msg": "ok",
"data": 15314513451345123
}
``` |