CRM调用API接口

1. 简介

CRM 套件中支持调用 API 接口。

CRM 套件调用 API 接口时有一些特殊规则，详情如下：

2. 新增字段类型

2.1 新字段类型的传参及返回值

字段类型	传参	返回值
company	和文本一致	和文本一致
leads_pool	ObjectId	{ "pool_id": "", "name": "" }
account_pool	ObjectId	{ "pool_id": "", "name": "" }
sale_stage	{ "stage_id": "" }	{ "template_id": "", "stage_id": "", "name": "" }
link_object	{ "link_form": "", "link_id": "" }	{ "link_form": "", "link_id": "", "name": "" }

2.2 新字段类型支持的过滤方法

字段类型	传参	支持的过滤方法
company	和文本一致	和文本一致
leads_pool	{ "field": "leads_pool", "method": "eq", "value": ["5b4973f79029811e613d4474"] }	eq，ne，in，nin，empty，not_empty
account_pool	{ "field": "account_pool", "method": "eq", "value": ["5b4973f79029811e613d4474"] }	eq，ne，in，nin，empty，not_empty
sale_stage	{ "field": "sale_stage", "method": "eq", "value": ["5b4973f79029811e613d4474"] }	eq，ne，in，nin，empty，not_empty
link_object	{ "field": "sale_stage", "method": "eq", "value": [ { "link_form": "020100500000000000000001", "link_id": "5b4973f79029811e613d4474" } ] }	eq，ne，in，nin，empty，not_empty

注：以上字段类型，若系统已预设/自定义设置了字段别名，如 leads_pool、account_pool 等，可以使用字段别名进行传参；若未设置别名，则需要使用字段 ID 进行传参。

3. 预设字段支持API提交/修改

部分预定义字段的信息支持 API 提交或修改，具体支持情况如下：

1）线索表

字段	字段类型	API 提交	API 修改
客户名称	company	支持	支持
联系人	text	支持	支持
手机号	text	支持	支持
归属部门	dept	支持	支持
负责人	user	支持	支持
协作人	usergroup	支持	支持
线索池	leads_pool	支持	支持
线索状态	text	不支持	不支持
领取时间	datetime	不支持	不支持
最后跟进时间	datetime	不支持	不支持
线索转换时间	datetime	不支持	不支持
线索退回原因	combo	不支持	不支持
预计回收时间	datetime	不支持	不支持

2）客户表

字段	字段类型	API 提交	API 修改
客户编号	sn	不支持	不支持
客户名称	company	支持	支持
归属部门	dept	支持	支持
负责人	user	支持	支持
协作人	usergroup	支持	支持
公海池	account_pool	支持	支持
领取时间	datetime	不支持	不支持
最后跟进时间	datetime	不支持	不支持
客户退回原因	combo	不支持	不支持
预计回收时间	datetime	不支持	不支持

3）商机表

字段	字段类型	API 提交	API 修改
商机编号	sn	不支持	不支持
商机名称	text	支持	支持
客户名称	linkobject	支持	支持
联系人	linkobject	支持	支持
销售阶段	sale_stage	支持	不支持
赢率	number	支持	支持
阶段类型	text	不支持	不支持
输单原因	combo	不支持	不支持
负责人	user	支持	支持
协作人	usergroup	支持	支持
归属部门	dept	支持	支持
预测成交时间	datetime	支持	支持
预测成交金额	number	支持	支持
最后跟进时间	datetime	不支持	不支持
阶段变更时间	datetime	不支持	不支持

4）联系人表

字段	字段类型	API 提交	API 修改
客户名称	linkobject	支持	支持
姓名	text	支持	支持
手机号	text	支持	支持
归属部门	dept	支持	支持
负责人	user	支持	支持
协作人	usergroup	支持	支持

5）跟进计划表

字段	字段类型	API 提交	API 修改
客户名称	linkobject	支持	支持
计划执行人	user	支持	支持
计划时间	datetime	支持	支持
计划内容	textarea	支持	支持
归属部门	dept	支持	支持
计划状态	text	不支持	不支持

6）跟进记录表

字段	字段类型	API 提交	API 修改
跟进主体	linkobject	不支持	不支持
跟进商机	linkobject	支持	支持
联系人	linkobject	支持	支持
跟进人	user	支持	支持
跟进方式	combo	支持	支持
跟进时间	datetime	支持	支持
跟进内容	textarea	支持	支持
归属部门	dept	支持	支持

注：归属部门在数据新增或修改时，需要和负责人所处部门一致，不然会在提交之后修改为负责人的所处部门。

4. 跟进记录表

跟进记录表作为线索和客户的子表，暂不支持直接查询，需要通过跟进主体的筛选，在单独接口进行查询，提供的查询接口如下：

4.1 客户的跟进记录

POST /api/crm/v1/app/{appid}/account/{accountid}/follow_records

路径参数：

参数	是否必需	类型	说明
appId	是	String	应用 ID
accountd	是	String	客户 ID（客户表中对应客户数据的 data_id）

请求参数：

参数	是否必需	类型	说明
data_id	否	String	上一次查询数据结果的最后一条数据的 ID，没有则留空
fields	否	Array	需要查询的数据字段
filter	否	JSON	数据筛选器
limit	否	Number	查询的数据条数，1~100，默认10

返回参数：

参数	类型	说明
data	Array	多条数据

4.2 线索的跟进记录

POST /api/crm/v1/app/{appid}/leads/{leadid}/follow_records

路径参数：

参数	是否必需	类型	说明
appId	是	String	应用 ID
leadId	是	String	线索 ID（线索表中对应线索数据的 data_id）

请求参数：

参数	是否必需	类型	说明
data_id	否	String	上一次查询数据结果的最后一条数据的 ID，没有则留空
fields	否	Array	需要查询的数据字段
filter	否	JSON	数据筛选器
limit	否	Number	查询的数据条数，1~100，默认 10

返回参数：

参数	类型	说明
data	JSON	多条数据

5. 公海池、线索池和销售阶段

获取公海池、线索池和销售阶段的列表，各查询接口如下：

5.1 公海池列表

POST /api/crm/v1/app/{appid}/account_pools

请求参数：无

返回参数：

参数	类型	说明
account_pools	Array	公海池列表
account_pools.#.id	String	公海池 ID
account_pools.#.name	String	公海池名称

5.2 线索池列表

POST /api/crm/v1/app/{appid}/leads_pools

请求参数：无

返回参数：

参数	类型	说明
leads_pools	Array	线索池列表
leads_pools.#.id	String	线索池 ID
leads_pools.#.name	String	线索池名称

5.3 销售阶段列表

POST /api/crm/v1/app/{appid}/sale_stages

请求参数：无

返回参数：

参数	类型	说明
sale_stages	Array	销售阶段列表
sale_stages.#.id	String	销售阶段 ID
sale_stages.#.type	String	销售阶段类型
sale_stages.#.name	String	销售阶段名称
sale_stages.#.win_rate	Number	赢率