...
Markdown |
---|
**接口地址** `自建应用配置` **请求方式** `POST` **consumes** `["application/json"]` **produces** `["application/json"]` **接口描述** `企业级接口,hearer必须携带X-Token` **应用权限** `用户->用户资料` **注意事项** # 请求参数 #请求参数 *** ###请求头参数### 请求头参数 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | X-Token | 自建应用访问token | header | true | string | | ### ###公共参数公共参数 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | orgId | 企业ID | body | false | string | | | appInstanceId | 应用实例ID | body | false | long | | | publicParamsopenids | 导入配置身份识别标识集合 | body | truefalse | objectarray | [用户资料导入配置身份识别标识](#用户资料导入配置#身份识别标识) | | dataphoneList | 导入数据,每次最大500条手机号码列表 | body | truefalse | array | [用户资料手机号码](#用户资料#手机号码) | ###用户资料导入配置 | 参数名称audienceUserId | 参数说明客户档案ID | 请求类型body | 是否必须false | 数据类型long | schema | | ------point | ------积分变动值 | ------body | ------true | ------int | ------ | | isMatchingremark | 是否进行用户匹配(true, false)备注 | body | true | booleanstring | | | matchingTypeeventType | 匹配方式(1: 精准匹配, 2: 模糊匹配) 行为类型 | body | false | intstring | | | identifyWayavatar | 模糊匹配 必传->身份识别方式(1: 开放平台unionid>公众号openid>手机号>用户ID, 2: 用户ID>手机号>公众号openid>开放平台unionid)用户头像 | body | false | intstring | | | accurateMatchTypenickName | 精确匹配的应用类型(gzh: 公众号, workwechat: 企业微信, YOUZAN: 有赞, EZR: 驿客, contentminiapp: 小程序, contenthome: 小程序首页)用户昵称 | body | false | string | | | contentId | 内容ID | body | false | Stringstring | | | accurateMatchValuecontentName | 精确匹配的应用ID内容名称 | body | false | Stringstring | | | importModeext | 导入方式(1: 完全导入, 2: 不完全导入)扩展信息 | body | truefalse | intstring | | ###用户资料### 身份识别标识 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | identityTypeopenid | 精确匹配 必填,身份识别类型(phone: 手机号码, id: 用户ID, openid: 公众号openid, unionid: 开放平台unionid) | body | false | string | | | thirdIdunionid | 用户ID | body | false | string | | | openidfromTo | 公众号openid | body | false | string | | | unionid | 开放平台unionid | 应用类型(contentminiapp:小程序, workwechat:企业微信外部联系人, gzh:公众号, workwechatgroup:客户群) | body | false | string | | | phoneappid | 手机应用ID | body | false | string | | | realNamejcappid | 真实姓名系统集成应用实例ID | body | false | stringlong | | | sexidentityId | 性别(男, 女)身份识别类型ID | body | false | string | | | addressidentityType | 地址 | body | false | string | | | birthday | 生日身份识别类型(phone: 手机号码, id: 第三方用户ID, openid: 公众号openid, unionid: 开放平台unionid) | body | false | string | | | remark | 备注 | body | false | string | | | customFields | 自定义字段 | body | false | array | [自定义字段](#自定义字段) | ###自定义字段 ### 手机号码 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | configIdphone | 自定义字段ID,营销平台获取,需要在"用户>字段管理->添加字段"中增加字段获取ID手机号 | body | false | intstring | | | configNameisVerify | 自定义字段名称 | body | false | string | | | values | 自定义字段值,单选和复选即单选和多选的对应的选项值是否验证(0:未验证, 1:已验证) | body | false | string[] | | ###请求示例### 请求示例 ```json { "publicParamsappInstanceId":{ 0, "audienceUserIds": [860484273911119872], "isMatchingavatar":true "", "contentId": "内容ID", "matchingTypecontentName":1 "内容明细", "eventType": "test", "importModeext":1 "", }"nickName": "用户昵称", "dataopenids": [ { "identityTypeappid": "uid", "thirdIdfromTo": "1", "customFieldsidentityId":[{ "", "configIdidentityType":1 "", "configNamejcappid":"属性1" 0, "valuesopenid":[ "p1-1","p1-2"] "unionid": "" } ],{ "orgId": "d515fa4b-8def-4188-8415-92632581795c", "configIdphoneList":2, [ { "configNameisVerify": "属性2", "valuesphone":["p2-1","p2-2"] "" } ] }], "point": 10, "remark": "积分自建应用测试" } ``` # 响应参数 #响应参数 *** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | code | 状态码 | body | true | string | | | errorCode | 异常码 | body | true | string | | | msg | 描述 | body | true | string | | | data | 导入批次ID,用来查询导入结果,[查询数据导入结果](http://docs.tuzhanai.com/pages/viewpage.action?pageId=1935628)操作是否成功 | body | true | longboolean | | ###响应状态### 响应状态 | 状态码 | 说明 | schema | | ------ | ------ | ------ | | 200 | OK | | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 响应示例 ###响应示例 ```json { "code": "200", "errorCode": "SUCCESS", "msg": "ok", "data": 15314513451345123true } ``` |