===== 概述 =====
帮我吧是一个客服管理系统。为了方便客服使用，它本身允许客服人员将服务过程中的客户信息保存下来，以供后续调取使用。但在很多情况下，使用帮我吧的服务提供商已经使用了第三方的CRM系统来进行客户管理，此时需要将帮我吧与第三方的CRM系统进行整合，客户管理功由CRM系统提供，帮我吧仅提供客服相关功能。

本文档描述了第三方CRM系统如何与帮我吧通过API调用进行结合，目标读者为第三方CRM系统的开发人员和相关技术人员。
==== 1. 数据流向说明 ====
----
在不与第三方CRM结合的情况下，客户信息和服务信息都保存在帮我吧服务器中。如下图所示，帮我吧客服端从帮我吧服务器获取客户及其服务信息，展示给客服人员：
{{ :帮我吧文档:crm接口:crm数据流图1.png?nolink |}}
在与第三方CRM结合的时候，帮我吧仅提供客服及相关功能，客户管理功能由CRM系统提供。如下图所示，此时帮我吧客服端仅从帮我吧服务器获取服务信息，客户的相关信息（如公司名称、联系人等信息）通过预定义接口从CRM系统获取：
{{ :帮我吧文档:crm接口:crm数据流图2.png?nolink |}}
<wrap em>在这种情况下，CRM系统和帮我吧客服端可能都部署在服务商的内部局域网中，所以CRM系统也无需向外网暴露任何服务接口，这极大地保障了服务商CRM系统中客户信息的安全性。</wrap>
==== 2. 接口交互 ====
----
在与第三方CRM结合时，帮我吧系统和CRM系统之间的API调用关系如下图所示(图中**黑色字体**的API为必须调用的，或者必须实现的接口)：
<BOOKMARK:APIChart>
{{map>:帮我吧文档:crm接口:api交互.png|API消息交互图}}
[[帮我吧文档:crm接口:帮我吧提供的接口#BW8_API_1|BW8_API_1 @ 248,99,548,123]]
[[帮我吧文档:crm接口:帮我吧提供的接口#BW8_API_2|BW8_API_2 @ 249,143,554,164]]
[[帮我吧文档:crm接口:帮我吧提供的接口#BW8_API_3|BW8_API_3 @ 326,189,475,207]]
[[帮我吧文档:crm接口:帮我吧提供的接口#BW8_API_4|BW8_API_4 @ 314,230,487,249]]
[[帮我吧文档:crm接口:帮我吧提供的接口#BW8_API_5|BW8_API_5 @ 301,270,497,289]]
[[帮我吧文档:crm接口:CRM系统提供的接口#CRM_API_1|CRM_API_1 @ 369,323,600,343]]
[[帮我吧文档:crm接口:CRM系统提供的接口#CRM_API_2|CRM_API_2 @ 404,370,581,390]]
[[帮我吧文档:crm接口:CRM系统提供的接口#CRM_API_3|CRM_API_3 @ 390,419,576,440]]
{{<map}}

**帮我吧**需要提供五个接口供CRM系统调用，其中__前两个接口__是CRM与帮我吧对接时__必须调用__的接口，其他的根据CRM系统的实际需要酌情调用。这五个接口具体是：
  * **[[帮我吧文档:crm接口:帮我吧提供的接口#BW8_API_1|BW8_API_1]]**: 批量导入客户的公司ID及其服务到期信息，CRM系统在与帮我吧系统结合时，在首次进行系统初始化时，需要调用此接口将CRM中的已有的客户公司ID及其服务到期时间导入到帮我吧服务器中；
  * **[[帮我吧文档:crm接口:帮我吧提供的接口#BW8_API_2|BW8_API_2]]**: 增删改一个客户的公司ID及其服务到期信息，当CRM系统发生客户公司的增加/删除或者服务到期时间修改时，调用此接口来同步修改帮我吧系统中的数据；
  * **[[帮我吧文档:crm接口:帮我吧提供的接口#BW8_API_3|BW8_API_3]]**: 获取服务记录，如果CRM系统希望将帮我吧中的服务记录导入，则需要调用此接口，否则可以不用调用此接口；
  * **[[帮我吧文档:crm接口:帮我吧提供的接口#BW8_API_4|BW8_API_4]]**: 获取客服账号列表，当需要在CRM系统中建立CRM账户和帮我吧客服账号的对应关系时，可以调用帮我吧的此接口获取当前服务商的所有客服人员帮我吧用户名列表；
  * **[[帮我吧文档:crm接口:帮我吧提供的接口#BW8_API_5|BW8_API_5]]**: 增删改查帮我吧平台里的服务卡记录，当需要将CRM系统中的收费科目与帮我吧服务卡建立对应关系时，可以调用此接口；

**CRM系统**需要提供三个接口供帮我吧客服端调用，它们分别是：
  * **[[帮我吧文档:crm接口:CRM系统提供的接口#CRM_API_1|CRM_API_1]]**: 查询客户的公司/联系人信息，帮我吧客服端调用此接口来查询当前请求服务的用户的相关信息；<BOOKMARK:CRM_API_1>
  * **[[帮我吧文档:crm接口:CRM系统提供的接口#CRM_API_2|CRM_API_2]]**: 添加/修改联系人信息，帮我吧客服端可以调用此接口添加/修改一个公司名下的联系人信息；<BOOKMARK:CRM_API_2>
  * **[[帮我吧文档:crm接口:CRM系统提供的接口#CRM_API_3|CRM_API_3]]**: 页面：添加/绑定公司，帮我吧客服端调用此接口为当前请求服务的用户在CRM中建立客户信息档案，并关联到当前用户上；<BOOKMARK:CRM_API_3>
为了减少需要由CRM系统提供的回调API入口的个数，我们根据是否需要提供用户交互界面，将不需要界面交互的CRM_API_1和CRM_API_2整合为一个接口（由后续URL参数做两种功能的区分），本文档后文以及帮我吧后台设置中称之为**CRM回调API**。将需要用户界面的CRM_API_3称做**CRM内嵌URL**。

以上所有接口的数据均使用UTF-8格式进行编码。