接口说明
请求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 | 是 | 事件导入配置 |
└─isMatching | int32 | 否 | 匹配方式(1: 精准匹配, 2: 模糊匹配) |
data | string | 是 | 事件数据。导入数据,每次最大500条 |
└─identities | Array | 是 | 用户身份 |
└─identityValue | string | 是 | 用户身份值 |
└─identityType | string | 是 | 用户身份类型,如openid(微信openid)、 unionid(微信openid)、phone(手机号)等 |
└─platform | string | 否 | 平台类型,如公众号平台(gzh)、企业微信平台(workwechat)等 |
└─mpid | string | 否 | 应用id,如公众号appid、小程序appid、自建应用id等 |
└─isWeChatEcosystem | boolean | 否 | 是否微信生态(传了 |
└─time | int64 | 否 | 事件时间戳,毫秒,不传系统自动生成当前时间 |
└─uuid | string | 否 | 随机字符串 |
└─eventKey | string | 是 | 元数据管理中该自定义事件的事件ID,如“c_buy” |
└─intid | string | 否 | 场景互动ID |
└─eventargs | Map | 否 | 事件参数,必有系统预设参数,可能包含自定义参数。仅支持自定义事件参数(系统预设事件仅供参考) |
返回参数
属性 | 类型 | 说明 |
---|---|---|
code | string | 响应状态码。200-请求成功, 100100-appid、secret错误, 100200-token错误 ,100300-授权code错误 |
errorCode | string | 错误码 |
msg | string | 消息提示 |
调用示例
示例说明: HTTPS调用
请求数据示例
{
"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"
:
"下单"
}
}]
}
返回数据示例
{
"code"
:
"200"
,
"errorCode"
:
"SUCCESS"
,
"msg"
:
"ok"
}
错误码
错误码 | 错误码取值 | 解决方案 |
---|---|---|
200 | Success | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |