接入小程序素材的客户访问轨迹数据
最后更新:2026/01/20企业可通过此接口将客户访问素材的轨迹记录保存到SCRM系统。如果需要统计访问时长,就需要每隔3s进行轮询调用。每次调用都会返回sessionId,下次轮询调用时需要将上一次返回的sessionId带上。
请求方式: POST(HTTPS)
请求地址: https://open.wshoto.com/openapi/media/statistics/customer_visit?access_token=x
Query参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 调用接口凭证 |
Body参数:
{
"material_id": 123456,
"content_key": "material_key_001",
"union_id": "oDF3iY9WMaswOPWjCIp92PdwJU",
"open_id": "oDF3iY9WMaswOPWjCIp92PdwJU",
"nickname": "张三",
"customer_image": "https://example.com/avatar.jpg",
"user_id": "Wang",
"send_time": 1705804800000,
"ws_scene": 1,
"ws_scene_id": "scene_12345",
"session_id": "session_abc123",
"mode": 0,
"stay_time": 30,
"visit_start_time": 1705804800
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| material_id | long | 是 | 素材id,唯一标识一个素材资源 |
| content_key | string | 否 | 素材归一化key,用于标识素材的标准化标识符,便于素材内容的统一识别和追踪 |
| union_id | string | 是 | 访问者的unionId,用于唯一标识用户身份,从用户的微信账户中获取,是用户的唯一标识(最大长度100) |
| open_id | string | 否 | 访问者的openId,特定公众号或小程序内的用户标识,与特定的微信公众号或小程序关联(最大长度100) |
| nickname | string | 否 | 访问者的昵称,用于展示用户身份信息,来自用户的微信个人信息(最大长度255) |
| customer_image | string | 否 | 访问者的头像URL,用于展示用户头像,来自用户的微信个人信息,用于界面展示(最大长度255) |
| user_id | string | 否 | 发送者员工id,标识发送该素材的员工,用于追踪素材的发送来源和员工绩效(最大长度100) |
| send_time | long | 否 | 发送时间戳(毫秒),记录素材被发送的时间,用于统计分析 |
| ws_scene | int | 否 | 微盛业务场景,用于后续的业务统计,对应值: 1:超级群发 2:客户跟进-客户群 3:聊天工具栏-通用素材 4:聊天工具栏-组合素材 5:群发客户 6:群发客户群 7:群发朋友圈 8:欢迎语 9:客户跟进-客户 10:群欢迎语 11:任务裂变欢迎语 12:红包活码欢迎语 13:员工部门欢迎语 14:识客码 |
| ws_scene_id | string | 否 | 微盛业务场景对应的业务id(最大长度255) |
| session_id | string | 否 | 会话id,用于轮询调用时的访问时长统计,同一个会话内的多次访问将被聚合计算总访问时长 |
| mode | int | 否 | 行为模式,0:轮询(默认);1:一次性上报 |
| stay_time | int | 否 | 停留时长(秒),当mode=1时必传 |
| visit_start_time | long | 否 | 开始访问时间戳(秒),当mode=1时必传 |
返回值:
{
"code": 0,
"msg": "请求成功",
"data": {
"session_id": "session_abc123",
"record_id": 789012
}
}
返回说明:
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 出错返回码,为0表示成功,非0表示调用失败 |
| msg | string | 返回码描述 |
| data | object | 返回数据对象 |
| session_id | string | 会话id,由服务端生成,用于关联多次访问请求为同一个会话,支持访问时长的聚合计算。 下次轮询调用时需要将此session_id作为请求参数传入 |
| record_id | long | 记录id,本次访问记录的唯一标识,由服务端生成,用于唯一标识一条访问记录,可用于后续的数据追踪和查询 |