查看源

接口说明

请求URI

/event/batchAdd

功能描述

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

注意事项

注意：获取各项选项设置信息，需要有授权方的授权，详见权限集说明。

调用方式

HTTPS 调用


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

请求数据类型

[ "application/json" ]

响应数据类型

[ "application/json" ]

**接口地址** `/api/integrate/event/batchAdd`

**请求方式** `POST`

**consumes** `["application/json"]`

**produces** `["application/json"]`

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


**应用权限** `事件->事件`
 
**注意事项** `对于企业业务系统、未接入斐波SDK的自有APP、小程序等产生的客户行为事件，如需导入兔展平台，需先在自定义事件中先进行定义。`






#请求参数
***


###请求头参数

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

  
###公共参数

| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| ------ | ------ | ------ | ------ | ------ | ------ |
| publicParams | 导入配置 | body | true | object | [事件导入配置](#事件导入配置) |
| data | 导入数据，每次最大500条 | body | true | array | [事件](#事件) |

###事件导入配置

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


###事件
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| ------ | ------ | ------ | ------ | ------ | ------ |
| identityType | 精确匹配 必填，身份识别类型(phone: 手机号码, uid: 客户ID, openid: 公众号openid, unionid: 开放平台unionid) | body | false | string | |
| thirdId | 客户ID | body | false | string | |
| openid | 公众号openid | body | false | string | |
| unionid | 开放平台unionid | body | false | string | |
| phone | 手机 | body | false | string | |
| time | 事件时间戳，毫秒，不传系统自动生成当前时间 | body | false | long | |
| uuid | 随机字符串 | body | false | string | |
| eventKey | 事件ID，兔展平台获取 | body | false | string | |
| intid | 场景互动ID | body | false | string | |
| eventargs | 事件参数，必有系统预设参数，可能包含自定义参数 | body | false | map | [系统预设参数](http://docs.tuzhanai.com/pages/viewpage.action?pageId=1934988) |

###请求示例

```json
{
	"publicParams":{
		"isMatching":true,
		"matchingType":1,
		"accurateMatchType":"gzh",
        "accurateMatchValue":"wxzj983hhg02ujd"
	},
	"data":[{
        "identityType":"openid",
        "openid":"wxnoafe-wjowjfoj-fsfs",
		"time":1605490615673,
		"uuid":"asd123",
		"eventKey":"c_buy",
		"intid":"jjsfia-fjfoha99-ljflw0h-90dsj",
		"eventargs":{
            "c_goods":"创维洗衣机",
			"c_price":1420.00,
			"unionid":"d3f4g2ferg3t2ff2g4g2f21f2",
			"title":"下单"
		}
	}]
}
```





#响应参数
***


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

###响应状态

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


###响应示例
```json
{
    "code": "200",
    "errorCode": "SUCCESS",
    "msg": "ok"
}


```