一、概述

版本要求：专有钉钉APP版本1.3.6及以上（浙政钉专用）
该文档用于三方isv应用接入轨迹基础应用能力，包括同步生成轨迹id、开启轨迹采集、关闭轨迹采集、注册推送等功能。
接口具体说明可查看接口文档。
image.png

二、对接流程

1. 轨迹采集对接

image.png

2. 轨迹推送对接

image.png
推送数据格式示例
推送数据格式.png

三、接口定义

注：

  1. 请明确区分用户所在租户和应用所在租户;
  2. 轨迹采集的接口名后缀为“ByIsv”的，代表从服务端发起调用，需要显式的传入用户id、用户的租户id等参数, 目前只支持ISV以这种方式接入。

轨迹服务返回对象示例

  1. {
  2.   success: true,        //业务接口返回成功
  3.   content:{}/[],        //业务接口结果数据
  4.   errorLevel:"",        //业务接口结果的errorLevel
  5.   errorCode:"",     //业务接口结果的errorCode
  6.   errorMsg:"",      //业务接口结果的errorMsg
  7. }

接口统一异常定义

异常码 异常信息
ERROR_PARAM_LACK_UNIFIED_GEO_CONFIG 参数非法：不合法的轨迹id
QUERY_TIME_OVER_LIMIT 查询时间超出限制
ILLEGAL_EMPLOYEE_CODE 参数非法：无效的employeeCode
REPORT_PERIOD_OVER_LIMIT 上报频率超出限制
COLLECT_TASK_HAS_BEEN_STOPED 采集任务已关闭
COLLECT_TASK_NOT_ALL_CLOSED 存在未关闭的采集任务
分割线 以上为轨迹采集，以下为轨迹推送
PUSH-F-002-00-15-001 业务参数校验失败
PUSH-F-002-00-15-002 网关参数校验失败
PUSH-F-002-00-16-001 推送业务逻辑错误
PUSH-F-002-00-16-002 回调url不合法
PUSH-F-002-00-16-003 应用事件已注册
PUSH-F-002-00-16-004 回调url测试失败
PUSH-F-002-00-16-005 应用事件未找到