接口说明

请求URI

/audience/tag/batchAdd

功能描述

企业将自有系统中的用户标签导入兔展平台,与兔展平台内的用户进行统一识别与匹配


注意事项

注意: 应用权限 用户->用户标签

调用方式

HTTPS 调用


POST https://integrate.rabbitpre.com/api/open/audience/tag/batchAdd
 

请求数据类型

[ "application/json" ]

响应数据类型

[ "application/json" ]

请求头参数


属性

类型

必填

说明

X-Token

string

自建应用访问token


请求体参数


属性

类型

必填

说明

属性

类型

必填

说明

publicParams
Object用户标签导入配置
└─isMatchingboolean是否进行用户匹配(true, false)
└─matchingTypeint32匹配方式(1: 精准匹配, 2: 模糊匹配)
└─identifyWayint32模糊匹配 必传->身份识别方式(1: 开放平台unionid>公众号openid>手机号>用户ID, 2: 用户ID>手机号>公众号openid>开放平台unionid)
└─accurateMatchTypestring精确匹配的应用类型(gzh: 公众号, workwechat: 企业微信, YOUZAN: 有赞, EZR: 驿客, contentminiapp: 小程序, contenthome: 小程序首页)
└─accurateMatchValuestring精确匹配的应用ID
└─optTypestring导入方式(add: 新增, delete: 删除)
data
Array
用户标签。导入数据,每次最大500条
└─identityTypestring精确匹配 必填,身份识别类型(phone: 手机号码, id: 用户ID, openid: 公众号openid, unionid: 开放平台unionid)
└─thirdIdstring用户ID
└─openidstring公众号openid
└─unionidstring开放平台unionid
└─phonestring手机
└─tagsstring用户标签,多个用,号隔开



返回参数


属性

类型

说明

code
string
响应状态码。200-请求成功, 100100-appid、secret错误, 100200-token错误 ,100300-授权code错误
data
long
导入批次ID,用来查询导入结果,查询数据导入结果
errorCode
string
错误码
msg
string消息提示



接口地址 /api/integrate/audience/tag/batchAdd

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

接口描述 企业级接口,hearer必须携带X-Token

应用权限 用户->用户标签

#请求参数


###请求头参数

参数名称参数说明请求类型是否必须数据类型schema
X-Token自建应用访问tokenheadertruestring

###公共参数

参数名称参数说明请求类型是否必须数据类型schema
publicParams导入配置bodytrueobject用户标签导入配置
data导入数据,每次最大500条bodytruearray用户标签

###用户标签导入配置

参数名称参数说明请求类型是否必须数据类型schema
isMatching是否进行用户匹配(true, false)bodytrueboolean
matchingType匹配方式(1: 精准匹配, 2: 模糊匹配)bodyfalseint
identifyWay模糊匹配 必传->身份识别方式(1: 开放平台unionid>公众号openid>手机号>用户ID, 2: 用户ID>手机号>公众号openid>开放平台unionid)bodyfalseint
accurateMatchType精确匹配的应用类型(gzh: 公众号, workwechat: 企业微信, YOUZAN: 有赞, EZR: 驿客, contentminiapp: 小程序, contenthome: 小程序首页)bodyfalseString
accurateMatchValue精确匹配的应用IDbodyfalseString
optType导入方式(add: 新增, delete: 删除)bodytrueString

###用户标签

参数名称参数说明请求类型是否必须数据类型schema
identityType精确匹配 必填,身份识别类型(phone: 手机号码, id: 用户ID, openid: 公众号openid, unionid: 开放平台unionid)bodyfalsestring
thirdId用户IDbodyfalsestring
openid公众号openidbodyfalsestring
unionid开放平台unionidbodyfalsestring
phone手机bodyfalsestring
tags用户标签,多个用,号隔开bodyfalsestring

###请求示例

{
	"publicParams":{
		"isMatching":true,
		"matchingType":2,
		"identifyWay":1,
		"optType":"add"
	},
	"data":[{
		"thirdId":"1",
		"tags":"tag1,tag2"
	}]
}

#响应参数


参数名称参数说明请求类型是否必须数据类型schema
code状态码bodytruestring
errorCode异常码bodytruestring
msg描述bodytruestring
data导入批次ID,用来查询导入结果,查询数据导入结果bodytruelong

###响应状态 | 状态码 | 说明 | schema | | ------ | ------ | ------ | | 200 | OK | | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | |

###响应示例

{
    "code": "500126",
    "errorCode": "IMPORT_DATA_ERROR",
    "msg": "导入失败",
    "data": 15314513451345123
}


  • 无标签