API开放平台

TIP

# 新增常规拜访计划

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/cusVisitPlanRoutine/v1/savePlanRoutine/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

[
  {
    "visitDate":"2023-2-23",
    "visitor":"5052943648704112943",
    "customer":"4616243321630416388",
    "planContent":"测试新增5"
  },{
  "visitDate":"2023-2-23",
  "visitor":"",
  "customer":"4616243321630416388",
  "planContent":"测试新增"
},{
  "visitDate":"2023-2-23",
  "visitor":"5052943648704112943",
  "customer":"",
  "planContent":"测试新增"
},{
  "visitDate":"",
  "visitor":"5052943648704112943",
  "customer":"4616243321630416388",
  "planContent":"测试新增"
}
]
**参数说明：**
参数 类型 必填 说明
visitDate VARCHAR(10) 是 拜访日期。格式YYYY-MM-DD
visitor VARCHAR(10) 是 拜访人ID
customer VARCHAR(10) 是 拜访客户ID
planContent String 否 拜访内容

响应示例：

{
  "return_code": "0",
  "return_msg": "失败",
  "msg_id": "90b4b267dd3d49aeace879038b1e7291",
  "response_data": "[{\"customer\":\"4616243321630416388\",\"planContent\":\"测试新增5\",\"visitDate\":\"2023-2-23\",\"visitor\":\"5052943648704112943\",\"wrongReason\":\"日期只能选择今日和今日之后的日期。\"},{\"customer\":\"4616243321630416388\",\"planContent\":\"测试新增\",\"visitDate\":\"2023-2-23\",\"visitor\":\"\",\"wrongReason\":\"日期只能选择今日和今日之后的日期。\"},{\"customer\":\"\",\"planContent\":\"测试新增\",\"visitDate\":\"2023-2-23\",\"visitor\":\"5052943648704112943\",\"wrongReason\":\"日期只能选择今日和今日之后的日期。\"},{\"customer\":\"4616243321630416388\",\"planContent\":\"测试新增\",\"visitDate\":\"\",\"visitor\":\"5052943648704112943\",\"wrongReason\":\"请填写日期。\"}]"
}

参数说明：

参数 说明
return_code 响应编码。0:成功，1:失败。其他详见附录错误码说明
return_msg 响应说明
msg_id 请求消息id
response_data 数据data

response_data相应信息：

参数 类型 说明
id VARCHAR(30) 拜访计划Id
visitDate VARCHAR(10) 拜访日期。格式YYYY-MM-DD
visitor VARCHAR(10) 拜访人ID
customer VARCHAR(10) 拜访客户ID
planContent String 拜访内容
wrongReason String 错误原因

# 删除常规拜访计划

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/cusVisitPlanRoutine/v1/delPlanRoutine/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "id":"8751028172904504981,5365307272442366966,6776609427490214574,4801719888431571710"
}

参数说明：

参数 类型 必填 说明
id String 是 拜访计划ID。多个用英文逗号隔开

响应示例：

{
  "return_code": "0",
  "return_msg": "失败",
  "msg_id": "90b4b267dd3d49aeace879038b1e7291",
  "response_data": "[{\"wrongReason\":\"拜访计划ID错误\"},{\"wrongReason\":\"拜访计划ID错误\"},{\"wrongReason\":\"拜访计划ID错误\"},{}]"
}

参数说明：

参数 说明
return_code 响应编码。0:成功，1:失败。其他详见附录错误码说明
return_msg 响应说明
msg_id 请求消息id
response_data 数据data

# 新增按周循环拜访计划

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/cusVisitPlanRoutine/v1/saveCycleRoutePlan/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

[
  {
    "cycleStartDate": "2024-01-01",
    "plans": [
      {
        "visitorAccount": "emp001",
        "visitorName": "张三",
        "lineName": "线路A",
        "customerCode": "CUS001",
        "customerName": "客户A",
        "week": "周一",
        "frequency": "每周1次",
        "startDate": "本周"
      },
      {
        "visitorAccount": "emp001",
        "lineName": "线路A",
        "customerCode": "CUS002",
        "week": "周一",
        "frequency": "两周1次",
        "startDate": "下周"
      },
      {
        "visitorAccount": "emp002",
        "visitorName": "李四",
        "lineName": "线路B",
        "customerCode": "CUS003",
        "customerName": "客户C",
        "week": "周三",
        "frequency": "每周1次",
        "startDate": "本周"
      }
    ]
  }

外层参数说明：

参数 类型 必填 说明
cycleStartDate VARCHAR(10) 是 循环周期开始时间。格式 yyyy-MM-dd
plans Array 是 计划明细列表，不能为空

plans 明细参数说明：

参数 类型 必填 说明
visitorAccount String 是 拜访人账号
visitorName String 否 拜访人姓名（仅供备注，不参与校验）
lineName String 是 线路名称
customerCode String 是 拜访客户编码
customerName String 否 拜访客户名称（仅供备注，不参与校验）
week String 是 线路所属周几。枚举值：周一/周二/周三/周四/周五/周六/周日
frequency String 是 拜访频率。枚举值：每周1次/两周1次/三周1次/四周1次
startDate String 是 生效开始时间。枚举值：本周/下周/第三个周/第四个周（表示从第几个周开始执行拜访）

响应示例：

{
  "return_code": "0",
  "return_msg": "成功",
  "msg_id": "90b4b267dd3d49aeace879038b1e7291",
  "response_data": "[{\"cycleStartDate\":\"2024-01-01\"},{\"cycleStartDate\":\"2024-03-01\",\"reason\":\"拜访人账号【emp002】不存在或已删除\"}]"
}

响应参数说明：

参数 说明
return_code 响应编码。0:成功，1:失败。其他详见附录错误码说明
return_msg 响应说明。全部成功返回"成功"，任意一条失败返回"失败"
msg_id 请求消息id
response_data 数据data，与请求数组一一对应

response_data 响应信息：

参数 类型 说明
cycleStartDate VARCHAR(10) 循环周期开始时间
reason String 失败原因。成功时为空，失败时描述具体错误（多个拜访人失败时以"; "分隔）

业务说明：

  • 一次请求最多新建 20 个批次（外层数组最多20个元素）
  • plans 列表中相同 visitorAccount 的明细归为同一拜访人处理；一个批次可包含多个拜访人
  • 若某拜访人已存在周循环线路计划，接口将覆盖原有配置，并重新生成拜访计划（今日及今日之后的未拜访计划）
  • 接口不走审批流，保存后计划立即生效
  • 同一拜访人不能在同一周几配置不同线路（一个周几只能对应一条线路）
  • 同一线路同一周几下，相同客户不能重复出现
  • 同一线路下同一客户，其拜访频率和开始时间必须完全一致
  • week 枚举值：周一/周二/周三/周四/周五/周六/周日
  • frequency 枚举值：每周1次/两周1次/三周1次/四周1次
  • startDate 枚举值：本周/下周/第三个周/第四个周
  • 拜访计划自动生成范围：从 cycleStartDate 起，向后取两个月月末；循环计划有效期为 cycleStartDate 起一年

← 客户签到接口 →