上报轨迹事件 - 尘锋SCRM开放平台

POST https://qw-openapi-tx.dustess.com/trail/v1/apply?accessToken=
--header application/json

应用场景：

可通过此接口上报用户在外部平台的行为数据至「尘锋」-「联系人」-「旅程」-「行为轨迹」

接口限制：

每分钟请求20次。

注意：除自定义字段（attr）外，其他上报字段内容限制50个字符，上报内容总大小限制10000个字符

行为轨迹图示

请求参数：

主事件请求参数

参数	类型	描述	是否必须
event	`String`	事件类型id，固定为"externalUserCustomMainActivity"	`true`
activityId	`String`	当前旅程事件id，仅当需要编辑已上传的主事件时才需要传递，否则可传空字符串""	`false`
customerId	`String`	尘锋联系人id	`true`
reportTime	`String`	事件上报时间，格式为"yyyy-MM-dd HH:mm:ss"	`true`
attr	`Object`	自定义上报字段	`true`
attr.shareUser	`String`	分享人，指尘锋员工uid	`false`
attr.accessSource	`String`	访问平台来源，自定义内容，如"微信小程序"、"微信视频号"、"抖音"等	`false`
attr.accessTitle	`String`	访问素材标题，自定义内容，如"直播标题"、"文章标题"	`true`
attr.accessType	`String`	访问素材类型，自定义内容，如"文章"、"直播"、"表单"	`true
attr.accessPageduration	`String`	访问页面时长，单位为：秒	`false`

子事件请求参数

参数	类型	描述	是否必须
event	`String`	事件类型id，固定为"externalUserCustomSubActivity"	`true`
activityId	`String`	当前旅程事件id，仅当需要编辑已上传的子事件时才需要传递，否则可传空字符串""	`false`
parentActivityId	`String`	父级事件id，指当前子事件所关联的主事件id	`true`
customerId	`String`	尘锋联系人id，需与主事件联系人id保持一致	`true
reportTime	`String`	事件上报时间，格式为"yyyy-MM-dd HH:mm:ss"	`true`
attr	`Object`	自定义上报字段	`true`
attr.userOprType	`String`	子事件行为类型，自定义内容，如"转发"、"分享"、"购买"、"填写"等	`true`
attr.userObjectiveAction	`String`	具体行为事项描述，自定义内容，如"xxx商品"、"xxx文章"、"xxx表单"等	`true`

请求参数示例
json - Request-Example:

行为轨迹主事件

{
    "event": "externalUserCustomMainActivity", 
    "activityId": "", 
    "customerId": "93828a27-3724-11ee-b8e5-5e2530eb3d4f", 
    "reportTime": "2023-08-10 10:22:13", 
    "attr": {
        "shareUser": "10", 
        "accessSource": "微信视频号", 
        "accessTitle": "产品头脑风暴线上交流会", 
        "accessType": "直播", 
        "accessPageduration": "195" 
    }
}

行为轨迹子事件

{
    "event": "externalUserCustomSubActivity", 
    "activityId": "",
    "parentActivityId": "ff89a204e6394b4dabb2fcc557d0fbd8", 
    "customerId": "a87f21f5-303b-11ee-b88b-fa2904467577", 
    "reportTime": "2023-08-09 17:57:57", 
    "attr": {
        "userOprType": "购买了", 
        "userObjectiveAction":"《java从入门到精通》商品"  
    }
}

响应结果
json - Request-Example:

{
    "code": 0,
    "msg": "SUCCESS",
    "data": "12345678",
    "success": true
}

响应参数：

参数	类型	描述
code	`Int`	状态码
msg	`String`	状态信息
data	`Object`	行为记录id
success	`Bool`	是否成功