使用场景:
企业将自有系统中的用户资料导入营销平台,与营销平台内的用户进行统一识别与匹配当积分主体配置为“外部积分系统”时,触发积分减少业务时,积分集成服务会请求积分类型自建应用中所配置的接口地址。
Markdown |
---|
**接口地址** `自建应用配置` **请求方式** `POST` **consumes** `["application/json"]` **produces** `["application/json"]` **接口描述** `企业级接口,hearer必须携带X-Token` **应用权限** `积分 -> `用户外部积分->用户资料`减少` **注意事项** # 请求参数 #请求参数 *** ### 请求头参数 ###请求头参数 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | X-Token | 自建应用访问token | header | true | string | | ### 公共参数 ###公共参数 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | publicParams| pointRecordId| 积分记录id | body | true| long| | | openids | 导入配置身份识别标识集合 | 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 | | | avatar | 用户头像 | body | identifyWayfalse | 模糊匹配 必传->身份识别方式(1: 开放平台unionid>公众号openid>手机号>用户ID, 2: 用户ID>手机号>公众号openid>开放平台unionid)string | | | nickName | 用户昵称 | body | false | intstring | | | accurateMatchTypecontentId | 精确匹配的应用类型(gzh: 公众号, workwechat: 企业微信, YOUZAN: 有赞, EZR: 驿客, contentminiapp: 小程序, contenthome: 小程序首页)内容ID | body | false | string | | | contentName | 内容名称 | body | false | Stringstring | | | accurateMatchValueext | 精确匹配的应用ID扩展信息 | body | false | string | | | instanceAppId| 自建应用appid | string | true | String | | | thirdCompanyId| 开放平台登陆componyId | string importMode| 非开放平台用户为空 | 导入方式(1: 完全导入, 2: 不完全导入) | bodyString | | | orgId| 企业id | string | true | intString | | ###用户资料### 身份识别标识 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | identityTypeopenid | 精确匹配 必填,身份识别类型(phone: 手机号码, id: 用户ID, openid: 公众号openid, unionid: 开放平台unionid) | body | false | string | | | thirdIdunionid | 用户ID | body | false | string | | | openidfromTo | 公众号openid 应用类型(contentminiapp:小程序, workwechat:企业微信外部联系人, gzh:公众号, workwechatgroup:客户群) | body | false | string | | | unionidappid | 开放平台unionid应用ID | body | false | string | | | phonejcappid | 手机系统集成应用实例ID | body | false | stringlong | | | realNameidentityId | 真实姓名身份识别类型ID | body | false | string | | | sexidentityType | 性别(男, 女身份识别类型(phone: 手机号码, id: 第三方用户ID, openid: 公众号openid, unionid: 开放平台unionid) | body | false | string | | ### 手机号码 | address参数名称 | 地址参数说明 | body请求类型 | false是否必须 | string数据类型 | schema | | birthday------ | 生日------ | body------ | false------ | string------ | ------ | | remarkphone | 备注手机号 | body | false | string | | | customFieldsisVerify | 自定义字段是否验证(0:未验证, 1:已验证) | body | false | arraystring | [自定义字段](#自定义字段) | ###自定义字段 ### 流程策略扩展信息字段 ext | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | configIdcomponentId | 自定义字段ID,营销平台获取,需要在"用户>字段管理->添加字段"中增加字段获取ID | 插件id|body | false | int string| | | configNamestrategyId | 自定义字段名称 策略id| body | false | string | | | values | 自定义字段值,单选和复选即单选和多选的对应的选项值 | strategyName|策略名称|body | false | string[] | | ### 请求示例 ###请求示例 ```json { "publicParamsappInstanceId":{ 0, "pointRecordId": 860484273911119872, "isMatchingaudienceUserId":true 860484273911119872, "avatar": "", "matchingTypecontentId":1 "内容ID", "importModecontentName":1 "内容明细", }, "data":[{ "identityType":"uid", "thirdId":"1", "customFields":[{ "configId":1, "configName":"属性1"eventType": "test", "ext":"{\"componentId\":\"5d28387a-c0ad-492c-acc7-66d8b5ad586d\",\"strategyId\":\"strategy_1653630397090_2\",\"strategyName\":\"策略001\",\"conditionVoList\":[],\"actionVo\":{\"type\":\"plugin\",\"roleType\":null,\"objId\":\"5d28387a-c0ad-492c-acc7-66d8b5ad586d\",\"objExtInfo\":\"[]\",\"componentId\":\"5d28387a-c0ad-492c-acc7-66d8b5ad586d\",\"action\":\"AddPoints\",\"frontAction\":null,\"params\":\"{\\\"action\\\":\\\"AddPoints\\\",\\\"point\\\":\\\"5\\\",\\\"sourceDesc\\\":\\\"新增5个积分\\\",\\\"DATA_BACK_UP_CONTAINER\\\":[{\\\"key\\\":\\\"targetRecord\\\",\\\"value\\\":[\\\"Plugin\\\",[],\\\"5d28387a-c0ad-492c-acc7-66d8b5ad586d\\\"],\\\"nestedRecord\\\":null},{\\\"id\\\":\\\"action\\\",\\\"key\\\":\\\"action\\\",\\\"value\\\":\\\"AddPoints\\\",\\\"paramClass\\\":\\\"PointsNumberSourceActionParam\\\"},{\\\"id\\\":\\\"PointsNumberSourceActionParam\\\",\\\"key\\\":\\\"point\\\",\\\"value\\\":\\\"5\\\",\\\"disableValid\\\":false},{\\\"id\\\":\\\"PointsNumberSourceActionParam_point\\\",\\\"key\\\":\\\"sourceDesc\\\",\\\"value\\\":\\\"新增5个积分\\\",\\\"disableValid\\\":true}],\\\"DATA_BACK_UP_ROLELIST\\\":[]}\"}}", "nickName": "用户昵称", "instanceAppId": "Ipu_t60KoV-gTTtCSkFMWtrkTIA", "thirdCompanyId": "0707", "openids": [ { "appid": "", "fromTo": "", "valuesidentityId":[ "p1-1","p1-2"] "identityType": "", },{ "jcappid": 0, "configIdopenid":2 "", "configName"unionid": "" } ], "orgId":"属性2", "d515fa4b-8def-4188-8415-92632581795c", "phoneList": [ { "valuesisVerify":[ "p2-1","p2-2"] "phone": "" } ], }]"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)客户积分记录id | body | true | longstring| | | ###响应状态### 响应状态 | 状态码 | 说明 | schema | | ------ | ------ | ------ | | 200 | OK | | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 响应示例 ###响应示例 ```json { "code": "200", "errorCode": "SUCCESS", "msg": "ok", "data": 15314513451345123"客户积分记录id" } ``` |