接口说明

请求URI

/event/v2/batchAdd

功能描述


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

注意事项

注意: 自建应用权限 事件→事件


旧地址 /api/integrate/event/batchAdd 即将废弃


对于企业业务系统、未接入斐波SDK的自有APP、小程序等产生的客户行为事件,如需导入兔展平台,需先在自定义事件中先进行定义。


身份类型在工作台中“用户”->“身份类型管理”中配置,需在运营后台开通


调用方式

HTTPS 调用


POST https://integrate.rabbitpre.com/api/open/event/v2/batchAdd

请求数据类型

[  "application/json" ]

响应数据类型

[ "application/json" ]


请求头参数


属性

类型

必填

说明

X-Token

string

自建应用访问token


请求体参数


属性

类型

必填

说明

publicParams
string事件导入配置
└─isMatchingint32匹配方式(1: 精准匹配, 2: 模糊匹配)
data
string事件数据。导入数据,每次最大500条
└─identitiesArray用户身份
     └─identityValuestring用户身份值
     └─identityTypestring用户身份类型,如openid(微信openid)、 unionid(微信openid)、phone(手机号)等
     └─platformstring平台类型,如公众号平台(gzh)、企业微信平台(workwechat)等
     └─appidstring应用id,如公众号appid、小程序appid、自建应用id等
     └─mpidstring应用id,如公众号appid、小程序appid、自建应用id等
     └─isWeChatEcosystemboolean是否微信生态(传了appid mpid必须传此参数)
└─timeint64事件时间戳,毫秒,不传系统自动生成当前时间
└─uuidstring随机字符串
└─eventKeystring元数据管理中该自定义事件的事件ID,如“c_buy”
└─intidstring场景互动ID
└─eventargsMap事件参数,必有系统预设参数,可能包含自定义参数。仅支持自定义事件参数(系统预设事件仅供参考)



#请求参数


###请求头参数

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

###公共参数

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

###事件导入配置

参数名称参数说明请求类型是否必须数据类型schema
matchingType匹配方式(1: 精准匹配, 2: 模糊匹配)bodyfalseint

###事件 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | identities | 用户身份 必填 | body | true | array |用户身份| | time | 事件时间戳,毫秒,不传系统自动生成当前时间 | body | false | long | | | uuid | 随机字符串 | body | false | string | | | eventKey | 元数据管理中该自定义事件的事件ID,如"c_buy"| body | true | string | | | intid | 场景互动ID | body | false | string | | | eventargs | 事件参数,必有系统预设参数,可能包含自定义参数 | body | false | map | 仅支持自定义事件参数(系统预设事件仅供参考) |

###用户身份 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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":1
	},
	"data":[{
        "identities": [{
			"identityValue": "18888888888",
			"identityType": "phone"
		}],
		"time":1605490615673,
		"uuid":"asd123",
		"eventKey":"c_buy",
		"intid":"jjsfia-fjfoha99-ljflw0h-90dsj",
		"eventargs":{
            "c_goods":"创维洗衣机",
			"c_price":1420.00,
			"unionid":"d3f4g2ferg3t2ff2g4g2f21f2",
			"title":"下单"
		}
	}]
}

#响应参数


参数名称参数说明请求类型是否必须数据类型schema
code状态码bodytruestring
errorCode异常码bodytruestring
msg描述bodytruestring

###响应状态

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

###响应示例

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


  • 无标签