知客CRM开发者接口文档

参数名称	描述
IsSuccess	是否成功
Message	详细描述
Data	返回内容（部分接口不返回该参数）

2.1 获取日程安排信息

为必填字段，非必填字段可不传；获取日程安排信息时必须指定日期。

字段名

描述

Category

标识需要进行的操作，当前调用为：GetCalendar

Key

身份验证秘钥

Data

获取日程所需要传递的信息

字段名	描述
Date	指定某一天的日程，格式要求为yyyy-MM-dd
User	指定某个人员的日程
Page	显示第几页，需传递数字
PageSize	每页显示多少条记录，需传递数字

Json示例

{
	"Category":"GetCalendar", 
	"Key":"", 
	"Data":{
		"Date":"2021-09-14",  
		"User":"", 
		"Page":1, 
		"PageSize":10
	}
}

返回内容的Data说明

字段名	描述
Id	日程ID
User	人员名称
Subject	主题
Memo	详细内容
StartTime	日程开始时间
EndTime	日程结束时间

返回示例

{
	"IsSuccess": true, 
	"Message": "", 
	"Data": [{
		"Id": "399", 
		"User": "谭朗", 
		"Subject": "应收提醒-某某公司", 
		"Memo": "第二笔款项已到应收期，请及时联系", 
		"StartTime": "2021-11-12 00:00", 
		"EndTime": "2021-11-13 00:00"
	},  {
		"Id": "398", 
		"User": "谭朗", 
		"Subject": "对至诚公司进行回访", 
		"Memo": "上一次是在2021-11-09联系了苏经理，上次的行动内容：客户在出差，让我3天后再进行详细沟通", 
		"StartTime": "2021-11-12 09:00", 
		"EndTime": "2021-11-12 11:00"
	}]
}

2.2 保存日程安排信息

为必填字段，非必填字段可不传；日程安排信息中的Id为必填字段，若为新增日程，则传递0，否则则按照Id值进行日程的修改。

字段名

描述

Category

标识需要进行的操作，当前调用为：SaveCalendar

Key

身份验证秘钥

Data

需要保存的日程安排信息

字段名	描述
Id	日程安排ID
User	人员（此处的人员名称需与员工表中的名称保持一致）
Subject	主题
Memo	详细内容（若不传递该参数，则详细内容与主题一致）
StartTime	开始时间（yyyy-MM-dd HH:mm）
EndTime	结束时间（yyyy-MM-dd HH:mm）
Completed	是否已完成（0或者1，如不需要做出修改，该参数可不传递）

Json示例

{
	"Category": "SaveCalendar", 
	"Key": "", 
	"Data": {
		"Id": 0, 
		"User": "唐逍", 
		"Subject": "客户拜访", 
		"Memo": "下午3点40分到客户公司进行需求沟通", 
		"StartTime": "2021-12-17 15:40", 
		"EndTime": "2021-12-17 17:30", 
		"Completed": "0"
	}
}

2.3 获取客户列表

为必填字段，非必填字段可不传；获取客户信息时必须指定筛选字段和关键字，如需要查找公司名称包含“上古软件”的客户，则FilterField传递Name，Keyword传递“上古软件”。

字段名

描述

Category

标识需要进行的操作，当前调用为：GetCustomer

Key

身份验证秘钥

Data

获取客户所需要传递的信息

字段名	描述
FilterField	进行筛选的字段，多个条件用半角逗号隔开，如 Province, User 查看字段
Keyword	筛选的关键字，多个条件用半角逗号隔开，且数量必须与FilterField保持一致，如福建, 谭朗
Fields	需要获取的字段，若不传递则显示默认字段，传递内容示例：Id, Name, Number, Mobile, Tel
Page	显示第几页，需传递数字
PageSize	每页显示多少条记录，需传递数字

Json示例

{
	"Category":"GetCustomer", 
	"Key":"", 
	"Data":{
		"FilterField":"Name",  
		"Keyword":"华为", 
		"Page":1, 
		"PageSize":10
	}
}

返回内容的Data说明

字段名	描述
Id	客户ID
Number	客户编号
Name	客户名称
Contact	主联系人
Tel	电话
Mobile	手机号码
Email	邮箱地址
Type	客户类型
Province	省份
City	城市
Address	地址
User	客户负责人

返回示例

{
	"IsSuccess": true, 
	"Message": "", 
	"Data": [{
		"Id": "53897", 
		"Number": "C00053897", 
		"Name": "厦门上古软件有限公司", 
		"Contact": "", 
		"Mobile": "", 
		"Tel": "", 
		"Email": "", 
		"Type": "重点关注", 
		"Province": "福建", 
		"City": "厦门市", 
		"Address": "", 
		"User": ""
	},  {
		"Id": "53898", 
		"Number": "C00053898", 
		"Name": "长沙上古软件有限公司", 
		"Contact": "", 
		"Mobile": "", 
		"Tel": "", 
		"Email": "", 
		"Type": "成交客户", 
		"Province": "湖南", 
		"City": "长沙市", 
		"Address": "", 
		"User": ""
	}]
}

2.4 保存客户信息

为必填字段，非必填字段可不传；接口调用动作默认为新增客户，当客户信息中的客户编号（Number）字段进行了传递且该编号的客户已存在系统中时，当前调用将更改为更新客户。

字段名

描述

Category

标识需要进行的操作，当前调用为：SaveCustomer

Key

身份验证秘钥

Data

需要保存的客户信息

字段名

描述

Number

客户编号

Name

客户名称

Contact

联系人

Tel

电话号码

Mobile

手机号码

Email

邮箱地址

Type

客户类型，该字段内容必须保持与字典表一致，否则该字段无法保存

Origin

客户来源，该字段内容必须保持与字典表一致，否则该字段无法保存

Province

省份

City

城市

User

业务员，人员名称必须与员工表中的名称一致，否则无法保存

Address

地址

Memo

备注信息

CustomFields

扩展字段

字段名	描述
扩展字段1
扩展字段2

如果为客户建立了扩展字段，则按照建立的扩展字段的名称来进行传递，如建立了“客户行业”、“企业规模”两个字段，则传递内容为"CustomFields": {"客户行业":"生产制作", "企业规模":"100人左右"}

Json示例

{
	"Category": "SaveCustomer", 
	"Key": "", 
	"Data": {
		"Number": "客户编号", 
		"Name": "客户名称", 
		"Contact": "联系人", 
		"Tel": "电话号码", 
		"Mobile": "手机号码", 
		"Email": "邮箱", 
		"Type": "客户类型", 
		"Origin": "客户来源", 
		"Province": "省份", 
		"City": "城市", 
		"User": "业务员", 
		"Address": "工作地址", 
		"Memo": "详细信息", 
		"CustomFields": {
			"客户行业": "", 
			"微信号": "", 
			"企业规模": ""
		}
	}
}

2.5 获取联系人列表

为必填字段，非必填字段可不传；获取联系人信息时必须指定筛选字段和关键字，如需要获取隶属公司名称为“厦门至鼎科技有限公司”名下的所有联系人，则FilterField传递CustomerName，Keyword可传递“厦门至鼎”。

字段名

描述

Category

标识需要进行的操作，当前调用为：GetContact

Key

身份验证秘钥

Data

获取联系人所需要传递的信息

字段名	描述
FilterField	进行筛选的字段，多个条件用半角逗号隔开，如 CustomerName, Name 查看字段
Keyword	筛选的关键字，多个条件用半角逗号隔开，且数量必须与FilterField保持一致，如华为, 李总
Fields	需要获取的字段，若不传递则显示默认字段，传递内容示例：Id, Name, CustomerName, Mobile, Tel
Page	显示第几页，需传递数字
PageSize	每页显示多少条记录，需传递数字

Json示例

{
	"Category": "GetContact", 
	"Key": "", 
	"Data": {
		"FilterField": "CustomerName", 
		"Keyword": "厦门至鼎", 
		"Page": 1, 
		"PageSize": 10
	}
}

返回内容的Data说明

字段名	描述
Id	联系人ID
Name	联系人名称
CustomerName	隶属的客户名称
Tel	电话
Mobile	手机号码
Email	邮箱地址
Group	所在部门
Title	职位
Type	联系人类型

返回示例

{
	"IsSuccess": true, 
	"Message": "", 
	"Data": [{
		"Id": "39683", 
		"Name": "谭朗", 
		"CustomerName": "厦门至鼎科技有限公司", 
		"Mobile": "", 
		"Tel": "", 
		"Email": "", 
		"Group": "业务部", 
		"Title": "销售经理", 
		"Type": "需求对接"
	},  {
		"Id": "39683", 
		"Name": "唐逍", 
		"CustomerName": "厦门至鼎科技有限公司", 
		"Mobile": "", 
		"Tel": "", 
		"Email": "", 
		"Group": "采购部", 
		"Title": "采购经理", 
		"Type": "关键决策人"
	}]
}

2.6 保存联系人

为必填字段，非必填字段可不传；接口调用动作默认为新增联系人，如果联系人所属客户及名称与系统中已存在的联系人一致，则接口调用动作为修改联系人

字段名

描述

Category

标识需要进行的操作，当前调用为：SaveContact

Key

身份验证秘钥

Data

需要保存的联系人信息

字段名

描述

Customer

联系人所属客户的名称，客户必须与系统中已存的客户名称一致，否则不予保存

Name

联系人名称

Tel

电话号码

Mobile

手机号码

Email

邮箱地址

Type

联系人类型，该字段内容必须保持与字典表一致，否则该字段无法保存

Group

所在部门

Title

联系人职务

Memo

备注信息

CustomFields

扩展字段

字段名	描述
扩展字段1
扩展字段2

如果为联系人建立了扩展字段，则按照建立的扩展字段的名称来进行传递，如建立了“爱好”、“毕业院校”两个字段，则传递内容为"CustomFields": {"爱好":"钓鱼、远东", "毕业院校":"厦门大学"}

Json示例

{
	"Category": "SaveContact", 
	"Key": "", 
	"Data": {
		"Customer": "所属客户的名称", 
		"Name": "联系人名称", 
		"Tel": "电话号码", 
		"Mobile": "手机号码", 
		"Email": "邮箱", 
		"Type": "联系人类型", 
		"Group": "所在部门", 
		"Title": "职位", 
		"Memo": "备注", 
		"CustomFields": {
			"爱好": "钓鱼、运动"
		}
	}
}

2.7 获取行动记录列表

为必填字段，非必填字段可不传；获取行动记录时可以指定筛选字段和关键字，如需要获取隶属公司名称为“厦门至鼎科技有限公司”名下的所有行动记录，则FilterField传递CustomerName，Keyword可传递“厦门至鼎”。

字段名

描述

Category

标识需要进行的操作，当前调用为：GetAction

Key

身份验证秘钥

Data

获取行动记录所需要传递的信息

字段名	描述
FilterField	进行筛选的字段，多个条件用半角逗号隔开，如 CustomerName, UserName 查看字段
Keyword	筛选的关键字，多个条件用半角逗号隔开，且数量必须与FilterField保持一致，如华为, 谭朗
StartDate	指定行动时间区间的开始日期（yyyy-MM-dd）
EndDate	指定行动时间区间的结束时间（yyyy-MM-dd）
Page	显示第几页，需传递数字
PageSize	每页显示多少条记录，需传递数字

Json示例

{
	"Category": "GetAction", 
	"Key": "", 
	"Data": {
		"FilterField": "CustomerName", 
		"Keyword": "厦门至鼎", 
		"StartDate": "2024-11-01", 
		"EndDate": "2024-12-31", 
		"Page": 1, 
		"PageSize": 10
	}
}

返回内容的Data说明

字段名	描述
Id	行动记录ID
CustomerName	客户
ContactName	客户联系人
UserName	行动人员
ActionDate	行动时间
Type	类型
Memo	详细信息

返回示例

{
	"IsSuccess": true, 
	"Message": "", 
	"Data": [{
		"Id": "39683", 
		"CustomerName": "厦门至鼎科技有限公司", 
		"ContactName": "张总", 
		"UserName": "谭朗", 
		"ActionDate": "2024-12-11", 
		"Type": "销售工作", 
		"Memo": "询问客户上次的报价考虑的如何，对方暂时还未给出明确回复"
	},  {
		"Id": "39682", 
		"CustomerName": "厦门至鼎科技有限公司", 
		"ContactName": "张总", 
		"UserName": "谭朗", 
		"ActionDate": "2024-11-26", 
		"Type": "销售工作", 
		"Memo": "给对方发送报价单，对方说老板出差，等回来之后再给回复"}]
}

2.8 获取产品列表

为必填字段，非必填字段可不传；

字段名

描述

Category

标识需要进行的操作，当前调用为：GetProduct

Key

身份验证秘钥

Data

获取产品所需要传递的信息

字段名	描述
FilterField	进行筛选的字段，多个条件用半角逗号隔开，且数量必须与FilterField保持一致，如 Name, TypeName 查看字段
Keyword	筛选的关键字，多个条件用半角逗号隔开，且数量必须与FilterField保持一致，如内存, 计算机配件
Fields	需要获取的字段，若不传递则显示默认字段，传递内容示例：Id, Number, Name, TypeName, Price, Unit, Memo
Page	显示第几页，需传递数字
PageSize	每页显示多少条记录，需传递数字

Json示例

{
	"Category":"GetProduct", 
	"Key":"", 
	"Data":{
		"FilterField": "Name", 
		"Keyword": "笔记本", 
		"Page": 1, 
		"PageSize": 10
	}
}

返回内容的Data说明

字段名	描述
Id	产品ID
Code	产品编号
Name	产品名称
TypeName	产品类型
Price	售价
Unit	单位
Memo	详细描述

返回示例

{
	"IsSuccess": true, 
	"Message": "", 
	"Data": [{
		"Id": "13453", 
		"Number": "E39133-321", 
		"Name": "内存DDL", 
		"TypeName": "计算机配件", 
		"Price": "400.00", 
		"Unit": "套", 
		"Memo": ""
	},  {
		"Id": "13454", 
		"Number": "E39133-323", 
		"Name": "硬盘2TB", 
		"TypeName": "计算机配件", 
		"Price": "400.00", 
		"Unit": "块", 
		"Memo": ""
	}]
}

2.9 获取销售机会列表

为必填字段，非必填字段可不传；获取销售机会信息时可以指定筛选字段和关键字，也可以指定销售机会的创建时间区间，如需要查找“上古软件”的销售机会，则FilterField传递CustomerName，Keyword传递“上古软件”。

字段名

描述

Category

标识需要进行的操作，当前调用为：GetPipeline

Key

身份验证秘钥

Data

获取销售机会所需要传递的信息

字段名	描述
FilterField	进行筛选的字段，多个条件用半角逗号隔开，如 CustomerName, UserName 查看字段
Keyword	筛选的关键字，多个条件用半角逗号隔开，且数量必须与FilterField保持一致，如可可食品, 卢青梅
StartDate	指定销售机会创建时间区间的开始日期（yyyy-MM-dd）
EndDate	指定销售机会创建时间区间的结束时间（yyyy-MM-dd）
Fields	需要获取的字段，若不传递则显示默认字段，传递内容示例：Id, CustomerName, Name, CreateDate, Status, StageName, EstimatePrice, EstimateDate, UserName, Memo
Page	显示第几页，需传递数字
PageSize	每页显示多少条记录，需传递数字

Json示例

{
	"Category": "GetPipeline", 
	"Key": "", 
	"Data": {
		"FilterField": "", 
		"Keyword": "", 
		"StartDate": "2021-07-01", 
		"EndDate": "2021-10-31", 
		"Page": 1, 
		"PageSize": 10
	}
}

返回内容的Data说明

字段名	描述
Id	销售机会ID
CustomerId	客户ID
Name	销售机会名称
CustomerName	客户名称
CreateDate	成交时间
Status	销售机会状态
StageName	销售机会阶段
EstimatePrice	预计成交金额
EstimateDate	预计成交日期
UserName	负责人
Memo	详细描述

返回示例

{
	"IsSuccess": true, 
	"Message": "", 
	"Data": [{
		"Id": "2175", 
		"CustomerId": "175420", 
		"CustomerName": "福建省厦门市可可食品", 
		"Name": "SWZCXH20210624", 
		"CreateDate": "2021-06-24", 
		"Status": "成功结束", 
		"StageName": "项目注册", 
		"EstimatePrice": "0.00", 
		"EstimateDate": "2021-02-28", 
		"UserName": "谭朗", 
		"Memo": ""
	},  {
		"Id": "2169", 
		"CustomerId": "175420", 
		"CustomerName": "福建省厦门市可可食品", 
		"Name": "20200905SWZCXH02", 
		"CreateDate": "2020-08-05", 
		"Status": "进行中", 
		"StageName": "项目注册", 
		"EstimatePrice": "20000.00", 
		"EstimateDate": "暂不清楚", 
		"UserName": "谭朗", 
		"Memo": ""
	}]
}

2.10 获取销售机会详情

为必填字段，非必填字段可不传；

字段名

描述

Category

标识需要进行的操作，当前调用为：GetPipelineDetail

Key

身份验证秘钥

Data

获取销售机会详情所需要传递的信息

字段名	描述
Id	传递需要获取销售机会的ID（与下方的销售机会名称进行2选1即可）
Name	传递需要获取销售机会的名称（与上方的销售机会ID进行2选1即可）

Json示例

{
	"Category": "GetPipelineDetail", 
	"Key": "", 
	"Data": {
		"Id": "2178", 
		"Name": ""
	}
}

返回内容的Data说明

字段名

描述

Id

销售机会ID

Name

销售机会名称

CustomerId

客户ID

CustomerName

客户名称

CreateDate

创建日期

Status

销售机会状态

StageName

销售机会阶段

EstimatePrice

预计成交金额

EstimateDate

预计成交日期

UserName

负责人

Memo

备注

扩展字段内容

根据已建立的销售机会扩展字段的内容进行展现......

Product

销售机会的报价产品信息

字段名	描述
ProductNumber	产品编号
ProductName	产品名称
ProductTypeName	产品类型
Price	报价金额
Amount	数量
Discount	折扣
TotalPrice	合计价格
Memo	产品备注

返回示例

{
	"IsSuccess": true, 
	"Message": "", 
	"Data": {
		"Id": "2178", 
		"CustomerName": "福建省厦门市可可食品", 
		"Name": "32582-BM4", 
		"CreateDate": "2021-10-20", 
		"Status": "进行中", 
		"StageName": "商务洽谈", 
		"EstimatePrice": "150000.00", 
		"EstimateDate": "2022-01-31", 
		"UserName": "谭朗", 
		"Memo": "", 
		"Product": [{
			"ProductNumber": "EW103021", 
			"ProductName": "服务费", 
			"ProductTypeName": "增值服务", 
			"Price": "6000.00", 
			"Amount": "5", 
			"Discount": "1.0000", 
			"TotalPrice": "30000.00", 
			"Memo": "无"
		},  {
			"ProductNumber": "EW106039", 
			"ProductName": "内存DDL", 
			"ProductTypeName": "计算机配件", 
			"Price": "30000.00", 
			"Amount": "4", 
			"Discount": "1.0000", 
			"TotalPrice": "120000.00", 
			"Memo": "无"
		}]
	}
}

2.11 获取合同列表

为必填字段，非必填字段可不传；获取合同信息时可以指定筛选字段和关键字，也可以指定合同的成交时间区间，如需要查找“上古软件”的合同，则FilterField传递CustomerName，Keyword传递“上古软件”。

字段名

描述

Category

标识需要进行的操作，当前调用为：GetOrder

Key

身份验证秘钥

Data

获取合同所需要传递的信息

字段名	描述
FilterField	进行筛选的字段，多个条件用半角逗号隔开，如 CustomerName, SubmitUserName 查看字段
Keyword	筛选的关键字，多个条件用半角逗号隔开，且数量必须与FilterField保持一致，如可可食品, 卢青梅
StartDate	指定合同签约时间区间的开始日期（yyyy-MM-dd）
EndDate	指定合同签约时间区间的结束时间（yyyy-MM-dd）
Fields	需要获取的字段，若不传递则显示默认字段，传递内容示例：Id, CustomerName, Number, TypeName, SubmitDate, SalesPrice, CurrencyName, SubmitUserName, Status, StageName, Memo
Page	显示第几页，需传递数字
PageSize	每页显示多少条记录，需传递数字

Json示例

{
	"Category": "GetOrder", 
	"Key": "", 
	"Data": {
		"FilterField": "", 
		"Keyword": "", 
		"StartDate": "2021-07-01", 
		"EndDate": "2021-10-31", 
		"Page": 1, 
		"PageSize": 10
	}
}

返回内容的Data说明

字段名	描述
Id	合同ID
CustomerId	客户ID
CustomerName	客户名称
Number	合同编号
TypeName	合同分类
SubmitDate	签约时间
SalesPrice	合同金额
CurrencyName	币种
Status	合同状态
StageName	合同当前所处阶段
SubmitUserName	签约用户
Memo	备注

返回示例

{
	"IsSuccess": true, 
	"Message": "", 
	"Data": [{
		"Id": "14915", 
		"CustomerId": "175420", 
		"Number": "20211117170029", 
		"CustomerName": "福建省厦门市可可食品", 
		"TypeName": "服务合同", 
		"SalesPrice": "1008000.00", 
		"CurrencyName": "人民币", 
		"SubmitDate": "2021-10-21", 
		"Status": "进行中", 
		"StageName": "已交付", 
		"SubmitUserName": "谭朗", 
		"Memo": ""
	},  {
		"Id": "14907", 
		"CustomerId": "175420", 
		"Number": "20210823230021", 
		"CustomerName": "福建省厦门市可可食品", 
		"TypeName": "产品合同", 
		"SalesPrice": "45000.00", 
		"CurrencyName": "人民币", 
		"SubmitDate": "2021-08-25", 
		"Status": "进行中", 
		"StageName": "合同签订", 
		"SubmitUserName": "卢青梅", 
		"Memo": ""
	}]
}

2.12 获取合同详情

为必填字段，非必填字段可不传；

字段名

描述

Category

标识需要进行的操作，当前调用为：GetOrderDetail

Key

身份验证秘钥

Data

获取合同详情所需要传递的信息

字段名	描述
Id	传递需要获取合同的ID（与下方的合同编号进行2选1即可）
Name	传递需要获取合同的编号（与上方的合同ID进行2选1即可）

Json示例

{
	"Category": "GetOrderDetail", 
	"Key": "", 
	"Data": {
		"Id": "14907", 
		"Number": ""
	}
}

返回内容的Data说明

字段名

描述

Id

合同ID

CustomerId

客户ID

CustomerName

客户名称

Number

合同编号

TypeName

合同分类

SubmitDate

签约时间

SalesPrice

合同金额

CurrencyName

币种

Status

合同状态

StageName

合同当前所处阶段

SubmitUserName

签约用户

ServiceUserName

服务人员

ExpireDate

服务到期日期

Memo

备注

扩展字段内容

根据已建立的合同扩展字段的内容进行展现......

Product

合同产品信息

字段名	描述
ProductNumber	产品编号
ProductName	产品名称
ProductTypeName	产品类型
Price	单价
Amount	数量
Discount	折扣
TotalPrice	合计价格
Cost	单位成本
TotalCost	合计成本
Profit	毛利
Memo	产品备注

返回示例

{
	"IsSuccess": true, 
	"Message": "", 
	"Data": {
		"Id": "14907", 
		"Number": "20210823230021", 
		"CustomerId": "175420", 
		"CustomerName": "福建省厦门市可可食品", 
		"TypeName": "服务合同", 
		"Status": "进行中", 
		"StageName": "合同签订", 
		"SalesPrice": "45000.00", 
		"CurrencyName": "人民币", 
		"SubmitDate": "2021-08-25", 
		"SubmitUserName": "卢青梅", 
		"ServiceUserName": "唐逍", 
		"ExpireDate": "", 
		"Memo": "", 
		"Product": [{
			"ProductNumber": "S904321", 
			"ProductName": "服务费", 
			"ProductTypeName": "增值服务", 
			"Price": "5000.00", 
			"Amount": "1", 
			"Discount": "1.0000", 
			"TotalPrice": "5000.00", 
			"Cost": "0.00", 
			"TotalCost": "0.00", 
			"Profit": "0.00", 
			"Memo": ""
		},  {
			"ProductNumber": "M203916", 
			"ProductName": "内存DDL", 
			"ProductTypeName": "增值服务", 
			"Price": "40000.00", 
			"Amount": "1", 
			"Discount": "1.0000", 
			"TotalPrice": "40000.00", 
			"Cost": "36000.00", 
			"TotalCost": "36000.00", 
			"Profit": "4000.00", 
			"Memo": ""
		}]
	}
}

2.13 保存合同信息

为必填字段，非必填字段可不传；接口调用动作默认为新增合同，当合同信息中的合同名称（Number）字段进行了传递且该名称的合同已存在系统中时，当前调用将更改为更新合同。

字段名

描述

Category

标识需要进行的操作，当前调用为：SaveOrder

Key

身份验证秘钥

Data

需要保存的合同信息

字段名

描述

Customer

合同所属客户的名称，客户必须与系统中已存的客户名称一致，否则不予保存

Number

合同编号

Type

合同类型，该字段内容必须保持与字典表一致，否则该字段无法保存

Status

合同状态，（进行中或者已归档）

Stage

合同阶段，该字段内容必须保持与合同阶段保持一致，否则默认为第一个阶段

User

签约用户，人员名称必须与员工表中的名称一致，否则该字段无法保存

ServiceUser

服务人员，人员名称必须与员工表中的名称一致，否则该字段无法保存

SubmitDate

签约日期，请填写日期格式内容，如：2021-09-17

ExpireDate

服务到期日期，请填写日期格式内容，如：2021-09-17

Currency

币种，需要与币种管理中的币种名称保持一致，否则默认为人民币

Memo

详细描述

CustomFields

扩展字段

字段名	描述
扩展字段1
扩展字段2

如果为合同建立了扩展字段，则按照建立的扩展字段的名称来进行传递，如建立了“合同类型”、“结算方式”两个字段，则传递内容为"CustomFields": {"合同类型":"框架合同", "结算方式":"月结"}

Product

合同产品（允许传递多个产品）

字段名

描述

ProductNumber

产品编号，该字段内容必须与产品表中的产品编号一致，否则无法保存（与下方的产品名称二选一进行传递即可）

ProductName

产品名称，该字段内容必须与产品表中的产品名称一致，否则无法保存（与下方的产品编号二选一进行传递即可）

Amount

数量，请填写数值

Price

销售单价，请填写数值

Discount

折扣，请填写数值，如八折，则填写0.8

Cost

单位成本，请填写数值

CustomFields

扩展字段

字段名	描述
扩展字段1
扩展字段2

如果为合同产品建立了扩展字段，则按照建立的扩展字段的名称来进行传递，如建立了“产品型号”、“产品尺寸”两个字段，则传递内容为"CustomFields": {"产品型号":"A-23013", "产品尺寸":"160cm*300cm"}

Json示例

{
	"Category": "SaveOrder", 
	"Key": "", 
	"Data": {
		"Customer": "合同客户", 
		"Type": "合同状态", 
		"Status": "进行中", 
		"Stage": "合同签订", 
		"User": "签约人员", 
		"ServiceUser": "服务人员", 
		"SubmitDate": "2022-03-08", 
		"ExpireDate": "2024-03-08", 
		"Currency": "人民币", 
		"Memo": "详细描述", 
		"CustomFields": {
			"结算方式": "月付", 
			"工程资质": ""
		}, 
		"Product": [{
			"ProductName": "产品名称1", 
			"Amount": "2", 
			"Price": "6800.00", 
			"Discount": "1.0", 
			"Cost": "3200", 
			"CustomFields": {
				"产品型号": "", 
				"产品尺寸": ""
			}
		},  {
			"ProductName": "产品名称2", 
			"Amount": "1", 
			"Price": "19800.00", 
			"Discount": "0.95", 
			"Cost": "12000", 
			"CustomFields": {
				"产品型号": "", 
				"产品尺寸": ""
			}
		}]
	}
}

2.14 新增业务关联表单数据

为必填字段，非必填字段可不传；接口调用动作为新增业务关联表单数据，必须指定表单对应的客户、销售机会或合同。

字段名

描述

Category

标识需要进行的操作，当前调用为：SaveRelationData

Key

身份验证秘钥

Data

需要保存的表单数据信息

字段名	描述
TableName	表单名称，与系统建立的表单名称必须保持一致
Customer	关联的客户编号，如果表单与客户关联则该字段内容必填
Order	关联的合同编号，如果表单与合同关联则该字段内容必填
Pipeline	关联的销售机会名称，如果表单与销售机会关联则该字段内容必填
扩展字段1	按照系统建立的字段名称填写，如果此字段类型为产品则填写产品名称、合同则填写合同名称、客户则填写客户编号
扩展字段2	按照系统建立的字段名称填写，如果此字段类型为产品则填写产品名称、合同则填写合同名称、客户则填写客户编号

Json示例

{
	"Category": "SaveRelationData",
	"Key": "",
	"Data": {
		"TableName": "账单数据",
		"Customer": "0175495",
		"单价": "12",
		"数量": "100",
		"总额": "1200",
		"产生时间": "2024-02-11 15:13:00",
		"产品": "度小满",
		"详细描述": ""
	}
}

2.15 获取流程表单数据

为必填字段，非必填字段可不传；获取流程表单数据时必须指定表单名称，也可以指定部分筛选内容。（仅允许获取已办理通过的流程）

字段名

描述

Category

标识需要进行的操作，当前调用为：GetWorkFlow

Key

身份验证秘钥

Data

获取流程表单数据所需要传递的信息

字段名	描述
FormName	流程的表单名称，必填字段
StartDate	指定流程提交时间区间的开始日期（yyyy-MM-dd）
EndDate	指定流程提交时间区间的结束时间（yyyy-MM-dd）
Page	显示第几页，需传递数字
PageSize	每页显示多少条记录，需传递数字

Json示例

{
	"Category": "GetWorkFlow", 
	"Key": "", 
	"Data": {
		"FormName": "请假流程", 
		"StartDate": "2024-07-01", 
		"EndDate": "2024-12-31", 
		"Page": 1, 
		"PageSize": 10
	}
}

返回内容的Data说明

字段名	描述
Id	流程ID
Name	流程名称
UserName	提交人员
SubmitDate	提交时间
（除文件类型外的表单字段）

返回示例

{
	"IsSuccess": true, 
	"Message": "", 
	"Data": [{
		"Id": "14915", 
		"Name": "WFZWLFPSQD20241107", 
		"UserName": "谭朗", 
		"SubmitDate": "2024-11-07 08:41", 
		"类型": "病假", 
		"请假开始时间": "2024-11-07", 
		"请假结束时间": "2024-11-09", 
		"备注": "胃不舒服，要去医院检查一下"
	},  {
		"Id": "14911", 
		"Name": "WFZWXWSQD20241105", 
		"UserName": "萧望", 
		"SubmitDate": "2024-11-05 08:32", 
		"类型": "病假", 
		"请假开始时间": "2024-11-05", 
		"请假结束时间": "2024-11-06", 
		"备注": "头疼，请假一天"
	}]
}

版本号	修改点说明	变更人	变更日期
0.1	文档创建	开发组-Analy	2021-09-16
0.14	补充了日程、产品等接口	开发组-Analy	2022-05-09
0.15	补充了合同获取等接口	开发组-Analy	2022-05-17
0.16	补充了销售机会获取接口、合同详情接口加入了扩展字段	开发组-Analy	2023-06-06
0.17	添加了业务关联表单的保存接口	开发组-Analy	2024-03-21

知客CRM

接口文档目录

知客CRM导航

知客CRM 开发者接口文档

版本：0.17

1、对接说明

1.1 编码格式

1.2 接口调用方式

1.3 接口调用地址

1.4 身份验证

1.5 返回信息

2、接口部分

2.1 获取日程安排信息

Json示例

返回内容的Data说明

返回示例

2.2 保存日程安排信息

Json示例

2.3 获取客户列表

Json示例

返回内容的Data说明

返回示例

2.4 保存客户信息

Json示例

2.5 获取联系人列表

Json示例

返回内容的Data说明

返回示例

2.6 保存联系人

Json示例

2.7 获取行动记录列表

Json示例

返回内容的Data说明

返回示例

2.8 获取产品列表

Json示例

返回内容的Data说明

返回示例

2.9 获取销售机会列表

Json示例

返回内容的Data说明

返回示例

2.10 获取销售机会详情

Json示例

返回内容的Data说明

返回示例

2.11 获取合同列表

Json示例

返回内容的Data说明

返回示例

2.12 获取合同详情

Json示例

返回内容的Data说明

返回示例

2.13 保存合同信息

Json示例

2.14 新增业务关联表单数据

Json示例

2.15 获取流程表单数据

Json示例

返回内容的Data说明

返回示例