知客CRM开放式接口OpenAPI-扩展和定制您的知客CRM

1、接口服务说明

1.1 编码格式

通信报文的文字编码格式全部采用UTF-8格式。

1.2 安全控制及秘钥生成

服务采用统一的用户认证,通过Login方法传递用户名和用户密码获取秘钥(token),之后才被允许调用数据接口,秘钥的有效期为3600秒,超出有效时间,需重新进行获取。

1.3 接口调用方式

接口采用WebServices访问的方式,同时支持Http Get。您可以在任意平台或使用任意开发语言进行调用。

1.4 最后修订日期

2018-08-07


2、秘钥的获取

方法名:Login

2.1 参数配置
参数 必要性 描述
account 账户名称
password 账户密码
2.2 返回值示例

{"ErrorMessage":"","token":" ZKsnP0evFcfn0GzxGV3iUFH7WudJYBMGvPID0p3epnY="}
错误的返回情况下,ErrorMessage的值可能为以下几种:

内容描述
密码错误
账号被禁用
无效的账号

3、获取工作日志列表

方法名:GetWorkReport

3.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
filter 查询条件
currentRow 从第几行开始查询
top 一次获取多少条记录
3.2 返回值示例
内容 描述
ErrorMessage 错误的描述,如果返回结果正确的话,则为空
Data 返回的记录集

如:
{"ErrorMessage":"",data:'[{"id":"92","sender":"101","senderName":"发送人员名称","receiver":"101","receiverName":"接收人员名称","userPhotos":"/WebFolder/defaultUser.png","category":1,"work1":"今日(本周、本月)完成工作","work2":"今日(本周、本月)工作总结","work3":"明天(下周、下个月)工作计划","memo":"备注","createDate":"2018-02-03 11:04"}]'}


4、添加工作日志

方法名:SaveWorkReport

4.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 编辑日志的ID,如果为新增,则将该参数设置为0
receiver 日志发给给谁进行查看
category 1为日报,2为周报,3为月报
work1 今日(本周、本月)完成工作
work2 今日(本周、本月)工作总结
work3 明天(下周、下个月)工作计划
memo 备注
files 上传的文件
4.2 返回值示例
内容描述
1,已保存完成
2,保存失败

5、删除工作日志

方法名:DeleteWorkReport

5.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要删除的日志ID
5.2 返回值示例
内容描述
1,已删除成功
2,删除失败

6、获取消息列表

方法名:GetMessageList

6.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
isRead 1,已读;0,未读。参数传递1或者0即可
6.2 返回值示例
内容 描述
ErrorMessage 错误的描述,如果返回结果正确的话,则为空
Data 返回的记录集

如:
{"ErrorMessage":"",data:'[{"id":"32326","sender":"101","senderName":"发送人员名称","message":"消息内容","date":"2018-07-24 08:13","isRead":1}]'}


7、发送消息

方法名:SendMessage

7.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
content 消息内容
receiver 消息接收人员
timer 消息发送时间
visible 是否为静默消息,请默认填写0
7.2 返回值示例
内容描述
1,已删除成功
2,删除失败

8、获取客户列表

方法名:GetCustomerList

8.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
filter 查询条件
sort 排序规则,为空的情况下默认是以最后行动时间进行排序
currentRow 从第几行开始查询
top 一次获取多少条记录
8.2 返回值示例
内容 描述
ErrorMessage 错误的描述,如果返回结果正确的话,则为空
Data 返回的记录集

如:
{"ErrorMessage":"",data:'[{"id":"54937","name":"福建省质协咨询中心","contact":"邓总","phone":"13778382911","email":"","address":"","pt":"","tel":"","mobile":"","province":"","city":"","type":"成交客户","originType":"朋友介绍","lastActionDate":"2017-10-09 9:41","memo":""},{"id":"54901","name":"重庆亚凡科技","contact":"刘先生”,"phone":"13637934279","email":"liuyh@163.com","address":"","pt":"","tel":"","mobile":"13637934279","province":"","city":"","type":"丢单客户","originType":"电话来访","lastActionDate":"2017-03-23 10:16","memo":""}]'}


9、获取单个客户的详情

方法名:GetCustomerInfo

9.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要获取的客户的ID
9.2 返回值示例
返回内容 描述
id 客户的ID
name 客户名称
contact 主联系人
mobile 手机号码
tel 电话号码
userName 客户的负责人
email 电子邮件
address 客户的地址
province 客户所在省份
city 客户所在城市
typeName 客户类型
originTypeName 客户来源
lastActionDate 最后行动日期
createDate 创建时间

10、新增或编辑客户资料

方法名:SaveCustomer

10.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要编辑的客户的ID,如果为新增,则将该参数设置为0
name 客户名称
contact 主联系人
type 客户类型
originType 客户来源
label 客户标签
area1 省份
area2 城市
mobile 手机号码
tel 电话号码
email 电子邮箱
address 客户地址
memo 备注
customFieldData 扩展字段内容,请默认为空
10.2 返回值示例
内容描述
0,保存失败,必填内容为空或者与系统现有客户池重复
1,保存成功

11、删除客户

方法名:DeleteCustomer

11.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要删除的客户的ID
11.2 返回值示例
内容描述
1,已删除成功
您没有删除客户的权限
无法删除已建立联系人的客户
无法删除已建立行动记录的客户
无法删除已建立销售机会的客户
无法删除已建立合同的客户

12、获取联系人列表

方法名:GetContactList

12.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
filter 查询条件
currentRow 从第几行开始查询
top 一次获取多少条记录
12.2 返回值示例
内容 描述
ErrorMessage 错误的描述,如果返回结果正确的话,则为空
Data 返回的记录集

如:
{"ErrorMessage":"",data:'[{"id":"39123","name":"联系人名称","typeName":"联系人类型","sex":"1","groupName":"所在部门","title":"联系人职位","mobile":"手机号码","tel":"电话","email":"电子邮箱","customerName":"联系人所属客户","memo":"备注","birthdate":"生日日期"}]'}


13、获取单个联系人的详情

方法名:GetContactInfo

13.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要获取的联系人的ID
13.2 返回值示例
返回内容 描述
id 联系人的ID
customerName 联系人所属客户的名称
mobile 手机号码
tel 电话号码
email 电子邮件
typeName 联系人类型
groupName 所在部门
title 联系人职位

14、新增或编辑联系人资料

方法名:SaveContact

14.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要编辑的联系人的ID,如果为新增,则将该参数设置为0
name 联系人名称
customerId 联系人的所属客户
type 联系人类型
sex 性别,1为男,0为女
groupName 所在部门
title 联系人职位
tel 电话
mobile 手机号码
email 电子邮箱
birthdate 生日
memo 备注信息
photo 联系人照片
customFieldData 扩展字段内容
14.2 返回值示例
内容描述
1,保存成功
0,保存失败,必填字段未填写

15、删除联系人

方法名:DeleteContact

15.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要删除的联系人的ID
15.2 返回值示例
内容描述
1,删除成功
0,删除失败

16、获取行动记录列表

方法名:GetActionList

16.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
filter 查询条件
currentRow 从第几行开始查询
top 一次获取多少条记录
16.2 返回值示例
内容 描述
ErrorMessage 错误的描述,如果返回结果正确的话,则为空
Data 返回的记录集

如:
{"ErrorMessage":"",data:'[{"id":"232396","typeName":"行动类型","customerName":"行动客户","contactName":"拜访的联系人","userName":"行动人员","actionDate":"2018-07-20","actionTime":"16:12","accessDate":"下次回访日期","accessTime":"下次回访时间","memo":"备注"}]'}


17、获取单条行动记录的详情

方法名:GetActionInfo

17.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要获取的行动记录的ID
17.2 返回值示例
内容 描述
id 行动记录ID
customerName 拜访的客户
contactName 拜访的联系人
userName 行动人员
typeName 行动类型
memo 行动内容
actionDate 行动日期
actionTime 行动时间
accessDate 下次回访日期
accessTime 下次回访时间

18、新增或编辑行动记录信息

方法名:SaveAction

18.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要编辑的行动记录ID,如果是新增,则将该参数设置为0
customerId 拜访的客户
typeId 行动类型
signId 关联的签到记录,默认为0
actionDate 行动日期
accessDate 下次回访日期
memo 行动内容
files 相关文件
18.2 返回值示例
内容描述
1,保存成功
0,保存失败

19、删除行动记录

方法名:DeleteAction

19.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要删除的行动记录ID
19.2 返回值示例
内容描述
1,删除成功
0,删除失败

20、获取知识库列表

方法名:GetKBList

20.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
filter 查询条件
keyword 关键字
sort 排序规则,默认不填写则按照日期先后进行排序
currentRow 从第几行开始查询
top 一次获取多少条记录
20.2 返回值示例
内容 描述
ErrorMessage 错误的描述,如果返回结果正确的话,则为空
Data 返回的记录集

如:
{"ErrorMessage":"",data:'[{"id":"3435","title":"知识库标题","text":"知识库内容","files":"文件","author":"作者","createDate":"2017-03-28 16:13"}]'}


21、获取知识库详情

方法名:GetKBInfo

21.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要获取的知识库的ID
21.2 返回值示例
内容 描述
id 知识库ID
title 知识库标题
text 知识库内容
author 作者
createDate 创建时间

22、获取公告列表

方法名:GetCallboardList

22.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
22.2 返回值示例
内容 描述
ErrorMessage 错误的描述,如果返回结果正确的话,则为空
Data 返回的记录集

如:
{"ErrorMessage":"",data:'[{"id":"39","name":"公告标题","typeName":"公告类型","type":"2447","isRead":1,"createUserName":"创建人员","text":"公告内容","datetime":"2017-03-26 04:06","files":"公告文件"}]'}


23、获取公告详情

方法名:GetCallboardInfo

23.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要获取的公告的ID
23.2 返回值示例
内容 描述
id 公告id
text 公告内容
name 公告标题
typeName 公告类型
isRead 是否已读
createUser 发布人员
datetime 发布时间

24、获取机会列表

方法名:GetProjectList

24.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
estimateDateType 销售机会类型,1为超期未谈成,2为本周内可能成交,3为本月内可能成交,为空则不做此限制
filter 查询条件
sort 排序规则
currentRow 从第几行开始查询
top 一次获取多少条记录
24.2 返回值示例
内容 描述
ErrorMessage 错误的描述,如果返回结果正确的话,则为空
Data 返回的记录集

如:
{"ErrorMessage":"",data:'[{"id":"203","name":"机会名称","customerName":"客户名称","userName":"跟进用户","stageName":"当前阶段","status":"机会状态","workText":"当前工作","estimatePrice":"预计成交金额","estimateDate":"预计成交日期","memo":"备注","label":"机会标签"}]'}


25、获取机会详情

方法名:GetProjectInfo

25.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要获取的机会ID
25.2 返回值示例
内容 描述
id 机会ID
customerName 客户名称
name 机会名称
userName 跟进用户
estimateDate 预计成交时间
estimatePrice 预计成交金额
stageName 当前阶段
status 机会状态
memo 备注

26、新增或编辑机会信息

方法名:SaveProject

26.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要编辑的机会ID,如果是新增,则将该参数设置为0
name 机会名称,为空时,则自动生成根据系统规则生成
customerId 机会的客户
estimateDate 预计成交日期
estimatePrice 预计成交金额
label 机会标签
memo 备注信息
files 相关文件
customFieldData 扩展字段内容
26.2 返回值示例
内容描述
1,保存成功
0,保存失败

27、获取机会中的产品信息

方法名:GetProductDetail

27.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
mode 0为机会产品,1为合同产品,此处应该填写0
parentId 机会ID
27.2 返回值示例
内容 描述
ErrorMessage 错误的描述,如果返回结果正确的话,则为空
Data 返回的记录集

如:
{"ErrorMessage":"",data:'[{"id":"203","productName":"产品名称","amount":"数量","price":"产品单价","salesPrice":"产品总价","memo":"备注"}]'}


28、保存机会的产品信息

方法名:SaveProductDetail

28.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
orderId 请直接将该参数设置为0
projectId 机会ID
productId 添加的产品
amount 数量
price 产品金额
salesPrice 产品总价
memo 备注
28.2 返回值示例
内容描述
1,保存成功
0,保存失败

29、删除销售机会

方法名:DeleteProject

29.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要删除的机会ID
29.2 返回值示例
内容描述
1,已经删除成功
0,无法删除已报价的销售机会
0,无法删除已建立竞争对手的销售机会

30、获取合同列表

方法名:GetOrderList

30.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
filter 查询条件
sort 排序规则
currentRow 从第几行开始查询
top 一次获取多少条记录
30.2 返回值示例
内容 描述
ErrorMessage 错误的描述,如果返回结果正确的话,则为空
Data 返回的记录集

如:
{"ErrorMessage":"",data:'[{"id":"6320","name":"合同名称","customerName":"客户名称","submitDate":"2018-07-24","createDate":"2018-07-24 08:16","submitUserName":"促成人员","expireDate":"服务到期时间","orderPrice":"合同金额","statusName":"合同状态","memo":"备注信息"}]'}


31、获取单条合同的详情

方法名:GetOrderInfo

31.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要获取的合同的ID
31.2 返回值示例
内容 描述
id 合同ID
name 合同名称
customerName 客户名称
submitUserName 促成人员
orderPrice 合同金额
money1 回款金额
money2 未回金额
statusName 合同状态
submitDate 成交日期
memo 备注信息

32、新增或编辑合同信息

方法名:SaveOrder

32.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 编辑的合同的ID,如果为新增,则将该参数设置为0
name 合同名称,如果为空,系统将根据规则自动分配合同名称
customerId 合同客户
submitDate 促成日期
submitUser 促成人员
status 合同状态
expireDate 服务到期时间
memo 备注
files 相关文件
customFieldData 扩展字段内容
32.2 返回值示例
内容描述
1,保存成功
0,保存失败

33、获取合同中的产品信息

方法名:GetProductDetail

27.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
mode 0为机会产品,1为合同产品,此处应该填写1
parentId 合同ID
27.2 返回值示例
内容 描述
ErrorMessage 错误的描述,如果返回结果正确的话,则为空
Data 返回的记录集

如:
{"ErrorMessage":"",data:'[{"id":"203","productName":"产品名称","amount":"数量","price":"产品单价","salesPrice":"产品总价","memo":"备注"}]'}


34、保存合同产品

方法名:SaveProductDetail

28.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
orderId 合同ID
projectId 请直接将该参数设置为0
productId 添加的产品
amount 数量
price 产品金额
salesPrice 产品总价
memo 备注
28.2 返回值示例
内容描述
1,保存成功
0,保存失败

35、删除合同

方法名:DeleteOrder

35.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
id 需要删除的合同的ID
35.2 返回值示例
内容描述
1,删除成功
0,无法删除已添加产品的合同

36、获取产品列表

方法名:GetProduct

36.1 参数配置
参数 必要性 描述
token 通过Login方法获得的秘钥
filter 查询条件
sort 排序规则
currentRow 从第几行开始查询
top 一次获取多少条记录
36.2 返回值示例
内容 描述
ErrorMessage 错误的描述,如果返回结果正确的话,则为空
Data 返回的记录集

如:
{"ErrorMessage":"",data:'[{"id":"145","name":"产品名称1","typeName":"产品类型","price":"单价","memo":""},{"id":"141","name":"产品名称2","typeName":"产品类型","price":"单价","memo":""}]'}