...
POST https://integrate.rabbitpre.com/api/open/audience/info/v2/batchAdd
请求数据类型
[ "application/json" ]
...
[ "application/json" ]
请求头参数
属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
X-Token | string | 是 | 自建应用访问token |
请求体参数
属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| publicParams | Object | 是 | 用户资料导入配置 |
| └─matchingType | int32 | 否 | 匹配方式(1: 精准匹配, 2: 模糊匹配) |
| └─importMode | int32 | 是 | 导入方式(1: 完全导入, 2: 不完全导入) |
| data | Array | 是 | 用户资料。导入数据，每次最大500条 |
| └─identities | 注意：系统预设的用户身份包括微信openid、微信unionid、企业微信客户id和手机号， 自定义的用户身份在导入前需要先创建。 | ||
| └─identityValue | string | 是 | 用户身份值 |
| └─identityType | string | 是 | 用户身份类型，如openid（微信openid）、 unionid（微信openid）、phone（手机号）等 |
| └─platform | string | 否 | 平台类型，枚举值——gzh（微信公众号）、contentminiapp（微信小程序）、workwechat（企业微信-第三方应用）、 selfbuilt（企业微信-自建应用）、YOUZAN（有赞）、EZR（驿客）、RP_LSY（零售云）、EXTERNAL（自建应用） |
| └─mpid | string | 否 | 应用id，如公众号appid、小程序appid、自建应用id等 |
| └─isWeChatEcosystem | boolean | 否 | 是否微信或企微生态下（传了 |
| └─realName | string | 否 | 真实姓名 |
| └─sex | string | 否 | 性别(男, 女) |
| └─address | string | 否 | 地址 |
| └─birthday | string | 否 | 生日 |
| └─remark | string | 否 | 备注 |
| └─customFields | Array | 否 | 自定义字段 |
| └─configKey | string | 是 | 自定义字段英文名称，营销平台获取，需要在”用户>字段管理->添加字段“中增加字段英文名称(20230203新增,无需再传configId和configName) |
| └─values | string[] |
| 是 | 自定义字段值，单选和复选即单选和多选的对应的选项值 |
返回参数
属性 | 类型 | 说明 |
|---|
属性
类型
说明
code | string | 响应状态码。200-请求成功， 100100-appid、secret错误， 100200-token错误 ，100300-授权code错误 |
data | long | 导入批次ID，用来查询导入结果，查询数据导入结果 |
errorCode | string | 错误码 |
msg | string | 消息提示 |
...
调用示例
...
示例说明: HTTPS调用
...
请求数据示例
{ "publicParams":{ "matchingType":1, "importMode":1 }, "data":[{ "identities": [{ "identityValue": "18888888888", "identityType": "phone" }], "customFields":[{ "configKey":"englishName1", "values":["p1-1","p1-2"]
...
},{
...
"configKey":"englishName2", "values":["p2-1","p2-2"]
...
}]
...
}]
...
}
...
返回数据示例
{ "code": "200", "errorCode": "SUCCESS", "msg": "ok", "data": 15314513451345123}
错误码
错误码 | 错误码取值 | 解决方案 |
|---|---|---|
| 200 | Success | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |