使用场景:

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


接口地址 /api/integrate/audience/group/rel/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
groups用户分组,多个用,号隔开bodyfalsestring

###请求示例

{
	"publicParams":{
		"isMatching":true,
		"matchingType":2,
		"identifyWay":1,
		"optType":"add"
	},
	"data":[{
		"thirdId":"1",
		"groups":"group1,group2"
	}]
}

#响应参数


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

###响应状态

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

###响应示例

{
    "code": "200",
    "errorCode": "SUCCESS",
    "msg": "ok",
    "data": 15314513451345123
}


  • 无标签