使用场景:
企业将自有系统中的用户标签导入兔展平台,与兔展平台内的用户进行统一识别与匹配
接口地址 /api/integrate/audience/tag/v2/batchAdd
请求方式 POST
consumes ["application/json"]
produces ["application/json"]
接口描述 企业级接口,hearer必须携带X-Token
应用权限 用户->用户标签
注意事项 旧地址
/api/integrate/audience/tag/batchAdd 即将废弃
身份类型在工作台中"用户"->"身份类型管理"中配置,需要在运营后台开通
#请求参数
###请求头参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
X-Token | 自建应用访问token | header | true | string |
###公共参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
publicParams | 导入配置 | body | true | object | 用户标签导入配置 |
data | 导入数据,每次最大500条 | body | true | array | 用户标签 |
###用户标签导入配置
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
matchingType | 匹配方式(1: 精准匹配, 2: 模糊匹配) | body | false | int | |
optType | 导入方式(add: 新增, delete: 删除) | body | true | String |
###用户标签
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
identities | 用户身份 必填 | body | true | array | 用户身份 |
operateTags | 运营标签 | body | false | array | 运营标签 |
###用户身份 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | identityValue | 用户身份值 | body | true | String | identityType | 用户身份类型,如openid(微信openid)、 unionid(微信openid)、phone(手机号)等 | body | true | String | platform | 平台类型,如公众号平台(gzh)、企业微信平台(workwechat)等| body | false | String |
appid |
应用id,如公众号appid、小程序appid、自建应用id等 |
body |
false |
String | mpid | 应用id,如公众号appid、小程序appid、自建应用id等 | body | false | String | isWeChatEcosystem | 是否微信生态(传了mpid必须传此参数) | body | false | Boolean
###运营标签
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
tagName | 标签名称 | body | false | string | |
tagValues | 标签值 | body | false | string[] | |
tagValueType | 标签类型 | body | false | string | 默认"TEXT" 文本型; TEXT 文本型、NUMBER 数值型、BOOLEAN 布尔型、DATE 日期型 |
###请求示例
{
"publicParams":{
"isMatching":true,
"matchingType":2,
"optType":"add"
},
"data":[{
"identities": [{
"identityValue": "18888888888",
"identityType": "phone"
}],
"operateTags":[{
"tagName":"性别",
"tagValues":["男"]
}]
}]
}
#响应参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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
}