尘锋SCRM开放平台
  1. 行为轨迹
尘锋SCRM开放平台
  • 接入前准备
    • 接口鉴权说明
    • 回调接入指南
    • 报错code码说明
    • 省市区code码
    • 获取附件URL访问签名
    • 更新日志
  • 对接方案介绍
    • 联系人架构介绍
    • 员工概览
    • ERP打通
    • 客户信息打通
    • 订单打通
    • 微信unionid互通场景
    • 获客助手对接场景
  • API文档
    • 客户
      • 联系人
        • 联系人管理
          • 查询联系人
          • 新增联系人
          • 编辑联系人
          • 删除联系人
          • 编辑联系人状态
          • 获取联系客户统计数据
          • 外部ID
            • 删除联系人外部ID
            • 更新联系人外部ID
            • 绑定外部ID与联系人ID
        • 联系人字段ID
          • 查询联系人自定义字段模板
          • 查询跟进状态列表
          • 查询联系人公海列表
          • 无效&放弃&删除原因查询
          • 联系人类型与标签和自定义字段关联关系
          • 联系人类型
          • 联系人联系方式
          • 多级联选列表
          • 来源
            • 来源列表查询(企业&联系人)
            • 编辑来源
            • 创建来源
        • 标签库
          • 给联系人打标签
          • 好友标签(企业微信标签)
            • 查询好友标签列表
            • 编辑好友标签
            • 新增好友标签
          • 联系人标签
            • 编辑联系人标签值
            • 新增联系人标签组
            • 编辑联系人标签组
            • 新增联系人标签值
            • 查询联系人标签列表
        • 跟进团队
          • 编辑(联系人/企业)共享人
          • 查询创建⼈跟进⼈和共享⼈
        • 跟进提醒
          • 查询跟进提醒
          • 新增跟进提醒
          • 编辑跟进提醒
          • 完成跟进提醒
          • 删除跟进提醒
        • 跟进记录
          • 查询跟进记录
          • 查询跟进记录模板
          • 新增跟进记录
        • 在职继承
          • 分配在职成员联系人
          • 查询接替状态
        • 签到
          • 查询签到记录
        • 行为轨迹
          • 轨迹参数说明
          • 上报轨迹事件
          • 查询轨迹事件
          • 查询旅程项目
      • 企业
        • 企业字段ID
          • 查询企业字段ID
          • 查询企业跟进状态
          • 查询企业公海列表
          • 来源列表查询(企业&联系人)
          • 查询企业类型
          • 查询企业删除原因
          • 查询多级联选
        • 企业管理
          • 查询企业列表
          • 新增企业
          • 编辑企业
          • 删除企业
          • 企业绑定联系人
          • 更新企业跟进人
          • 放弃企业到公海
          • 分配公海中企业
        • 企业标签
          • 查询企业标签
      • 好友
        • 查询好友列表
        • 编辑好友信息
        • 好友关联联系人
        • 好友取消关联联系人
        • unionId上传&关联externalUserId
      • 客户群
        • 查询客户群列表
        • 查询客户群详情
        • 编辑客户群标签
        • 查询群标签列表
        • 查询群聊数据统计-按群主聚合方式
        • 查询群聊数据统计-按自然日聚合方式
    • 销售机会
      • 销售机会管理
        • 查询销售机会列表
        • 新增销售机会
        • 编辑销售机会
        • 删除销售机会
        • 新增销售机会协同人
        • 移除销售机会协同人
        • 销售机会绑定订单
        • 销售机会解绑订单
        • 销售机会阶段变更记录
      • 销售机会字段ID
        • 查询销售机会字段ID
        • 查询销售机会类型
        • 查询销售机会阶段
        • 查询协同角色ID
        • 查询竞争对手
        • 查询丢单原因
        • 查询销售机会多级联选选项
        • 修改销售机会多级联选选项
    • 交易
      • 订单
        • 查询订单列表
        • 新增&编辑订单
        • 查询订单自定义字段ID
        • 修改订单归属人/归属部门
        • 订单发货
        • 查询物流公司列表
        • 查询订单来源
        • 编辑自主下单
      • 售后单
        • 查询售后单列表
        • 创建售后单
        • 售后单操作退款
      • 回款单
        • 查询回款单列表
        • 创建回款单
      • 会员积分
        • 查询会员列表
        • 新增会员
        • 变更会员等级
        • 查询会员等级变更明细
        • 变更会员积分
        • 变更会员成长值
        • 查询会员积分变更明细
      • 商品类
        • 查询商品列表
        • 查询商品详情
        • 新增商品
        • 商品图片/视频上传
        • 编辑商品库存
    • 员工
      • 查询员工信息
      • 编辑员工信息
      • 部门信息查询
      • 批量为员工启用系统
      • 给员工发送企微通知
    • 预约单
      • 查询预约列表
    • 评论
      • 查询评论列表接口
    • 运营
      • 活码
        • 查询活码详情
        • 查询活码列表
      • 表单
        • 查询表单字段模板
        • 查询表单填写内容
      • sop
        • 查询sop列表
        • 查询sop执行情况列表
      • 素材
        • 查询素材列表
        • 查询素材详情
        • 查询员工发送素材明细
      • 营销任务
        • 查询营销任务执行情况
        • 查询营销任务列表
      • 朋友圈
        • 获取企业发布的朋友圈员工执行情况
        • 获取朋友圈的互动数据
        • 获取企业全部发布列表
      • 获客助手短链
        • 查询获客助手来源及链接信息
        • 查询获客助手配置列表
        • 获取专属短链详情列表
        • 生成用户专属短链接
    • 会话存档
      • 上传会话存档记录
    • 通话短信
      • 查询通话记录列表
      • 电销手机外呼
      • 查询通话录音转文字结果
      • 查询短信记录列表
    • 页面嵌入
      • 页面嵌入配置说明
      • 解密嵌入页面传参
      • 菜单嵌入说明
    • 应用
      • 楼盘管理
        • 查询楼盘
        • 新增楼盘
        • 删除楼盘
      • 外联盟管理
        • 查询外联盟
        • 新增外联盟
        • 编辑外联盟
        • 删除外联盟
        • 启停用外联盟
        • 查询外联盟字段ID
        • 外联盟多级联选选项
  • 事件推送
    • 联系人
      • 新增联系人事件
      • 编辑联系人事件
      • 联系人跟进状态变更事件
      • 删除联系人事件
      • 联系人合并事件
      • 跟进提醒
        • 联系人跟进提醒状态变更
      • 联系人流转
        • 跟进团队变更事件
        • 联系人流转事件
      • 跟进记录
        • 跟进记录操作事件
    • 好友
      • 添加好友事件
      • 好友与联系人绑定事件
      • 好友与联系人解绑事件
      • 好友主动删除员工事件
      • 员工主动删除好友事件
      • 更新好友信息事件
    • 客户群
      • 新增客户群事件
      • 变更客户群事件
      • 解散客户群事件
    • 销售机会
      • 销售机会负责人变更
      • 销售机会协同人变更
      • 销售机会操作事件
    • 企业
      • 企业跟进团队流转事件
      • 企业新增事件
      • 编辑企业事件
      • 企业跟进状态变更事件
      • 企业删除事件
    • 交易
      • 推送说明
      • 订单
        • 新增订单事件
        • 编辑订单事件
        • 订单状态变更事件
        • 订单支付完成事件
        • 删除订单事件
      • 售后单
        • 售后单创建事件
        • 编辑售后单事件
        • 售后单状态变更事件
        • 删除售后单事件
        • 售后单退款成功事件
      • 商品
        • 新增商品事件
        • 商品库存变更事件
        • 编辑商品事件
        • 商品状态变更事件
      • 会员积分
        • 新增会员事件
        • 会员合并事件
        • 成长值变更事件
        • 会员等级变更事件
        • 会员积分变更事件
    • 工单
      • 新增工单事件
      • 流转工单事件
      • 编辑工单事件
    • 运营
      • 提交表单事件
    • 通话短信
      • 通话记录操作事件
      • 短信记录操作事件
    • 预约单
      • 新增预约单事件
    • 应用
      • 楼盘
        • 新增楼盘事件
        • 编辑楼盘事件
        • 删除楼盘事件
      • 外联盟
        • 新增外联盟事件
        • 编辑外联盟事件
        • 删除外联盟事件
        • 启/停外联盟事件
        • 外联盟审批完成事件
  1. 行为轨迹

查询轨迹事件

ActivityId=旅程记录id(事件id)
parentActivityId 为空,说明为主事件(用户访问营销素材的行为主事件),如:访问了XXX文章
parentActivityId有值,说明为子事件,如:停留了25秒、分享了文章
POST https://qw-openapi-tx.dustess.com/open-integration-api/trail/v2/query?accessToken=

Content-Type: application/json
应用场景
查询客户上报的内容。
接口限制
每分钟请求60次。
Params:
字段类型描述是否必须
accessTokenStringaccessTokentrue
请求参数
参数类型描述是否必须
trailIdString项目id(传固定ID:56d3c3371f0142859ca05b031c363bdc)是
queryDateString查询时间(拉取某一天0点-24点的数据。格式:yyyy-MM-dd,如果customerId和unionId都为空时,查询时间必传)否
customerIdString客户id(查询customerId和其关联的unionId上报的所有事件)否
unionIdString微信用户id(customerId和unionId都传的时候,以customerId查询)否
pageInt页码(默认从第一页开始)否
pageSizeInt每页显示记录数(单页最大500,默认10)否
请求示例
{
    "trailId": "56d3c3371f0142859ca05b031c363bdc",
    "queryDate": "2022-07-25",
    "customerId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
    "unionId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
    "page": 1,
    "pageSize": 100
}
响应结果
参数类型描述
codeInt状态码
msgString状态信息
successBoolean是否成功
dataObject响应内容
data.pageInt页码
data.pageSizeInt每页显示记录数
data.totalInt总记录数
data.dataObject[]总记录数
data.data.idString事件记录id
data.data.accountString公司id
data.data.activityIdString旅程记录id
data.data.parentActivityIdString上级旅程记录id
data.data.operatorIdString操作人id(员工id)
data.data.operatorTypeString操作人类型,固定为EMPLOYEE(员工)
data.data.unionIdString微信用户id
data.data.customerIdString客户id
data.data.eventString事件(系统已存在行为轨迹事件详见轨迹参数说明)
data.data.trailIdString项目id
data.data.subjectString所属对象,固定为:CUSTOMER(客户)
data.data.targetIdString操作对象id,可能是unionId、customerId,根据targetType判断
data.data.targetTypeString操作对象类型,WX、CUSTOMER
data.data.reportTimeInt上报时间戳
data.data.operateTimeInt发生时间戳
data.data.createTimeString入库时间
data.data.updateTimeString更新时间
data.data.stayTimeInt停留时间戳
data.data.dateString日期
data.data.timeString时间
data.data.extraInfoObject额外自定义信息(系统已存在行为轨迹事件自定义字段信息详见轨迹参数说明)
data.data.childrenObject[]下级旅程记录列表
trace_idString链路id
extraInfo内容信息说明
{
    "account": "租户ID,必填",
    "customerId": "客户Id,非必填 微信生态联系人id,非微信生态 cookieId ",
    "unionId": "用户unionId,非必填 ",
    "event": "事件,必填",
    "activityId": "记录唯一ID,ID重复会根据配置更新字段,不产生新记录",
    "version": 1,
    "parentActivityId": "父级记录唯一ID",
    "operator": "操作人ID,非必填",
    "reportTime": "上报时间,格式为2021-10-12 10:10:10",
    "relationId": "关联主体id 非必填",
    "attr": {
        "deliverType": "来源类型(staffShare员工分享 publicLaunch公域投放 advertising广告投放)",
        "sourceId": "来源ID(员工id, 来源ID)(链接带参)",
        "deviceId": "设备Id,非必填",
        "deviceManufacturer": "设备制造商 非必填",
        "deviceModel": "设备型号 非必填",
        "browser": "当前访问的浏览器,如'微信浏览'非必填",
        "country": "国家 非必填",
        "province": "省 非必填",
        "city": "市 非必填",
        "area": "区 非必填",
        "platform": "平台:WPN(公众号)/MINI(小程序)/QW(企微)/OTHER(第三方) 必填",
        "contentId": "内容id (可以是表单id、文章Id、商品Id、案例Id..,此字段不做强制校验,因为是全链路需要兼容无素材id情况)",
        "reportType": "wx:unionId上报  customer:联系人id上报  cookie:cookie上报  ",
        "sceneType": "material(营销资料),miniMaterial(小程序素材),commonMaterial(普通素材),hotMaterial(热门营销资料),hot-article(热门好文-营销资料类型),redPacket(红包),dynamic(企业动态),tempMaterial,marketingRedPacket(营销红包),card(名片),living(直播),fission(裂变活动),microSite,phone(手机号),tel(座机),address(通讯录),fissionTemp(营销获客)",
        "shareType": "分享人类型  :微信用户(存在unionId)staff:员工 selfVisit:自主访问(存在的场景是用户自己通过搜索名片进行访问)非必填",
        "actionType": "电话:phone,微信:wechat,邮箱:email 非必填",
        "shareId": "分享人id 例如unionid|staffId,非必填",
        "compatibleShareId": "为了兼容老的已经发送出去的链接,此字段用于存储之前的shareId",
        "firstScene": "一级场景:2001(文章),2002(表单),2003(H5),2004(案例库),2005(宣传册),2006(视频),2007(文件),2008(销售名片),2009(名片小程序),2010(营销视频),2011(企业动态),2012(H5商城),2013(小程序商城),2014(营销红包),2015(商品),9999(其他)",
        "secondScene": "二级场景,0(销售分享),1:(客户转发),2:(自主访问)",
        "ruleIds": "5d846128-8d6e-11ed-a9d2-aaa8e229953f,db1afcfb-4ebd-4693-ab37-8ca7dbff956f(规则id,可能存在多个,使用英文逗号分隔)",
        "externalUserId": "外部联系人id",
        "contentId": "素材ID[查询素材详情](/doc-5158628)",
        "uid": "员工id",
        "addFriendTime": "添加好友时间,格式yyyy-MM-dd HH:mm:ss",
        "submitFormId": "提交表单id",
        "carrier": {
            "channel": "通道  1v1Message:1v1消息-0, groupMessage:群聊消息-1, qwMoments:企微朋友圈-2, friendCircle:个微朋友圈-3, friend:微信好友-4, microMass:微群发-5,groupMass:群群发-6",
            "carrierType": "载体类型 例如:mkPlan:营销计划、massPlan:群发",
            "carrierId": "对应载体类型的 任务id",
            "extra": "plainId等其他的信息"
        },
        "stayTime": "停留时长(单位秒)",
        "viewRatio": "播放比例 (百分比)10.00"
    }
}
成功响应示例
{
    "code": 0,
    "msg": "成功",
    "data": {
        "page": 1,
        "pageSize": 10,
        "total": 1,
        "data": [{
            "id": "2b660bc9-c8a6-4b0f-9dd9-94251f62db5d#1",
            "account": "W00000000109",
            "activityId": "2b660bc9-c8a6-4b0f-9dd9-94251f62db5d",
            "parentActivityId": "",
            "operatorId": "2783",
            "operatorType": "EMPLOYEE",
            "unionId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
            "customerId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
            "event": "enterPageActivity",
            "trailId": "56d3c3371f0142859ca05b031c363bdc",
            "subject": "CUSTOMER",
            "eventType": "ACTIVITY",
            "targetId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
            "targetType": "WX",
            "effectId": "",
            "effectType": "card",
            "effectName": "",
            "deviceId": "",
            "deviceInfo": "",
            "bizId": "2b660bc9-c8a6-4b0f-9dd9-94251f62db5d#1",
            "reportTime": 1648097916300,
            "operateTime": 1648097916300,
            "createTime": "2022-03-24 12:58:36",
            "updateTime": "2022-03-25 10:27:55",
            "stayTime": 0,
            "date": "03月24日",
            "time": "12:58",
            "extraInfo": {
                "platform": "MINI"
            },
            "children": [{
                    "id": "1ba8b12b-ab2f-11ec-b563-d29bb107c48b#3",
                    "account": "W00000000109",
                    "activityId": "1bca1826-ab2f-11ec-a12f-22943c823276",
                    "parentActivityId": "961d23e0-b0ca-4263-b3c2-9a62640d523c",
                    "operatorId": "2783",
                    "operatorType": "EMPLOYEE",
                    "unionId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
                    "customerId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
                    "event": "stayActivity",
                    "trailId": "56d3c3371f0142859ca05b031c363bdc",
                    "subject": "CUSTOMER",
                    "eventType": "ACTIVITY",
                    "targetId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
                    "targetType": "WX",
                    "effectId": "4ece6410-a5d7-11ec-a160-02ab67da82b0",
                    "effectType": "article",
                    "effectName": "",
                    "deviceId": "",
                    "deviceInfo": "",
                    "bizId": "1ba8b12b-ab2f-11ec-b563-d29bb107c48b#3",
                    "reportTime": 1648097935749,
                    "operateTime": 1648097935749,
                    "createTime": "2022-03-24 12:58:55",
                    "updateTime": "2022-03-25 10:27:55",
                    "stayTime": 0,
                    "date": "03月24日",
                    "time": "12:58",
                    "extraInfo": {
                        "platform": "MINI"
                    },
                    "children": []
                },
                {
                    "id": "744ba567-ab2f-11ec-b563-d29bb107c48b#3",
                    "account": "W00000000109",
                    "activityId": "74720f2f-ab2f-11ec-a12f-22943c823276",
                    "parentActivityId": "961d23e0-b0ca-4263-b3c2-9a62640d523c",
                    "operatorId": "2783",
                    "operatorType": "EMPLOYEE",
                    "unionId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
                    "customerId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
                    "event": "leavePageActivity",
                    "trailId": "56d3c3371f0142859ca05b031c363bdc",
                    "subject": "CUSTOMER",
                    "eventType": "ACTIVITY",
                    "targetId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
                    "targetType": "WX",
                    "effectId": "4ece6410-a5d7-11ec-a160-02ab67da82b0",
                    "effectType": "article",
                    "effectName": "",
                    "deviceId": "",
                    "deviceInfo": "",
                    "bizId": "744ba567-ab2f-11ec-b563-d29bb107c48b#3",
                    "reportTime": 1648098084456,
                    "operateTime": 1648098084456,
                    "createTime": "2022-03-24 13:01:24",
                    "updateTime": "2022-03-25 10:27:55",
                    "stayTime": 0,
                    "date": "03月24日",
                    "time": "13:01",
                    "extraInfo": {
                        "platform": "MINI"
                    },
                    "children": []
                }
            ]
        }]
    },
    "trace_id": "51ca6690e2f94eb1980bad01a465e78b",
    "success": true
}
错误响应示例
 {
    "success": false,
    "code": 10001,
    "msg": "system unknown error",
    "data": null
}
``

上一页
上报轨迹事件
下一页
查询旅程项目
Built with