获取轨迹素材访问记录(新)

最后更新：2023/09/13

企业可通过此接口获取客户访问轨迹素材的记录

请求方式： POST（HTTPS）

请求地址： https://open.wshoto.com/openapi/media/statistics/customer_visit_media_record?access_token=x

Query参数：

参数 类型 必填 说明
access_token string 是 调用接口凭证

Body参数：

{
  "start_time": 16789734534,
  "end_time": 16789734534,
  "send_user_ids": [
    "fake_data"
  ],
  "send_chat_groups": [
    "fake_data"
  ],
  "union_ids": [
    "fake_data"
  ],
  "cursor": 12324576556756566,
  "limit": 100
}
参数 类型 必填 说明
start_time long 否 接口传入起始时间和结束时间后，可查询指定时间范围内访问轨迹素材（含组合素材里的轨迹素材）的记录。
此参数为需查询的起始时间，时间戳，精确到天，不可大于结束时间；填写起始时间后，结束时间必填，查询时间范围不可超过90天。
如不填写将默认查询最近30天内的记录。
end_time long 否 此参数为需查询的终止时间，时间戳，精确到天，不可小于起始时间；填写起始时间后，结束时间必填，查询时间范围不可超过90天。
如不填写将默认查询最近30天内的记录。
send_user_ids array 否 发送人的员工帐号userid list，不填写默认返回当前租户下所有员工发送的素材对应的客户访问记录；
每日最多可传入200个ID
send_chat_groups array 否 传入客户群ID（list）后，可查询在指定场景下发送到该客户群的轨迹素材并被群客户访问的记录，每次最多可传入100个ID
以下指定场景下发送轨迹素材（含组合素材里的轨迹素材）到客户群时，可被识别为是在对应客户群发送的素材及其对应的访问记录：
1.超级群发
2.跟进任务-跟进客户群
3.聊天工具栏-通用素材
4.聊天工具栏-组合素材
union_ids array 否 访问素材的客户在三方应用服务商里的客户UnionID，支持传入ID list，每次最多可传入200个ID
cursor long 否 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用不填
limit int 否 默认为每页100条，最大为每页1000条

返回值：

{
  "code": 0,
  "msg": "请求成功",
  "data": {
    "next_cursor": 15324576556756566,
    "records": [
      {
        "id": 167892345111111,
        "external_id": "fake_data",
        "union_id": "fake_data",
        "material_id": 167891345343244,
        "type": 14,
        "package_child_id": 167891345343244,
        "package_child_type": 3,
        "title": "fake_data",
        "visit_time": 16789134534,
        "visit_end_time": 16789734534,
        "visit_time_count": 156,
        "use_status": 0,
        "user_id": "fake_data",
        "source": 1,
        "source_id": "fake_data"
      }
    ]
  }
}

参数说明：

参数 类型 说明
code int 返回码,0-请求成功,
msg string 对返回码的文本描述内容
data array 集合对象
  next_cursor long 用于分页查询的游标（访问记录的主键ID）
  records obj[] 数据
    id long 访问记录的唯一id
    external_id string 访问素材的客户在三方应用里的客户External_userid，仅当访问素材的人是企业好友或群成员时，返回此ID。
    union_id string 访问素材的客户在三方应用服务商里的客户UnionID
    material_id long 素材id
若是访问了组合素材A里的轨迹素材，将返回组合素材A的素材ID。
    type int 4-文章 6-视频 7-文件 9-网页 14-组合素材 16-收集表
若是访问了组合素材A里的轨迹素材，将固定返回14-组合素材。
    title string 素材标题
若是访问了组合素材A里的轨迹素材，将返回组合素材A的素材名称。
    visit_time long 客户访问素材的开始时间，时间戳，精度:秒
    visit_end_time long 客户访问素材的结束时间，时间戳，精度:秒；
仅当素材类型或子素材类型为“4-文章 或 6-视频 或 7-文件”时，返回此信息
    visit_time_count long 客户访问素材的访问时长，单位:秒；
仅当素材类型或子素材类型为“4-文章 或 6-视频 或 7-文件”时，返回此信息
    use_status int 素材使用状态，0-使用中 1-已停用 2-未开始 3-已过期
    user_id string 素材发送人的员工帐号userid
    source int 在指定场景下发送到企业客户群的轨迹素材并被群客户访问的记录，会返回此信息，返回值对应为：
1-超级群发，2-跟进任务-跟进客户群，3-聊天工具栏-通用素材，4-聊天工具栏-组合素材。
注：在以下指定场景下发送轨迹素材（含组合素材里的轨迹素材）到客户群时，可被识别为是在客户群发送的素材及其对应的访问记录：
1.超级群发
2.跟进任务-跟进客户群
3.聊天工具栏-通用素材
4.聊天工具栏-组合素材
    source_id string 当通过「超级群发」、「跟进任务-跟进客户群」、「聊天工具栏-通用素材」、「聊天工具栏-组合素材」功能发送到企业客户群并被群客户访问的记录，会返回对应的客户群ID，即群客户是在哪个客户群访问的此素材。

results matching ""

    No results matching ""