使用场景:
企业将自有系统中的用户资料导入营销平台,与营销平台内的用户进行统一识别与匹配当积分主体配置为“外部积分系统”时,触发积分减少业务时,积分集成服务会请求积分类型自建应用中所配置的接口地址。
Markdown |
---|
**接口地址** `自建应用配置` **请求方式** `POST` **consumes** `["application/json"]` **produces** `["application/json"]` **接口描述** `企业级接口,hearer必须携带X-Token` **应用权限** `用户->用户资料` **注意事项** #请求参数 *** ###请求头参数 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | X-Token | 自建应用访问token | header | true | string | | ###公共参数 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | publicParams | 导入配置 | body | true | object | [用户资料导入配置](#用户资料导入配置) | | data | 导入数据,每次最大500条 | body | true | array | [用户资料](#用户资料) | ###用户资料导入配置 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | isMatching | 是否进行用户匹配(true, false) | body | true | boolean | | | matchingType | 匹配方式(1: 精准匹配, 2: 模糊匹配) | body | false | int | | | identifyWay | 模糊匹配 必传->身份识别方式(1: 开放平台unionid>公众号openid>手机号>用户ID, 2: 用户ID>手机号>公众号openid>开放平台unionid) | body | false | int | | | accurateMatchType | 精确匹配的应用类型(gzh: 公众号, workwechat: 企业微信, YOUZAN: 有赞, EZR: 驿客, contentminiapp: 小程序, contenthome: 小程序首页) | body | false | String | | | accurateMatchValue | 精确匹配的应用ID | body | false | String | | | importMode | 导入方式(1: 完全导入, 2: 不完全导入) | body | true | int | | ###用户资料 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | identityType | 精确匹配 必填,身份识别类型(phone: 手机号码, id: 用户ID, openid: 公众号openid, unionid: 开放平台unionid) | body | false | string | | | thirdId | 用户ID | body | false | string | | | openid | 公众号openid | body | false | string | | | unionid | 开放平台unionid | body | false | string | | | phone | 手机 | body | false | string | | | realName | 真实姓名 | body | false | string | | | sex | 性别(男, 女) | body | false | string | | | address | 地址 | body | false | string | | | birthday | 生日 | body | false | string | | | remark | 备注 | body | false | string | | | customFields | 自定义字段 | body | false | array | [自定义字段](#自定义字段) | ###自定义字段 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | configId | 自定义字段ID,营销平台获取,需要在"用户>字段管理->添加字段"中增加字段获取ID | body | false | int | | | configName | 自定义字段名称 | body | false | string | | | values | 自定义字段值,单选和复选即单选和多选的对应的选项值 | body | false | string[] | | ###请求示例 ```json { "publicParams":{ "isMatching":true, "matchingType":1, "importMode":1 }, "data":[{ "identityType":"uid", "thirdId":"1", "customFields":[{ "configId":1, "configName":"属性1", "values":["p1-1","p1-2"] },{ "configId":2, "configName":"属性2", "values":["p2-1","p2-2"] }] }] } ``` #响应参数 *** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 | long | | ###响应状态 | 状态码 | 说明 | schema | | ------ | ------ | ------ | | 200 | OK | | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ###响应示例 ```json { "code": "200", "errorCode": "SUCCESS", "msg": "ok", "data": 15314513451345123 } ``` |
...