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

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

访问路径:/api/audience/getAndUpdate

应用权限:   用户→用户修改

Type: POST

Author: zhuyanpeng

Content-Type: application/json; charset=utf-8

Description: 查询并更新客户档案

Body-parameters:

ParameterTypeRequiredDescription

companyId

string

false

第三方企业id;如果companyId不传,会通过token校验拿到当前数据集成对应的企业信息,如果要操作数据集成应用下面子企业的客户信息,那么companyId一定要传。

audienceUserId

int64

false

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

unionid

string

false

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

openid

string

false

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

phone

string

false

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

doc

object

false

需要更新客户档案的文档字段。

└─unionid

string

false

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

└─realName

string

false

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

└─sex

int32

false

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

└─avatar

string

false

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

└─wxNickname

string

false

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

└─wxCountry

string

false

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

└─wxProvince

string

false

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

└─wxCity

string

false

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

└─province

string

false

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

└─city

string

false

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

└─lbsProvince

string

false

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

└─lbsCity

string

false

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

└─openids

array

false

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

     └─appid

string

false

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

     └─fromTo

string

false

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

     └─identityId

string

false

系统集成身份ID。

     └─identityType

string

false

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

     └─jcappid

string

false

系统集成的应用ID。

     └─openid

string

false

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

     └─platform

string

false

平台类型。

     └─unionid

string

false

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

└─phoneList

array

false

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

     └─phone

string

false

手机号。

     └─source

string

false

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

     └─Verify

array

false

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

└─addressList

array

false

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

     └─address

string

false

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

Response-fields:

FieldTypeDescription

code

string

状态码

errorCode

string

错误状态码

msg

string

状态描述

data

object

数据

请求示例

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'X-Token: r9i6T6VXdAV0vjiMBxODFRddRVY' -d '{  
  "companyId": "123",
  "audienceUserId": 123,
  "unionid": "oilcW5hX5zbPudKpeAKVAGz9u11"
  "openid": "oqm2m5MEyDHmLy3ySThLOHsiM22",
  "phone": "13888888888",
  "doc": {
	"unionid": "oilcW5hX5zbPudKpeAKVAGz9u11",
	"realName": "小兔子",
	"sex": 1,
	"avatar": "https://file3.rabbitpre.com/f5c8c727-cc57-4f6d-8874-1895cfc875ee-7266",
	"wxNickname": "小兔子",
	"wxCountry": "中国",
	"wxProvince": "广东"
	"wxCity": "深圳",
	"province": "广东",
	"city": "深圳",
	"lbsProvince": "广东",
	"lbsCity": "深圳",
    "openids": [
      {
        "appid": "wx123123123",
        "fromTo": "gzh",
        "identityId": "123",
        "identityType": "phone",
        "jcappid": "123",
        "openid": "oqm2m5MEyDHmLy3ySThLOHsiM22",
        "platform": "gzh",
        "unionid": "oilcW5hX5zbPudKpeAKVAGz9u11"
      }
    ],
    "phoneList": [
      {
        "isVerify": "1",
        "phone": "13888888888",
        "source": [
          "form"
        ]
      }
    ],
    "addressList": [
      {
        "address": "深圳"
      }
    ]
  }
 }' 'https://integrate.rabbitpre.com/api/open/api/audience/getAndUpdate'

返回成功示例


{
    "code":"200",
    "errorCode":"SUCCESS",
    "msg":"ok",
    "data":null
}