使用场景:
企业将自有系统中的用户标签导入兔展平台,与兔展平台内的用户进行统一识别与匹配
接口地址 /api/integrate/audience/tag/batchAdd
请求方式 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 | |
optType | 导入方式(add: 新增, delete: 删除) | body | true | String |
###用户标签
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 | |
tags | 用户标签,多个用,号隔开 | body | false | string |
###请求示例
{
"publicParams":{
"isMatching":true,
"matchingType":2,
"identifyWay":1,
"optType":"add"
},
"data":[{
"thirdId":"1",
"tags":"tag1,tag2"
}]
}
#响应参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
code | 状态码 | body | true | string | |
errorCode | 异常码 | body | true | string | |
msg | 描述 | body | true | string | |
data | 导入批次ID,用来查询导入结果,查询数据导入结果 | body | true | long |
###响应状态 | 状态码 | 说明 | schema | | ------ | ------ | ------ | | 200 | OK | | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | |
###响应示例
{
"code": "500126",
"errorCode": "IMPORT_DATA_ERROR",
"msg": "导入失败",
"data": 15314513451345123
}