访问路径:/api/audience/import
接口说明:导入客户数据,需要鉴权
限制说明:允许1分钟内连续请求1000次,否则返回:操作频繁,请稍后重试
URL结构
https://open.rabbitpre.com/api/audience/import
接口协议:HTTPS
HTTP请求方式:POST
请求参数
参数 | 必填 | 类型 | 说明 |
opfid | true | string | 开放平台id |
uid | true | string | 企业的账号id,若开放平台的集成对象是企业,则传该企业的账号id;若集成对象是平台,且要批量修改其存量第三方企业的用户身份,则不传uid;若集成对象是平台,且只修改其下某个第三方企业的用户身份,则传该第三方企业的账号id(若该账号id绑定了多个第三方企业,则还需传入companyId指定修改的企业,否则会批量修改多个绑定第三方企业的用户身份); |
companyId | false | string | 第三方企业id;若开放平台的集成对象是企业,则不传;若开放平台的集成对象是平台,传则只修改该第三方企业的用户身份,不传则批量修改该平台下所有第三方企业的用户身份。 |
publicParams | false | boolean | 导入配置 |
data | false | int | 导入数据,每次最大500条 |
publicParams
参数 | 必填 | 类型 | 说明 |
matchingType | false | int | 匹配方式(1: 精准匹配, 2: 模糊匹配) |
importMode | true | int | 导入方式(1: 完全导入, 2: 不完全导入) |
data
参数 | 必填 | 类型 | 说明 |
identities | true | array | 用户身份 |
realName | false | string | 真实姓名 |
sex | false | string | 性别(男、女) |
address | false | string | 地址 |
birthday | false | string | 生日 |
remark | false | string | 备注 |
customFields | false | array | 自定义字段 |
identities
参数 | 必填 | 类型 | 说明 |
identityValue | true | string | 用户身份值 |
identityType | true | string | 用户身份类型,如openid(微信openid)、 unionid(微信openid)、phone(手机号)等 |
platform | false | string | 平台类型,枚举值——gzh(微信公众号)、contentminiapp(微信小程序)、workwechat(企业微信-第三方应用)、selfbuilt(企业微信-自建应用)、YOUZAN(有赞)、EZR(驿客)、RP_LSY(零售云)、EXTERNAL(自建应用) |
appid | false | string | 应用id,如公众号appid、小程序appid、自建应用id等 |
isWeChatEcosystem | false | boolean | 是否微信生态(传了appid必须传此参数) |
注意:系统预设的用户身份包括微信openid、微信unionid、企业微信客户id和手机号,自定义的用户身份在导入前需要先创建。
customFields
参数 | 必填 | 类型 | 说明 |
configId | false | int | 自定义字段ID,兔展平台获取,需要在”用户>字段管理->添加字段“中增加字段获取ID |
configName | false | string | 自定义字段名称 |
values | false | string[] | 自定义字段值,单选和复选即单选和多选的对应的选项值 |
请求示例
换行和缩进只是为了更好的展示:
https://open.rabbitpre.com/api/audience/import
返回参数
参数 | 类型 | 说明 |
code | string | 状态码 |
errorCode | string | 错误状态码 |
msg | string | 响应信息 |
data | array | 失败详情,成功为null |
返回成功示例