访问路径:/api/audience/import

接口说明:导入客户数据,需要鉴权

限制说明:允许1分钟内连续请求1000次,否则返回:操作频繁,请稍后重试

URL结构

https://open.rabbitpre.com/api/audience/import

接口协议:HTTPS

HTTP请求方式:POST

请求参数


参数必填类型说明
opfidtrue
string
开放平台id
uidtrue
string
企业的账号id,若开放平台的集成对象是企业,则传该企业的账号id;若集成对象是平台,且要批量修改其存量第三方企业的用户身份,则不传uid;若集成对象是平台,且只修改其下某个第三方企业的用户身份,则传该第三方企业的账号id(若该账号id绑定了多个第三方企业,则还需传入companyId指定修改的企业,否则会批量修改多个绑定第三方企业的用户身份);
companyIdfalse
string
第三方企业id;若开放平台的集成对象是企业,则不传;若开放平台的集成对象是平台,传则只修改该第三方企业的用户身份,不传则批量修改该平台下所有第三方企业的用户身份。
publicParamsfalse
boolean
导入配置
datafalseint导入数据,每次最大500条

publicParams

参数必填类型说明
matchingTypefalseint匹配方式(1: 精准匹配, 2: 模糊匹配)
importModetrueint导入方式(1: 完全导入, 2: 不完全导入)

data

参数必填类型说明
identitiestruearray用户身份
realNamefalsestring真实姓名
sexfalsestring性别(男、女)
addressfalsestring地址
birthdayfalsestring生日
remarkfalsestring备注
customFieldsfalsearray自定义字段

identities

参数必填类型说明
identityValuetruestring用户身份值
identityTypetruestring用户身份类型,如openid(微信openid)、 unionid(微信openid)、phone(手机号)等
platformfalsestring平台类型,如公众号平台(gzh)、企业微信平台(workwechat)等
appidfalsestring应用id,如公众号appid、小程序appid、自建应用id等
isWeChatEcosystemfalseboolean是否微信生态(传了appid必须传此参数)

注意:系统预设的用户身份包括微信openid、微信unionid、企业微信客户id和手机号,自定义的用户身份在导入前需要先创建。


customFields

参数必填类型说明
configIdfalseint自定义字段ID,兔展平台获取,需要在”用户>字段管理->添加字段“中增加字段获取ID
configNamefalsestring自定义字段名称
valuesfalsestring[]自定义字段值,单选和复选即单选和多选的对应的选项值

请求示例

换行和缩进只是为了更好的展示:

https://open.rabbitpre.com/api/audience/import

返回参数

参数类型说明
code
string状态码
errorCodestring错误状态码
msgstring响应信息

data

array

失败详情,成功为null

返回成功示例

                  
  • 无标签