开放接口API说明-客户拜访数据查询接口

参数名称 参数值
应用编码 cusVisit
应用版本 v1
接口名称 拜访记录查询
接口编码 queryCusVisitRecord
接口URL https://openapi.waiqin365.com/api/cusVisit/v1/queryCusVisitRecord/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
date_start VARCHAR(10) 查询拜访日期起,格式:“yyyy-MM-dd”
date_end VARCHAR(10) 查询拜访日期止,格式:“yyyy-MM-dd”
page VARCHAR(10) 数据页码
rows VARCHAR(10) 每页数据显示条数(最大1000)
响应信息 参照表响应信息格式
拜访信息结构:
参数 类型 名称 备注
id VARCHAR(32) id 拜访记录ID
status VARCHAR(1) 数据状态 0:已删除,1:正常
creator_id VARCHAR(32) 拜访记录创建人ID
creator_name VARCHAR(100) 拜访记录创建人姓名
creator_sourcecode VARCHAR(32) 拜访记录创建人外部source_code
create_time TIMESTAMP 拜访记录创建时间 格式:yyyy-mm-dd hh24:mi:ss
modifyier_id VARCHAR(32) 拜访记录修改人ID
modifyier_name VARCHAR(100) 拜访记录修改人姓名
modifyier_sourcecode VARCHAR(32) 拜访记录修改人外部source_code
modify_time TIMESTAMP 拜访记录修改时间 格式:yyyy-mm-dd hh24:mi:ss
visitor VARCHAR(32) 拜访人ID
visitor_name VARCHAR(100) 拜访人姓名
visitor_sourcecode VARCHAR(32) 拜访人外部source_code
visit_type VARCHAR(1) 拜访类型 1:计划拜访,2:临时拜访,3:线路拜访
flow_type VARCHAR(1) 流程类型 1:拜访,2:车销,3:车铺
plan_source VARCHAR(1) 流程类型 0:手机端计划,1:新增计划,2:导入计划,3:按频率生成计划,4:按周生成计划,5:按线路生成计划
approval_status VARCHAR(1) 审批状态 0:未审批,1:已审批
customer VARCHAR(32) 拜访客户ID
customer_name VARCHAR(100) 客户名称
customer_sourcecode VARCHAR(32) 客户外部source_code
visit_date TIMESTAMP 拜访日期 预定拜访日期,格式:yyyy-mm-dd hh24:mi:ss
visit_time TIMESTAMP 拜访时间 实际拜访时间,格式:yyyy-mm-dd hh24:mi:ss
sequence NUMERIC 拜访序号
visit_status VARCHAR(1) 拜访状态 0:未拜访,1:已拜访,2:失访
flow_set_id VARCHAR(32) 拜访流程ID 对应拜访流程设置表id,拜访执行的时候所使用的流程id
flow_set_name VARCHAR(200) 拜访流程名称
missed_type VARCHAR(32) 失访原因id
missed_type_name VARCHAR(200) 失访原因名称
missed_regtime TIMESTAMP 失访登记时间 格式:yyyy-mm-dd hh24:mi:ss
missed_reason VARCHAR(4000) 失访备注
missed_picture_path VARCHAR(200) 失访拍照照片路径 照片完整路径,多张图片以','分隔
missed_ll VARCHAR(200) 失访位置
missed_llc VARCHAR(200) 失访纠偏位置 经纬度,此次拍照时纠偏后的定位数据
missed_lla VARCHAR(200) 失访地标信息 纠偏后的定位数据转换得到的地标信息
is_finished VARCHAR(1) 必做流程是否完成 0:未完成,1:完成
plan_content VARCHAR(5000) 计划内容
arrive_time TIMESTAMP 到店时间 格式:yyyy-mm-dd hh24:mi:ss
arrive_llc VARCHAR(200) 到店纠偏位置 经纬度,此次拍照时纠偏后的定位数据
arrive_lla VARCHAR(200) 到店地标信息 纠偏后的定位数据转换得到的地标信息
arrive_rg_type VARCHAR(1) 到店定位类型 1:GPS定位;2:基站定位;
arrive_pos_offset NUMERIC(20,2) 到店偏差距离 纠偏后的位置和客户纠偏后的位置的差值
arrive_picture_path VARCHAR(4000) 到店照片路径 照片完整路径,多张图片以','分隔
arrive_remarks VARCHAR(4000) 到店备注
leave_time TIMESTAMP 离店时间 格式:yyyy-mm-dd hh24:mi:ss
leave_llc VARCHAR(200) 离店纠偏位置 经纬度,此次拍照时纠偏后的定位数据
leave_lla VARCHAR(200) 离店地标信息 纠偏后的定位数据转换得到的地标信息
leave_rg_type VARCHAR(1) 离店定位类型 1:GPS定位;2:基站定位;
leave_pos_offset NUMERIC(20,2) 离店偏差距离 纠偏后的位置和客户纠偏后的位置的差值
leave_picture_path VARCHAR(4000) 离店照片路径 照片完整路径,多张图片以','分隔
leave_remarks VARCHAR(4000) 离店备注
time_consume NUMERIC(20,2) 拜访用时
summary VARCHAR(4000) 拜访总结内容
summary_pictures VARCHAR(4000) 拜访总结图片 照片完整路径,多张图片以','分隔
summary_time TIMESTAMP 拜访总结时间 格式:yyyy-mm-dd hh24:mi:ss
del_person VARCHAR(32) 删除人ID
del_person_name VARCHAR(200) 删除人姓名
del_time TIMESTAMP 删除时间 格式:yyyy-mm-dd hh24:mi:ss

// 请求消息体示例:
{
    "date_start": "2017-01-10",
    "date_end": "2017-01-20",
    "page":"1",
    "rows":"1000"
}

// 响应信息示例:
{
    "msg_id": "YY698688888",
    "response_data":[{
        "id":"8336850706919142842",
        "customer": "6313529032719815457",
        "customer_name": "门店",
        "customer_sourcecode": "mendian",
        "visitor":"7986507193511966864",
        "visitor_name":"东东",
        "visitor_sourcecode":"dongdong",
        "visit_date":"2016-08-17 00:00:00",
        "sequence":"4",
        "visit_status":"0",
        "summary": "总结",
        "leave_time": "2016-07-01 13:53:02",
        "plan_content":"1",
        "visit_type":"1",
        "creator_id":"6611925934866977709",
        "creator_name":"小明",
        "creator_sourcecode":"CODE93486697",
        "create_time":"2016-08-17 15:30:02",
        "modifyier_id":"-1",
        "modify_time":""
    }],
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 cusVisit
应用版本 v1
接口名称 拜访任务功能配置查询
接口编码 queryFunction
接口URL https://openapi.waiqin365.com/api/cusVisit/v1/queryFunction/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
响应信息 参照表响应信息格式
参数 类型 名称 备注
function_id VARCHAR(32) 任务ID
function_name VARCHAR(200) 任务名称
function_alias VARCHAR(200) 任务描述信息
table_name VARCHAR(32) 该任务的表名
release_time TIMESTAMP 发布时间 格式:yyyy-mm-dd hh24:mi:ss
columns list 任务自定义表单各字段集合
columns.col_code VARCHAR(32) 字段编码
columns.col_name VARCHAR(32) 字段名称
columns.group_id VARCHAR(32) 分组ID 需要在流程模版里配置,存在分组的时候使用
columns.group_name VARCHAR(32) 分组名称
sts list 任务子表集合 需要在流程模版里配置,存在子表的时候使用
sts.table_name VARCHAR(32) 子表编码
sts.table_name_cn VARCHAR(32) 子表名称
sts.columns list 自定义表单子表各字段集合
sts.columns.col_code VARCHAR(32) 子表字段编码
sts.columns.col_name VARCHAR(32) 子表字段名称

// 响应信息示例:
{
    "msg_id": "YY698688888",
    "response_data":[ {
        "function_id":"8012364236566436401",
        "function_name": "终端形象采集",
        "function_alias": "终端形象采集描述",
        "table_name": "slfdf_160624001",
        "release_time": "2017-11-20 13:32:22",
        "columns": [
                    {
                        "col_name": "",
                        "col_code": "id",
                        "group_id": "5310624925353881186",
                        "group_name": "分组A",
                    }
        ],
        "sts": [
                {
                    "table_name": "slfdf_1606240015",
                    "table_name_cn": "表名",
                    "columns": [
                        {
                            "col_name": "",
                            "col_code": "id",
                        },
                        {
                            "col_name": "",
                            "col_code": "creator_id",
                        },
                        {
                            "col_name": "",
                            "col_code": "create_time",
                        },
                        {
                            "col_name": "姓名",
                            "col_code": "slfdf_1606240016",
                        },
                        {
                            "col_name": "年龄",
                            "col_code": "slfdf_1606240017",
                        }
                    ]
                }
            ]
    }],
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 cusVisit
应用版本 v1
接口名称 拜访任务明细查询
接口编码 queryCusVisitDetail
接口URL https://openapi.waiqin365.com/api/cusVisit/v1/queryCusVisitDetail/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
function_id VARCHAR(32) 拜访任务功能配置查询结果中的任务id(function_id)
date_start VARCHAR(10) 查询任务执行日期起,格式:“yyyy-MM-dd”
date_end VARCHAR(10) 查询任务执行日期止,格式:“yyyy-MM-dd”
page VARCHAR(10) 数据页码
rows VARCHAR(10) 每页数据显示条数(最大1000)
响应信息 参照表响应信息格式
参数 类型 名称 备注
id VARCHAR(32) 记录ID
create_time VARCHAR(32) 记录创建时间
visit_implement_id VARCHAR(32) 高级拜访主数据ID
slfdf_XXXXXXXXXX VARCHAR(4000) 自定义字段数据 slfdf_XXXXXXXXXX含义详见任务功能配置查询
sts list 子表集合
sts.table_name VARCHAR(32) 子表名
sts.rows list 子表数据集合
sts.rows.id VARCHAR(32) 子表数据ID
sts.rows.create_time VARCHAR(32) 子表数据创建时间
sts.rows.master_id VARCHAR(32) 主数据ID ID
sts.rows.slfdf_XXXXXXXXXX VARCHAR(4000) 子表自定义字段数据 slfdf_XXXXXXXXXX含义详见任务功能配置查询

// 请求消息体示例:
{
    "function_id": "4622631669645698414",
    "date_start": "2017-01-10",
    "date_end": "2017-01-20",
    "page":"1",
    "rows":"1000"
}

// 响应信息示例:
{
    "msg_id": "YY698688888",
    "response_data":[ {
         "id": "4622631669645698414",
         "slfdf_1606240016": "张三",
         "slfdf_1606240017": "26",
         "create_time": "2016-07-01 13:51:26",
         "visit_implement_id": "7158134644391369579",
         "sts": [
             {
                 "table_name": "slfdf_1606240015",
                 "rows": [
                     {
                         "id": "5542631669645698323",
                         "slfdf_1606240020": "李四",
                         "slfdf_1606240021": "30",
                         "create_time": "2016-07-01 13:51:26",
                         "master_id": "4622631669645698414",
                     }
                 ]
             }
         ]
}],
    "return_code": 0,
    "return_msg": ""
}