API开放平台

TIP

新增线索数据
修改线索数据
修改apaas线索数据
删除线索数据
线索数据查询
推送线索跟进记录

# 新增线索数据

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

{
	"empName":"负责人",
	"code":"code",
	"cus_name":"api专用",
	"poolName":"线索池名称",
	"source_type":"客户介绍",
	"market_name":"市场活动1",
	"linkman":"联系人1",
	"mobile_country":"86",
	"mobile":"18811111111",
	"mobile_repeat":"0",
	"tel":"02588888888",
	"customer_classification_name":"学校",
	"position":"公务员",
	"detail":"线索详情线索详情",
	"mssProvinceName":"江苏省",
	"mssCityName":"南京市",
	"mssAreaName":"建邺区",
	"mssStreetName":"沙洲街道",
	"mark_addr":"江苏省南京市雨花台区春江路1号肯德基(铁心桥餐厅)",
	"email":"waiqin365@waiqin365.com",
	"website":"https://api.waiqin365.com/",
	"address":"江苏省南京市雨花台区春江路1号肯德基(铁心桥餐厅)",
	"latlon":"31.963018601806095,118.76207851993819",
    "exts":[ {
               "salesleads_ext_key":"自定义字段1",
                "salesleads_ext_value":"api测试用啊"
                 },{
                 "salesleads_ext_key":"自定义字段2",
                  "salesleads_ext_value":"测试用"
                  }]
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
empName	VARCHAR(100)	是	负责人
poolName	VARCHAR(100)	是	线索池名称，与负责人二者必填其一
code	VARCHAR(100)	否	线索编码，校验是否已存在
cus_name	VARCHAR(100)	是	客户名称
source_type	VARCHAR(100)	否	线索来源，校验是否存在
market_name	VARCHAR(100)	否	市场活动名称，校验是否存在
linkman	VARCHAR(100)	否	联系人
mobile_country	VARCHAR(32)	否	手机号码国家码
mobile	VARCHAR(100)	否	手机号码
mobile_repeat	CHAR(1)	否	手机号码是否能重复，0：不可以，1或空：可以
tel	VARCHAR(100)	否	固话
customer_classification_name	VARCHAR(100)	否	线索类型
position	VARCHAR(100)	否	职务
detail	VARCHAR(4000)	否	线索详情
mssProvinceName	VARCHAR(100)	否	省名称
mssCityName	VARCHAR(100)	否	市名称
mssAreaName	VARCHAR(100)	否	区县名称
mssStreetName	VARCHAR(100)	否	乡镇街道名称
mark_addr	VARCHAR(100)	否	地址
email	VARCHAR(100)	否	邮箱
website	VARCHAR(100)	否	网址
latlon	VARCHAR(400)	否	标注位置
address	VARCHAR(4000)	否	标注位置
exts	List	否	自定义字段列表
exts.salesleads_ext_key	VARCHAR(100)	否	自定义字段key
exts.salesleads_ext_value	VARCHAR(100)	否	自定义字段value

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": "90b4b267dd3d49aeace879038b1e7291",
    "response_data": null
}

参数说明：

参数	类型	说明
msg_id	String	请求消息ID
return_code	int	响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg	String	响应说明

# 修改线索数据

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

{
    "id": 6789690485561771524,
    "code": "codezs",
    "poolName": "线索池名称",
    "cus_name": "api专用",
    "source_type": "客户介绍",
    "market_name": "市场活动1",
    "linkman": "联系人1",
    "mobile_country": "86",
    "mobile": "18811111111",
    "tel": "02588888888",
    "customer_classification_name": "学校",
    "position": "公务员",
    "detail": "线索详情线索详情",
    "mssProvinceName": "江苏省",
    "mssCityName": "南京市",
    "mssAreaName": "建邺区",
    "mssStreetName": "沙洲街道",
    "mark_addr": "南京市铁心桥",
    "email": "waiqin365@waiqin365.com",
    "website": "https://api.waiqin365.com/",
    "address": "江苏省南京市雨花台区春江路1号肯德基(铁心桥餐厅)",
    "latlon": "31.963018601806095,118.76207851993819",
    "exts": [
        {
            "salesleads_ext_key": "自定义字段1",
            "salesleads_ext_value": "api测试用啊"
        },
        {
            "salesleads_ext_key": "自定义字段2",
            "salesleads_ext_value": "测试用"
        }
    ]
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
id	VARCHAR(40)	是	线索ID
code	VARCHAR(100)	否	线索编码，校验是否已存在。与线索ID不能同时为空
poolName	VARCHAR(100)	是	线索池名称
cus_name	VARCHAR(100)	是	客户名称
source_type	VARCHAR(100)	否	线索来源，校验是否存在
market_name	VARCHAR(100)	否	市场活动名称，校验是否存在
linkman	VARCHAR(100)	否	联系人
mobile_country	VARCHAR(32)	否	手机号码国家码
mobile	VARCHAR(100)	否	手机号码
tel	VARCHAR(100)	否	固话
customer_classification_name	VARCHAR(100)	否	线索类型
position	VARCHAR(100)	否	职务
detail	VARCHAR(4000)	否	线索详情
mssProvinceName	VARCHAR(100)	否	省名称
mssCityName	VARCHAR(100)	否	市名称
mssAreaName	VARCHAR(100)	否	区县名称
mssStreetName	VARCHAR(100)	否	乡镇街道名称
mark_addr	VARCHAR(100)	否	地址
email	VARCHAR(100)	否	邮箱
website	VARCHAR(100)	否	网址
latlon	VARCHAR(400)	否	标注位置
address	VARCHAR(4000)	否	标注位置
exts	List	否	自定义字段列表
exts.salesleads_ext_key	VARCHAR(100)	否	自定义字段key
exts.salesleads_ext_value	VARCHAR(100)	否	自定义字段value

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": "90b4b267dd3d49aeace879038b1e7291",
    "response_data": null
}

参数说明：

参数	类型	说明
msg_id	String	请求消息ID
return_code	int	响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg	String	响应说明

# 修改apaas线索数据

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

{
    "id": 5031887187231707391,
    "company_name": "掌控网络",
    "source_type": "智能拓店",
    "customer_classification_name": "运动场馆",
    "return_reason": "联系不上客户",
    "invalid_reason": "其他",
    "market_name": "市场活动",
    "linkman": "张三",
    "mobile": {
        "phone":"15444212232", 
        "code":"86"
    },
    "telephone": "",
    "position": "经理",
    "detail": "这是一个线索详情",
    "mss_country": "中国",
    "mss_province": "江苏省",
    "mss_city": "南京",
    "mss_area": "建邺区",
    "mss_street": "秣陵街道",
    "mark_address": "江苏省南京市建邺区国家广告产业园",
    "email": "qince@163.com",
    "website": "https://qince.com",
    "allocation_status": "1",
    "salesleads_status": "1",
    "pool_name": "默认线索池",
    "removed_result": null,
    "salesleads_label": null,
    "responsible_person: "5031887187231707391",
    "card_photo": null,
    "exts:{ "field_kig9p__cywdzm9": "10000.00",
            "field_dacfk__cxuv3jd": "1214123412341234",
            "field_puezh__cdc07gx": "12341234125463457634567",
            "field_db3nn__ctvj575": "2024-07-26",
            "field_xvw5t__cz8n029": "j8gKhgpu",
            "field_swe5j__cpzhpuj": "xA62mwYV,QlmleNPY"
         }
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
id	BIGINT	是	线索ID
code	VARCHAR(100)	是	线索编码，校验是否已存在。与线索ID不能同时为空
company_name	VARCHAR(100)	否	企业名称
source_type	VARCHAR(100)	否	来源。支持传入来源选项值名称
customer_classification_name	VARCHAR(100)	否	线索类型。支持传入选项值名称
return_reason	VARCHAR(100)	否	退回原因。支持传入选项值名称
invalid_reason	VARCHAR(100)	否	作废原因。支持传入选项值名称
market_name	VARCHAR(100)	否	市场活动名称。市场活动取值优先级：市场活动勤策id>市场活动名称
market_id	VARCHAR(100)	否	市场活动id。市场活动取值优先级：市场活动勤策id>市场活动名称
linkman	VARCHAR(100)	否	联系人
mobile	VARCHAR(100)	否	phone:手机号. code:国家编码
telephone	VARCHAR(100)	否	固话
position	VARCHAR(100)	否	职位
detail	VARCHAR(4000)	否	销售线索详情
mss_country	VARCHAR(32)	否	国家名称
mss_province	VARCHAR(32)	否	省名称
mss_city	VARCHAR(32)	否	市名称
mss_area	VARCHAR(32)	否	区县名称
mss_street	VARCHAR(32)	否	乡镇街道名称
mark_address	VARCHAR(200)	否	地址
email	VARCHAR(100)	否	邮箱
website	VARCHAR(200)	否	地址
allocation_status	VARCHAR(200)	否	分配状态。1：已分配，0：未分配。未分配的线索进入线索池，必填线索池字段，负责人字段为空；已分配的线索，负责人字段必填
salesleads_status	VARCHAR(200)	否	跟进状态。1：待处理，2：跟进中，5：已转换
pool_name	VARCHAR(100)	否	线索池
removed_result	VARCHAR(100)	否	作废补充说明
labels	VARCHAR(100)	否	线索标签
responsible_person	VARCHAR(32)	否	负责人id(勤策员工id)
card_photo	VARCHAR(100)	否	名片
exts	Map	否	扩展字段集合。json数据格式为{"ext_keyA": "ext_valueA"}。参数格式参考 (opens new window)

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": "90b4b267dd3d49aeace879038b1e7291",
    "response_data": null
}

参数说明：

参数	类型	说明
msg_id	String	请求消息ID
return_code	int	响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg	String	响应说明

# 删除线索数据

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

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
id	VARCHAR(40)	是	线索ID
code	VARCHAR(100)	是	线索编码，校验是否已存在。与线索ID不能同时为空
reason_id	VARCHAR(40)	是	作废原因编码，校验是否已存在
content	VARCHAR(4000)	是	作废原因

响应示例：

{
    "return_code": "0",
    "return_msg": null,
    "msg_id": "90b4b267dd3d49aeace879038b1e7291",
    "response_data": null
}

参数说明：

参数	类型	说明
msg_id	String	请求消息ID
return_code	int	响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg	String	响应说明

# 线索数据查询

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

{
	"code":"codezs",
    "id":"5025653528380651509",
    "linkman":"联系人",
    "mobile":"18811111111",
    "emp_name":"张三",
    "cus_name":"线索1",
    "create_time_start":"2020-01-20",
    "create_time_end":"2020-09-20",
    "salesleads_status":"1",
    "page":1,
    "pageSize":10
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：
注：查询条件至少需要填写一个参数

参数	类型	必填	说明
code	VARCHAR(100)	否	线索编码
id	VARCHAR(100)	否	线索id
linkman	VARCHAR(100)	否	联系人
mobile	VARCHAR(40)	否	手机号码
emp_name	VARCHAR(100)	否	负责人
cus_name	VARCHAR(100)	否	线索名称
create_time_start	VARCHAR(100)	否	创建时间起始。格式：yyyy-MM-dd
create_time_end	VARCHAR(100)	否	创建时间结束。格式：yyyy-MM-dd
modify_time_start	VARCHAR(100)	否	修改时间起始。格式：yyyy-MM-dd
modify_time_end	VARCHAR(100)	否	修改时间结束。格式：yyyy-MM-dd
salesleads_status	VARCHAR(1)	否	线索状态。1：待处理，2：跟进，3：无效，5：转换，6：未分配
page	INT	否	页码，默认1
pageSize	INT	否	分页大小，默认1000

响应示例：

{
    "return_code": "0", 
    "return_msg": null,
    "msg_id": null,
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
     {
         "id":"6789690485561771524",
         "cus_name":"api专用",
         "code":"",
         "source_type_name":"客户介绍",
         "market_name":"市场活动1",
         "linkman":"联系人1",
		 "mobile_country":"86",
         "mobile":"18811111111",
         "tel":"02588888888",
         "position":"公务员",
         "detail":"线索详情",
         "mss_province":"江苏省",
         "mss_city":"南京市",
         "mss_area":"雨花台区",
         "mss_street":"",
         "mark_addr":"江苏省南京市雨花台区春江路1号肯德基(铁心桥餐厅)详细地址",
         "email":"waiqin365@waiqin365.com",
         "website":"https://api.waiqin365.com/",
         "emp_name":"李四",
         "status_value":"跟进",
         "emp_id_str":"5025653528380651509",
         "create_time":"2020-07-25 14:45",
         "owner_change_time":"2020-07-27 17:10",
         "result":"跟进内容",
         "disable_reason_name":"线索重复2",
         "disable_reason_ext":"误操作重复导入了",
         "creator_name":"系统",
         "follow_name":"张三",
         "follow_time":"2020-07-27 19:43",
         "modifyier_name":"张三",
         "transf_time":"",
         "modify_time":"2020-07-27 19:42",
         "pool_name":"",
         "distribution_name":"",
         "distribution_take_time":"",
         "return_reason_name":"",
         "delete_reason_name":"客户暂无需求",
         "delete_reason_ext":"录制错误了",
         "customer_classification_name":"学校",
         "cm_code":"CUS000044",
         "cm_name":"已转换客户名称",
         "labels":[
            {
                "salesleads_id":"6789690485561771524",
                "color":"#cc0000",
                "name":"重复",
                "rule_description":"新增、编辑线索时根据设置的查重条件检查当前线索是否与系统内已存在的线索重复，如果重复则打上此标签",
                "id":"1",
                "status":"1"
            }
         ],
         "exts":[
            {
                "ext_column":"ext_2206290023",
                "ext_key":"数值111",
                "ext_value":"10"
            }
         ]
     }
]

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	是	线索id
cus_name	VARCHAR(100)	是	线索名称
code	VARCHAR(100)	是	线索编码
source_type_name	VARCHAR(100)	是	线索来源
market_name	VARCHAR(100)	是	市场活动名称
linkman	VARCHAR(100)	是	联系人
mobile_country	VARCHAR(32)	否	手机号码国家码
mobile	VARCHAR(100)	是	手机号码
tel	VARCHAR(100)	是	固话
position	VARCHAR(100)	是	职务
detail	VARCHAR(4000)	是	线索详情
mss_province	VARCHAR(100)	是	省名称
mss_city	VARCHAR(100)	是	市名称
mss_area	VARCHAR(100)	是	区县名称
mss_street	VARCHAR(100)	是	乡镇街道名称
mark_addr	VARCHAR(100)	是	地址
email	VARCHAR(100)	是	邮箱
website	VARCHAR(100)	是	网址
emp_name	VARCHAR(100)	是	负责人
emp_id_str	VARCHAR(100)	是	负责人勤策id
status_value	VARCHAR(100)	是	状态
result	VARCHAR(100)	是	跟进内容
disable_reason_name	VARCHAR(100)	是	线索无效原因
disable_reason_ext	VARCHAR(100)	是	无效补充说明
delete_reason_name	VARCHAR(100)	是	作废原因
delete_reason_ext	VARCHAR(100)	是	作废补充说明
return_reason_name	VARCHAR(4000)	是	退回原因
pool_name	VARCHAR(4000)	是	所属线索池
distribution_name	VARCHAR(100)	是	分配人
distribution_take_time	VARCHAR(100)	是	分配时间
creator_name	VARCHAR(100)	是	创建人
create_time	VARCHAR(100)	是	创建时间。格式：yyyy-MM-dd HH:mm
transf_time	VARCHAR(100)	是	转换时间
owner_change_time	VARCHAR(100)	是	负责人变更时间。格式：yyyy-MM-dd HH:mm
follow_name	VARCHAR(100)	是	最后跟进人
follow_time	VARCHAR(100)	是	最后跟进时间。格式：yyyy-MM-dd HH:mm
modifyier_name	VARCHAR(100)	是	最后修改人
modify_time	VARCHAR(100)	是	最后修改时间。格式：yyyy-MM-dd HH:mm
customer_classification_name	VARCHAR(100)	是	线索类型
cm_code	VARCHAR(100)	是	已转换客户编码
cm_name	VARCHAR(100)	是	已转换客户名称
labels	List	否	标签列表
labels.salesleads_id	VARCHAR(100)	否	标签对应线索id
labels.color	VARCHAR(100)	否	标签颜色
labels.name	VARCHAR(100)	否	标签名
labels.rule_description	VARCHAR(100)	否	标签规则描述
labels.id	VARCHAR(100)	否	标签id
labels.status	VARCHAR(100)	否	标签status
exts	List	否	自定义字段列表
exts.ext_key	VARCHAR(100)	否	自定义字段key
exts.ext_value	VARCHAR(100)	否	自定义字段value
exts.ext_column	VARCHAR(100)	否	自定义字段column

# 推送线索跟进记录

当提交了线索跟进记录时则将跟进记录进行推送

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL

请求参数：

参数名称	参数值
msgId	消息ID
dataId	数据ID
dataVersion	接口数据版本，如：001
dataFormat	数据格式：json
dataSource	数据来源。biz：业务功能产生，api：开放接口产生
timestamp	请求时间戳，如：1503276678552
status	数据同步状态。0：数据首次同步，2：数据失败同步
statusTime	上次同步失败时间。格式：yyyy-MM-dd HH:mm:ss
tenantId	企业ID，各注册企业在勤策中对应的唯一ID
digest	数据签名，md5(data\|pushsecret\|timestamp)
dataType	salesLeads_follow
data	<<请求数据体>> ，说明：格式为JSON格式数据

请求数据体：

{
      "lead_ID": "SK202101090003",
      "lead_code": "zsmd",
      "lead_name":"张三门店",
      "activity_type":"",
      "activity_content": "zhangsan",
      "location": "10,20",
      "offset": "50",
      "photo_path": "/aaa/bb.png",
      "create_by": "创建人",
      "department": "部门",
      "create_at": "yyyy-mm-dd hh:mm",
      "ext_*":"自定义字段"
   }

参数说明：

参数	类型	必填	说明
lead_ID	INT8	是	线索ID
lead_code	VARCHAR(32)	是	线索编码
lead_name	VARCHAR(32)	是	客户名称
activity_type	VARCHAR(32)	是	跟进方式，取跟进方式描述
activity_content	VARCHAR(32)	是	跟进内容
location	VARCHAR(32)	是	位置，取位置描述
offset	varchar(32)	是	偏差（米）
photo_path	VARCHAR(32)	是	照片路径。格式：yyyy-mm-dd
create_by	VARCHAR(32)	是	跟进人（跟进人姓名）
department	VARCHAR(32)	是	跟进人部门，跟进人所在部门描述
create_at	VARCHAR(32)	是	跟进时间。格式：yyyy-mm-dd hh:mm
ext_*	VARCHAR(32)	是	自定义字段

响应示例：

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001"
}

参数说明：

参数	说明
return_code	响应编码
return_msg	响应消息内容
msg_id	消息ID

← 印章授权状态接口商机 →