用户分组导入v2

接口说明

请求URI

/audience/group/rel/v2/batchAdd

功能描述

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

注意事项

注意：自建应用权限 用户→用户分组

旧地址 /api/integrate/audience/group/rel/batchAdd 即将废弃
身份类型在工作台中“用户”->“身份类型管理”中配置，需要在运营后台开通

调用方式

HTTPS 调用


POST https://integrate.rabbitpre.com/api/open/audience/group/rel/v2/batchAdd

请求数据类型

[ "application/json" ]

响应数据类型

[ "application/json" ]

请求头参数

属性	类型	必填	说明
X-Token	string	是	自建应用访问token

请求体参数

属性	类型	必填	说明
属性	类型	必填	说明
publicParams	Object	是	用户分组导入配置
└─isMatching	boolean	是	是否进行用户匹配(true, false)
└─matchingType	int32	否	匹配方式(1: 精准匹配, 2: 模糊匹配)
└─identifyWay	int32	否	模糊匹配必传->身份识别方式(1: 开放平台unionid>公众号openid>手机号>用户ID, 2: 用户ID>手机号>公众号openid>开放平台unionid)
└─accurateMatchType	string	否	精确匹配的应用类型(gzh: 公众号, workwechat: 企业微信, YOUZAN: 有赞, EZR: 驿客, contentminiapp: 小程序, contenthome: 小程序首页)
└─accurateMatchValue	string	否	精确匹配的应用ID
└─optType	string	是	导入方式(add: 新增, delete: 删除)
data	Array	是	用户分组。导入数据，每次最大500条
└─identityType	string	否	精确匹配必填，身份识别类型(phone: 手机号码, id: 用户ID, openid: 公众号openid, unionid: 开放平台unionid)
└─thirdId	string	否	用户ID
└─openid	string	否	公众号openid
└─unionid	string	否	开放平台unionid
└─phone	string	否	手机
└─groups	string	否	用户分组，多个用,号隔开

返回参数

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

调用示例

示例说明: HTTPS调用

请求数据示例

{
    "publicParams":{
        "isMatching":true,
        "matchingType":2,
        "optType":"add"
    },
    "data":[{
        "identities": [{
            "identityValue": "18888888888",
            "identityType": "phone"
        }],
        "groups":"group1,group2"
    }]
}

返回数据示例

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

错误码

错误码	错误码取值	解决方案
200	Success
401	Unauthorized
403	Forbidden
404	Not Found

接口地址 /api/integrate/audience/group/rel/v2/batchAdd

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

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

应用权限 用户->用户分组

注意事项 旧地址 ~~/api/integrate/audience/group/rel/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

###用户分组

部门匹配优先级 wxDeptId > thirdDeptId > deptId，匹配标识选填一种

参数名称	参数说明	请求类型	是否必须	数据类型	schema
identities	用户身份必填	body	true	array	用户身份
groups	用户分组，多个用","号隔开，分组不存在时自动创建静态分组，分类为"未分类"	body	false	string
categoryType	分组分类类型(1:企业分组分类, 2:部门分组分类)，默认：1	body	false	String
deptId	部门ID，categoryType为2时必填，部门匹配标识选填一个	body	false	Long
thirdDeptId	第三方部门ID，categoryType为2时必填，部门匹配标识选填一个	body	false	String
wxDeptId	企业微信部门ID，categoryType为2时必填，部门匹配标识选填一个	body	false	String

###用户身份 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 | 是否微信生态（传了 ~~appid~~ mpid必须传此参数） | body | false | Boolean

###请求示例

{
	"publicParams":{
		"isMatching":true,
		"matchingType":2,
		"optType":"add"
	},
	"data":[{
		"identities": [{
			"identityValue": "18888888888",
			"identityType": "phone"
		}],
		"groups":"group1,group2"
	}]
}

#响应参数

参数名称	参数说明	请求类型	是否必须	数据类型
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": "200",
    "errorCode": "SUCCESS",
    "msg": "ok",
    "data": 15314513451345123
}

页面树结构