网络引流系统前后端数据交互接口设计

发布时间:2016-06-04 17:41:04

网络引流系统前后端数据交互接口设计

网络引流系统采用前后端完全解耦的方式进行写作开发,前端主要责任是实现跟用户之间的界面交互,后台的主要责任是进行业务逻辑的处理及业务数据的持久化,前后端通过http协议进行数据交互实现系统的整体联动。

根据用户交互界面,前后端交互接口如下:

注:接口引用中base_url为系统项目管理平台的部署入口URL

登录

接口URLbase_url/login

交互方式:POST JSON

交互参数:单层JSON格式

参数名称

参数说明

备注

username

用户名

必须提供此参数

passwd

密码

必须提供此参数,前端对用户输入数据先进性MD5加密,传入的参数是MD5加密后的字符串

响应数据格式:JSON

{

‘flg’:x, //状态,0:登录失败;1:成功

‘msg’:’xxxxxx’, //消息,失败原因,用户名密码错误或者是系统内部错误

‘username’:’xxxxxx’ //登录用户名

}

退出

接口URLbase_url/logout

交互方式:HTTP GET

交互参数:无

响应数据格式:JSON

{

‘flg’:x, //状态,0:登录失败;1:成功

‘msg’:’xxxxxx’ //消息,失败原因,用户名密码错误或者是系统内部错误

}

加载渠道列表

接口URL:base_url/channel/list

交互方式:POST JSON

交互参数:单层JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

渠道名称模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

sortcol

排序字段

如未提供此参数,默认用创建时间降序排序

descsort

降序排序

此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否则降序排序,此参数值为true或者false

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{渠道数据}] //渠道数据列表,如失败或者未登录,则不需要响应此数据

}

注:渠道数据中,需要一个额外的字段,创建人名称,此字段数据来源于用户表,前端可排序字段:名称、创建时间、状态

1 编辑渠道

接口URL:base_url/channel/edit

交互方式:POST JSON

交互参数:复杂JSON格式

{

‘id’:xxxx, //ID,新增渠道时,ID为空

‘code’:xxxx, //代码

‘name’:xxxx, //名称

remark’:xxxx, //说明

level’:xxxx, //等级

feature’:xxxx, //特性

state’:xxxx, //状态

‘flag’:xx //操作标志,-1:删除;0:编辑;1:新增

‘props’:[

{

‘id’:xxxxx //属性ID,新增的属性,ID为空

‘code’:xxxx, //属性代码

name’:xxxxx //属性名称

value’:xxxx, //属性值

‘flag’:xx //操作标志,-1:删除;0:编辑;1:新增

}

…… //其他属性

]

}

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

}

注:渠道特性来源于属性模板表,属性模板表里的类别为channel_feature_props_tmpl”的属性列表即为渠道特性选项列表。属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。另外,有模板id的,如果模板上定义的属性是不可删除的,则这条属性是不能删除的,界面上对应的属性不需要删除按钮及操作,后台也不能删除此属性,如果模板定义的属性是必填的,则这条属性的值不能为空,前端后端就要进行验证。

加载渠道属性

接口URL:base_url/channel/props/{id}

交互方式:RESTFul

交互参数:渠道记录ID,直接包含在URL,{id}即为渠道记录ID,以get的方式交互

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{渠道属性数据}] //渠道属性数据列表,如失败或者未登录,则不需要响应此数据

}

注:渠道属性数据中,需要额外的字段,可删除、必填,字段数据来源于属性模板表。

属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。另外,有模板id的,如果是不可删除的,则这条属性是不能删除的,界面上对应的属性不需要删除按钮及操作,后台也不能删除此属性,如果是必填的,则这条属性的值不能为空,前端后端就要进行验证。渠道属性模板的类别为channel_props_tmpl

加载渠道营销活动

接口URL:base_url/campaign/list/{id}

交互方式:RESTFul POST JSON

交互参数:渠道记录ID包含在URL,{id}即为渠道记录ID,单层JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

名称或关键字模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

sortcol

排序字段

如未提供此参数,默认用创建时间降序排序

descsort

降序排序

此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否则降序排序,此参数值为true或者false

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{营销活动数据}] //营销活动数据列表,如失败或者未登录,则不需要响应此数据

}

注:营销活动数据字段

字段

说明

来源

id

ID

营销活动表

channel_id

渠道ID

营销活动表

name

营销活动名称

营销活动表

keyword

营销活动关键字

营销活动表

price

营销活动价格

营销活动表

remark

营销活动说明

营销活动表

link_code

引流标识码

营销活动引流点对应表

cplink_state

状态,营销活动引流点对应关系状态

营销活动引流点对应表

customer_id

客户ID

客户信息表

customer_name

客户名称

客户信息表

linkpoint_id

引流点ID

引流点信息表

linkpoint_url

引流点URL,即客户入口URL

引流点信息表

created_date

创建时间

营销活动引流点对应表

creator_id

创建人ID

营销活动引流点对应表

creator_name

创建人姓名

用户表

link_url

引流系统入口ULR

系统参数表

前端可排序字段:名称、价格、关键字、创建时间

注:

引流URL=引流系统入口URL+/+引流标识码;

引流系统入口URL通过系统参数配置;

编辑营销活动

接口URL:base_url/campaign/edit

交互方式:POST JSON

交互参数:单层JSON格式

{

‘id’:xxxx, //ID,新增营销活动时,ID为空

channel_id’//渠道id

‘keyword’:xxxx, //关键字

‘name’:xxxx, //名称

‘price’:xxxx, //营销活动价格

‘remark’:xxxxx, //营销活动说明

‘cplink_state’:xxxx, //营销活动引流点对应关系状态

‘linkpoint_id’:xxxx, //引流点ID

‘flag’:xx //操作标志,-1:删除;0:编辑;1:新增

}

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’ //消息,失败原因,参数错误或者是系统内部错误

‘link_url’:’xxxxxx’, //引流系统入口ULR

‘link_code’:’xxxxxx’ //引流标识码

}

注:引流标识码=MD5(渠道名称+制表符+营销活动名+制表符+营销活动关键字+制表符+客户名称+制表符+引流点URL)

引流URL=引流系统入口URL+/+引流标识码;

引流系统入口URL通过系统参数配置;

加载客户列表

接口URL:base_url/customer/list

交互方式:POST JSON

交互参数:单层JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

客户名称模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

sortcol

排序字段

如未提供此参数,默认用创建时间降序排序

descsort

降序排序

此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否则降序排序,此参数值为true或者false

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{客户数据}] //客户数据列表,如失败或者未登录,则不需要响应此数据

}

注:客户数据中,需要一个额外的字段,创建人名称,此字段数据来源于用户表,前端可排序字段:名称、创建时间、状态

编辑客户

接口URL:base_url/customer/edit

交互方式:POST JSON

交互参数:复杂JSON格式

{

‘id’:xxxx, //ID,新增客户时,ID为空

‘code’:xxxx, //代码

‘name’:xxxx, //名称

remark’:xxxx, //说明

level’:xxxx, //等级

state’:xxxx, //状态

‘flag’:xx //操作标志,-1:删除;0:编辑;1:新增

‘props’:[

{

‘id’:xxxxx //属性ID,新增的属性,ID为空

‘code’:xxxx, //属性代码

name’:xxxxx //属性名称

value’:xxxx, //属性值

‘flag’:xx //操作标志,-1:删除;0:编辑;1:新增

}

…… //其他属性

]

}

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

}

注:属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。另外,有模板id的,如果模板上定义的属性是不可删除的,则这条属性是不能删除的,界面上对应的属性不需要删除按钮及操作,后台也不能删除此属性,如果模板定义的属性是必填的,则这条属性的值不能为空,前端后端就要进行验证。

加载客户属性

接口URL:base_url/customer/props/{id}

交互方式:RESTFul

交互参数:客户记录ID,直接包含在URL,{id}即为客户记录ID,以get的方式交互

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{客户属性数据}] //客户属性数据列表,如失败或者未登录,则不需要响应此数据

}

注:客户属性数据中,需要额外的字段,可删除、必填,字段数据来源于属性模板表。

属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。另外,有模板id的,如果是不可删除的,则这条属性是不能删除的,界面上对应的属性不需要删除按钮及操作,后台也不能删除此属性,如果是必填的,则这条属性的值不能为空,前端后端就要进行验证。客户属性模板的类别为customer_props_tmpl

客户信息导入

接口URL:base_url/excel/customer_in

交互方式:POST form data

交互参数:excel文件,字段名:excel_file

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;2:有异常;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘success_count’:x, //成功记录数,如失败或者未登录,则不需要响应此数据

‘error_count’:x, //失败记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{客户导入错误数据}] //客户导入错误数据列表,如失败或者未登录,则不需要响应此数据

}

注:lead导入错误数据字段:

字段

说明

来源

row

Excel行号

msg

错误原因

此接口暂时不用做实现

加载引流点列表

接口URL:base_url/linkpoint/list/{id}

交互方式:RESTFul

交互参数:客户记录ID,直接包含在URL,{id}即为客户记录ID,以get的方式交互

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{引流点数据}] //引流点数据列表,如失败或者未登录,则不需要响应此数据

}

编辑引流点

接口URL:base_url/linkpoint/edit

交互方式:RESTFul POST JSON

交互参数:单层JSON格式

{

‘id’:xxxx, //ID,新增时,ID为空

‘name’:xxxx, //名称

customer_id//客户id

url //引流点url

state //状态值

remark //引流说明

‘flag’:xx //操作标志,-1:删除;0:编辑;1:新增

}

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

}

加载供应商列表

接口URL:base_url/vender/list

交互方式:POST JSON

交互参数:单层JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

供应商名称模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

sortcol

排序字段

如未提供此参数,默认用创建时间降序排序

descsort

降序排序

此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否则降序排序,此参数值为true或者false

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{供应商数据}] //供应商数据列表,如失败或者未登录,则不需要响应此数据

}

注:客户数据中,需要额外的字段,创建人名称,此字段数据来源于用户表,前端可排序字段:名称、创建时间、状态

编辑供应商

接口URL:base_url/vender/edit

交互方式:POST JSON

交互参数:复杂JSON格式

{

‘id’:xxxx, //ID,新增供应商时,ID为空

‘code’:xxxx, //代码

‘name’:xxxx, //名称

remark’:xxxx, //说明

level’:xxxx, //等级

state’:xxxx, //状态

‘flag’:xx //操作标志,-1:删除;0:编辑;1:新增

‘props’:[

{

‘id’:xxxxx //属性ID,新增的属性,ID为空

‘code’:xxxx, //属性代码

name’:xxxxx //属性名称

value’:xxxx, //属性值

‘flag’:xx //操作标志,-1:删除;0:编辑;1:新增

}

…… //其他属性

]

}

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

}

注:属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。另外,有模板id的,如果模板上定义的属性是不可删除的,则这条属性是不能删除的,界面上对应的属性不需要删除按钮及操作,后台也不能删除此属性,如果模板定义的属性是必填的,则这条属性的值不能为空,前端后端就要进行验证。

加载供应商属性

接口URL:base_url/vender/props/{id}

交互方式:RESTFul

交互参数:供应商记录ID,直接包含在URL,{id}即为供应商记录ID,以get的方式交互

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{供应商属性数据}] //供应商属性数据列表,如失败或者未登录,则不需要响应此数据

}

注:供应商属性数据中,需要额外的字段,可删除、必填,字段数据来源于属性模板表。

属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。另外,有模板id的,如果是不可删除的,则这条属性是不能删除的,界面上对应的属性不需要删除按钮及操作,后台也不能删除此属性,如果是必填的,则这条属性的值不能为空,前端后端就要进行验证。客户属性模板的类别为customer_props_tmpl

供应商信息导入

接口URL:base_url/vender/import

交互方式:POST form data

交互参数:excel文件,字段名:excel_file

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;2:有异常;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘success_count’:x, //成功记录数,如失败或者未登录,则不需要响应此数据

‘error_count’:x, //失败记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{供应商导入数据}] //供应商导入数据列表,如失败或者未登录,则不需要响应此数据

}

注:供应商导入数据字段:

此接口暂时不用做实现

加载统计报表列表

接口URL:base_url/report/list

交互方式:http get

交互参数:无

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{报表脚本数据}] //报表脚本数据列表,如失败或者未登录,则不需要响应此数据

}

加载统计结果

接口URL:base_url/report/result/{id}

交互方式:RESTFul

交互参数:报表脚本记录ID,直接包含在URL,{id}即为报表脚本记录ID,以get的方式交互

交互参数:单层JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘titles’:[‘xxxx’,……], //结果集字段数组,如失败或者未登录,则不需要响应此数据

‘items’:[{脚本执行结果数据}] //脚本执行结果数据列表,如失败或者未登录,则不需要响应此数据

}

注:交互参数的分页信息是针对统计脚本的分页信息,也就是在统计脚本的基础上增加分页功能

titles是查询数据库返回的字段名称组成的数组

编辑统计报表

接口URL:base_url/report/edit

交互方式:POST JSON

交互参数:单层JSON格式

{

‘id’:xxxx, //ID,新增时,ID为空

‘name’:xxxx, //名称

script’:xxxx, //统计语句

‘flag’:xx //操作标志,-1:删除;0:编辑;1:新增

}

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

}

加载分析数据列表

接口URL:base_url/lead/list

交互方式:POST JSON

交互参数:单层JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

手机、账号、IP、姓名模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

distributed_state

发送状态

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

level

级别

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

register_date_from

注册时间开始条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

register_date_to

注册时间结束条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

created_date_from

创建时间开始条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

created_date_to

创建时间结束条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

sortcol

排序字段

如未提供此参数,默认用创建时间降序排序

descsort

降序排序

此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否则降序排序,此参数值为true或者false

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{lead数据}] //lead数据列表,如失败或者未登录,则不需要响应此数据

}

注:lead数据字段:

字段

说明

来源

id

ID

Lead信息表

name

姓名

Lead信息表

code

编码(在外部系统的编码)

Lead信息表

user_ip

IP

Lead信息表

comefrom

Lead信息来源(1:渠道;2:营销活动;3:客户;4:采购;5人工录入;6:其他

Lead信息表

source_id

Lead来源ID

Lead信息表

remark

Lead信息来源说明

Lead信息表

level

Lead级别(A-D

Lead信息表

register_date

注册时间

Lead信息表

sex

性别

Lead信息表

state

lead状态

Lead信息表

distributed_state

发送状态(0:未发送;1:已发送)

Lead信息表

distributed_date

发送时间

Lead信息表

distributed_remark

发送说明

Lead信息表

created_date

创建时间

Lead信息表

channel_name

渠道名称

渠道信息表

campaign_keywork

营销活动关键字

营销活动表

phone

电话

Lead属性表

mobile

手机

Lead属性表

email

邮箱

Lead属性表

前端展示来源时,如果comefrom1,则展示渠道名称,为2,则展示渠道名称->营销活动关键字,其他情况来源展示comefrom代码对应的名称(3:客户;4:采购;5人工录入;6:其他),前端可排序字段:姓名、IP、编码、创建时间、注册时间、发送时间、电话、手机、邮箱、级别、来源

注:加载数据的时候,不加载被合并的数据,就是状态为1的不加载

加载分析数据属性

接口URL:base_url/lead/props/{id}

交互方式:RESTFul

交互参数:lead记录ID,直接包含在URL,{id}即为lead记录ID,以get的方式交互

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{lead属性数据}] //lead属性数据列表,如失败或者未登录,则不需要响应此数据

}

注:lead属性不可编辑,也不可增加,只能查看。

Lead 查重

接口URL:base_url/lead/repeatdetect

交互方式:POST JSON

交互参数:复杂JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

手机号模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘repeat_count’:x, //总重复记录数,如失败或者未登录,则不需要响应此数据

‘items’:[lead查重结果数据] //lead查重结果数据,如失败或者未登录,则不需要响应此数据

}

注:lead查重结果数据

{

电话号码:{

repeat_count : x, //重复记录数,如失败或者未登录,则不需要响应此数据

items : [lead数据]

},

…… //其他电话号码的重复数据

}

lead数据字段:

字段

说明

来源

id

ID

Lead信息表

name

姓名

Lead信息表

code

编码(在外部系统的编码)

Lead信息表

phone

电话

Lead信息

mobile

手机

Lead信息

sex

性别

Lead信息表

age

年龄

Lead信息表

user_ip

IP

Lead信息表

comefrom

Lead信息来源(1:渠道;2:营销活动;3:客户;4:采购;5人工录入;6:其他)

Lead信息表

source_id

Lead来源ID

Lead信息表

remark

Lead信息来源说明

Lead信息表

level

Lead级别(A-D

Lead信息表

register_date

注册时间

Lead信息表

state

lead状态

Lead信息表

distributed_state

发送状态(0:未发送;1:已发送)

Lead信息表

distributed_date

发送时间

Lead信息表

distributed_remark

发送说明

Lead信息表

created_date

创建时间

Lead信息表

channel_name

渠道名称

渠道信息表

campaign_keywork

营销活动关键字

营销活动表

email

邮箱

Lead信息

前端展示来源时,如果comefrom1,则展示渠道名称,为2,则展示渠道名称->营销活动关键字,其他情况来源展示comefrom代码对应的名称(3:客户;4:采购;5人工录入;6:其他)。

后台查询数据分页处理时总数据量统计的是符合条件的phone去重后的数据量,当前页的数据集也是phone去重后的数据量,比如,每页显示10条记录,则当前页要有10phone分组的数据集(实际数据量可能超过10条,因为每个IP分组下可能有多条记录——IP相同的记录),后台查询结果排序规则:IP、创建时间(降序)、注册时间(降序)

Lead 查重结果

接口URL:base_url/lead/repeatresult

交互方式:POST JSON

交互参数:复杂JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

手机号模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘repeat_count’:x, //符合条件的总重复记录数,如失败或者未登录,则不需要响应此数据

‘items’:[lead查重结果数据] //lead查重结果数据,如失败或者未登录,则不需要响应此数据

}

注:lead查重结果数据

{

电话号码:{

repeat_count : x, //重复记录数,如失败或者未登录,则不需要响应此数据

items : [lead数据]

},

…… //其他电话号码的重复数据

}

lead数据字段:

字段

说明

来源

id

ID

Lead信息表

name

姓名

Lead信息表

code

编码(在外部系统的编码)

Lead信息表

phone

电话

Lead信息

mobile

手机

Lead信息

sex

性别

Lead信息表

age

年龄

Lead信息表

user_ip

IP

Lead信息表

comefrom

Lead信息来源(1:渠道;2:营销活动;3:客户;4:采购;5人工录入;6:其他)

Lead信息表

source_id

Lead来源ID

Lead信息表

remark

Lead信息来源说明

Lead信息表

level

Lead级别(A-D

Lead信息表

register_date

注册时间

Lead信息表

state

lead状态

Lead信息表

distributed_state

发送状态(0:未发送;1:已发送)

Lead信息表

distributed_date

发送时间

Lead信息表

distributed_remark

发送说明

Lead信息表

created_date

创建时间

Lead信息表

channel_name

渠道名称

渠道信息表

campaign_keywork

营销活动关键字

营销活动表

email

邮箱

Lead信息

前端展示来源时,如果comefrom1,则展示渠道名称,为2,则展示渠道名称->营销活动关键字,其他情况来源展示comefrom代码对应的名称(3:客户;4:采购;5人工录入;6:其他)。

后台查询数据分页处理时总数据量统计的是符合条件的phone去重后的数据量,当前页的数据集也是phone去重后的数据量,比如,每页显示10条记录,则当前页要有10phone分组的数据集(实际数据量可能超过10条,因为每个IP分组下可能有多条记录——IP相同的记录),后台查询结果排序规则:IP、创建时间(降序)、注册时间(降序)

Lead 合并记录

接口URL:base_url/lead/mergelog/{id}

交互方式:RESTFul

交互参数:Lead记录ID,直接包含在URL,{id}即为Lead记录ID,以get的方式交互

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{Lead数据}] //Lead数据列表,如失败或者未登录,则不需要响应此数据

}

lead数据字段:

字段

说明

来源

id

ID

Lead信息表

name

姓名

Lead信息表

code

编码(在外部系统的编码)

Lead信息表

phone

电话

Lead信息表

mobile

手机

Lead信息表

sex

性别

Lead信息表

age

年龄

Lead信息表

user_ip

IP

Lead信息表

comefrom

Lead信息来源(1:渠道;2:营销活动;3:客户;4:采购;5人工录入;6:其他)

Lead信息表

source_id

Lead来源ID

Lead信息表

remark

Lead信息来源说明

Lead信息表

level

Lead级别(A-D

Lead信息表

register_date

注册时间

Lead信息表

state

lead状态

Lead信息表

distributed_state

发送状态(0:未发送;1:已发送)

Lead信息表

distributed_date

发送时间

Lead信息表

distributed_remark

发送说明

Lead信息表

created_date

创建时间

Lead信息表

channel_name

渠道名称

渠道信息表

campaign_keywork

营销活动关键字

营销活动表

email

邮箱

Lead信息表

注:返回的lead数据数组是target_id等于参数上的id的数据数组

Lead合并

接口URL:base_url/lead/merge

交互方式:POST JSON

交互参数:复杂JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

手机号模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

mobiles

Lead记录mobiles数组

用户选择的mobiles数组

checkall

符合条件的所有记录标记,取值为01,

mobiles有排他性,如果此参数为1,则查询时忽略mobiles提供的数据,转而查询所有符合其他条件的记录

mobiles格式

[

{

id:xxx, //指定的合并目标Lead记录id

m:xxx //选择的手机号码

}

…… //其他目标

]

查重合并流程

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //符合条件的电话号码数,用于分页,如失败或者未登录,则不需要响应此数据

‘total_count’:x, //合并处理总记录数,如失败或者未登录,则不需要响应此数据

‘success_count’:x, //成功记录数,如失败或者未登录,则不需要响应此数据

‘error_count’:x //失败记录数,如失败或者未登录,则不需要响应此数据

‘items’:[lead合并结果数据] //lead合并结果数据,如失败或者未登录,则不需要响应此数据

}

注:lead合并结果数据

{

电话号码:{

success_count:x, //成功记录数,如失败或者未登录,则不需要响应此数据

error_count:x //失败记录数,如失败或者未登录,则不需要响应此数据

items : [lead数据]

},

…… //其他电话号码的重复数据

}

注:lead数据字段:

字段

说明

来源

id

ID

Lead信息表

name

姓名

Lead信息表

code

编码(在外部系统的编码)

Lead信息表

phone

电话

Lead信息

mobile

手机

Lead信息

sex

性别

Lead信息表

age

年龄

Lead信息表

user_ip

IP

Lead信息表

comefrom

Lead信息来源(1:渠道;2:营销活动;3:客户;4:采购;5人工录入;6:其他)

Lead信息表

source_id

Lead来源ID

Lead信息表

remark

Lead信息来源说明

Lead信息表

level

Lead级别(A-D

Lead信息表

register_date

注册时间

Lead信息表

state

lead状态

Lead信息表

distributed_state

发送状态(0:未发送;1:已发送)

Lead信息表

distributed_date

发送时间

Lead信息表

distributed_remark

发送说明

Lead信息表

created_date

创建时间

Lead信息表

channel_name

渠道名称

渠道信息表

campaign_keywork

营销活动关键字

营销活动表

email

邮箱

Lead属性表

merge_date

同步时间

Lead信息表

merge_err

合并结果

Lead信息表

前端展示来源时,如果comefrom1,则展示渠道名称,为2,则展示渠道名称->营销活动关键字,其他情况来源展示comefrom代码对应的名称(3:客户;4:采购;5人工录入;6:其他)。

后台查询数据分页处理时总数据量统计的是符合条件的IP 去重后的数据量,当前页的数据集也是IP去重后的数据量,比如,每页显示10条记录,则当前页要有10IP分组的数据集(实际数据量可能超过10条,因为每个IP分组下可能有多条记录——IP相同的记录)

此接口分页、查询是针对手机号分组进行分页及条件查询。

Lead合并结果

接口URL:base_url/lead/mergeresult

交互方式:POST JSON

交互参数:复杂JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

手机号模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

mobiles

Lead记录mobiles数组

用户选择的mobiles数组

checkall

符合条件的所有记录标记,取值为01,

mobiles有排他性,如果此参数为1,则查询时忽略mobiles提供的数据,转而查询所有符合其他条件的记录

mobiles格式

[

{

id:xxx, //指定的合并目标Lead记录id

m:xxx //选择的手机号码

}

…… //其他目标

]

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //符合条件的电话号码数,用于分页,如失败或者未登录,则不需要响应此数据

‘success_count’:x, //符合条件的成功记录数,如失败或者未登录,则不需要响应此数据

‘error_count’:x //符合条件的失败记录数,如失败或者未登录,则不需要响应此数据

‘items’:[lead合并结果数据] //lead合并结果数据,如失败或者未登录,则不需要响应此数据

}

注:lead合并结果数据

{

电话号码:{

success_count:x, //成功记录数,如失败或者未登录,则不需要响应此数据

error_count:x //失败记录数,如失败或者未登录,则不需要响应此数据

items : [lead数据]

},

…… //其他电话号码的重复数据

}

注:lead数据字段:

字段

说明

来源

id

ID

Lead信息表

name

姓名

Lead信息表

code

编码(在外部系统的编码)

Lead信息表

phone

电话

Lead信息

mobile

手机

Lead信息

sex

性别

Lead信息表

age

年龄

Lead信息表

user_ip

IP

Lead信息表

comefrom

Lead信息来源(1:渠道;2:营销活动;3:客户;4:采购;5人工录入;6:其他)

Lead信息表

source_id

Lead来源ID

Lead信息表

remark

Lead信息来源说明

Lead信息表

level

Lead级别(A-D

Lead信息表

register_date

注册时间

Lead信息表

state

lead状态

Lead信息表

distributed_state

发送状态(0:未发送;1:已发送)

Lead信息表

distributed_date

发送时间

Lead信息表

distributed_remark

发送说明

Lead信息表

created_date

创建时间

Lead信息表

channel_name

渠道名称

渠道信息表

campaign_keywork

营销活动关键字

营销活动表

email

邮箱

Lead属性表

merge_date

同步时间

Lead信息表

merge_err

合并结果

Lead信息表

前端展示来源时,如果comefrom1,则展示渠道名称,为2,则展示渠道名称->营销活动关键字,其他情况来源展示comefrom代码对应的名称(3:客户;4:采购;5人工录入;6:其他)。

后台查询数据分页处理时总数据量统计的是符合条件的IP 去重后的数据量,当前页的数据集也是IP去重后的数据量,比如,每页显示10条记录,则当前页要有10IP分组的数据集(实际数据量可能超过10条,因为每个IP分组下可能有多条记录——IP相同的记录)

此接口分页、查询是针对手机号分组进行分页及条件查询。

Lead分配

接口URL:base_url/lead/distribute

交互方式:POST JSON

交互参数:复杂JSON格式

参数名称

参数说明

备注

Page

当前页

如未提供此参数,默认为0

Pagesize

每页记录数

如未提供此参数,默认全部

name

手机、账号、IP、姓名模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

ids

Lead记录ID数组

用户选择的Lead记录ID

checkall

符合条件的所有记录标记,取值为01,

ids有排他性,如果此参数为1,则查询时忽略ids提供的id列表,转而查询所有符合其他条件的记录

level

级别

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

register_date_from

注册时间开始条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

register_date_to

注册时间结束条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

created_date_from

创建时间开始条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

created_date_to

创建时间结束条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

sortcol

排序字段

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

descsort

降序排序

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘distribute_count’:x //分配记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{lead数据}] //lead数据列表,如失败或者未登录,则不需要响应此数据

}

注:lead数据字段:

字段

说明

来源

id

ID

Lead信息表

name

姓名

Lead信息表

code

编码(在外部系统的编码)

Lead信息表

phone

电话

Lead信息

mobile

手机

Lead信息

sex

性别

Lead信息表

age

年龄

Lead信息表

user_ip

IP

Lead信息表

comefrom

Lead信息来源(1:渠道;2:营销活动;3:客户;4:采购;5人工录入;6:其他)

Lead信息表

source_id

Lead来源ID

Lead信息表

remark

Lead信息来源说明

Lead信息表

level

Lead级别(A-D

Lead信息表

register_date

注册时间

Lead信息表

state

lead状态

Lead信息表

created_date

创建时间

Lead信息表

channel_name

渠道名称

渠道信息表

campaign_keywork

营销活动关键字

营销活动表

email

邮箱

Lead信息

distributed_state

发送状态(0:未发送;1:已发送)

Lead信息表

distributed_date

发送时间

Lead信息表

distributed_remark

发送说明

Lead信息表

前端展示来源时,如果comefrom1,则展示渠道名称,为2,则展示渠道名称->营销活动关键字,其他情况来源展示comefrom代码对应的名称(3:客户;4:采购;5人工录入;6:其他)。

进行数据分配时只分配未分配过的已分配过的不进行重复分配

Lead分配结果

接口URL:base_url/lead/distributeresult

交互方式:POST JSON

交互参数:复杂JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

手机、账号、IP、姓名模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

ids

Lead记录ID数组

用户选择的Lead记录ID

checkall

符合条件的所有记录标记,取值为01,

ids有排他性,如果此参数为1,则查询时忽略ids提供的id列表,转而查询所有符合其他条件的记录

distributed_state

发送状态

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

level

级别

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

register_date_from

注册时间开始条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

register_date_to

注册时间结束条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

created_date_from

创建时间开始条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

created_date_to

创建时间结束条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

sortcol

排序字段

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

descsort

降序排序

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{lead数据}] //lead数据列表,如失败或者未登录,则不需要响应此数据

}

注:lead数据字段:

字段

说明

来源

id

ID

Lead信息表

name

姓名

Lead信息表

code

编码(在外部系统的编码)

Lead信息表

phone

电话

Lead信息

mobile

手机

Lead信息

sex

性别

Lead信息表

age

年龄

Lead信息表

user_ip

IP

Lead信息表

comefrom

Lead信息来源(1:渠道;2:营销活动;3:客户;4:采购;5人工录入;6:其他)

Lead信息表

source_id

Lead来源ID

Lead信息表

remark

Lead信息来源说明

Lead信息表

level

Lead级别(A-D

Lead信息表

register_date

注册时间

Lead信息表

state

lead状态

Lead信息表

created_date

创建时间

Lead信息表

channel_name

渠道名称

渠道信息表

campaign_keywork

营销活动关键字

营销活动表

email

邮箱

Lead属性表

distributed_state

发送状态(0:未发送;1:已发送)

Lead信息表

distributed_date

发送时间

Lead信息表

distributed_remark

发送说明

Lead信息表

前端展示来源时,如果comefrom1,则展示渠道名称,为2,则展示渠道名称->营销活动关键字,其他情况来源展示comefrom代码对应的名称(3:客户;4:采购;5人工录入;6:其他)。

Lead导入批次列表

接口URL:base_url/leadimp/list

交互方式:POST form data

交互参数:

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

供应商、批次号模糊查询

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

level

级别

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

syn_state

同步状态

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

imported_date_from

导入时间开始条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

imported_date_to

导入时间结束条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

syn_date_from

同步时间开始条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

srn_date_to

同步时间结束条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

sortcol

排序字段

如未提供此参数,默认用创建时间降序排序

descsort

降序排序

此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否则降序排序,此参数值为true或者false

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{lead导入批次数据}] //lead导入批次数据列表,如失败或者未登录,则不需要响应此数据

}

注:lead导入批次数据字段:

字段

说明

来源

id

ID

导入批次表

vender_id

供应商ID

导入批次表

vender_name

供应商名称

供应商表

vender_level

供应商级别

供应商表

lot

批次号,每执行一次导入,生成一个批次号,批次号用UUID生成,同一批次导入的记录用同一个批次号

导入批次表

state

lead状态(1:导入成功;0:导入失败;)

导入批次表

imported_date

导入时间

导入批次表

importer_id

导入人ID

导入批次表

total_count

总条数

导入批次表

success_count

成功条数

导入批次表

error_count

失败条数

导入批次表

import_err

导入错误

导入批次表

syn_state

同步状态(0:未同步;1:已同步;-1:出错)

导入批次表

syn_date

同步时间

导入批次表

syn_succ_cnt

同步成功条数

导入批次表

syn_err_cnt

同步失败条数

导入批次表

synor_id

同步人ID

导入批次表

synor_name

同步人姓名

用户表

import_file

对应excel文件名

导入批次表

Lead导入批次明细记录

接口URL:base_url/leadimp/detail/{id}

交互方式:RESTFul

交互参数:导入批次记录ID,直接包含在URL,{id}即为导入批次记录ID,以post的方式交互

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

手机、账号、IP、姓名、导入状态模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

sortcol

排序字段

如未提供此参数,默认用创建时间降序排序

descsort

降序排序

此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否则降序排序,此参数值为true或者false

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘imp_lot’:{lead导入批次记录数据} //lead导入批次记录数据,如失败或者未登录,则不需要响应此数据

‘items’:[{Lead数据}] //Lead数据列表,如失败或者未登录,则不需要响应此数据

}

注:lead导入批次记录数据字段:

字段

说明

来源

id

ID

导入批次表

vender_id

供应商ID

导入批次表

vender_name

供应商名称

供应商表

vender_level

供应商级别

供应商表

lot

批次号,每执行一次导入,生成一个批次号,批次号用UUID生成,同一批次导入的记录用同一个批次号

导入批次表

state

lead状态(1:导入成功;0:导入失败;)

导入批次表

imported_date

导入时间

导入批次表

importer_id

导入人ID

导入批次表

total_count

总条数

导入批次表

success_count

成功条数

导入批次表

error_count

失败条数

导入批次表

import_err

导入错误

导入批次表

import_file

对应excel文件名

导入批次表

lead数据字段:

字段

说明

来源

id

ID

Lead导入日志表

imp_lot_id

导入批次ID

Lead导入日志表

name

姓名

Lead导入日志表

code

编码(在外部系统的编码)

Lead导入日志表

phone

电话

Lead导入日志表

mobile

手机

Lead导入日志表

sex

性别

Lead导入日志表

age

年龄

Lead导入日志表

user_ip

IP

Lead导入日志表

comefrom

Lead信息来源(1:渠道;2:营销活动;3:客户;4:采购;5人工录入;6:其他)

Lead导入日志表

source_id

Lead来源ID

Lead导入日志表

remark

Lead信息来源说明

Lead导入日志表

level

Lead级别(A-D

Lead导入日志表

register_date

注册时间

Lead导入日志表

state

lead状态(1:导入成功;0:导入失败;)

Lead导入日志表

inspected_state

查重状态(0:不存在;1:已存在)

syn_state

同步状态(0:未同步;1:已同步;2:出错)

Lead导入日志表

syn_date

同步时间

Lead导入日志表

syn_error

同步错误原因

Lead导入日志表

distributed_remark

发送说明

Lead导入日志表

created_date

创建时间

Lead导入日志表

channel_name

渠道名称

渠道信息表

campaign_keywork

营销活动关键字

营销活动表

email

邮箱

Lead导入日志表

imported_date

导入时间

Lead导入日志表

import_row

对应excel文件行号

Lead导入日志表

import_file

对应excel文件名

Lead导入日志表

import_err

错误描述

Lead导入日志表

前端展示来源时,如果comefrom1,则展示渠道名称,为2,则展示渠道名称->营销活动关键字,其他情况来源展示comefrom代码对应的名称(3:客户;4:采购;5人工录入;6:其他),按照行号升序排序

此接口的分页参数针对的是明细记录而非批次记录

Lead导入日志关联记录

接口URL:base_url/leadimp/referral/{id}

交互方式:RESTFul

交互参数:lead记录ID,直接包含在URL,{id}即为lead记录ID,以get的方式交互

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{Lead数据}] //Lead数据列表,如失败或者未登录,则不需要响应此数据

}

lead数据字段:

字段

说明

来源

id

ID

Lead信息表

name

姓名

Lead信息表

code

编码(在外部系统的编码)

Lead信息表

phone

电话

Lead信息表

mobile

手机

Lead信息表

sex

性别

Lead信息表

age

年龄

Lead信息表

user_ip

IP

Lead信息表

comefrom

Lead信息来源(1:渠道;2:营销活动;3:客户;4:采购;5人工录入;6:其他)

Lead信息表

source_id

Lead来源ID

Lead信息表

remark

Lead信息来源说明

Lead信息表

level

Lead级别(A-D)

Lead信息表

register_date

注册时间

Lead信息表

state

lead状态

Lead信息表

distributed_state

发送状态(0:未发送;1:已发送)

Lead信息表

distributed_date

发送时间

Lead信息表

distributed_remark

发送说明

Lead信息表

created_date

创建时间

Lead信息表

channel_name

渠道名称

渠道信息表

campaign_keywork

营销活动关键字

营销活动表

email

邮箱

Lead信息表

注:返回的lead数据数组是imp_id等于参数上的id的数据数组,此接口主要是查看关联的Lead数据

Lead导入

接口URL:base_url/leadimp/import

交互方式:POST form data

交互参数:

参数名称

参数说明

备注

excel_file

Excel 文件名

必须提供此参数

vender_id

供应商ID

必须提供此参数

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;2:有异常;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘imp_lot’:{lead导入批次记录数据} //lead导入批次记录数据,如失败或者未登录,则不需要响应此数据

‘total’:x, // lead导入数据总记录数,用于分页,如失败或者未登录,则不需要响应此数据

imp_items’:[{lead导入数据}] //lead当前导入批次的数据列表,如失败或者未登录,则不需要响应此数据

}

注:lead导入批次记录数据字段:

字段

说明

来源

id

ID

导入批次表

vender_id

供应商ID

导入批次表

vender_name

供应商名称

供应商表

vender_level

供应商级别

供应商表

lot

批次号,每执行一次导入,生成一个批次号,批次号用UUID生成,同一批次导入的记录用同一个批次号

导入批次表

state

导入状态(1:导入成功;0:导入失败;)

导入批次表

imported_date

导入时间

导入批次表

importer_id

导入人ID

导入批次表

total_count

总条数

导入批次表

success_count

成功条数

导入批次表

error_count

失败条数

导入批次表

import_err

导入错误

导入批次表

syn_state

同步状态(0:未同步;1:已同步;-1:出错)

导入批次表

syn_date

同步时间

导入批次表

syn_succ_cnt

同步成功条数

导入批次表

syn_err_cnt

同步失败条数

导入批次表

synor_id

同步人ID

导入批次表

synor_name

同步人姓名

用户表

import_file

对应excel文件名

导入批次表

lead导入数据字段:

字段

说明

来源

id

ID

Lead导入日志表

imp_lot_id

导入批次ID

Lead导入日志表

name

姓名

Lead导入日志表

code

编码(在外部系统的编码)

Lead导入日志表

phone

电话

Lead导入日志表

mobile

手机

Lead导入日志表

sex

性别

Lead导入日志表

age

年龄

Lead导入日志表

user_ip

IP

Lead导入日志表

comefrom

Lead信息来源(1:渠道;2:营销活动;3:客户;4:采购;5人工录入;6:其他)

Lead导入日志表

source_id

Lead来源ID

Lead导入日志表

remark

Lead信息来源说明

Lead导入日志表

level

Lead级别(A-D

Lead导入日志表

register_date

注册时间

Lead导入日志表

state

导入状态(1:导入成功;0:导入失败;)

Lead导入日志表

inspected_state

查重状态(0:不存在;1:已存在)

syn_state

同步状态(0:未同步;1:已同步;2:出错)

Lead导入日志表

syn_date

同步时间

Lead导入日志表

syn_error

同步错误原因

Lead导入日志表

distributed_remark

发送说明

Lead导入日志表

created_date

创建时间

Lead导入日志表

channel_name

渠道名称

渠道信息表

campaign_keywork

营销活动关键字

营销活动表

email

邮箱

Lead导入日志表

imported_date

导入时间

Lead导入日志表

import_row

对应excel文件行号

Lead导入日志表

import_file

对应excel文件名

Lead导入日志表

import_err

错误描述

Lead导入日志表

前端展示来源时,如果comefrom1,则展示渠道名称,为2,则展示渠道名称->营销活动关键字,其他情况来源展示comefrom代码对应的名称(3:客户;4:采购;5人工录入;6:其他),前端可排序字段:按照行号升序排序

此接口的分页参数针对的是明细记录而非批次记录

Lead导入结果

接口URL:base_url/leadimp/importresult/{id}

交互方式:RESTFul

交互参数:导入批次记录ID,直接包含在URL,{id}即为导入批次记录ID,以post的方式交互

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

手机、账号、IP、姓名、导入状态模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

sortcol

排序字段

如未提供此参数,默认用创建时间降序排序

descsort

降序排序

此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否则降序排序,此参数值为true或者false

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;2:有异常;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘imp_lot’:{lead导入批次记录数据} //lead导入批次记录数据,如失败或者未登录,则不需要响应此数据

‘total’:x, // lead导入数据总记录数,用于分页,如失败或者未登录,则不需要响应此数据

imp_items’:[{lead导入数据}] //lead当前导入批次的数据列表,如失败或者未登录,则不需要响应此数据

}

注:lead导入批次记录数据字段:

字段

说明

来源

id

ID

导入批次表

vender_id

供应商ID

导入批次表

vender_name

供应商名称

供应商表

vender_level

供应商级别

供应商表

lot

批次号,每执行一次导入,生成一个批次号,批次号用UUID生成,同一批次导入的记录用同一个批次号

导入批次表

state

导入状态(1:导入成功;0:导入失败;)

导入批次表

imported_date

导入时间

导入批次表

importer_id

导入人ID

导入批次表

total_count

总条数

导入批次表

success_count

成功条数

导入批次表

error_count

失败条数

导入批次表

import_err

导入错误

导入批次表

syn_state

同步状态(0:未同步;1:已同步;-1:出错)

导入批次表

syn_date

同步时间

导入批次表

syn_succ_cnt

同步成功条数

导入批次表

syn_err_cnt

同步失败条数

导入批次表

synor_id

同步人ID

导入批次表

synor_name

同步人姓名

用户表

import_file

对应excel文件名

导入批次表

lead导入数据字段:

字段

说明

来源

id

ID

Lead导入日志表

imp_lot_id

导入批次ID

Lead导入日志表

name

姓名

Lead导入日志表

code

编码(在外部系统的编码)

Lead导入日志表

phone

电话

Lead导入日志表

mobile

手机

Lead导入日志表

sex

性别

Lead导入日志表

age

年龄

Lead导入日志表

user_ip

IP

Lead导入日志表

comefrom

Lead信息来源(1:渠道;2:营销活动;3:客户;4:采购;5人工录入;6:其他)

Lead导入日志表

source_id

Lead来源ID

Lead导入日志表

remark

Lead信息来源说明

Lead导入日志表

level

Lead级别(A-D

Lead导入日志表

register_date

注册时间

Lead导入日志表

state

导入状态(1:导入成功;0:导入失败;)

Lead导入日志表

inspected_state

查重状态(0:不存在;1:已存在)

syn_state

同步状态(0:未同步;1:已同步;2:出错)

Lead导入日志表

syn_date

同步时间

Lead导入日志表

syn_error

同步错误原因

Lead导入日志表

distributed_remark

发送说明

Lead导入日志表

created_date

创建时间

Lead导入日志表

channel_name

渠道名称

渠道信息表

campaign_keywork

营销活动关键字

营销活动表

email

邮箱

Lead导入日志表

imported_date

导入时间

Lead导入日志表

import_row

对应excel文件行号

Lead导入日志表

import_file

对应excel文件名

Lead导入日志表

import_err

错误描述

Lead导入日志表

前端展示来源时,如果comefrom1,则展示渠道名称,为2,则展示渠道名称->营销活动关键字,其他情况来源展示comefrom代码对应的名称(3:客户;4:采购;5人工录入;6:其他),前端可排序字段:按照行号升序排序

此接口的分页参数针对的是明细记录而非批次记录

导入同步流程

Lead同步

接口URL:base_url/leadimp/syn

交互方式:POST JSON

交互参数:复杂JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

ids

Lead导入批次记录ID数组

用户选择的Lead导入批次记录ID

checkall

符合条件的所有记录标记,取值为01,

ids有排他性,如果此参数为1,则查询时忽略ids提供的id列表,转而查询所有符合其他条件的记录

level

级别

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

imported_date_from

导入时间开始条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

imported_date_to

导入时间结束条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

sortcol

排序字段

如未提供此参数,默认用创建时间降序排序

descsort

降序排序

此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否则降序排序,此参数值为true或者false

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //符合条件的批次记录数,用于分页,如失败或者未登录,则不需要响应此数据

‘total_count’:x, //同步总记录数,如失败或者未登录,则不需要响应此数据

‘success_count’:x, //成功记录数,如失败或者未登录,则不需要响应此数据

‘error_count’:x //失败记录数,如失败或者未登录,则不需要响应此数据

‘skipped_count’:x //忽略记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{lead导入批次同步数据}] //lead导入批次同步数据列表,如失败或者未登录,则不需要响应此数据

}

注:lead导入批次同步数据

字段

说明

来源

id

ID

导入批次表

vender_id

供应商ID

导入批次表

vender_name

供应商名称

供应商表

vender_level

供应商级别

供应商表

lot

批次号,每执行一次导入,生成一个批次号,批次号用UUID生成,同一批次导入的记录用同一个批次号

导入批次表

state

lead状态(1:导入成功;0:导入失败;)

导入批次表

imported_date

导入时间

导入批次表

importer_id

导入人ID

导入批次表

total_count

总条数

导入批次表

success_count

成功条数

导入批次表

error_count

失败条数

导入批次表

import_err

导入错误

导入批次表

syn_state

同步状态(0:未同步;1:已同步;-1:出错)

导入批次表

syn_date

同步时间

导入批次表

syn_succ_cnt

同步成功条数

导入批次表

syn_err_cnt

同步失败条数

导入批次表

synor_id

同步人ID

导入批次表

synor_name

同步人姓名

用户表

import_file

对应excel文件名

导入批次表

Lead同步结果

接口URL:base_url/leadimp/synresult

交互方式:POST JSON

交互参数:复杂JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

ids

Lead导入批次记录ID数组

用户选择的Lead导入批次记录ID

checkall

符合条件的所有记录标记,取值为01,

ids有排他性,如果此参数为1,则查询时忽略ids提供的id列表,转而查询所有符合其他条件的记录

level

级别

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

syn_date_from

同步时间开始条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

syn_date_to

同步时间结束条件

如提供此参数,则将此参数作为数据过滤条件进行查询过滤

sortcol

排序字段

如未提供此参数,默认用创建时间降序排序

descsort

降序排序

此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否则降序排序,此参数值为true或者false

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //符合条件的批次记录数,用于分页,如失败或者未登录,则不需要响应此数据

‘items’:[{lead导入批次同步数据}] //lead导入批次同步数据列表,如失败或者未登录,则不需要响应此数据

}

注:lead导入批次同步数据:

字段

说明

来源

id

ID

导入批次表

vender_id

供应商ID

导入批次表

vender_name

供应商名称

供应商表

vender_level

供应商级别

供应商表

lot

批次号,每执行一次导入,生成一个批次号,批次号用UUID生成,同一批次导入的记录用同一个批次号

导入批次表

state

lead状态(1:导入成功;0:导入失败;)

导入批次表

imported_date

导入时间

导入批次表

importer_id

导入人ID

导入批次表

total_count

总条数

导入批次表

success_count

成功条数

导入批次表

error_count

失败条数

导入批次表

import_err

导入错误

导入批次表

syn_state

同步状态(0:未同步;1:已同步;-1:出错)

导入批次表

syn_date

同步时间

导入批次表

syn_succ_cnt

同步成功条数

导入批次表

syn_err_cnt

同步失败条数

导入批次表

synor_id

同步人ID

导入批次表

synor_name

同步人姓名

用户表

import_file

对应excel文件名

导入批次表

加载用户列表

接口URL:base_url/user/list

交互方式:POST JSON

交互参数:单层JSON格式

参数名称

参数说明

备注

page

当前页

如未提供此参数,默认为0

pagesize

每页记录数

如未提供此参数,默认全部

name

用户名称模糊查询条件

如未提供此参数,则查询所有的数据,否则模糊匹配符合条件的记录

sortcol

排序字段

如未提供此参数,默认用创建时间降序排序

descsort

降序排序

此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否则降序排序,此参数值为true或者false

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{用户数据}] //用户数据列表,如失败或者未登录,则不需要响应此数据

}

注:用户数据中,需要一个额外的字段,创建人名称,此字段数据来源于用户表,前端可排序字段:名称、创建时间、状态

编辑用户

接口URL:base_url/user/edit

交互方式:POST JSON

交互参数:复杂JSON格式

{

‘id’:xxxx, //ID,新增时,ID为空

username:xxxx, //用户名称

passwd:xxxx, //用户密码

state’:xxxx, //用户状态

‘flag’:xx //操作标志,-1:删除;0:编辑;1:新增

‘props’:[

{

‘id’:xxxxx //属性ID,新增的属性,ID为空

‘code’:xxxx, //属性代码

name’:xxxxx //属性名称

value’:xxxx, //属性值

‘flag’:xx //操作标志,-1:删除;0:编辑;1:新增

}

…… //其他属性

]

}

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

}

注:属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。另外,有模板id的,如果模板上定义的属性是不可删除的,则这条属性是不能删除的,界面上对应的属性不需要删除按钮及操作,后台也不能删除此属性,如果模板定义的属性是必填的,则这条属性的值不能为空,前端后端就要进行验证。用户属性模板的类别为user_props_tmpl

加载用户属性

接口URL:base_url/user/props/{id}

交互方式:RESTFul

交互参数:用户记录ID,直接包含在URL,{id}即为用户记录ID,以get的方式交互

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{用户属性数据}] //用户属性数据列表,如失败或者未登录,则不需要响应此数据

}

注:用户属性数据中,需要额外的字段,可删除、必填,字段数据来源于属性模板表。

属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。另外,有模板id的,如果是不可删除的,则这条属性是不能删除的,界面上对应的属性不需要删除按钮及操作,后台也不能删除此属性,如果是必填的,则这条属性的值不能为空,前端后端就要进行验证。用户属性模板的类别为user_props_tmpl

重置密码

接口URLbase_url/user/resetpasswd/{id}

交互方式:用户记录ID,直接包含在URL,{id}即为用户记录ID,以get的方式交互

交互参数:无

响应数据格式:JSON

{

‘flg’:x, //状态,0:登录失败;1:成功-1:未登录

‘msg’:’xxxxxx’ //消息,失败原因,用户名密码错误或者是系统内部错误

}

加载系统参数列表

接口URL:base_url/sysprops/list

交互方式:http get

交互参数:

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{系统参数数据}] //系统参数数据列表,如失败或者未登录,则不需要响应此数据

}

注:用户数据中,需要一个额外的字段,创建人名称,此字段数据来源于用户表,前端可排序字段:代码、名称、创建时间

编辑系统参数

接口URL:base_url/sysprops/edit

交互方式:POST JSON

交互参数:单层JSON格式

[

{

‘id’:xxxx, //ID,新增时,ID为空

‘code’:xxxx, //代码

‘name’:xxxx, //名称

value’:xxxx, //参数值

description’:xxxx, //参数说明

‘flag’:xx //操作标志,-1:删除;0:编辑;1:新增

}

…… //其他参数信息

]

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

}

加载属性模板类别列表

接口URL:base_url/propstempl/list

交互方式:http get

交互参数:无

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘items’:[{属性模板类别数据}] //属性模板类别数据列表,如失败或者未登录,则不需要响应此数据

}

注:属性模板类别由后台配置定义,以key->value的方式提供给前端,系统预定义如下属性类别:

'user_props_tmpl' => '用户属性',

'customer_props_tmpl' => '客户属性',

'channel_props_tmpl' => '渠道属性',

'vender_props_tmpl' => '供应商属性',

'campaign_props_tmpl' => '营销活动属性',

'linkpoint_props_tmpl' => '引流点属性',

'lead_props_tmpl' => 'Lead属性',

'lead_dist_log_props_tmpl' => 'Lead分配属性',

'reply_log_props_tmpl' => '目标反馈分解',

'request_log_props_tmpl' => '用户请求分解',

'channel_feature_props_tmpl' => '渠道特性'

这些属性类别保存在管理平台的配置文件里面

加载属性模板

接口URL:base_url/propstempl/{type}

交互方式:RESTFul

交互参数:属性模板类别,直接包含在URL,{type}即为属性模板类别,以get的方式交互

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

‘total’:x, //总记录数,如失败或者未登录,则不需要响应此数据

‘items’:[{属性模板数据}] //属性模板数据列表,如失败或者未登录,则不需要响应此数据

}

编辑属性模板

接口URL:base_url/propstempl/edit/{type}

交互方式:RESTFul POST JSON

交互参数:属性模板类别包含在URL,{id}即为属性模板类别,复杂JSON格式

[

{

‘id’:xxxxx //属性ID,新增的属性,ID为空

‘code’:xxxx, //属性代码

name’:xxxx, //属性名称

deletable’:xxxxx //可删

required’:xxxx, //必填

description’:xxxx, //属性说明

‘flag’:xx //操作标志,-1:删除;0:编辑;1:新增

}

…… //其他属性

]

响应数据格式:JSON

{

‘flg’:x, //状态,0:失败;1:成功;-1:未登录

‘msg’:’xxxxxx’, //消息,失败原因,参数错误或者是系统内部错误

}

注:如果属性模板的某条属性被删除了,对应对象实例的属性的模板id要被设置成null,也就是说将此属性转化为用户自定义的,比如用户属性模板里面删除了身份证号这个属性,所有用户的身份证号的属性的模板ID都要被设置成null。如果模板里面添加了一个属性,代码或者名称跟实例的有一项一致,则用模板的代码和名称更新实例的属性,并且将实例的属性的模板id设置成模板添加的属性的id。比如,用户a,有一个自定义的属性代码为X属性名称为Y的属性,用户b,有一个自定义的属性代码为V属性名称为Z的属性,用户属性模板添加了一个属性,代码X名称为Z idE,则用户a的属性代码为X的属性和用户b的属性代码为V的属性将被更新为模板idE,代码为X,名称为Z

附注:

分页

默认的每页记录数是25条,选项有255075100、150all,就这几个选项就行了,低于25条的在测试阶段可以有(为了测试分页功能),发布出去的时候就不需要了。另外一个就是前后台都要增加的,就是分页方面的,每页记录数那里有个all的选项,就是显示所有的记录。后台收到all的页面记录数时,不进行分页查询,直接查询出来全部记录。

网络引流系统前后端数据交互接口设计

相关推荐