访问路径:/api/audience/getAndUpdate

接口说明:根据条件查询客户档案,如果查到一个,就更新

限制说明:允许两秒请求一次,否则返回:操作频繁,请稍后重试

URL结构

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

接口协议:HTTPS

HTTP请求方式:POST

请求参数

参数

必选

类型

说明

audienceUserId

false

long

客户Id,查询客户档案参数,与其他三个参数至少传一个。若传,则使用当前参数去查询客户档案,如不传,则匹配查询下一个条件,以此类推。

unionid

false

string

微信unionid,查询客户档案参数,与其他三个参数至少传一个。若传,则使用当前参数去查询客户档案,如不传,则匹配查询下一个条件,以此类推。

openidfalsestring微信openid,查询客户档案参数,与其他三个参数至少传一个。若传,则使用当前参数去查询客户档案,如不传,则匹配查询下一个条件,以此类推。
phonefalsestring手机号,查询客户档案参数,与其他三个参数至少传一个。若传,则使用当前参数去查询客户档案,如不传,则匹配查询下一个条件,以此类推。
docfalseobject需要更新客户档案的文档字段。

unionid

falsestring微信unionid,覆盖当前值。长度不允许超过36字符。

realName

falsestring真实姓名,覆盖当前值。长度不允许超过50字符。

sex

falseinteger性别,覆盖当前值。只能为 0 未知 1男 2女。

avatar

falsestring头像,覆盖当前值。长度不允许超过200字符。

wxNickname

falsestring微信昵称,覆盖当前值。长度不允许超过100字符。

wxCountry

falsestring微信资料获取的国家名称,覆盖当前值。长度不允许超过100字符。

wxProvince

falsestring微信资料获取的省名称,覆盖当前值。长度不允许超过100字符。

wxCity

falsestring微信资料获取的市名称,覆盖当前值。长度不允许超过100字符。

province

falsestring最近通过IP获取的省名称,覆盖当前值。长度不允许超过100字符。

city

falsestring最近通过IP获取的市名称,覆盖当前值。长度不允许超过100字符。

lbsProvince

falsestring通过地理位置授权获取的省名称,覆盖当前值。长度不允许超过100字符。

lbsCity

falsestring通过地理位置授权获取的市名称,覆盖当前值。长度不允许超过100字符。

openids

falselist需要新增的openid,在原列表基础上去重追加。

appid

falsestring小程序id 或 公众号id 或 企业微信id。

formTo

falsestring来源。contentminiapp 小程序,workwechat 企业微信外部联系人,gzh 公众号。

identityId

falsestring系统集成身份ID。

identityType

falsestring系统集成的身份类型。如 phone 手机、uid 用户id、openid 微信openid。

jcappid

falsestring系统集成的应用ID。

openid

falsestring微信openid。长度不允许超过64字符。

platform

falsestring平台类型。

unionid

falsestring微信unionid。长度不允许超过36字符。

phoneList

falselist需要新增的phone,在原列表基础上去重追加。最多保留15个,如超过,则只保留最新的15个。如果有相同手机号,来源集合会去重追加,验证信息保留已验证的。

phone

falsestring手机号。

source

falselist(string)来源。form表单 xcxauth 小程序授权 api接口 excel表格导入 manual手动添加。

isVerify

falsestring是否验证。0 未验证 1 验证。

addressList

falselist需要新增的address,在原列表基础上去重追加。最多保留10个,如超过,则只保留最新的10个。

address

falsestring地址。长度不允许超过60字符。

请求示例

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

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

请求JSON 参数


返回成功示例