使用场景:

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


接口地址 /api/integrate/audience/info/batchAdd /api/integrate/audience/group/batchAdd旧地址已废弃

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

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

#请求参数


###请求头参数

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

###公共参数

参数名称参数说明请求类型是否必须数据类型schema
publicParams导入配置bodytrueobject客户分组导入配置
data导入数据bodytruearray客户分组

###客户分组导入配置

参数名称参数说明请求类型是否必须数据类型schema
isMatching是否进行客户匹配(true, false)bodytrueboolean
matchingType匹配方式(1: 精准匹配, 2: 模糊匹配)bodyfalseint
identifyWay模糊匹配 必传->身份识别方式(1: unionid>openid>手机号>客户ID, 2: 手机号>unionid>openid>客户ID)bodyfalseint
optType导入方式(add: 新增, delete: 删除)bodytrueint

###客户分组

参数名称参数说明请求类型是否必须数据类型schema
audienceUserId客户IDbodyfalsestring
openid微信openidbodyfalsestring
unionid微信unionidbodyfalsestring
phone手机bodyfalsestring
groups客户分组,多个用,号隔开bodyfalsestring

###请求示例

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

#响应参数


参数名称参数说明请求类型是否必须数据类型schema
code状态码bodytruestring
errorCode异常码bodytruestring
msg描述bodytruestring
data响应数据bodytrueobject客户分组导入结果

###客户分组导入结果 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | status | 任务状态(-1: 失败, 0: 进行中, 1: 成功, 2: 部分导入成功) | body | true | int | | | message | 提示信息 | body | true | string | | | importSuccessNum | 导入成功数量 | body | true | int | | | importFailNum | 导入失败数量 | body | true | int | | | errorData | 导入失败数据 | body | true | array | 客户分组 |

###响应状态

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

###响应示例

{
    "code": "200",
    "errorCode": "SUCCESS",
    "msg": "ok",
    "data": {
        "importSuccessNum": 1,
        "message": "成功",
        "importFailNum": 0,
        "errorData": null,
        "status": 1
    }
}


  • 无标签