侧边栏

文档首页

CRM扩展

数据接口

呼叫能力

Android IM SDK手册（暂停使用）

iOS IM SDK手册（暂停使用）

—-

Android SIP SDK手册

iOS SIP SDK手册

客户端标准版快速集成

帮我吧远程SDK版本

网页在线客服集成

微信接入

帮我吧文档:crm接口:帮我吧提供的接口

目录

帮我吧提供的接口

如概述中的API交互图所示，CRM集成时，CRM系统可调用帮我吧提供的如下七个接口。

<BOOKMARK:BW8_API_1>

1. BW8_API_1：批量导入公司信息（不支持客户分组）

当CRM系统在与帮我吧系统结合时，在进行系统初始化的时候，需要调用此接口将CRM中的所有客户公司ID及该公司的服务到期时间导入到帮我吧服务器中。
注意：无需导入公司ID以外的其他信息。

请求地址：

https://www.bangwo8.com/api/apiImportUser.php?vendorID={vendorID}&authcode={authcode}

请求方法：POST
URL参数说明：

参数 是否必填 说明
vendorID 是 帮我吧后台唯一标示的vendorID
authcode 是 用于接口保护的共享密钥，具体参见接口的安全保护

POST数据内容：

{ 		 
    "companyid":"第三方系统客户的唯一id",	 		 		 
    "servicestarttime":"客户服务开始时间" ,    	
    "serviceendtime":"客户服务到期时间"
    "custmers" :{"CRM系统中的用户ID"："帮我吧ID"}
}

POST参数说明:

参数 是否必填 说明 示例
companyid 是 第三方系统客户的唯一id
servicestarttime 否 服务开始时间
serviceendtime 否 服务结束时间
custmers 否 绑定帮我吧ID {“CRM系统中的用户ID”：“帮我吧ID”} “custmers”:{“123”:123456789,“321”:987654321}

请求示例: 

[{
    "companyid":12,
    "servicestarttime":"2015-12-12",
    "serviceendtime":"2016-12-12",
    "custmers":
    {
        "123":"999888777";
        "124":"333222111";
    }
},
{
    "companyid":13,
    "servicestarttime":"2015-12-12",
    "serviceendtime":"2016-12-12",
    "custmers": {}
}]

返回说明：
正确时返回如下格式的JSON数据： 

{
     "errcode" : 0,
     "errmsg" : "ok",
}

<BOOKMARK:BW8_API_2>

2. BW8_API_2：批量导入客户分组信息

当CRM系统在与帮我吧系统结合时，在进行系统初始化的时候，需要调用此接口将CRM中的所有客户分组ID及名称导入到帮我吧服务器中。

请求地址：

https://www.bangwo8.com/api/apiImportUserGroup.php?vendorID={vendorID}&authcode={authcode}

请求方法：POST
URL参数说明：

参数 是否必填 说明
vendorID 是 帮我吧后台唯一标示的vendorID
authcode 是 用于接口保护的共享密钥，具体参见接口的安全保护

POST数据内容：

{ 		 
    "groupid":"第三方系统客户分组的唯一id",	 		 		 
    "groupname":"第三方系统客户分组的组名" 
}

POST参数说明:

参数 是否必填 说明 示例
groupid 是 第三方系统客户分组的唯一id
groupname 是 第三方系统客户分组的组名

请求示例: 

[{
    "groupid":12,
    "groupname":"北京区域"
},
{
    "groupid":13,
    "groupname":"上海区域"
}]

返回说明：
正确时返回如下格式的JSON数据： 

{
     "errcode" : 0,
     "errmsg" : "ok",
}

<BOOKMARK:BW8_API_3>

3. BW8_API_3：批量导入客户公司信息（支持客户分组）

当CRM系统在与帮我吧系统结合时，在进行系统初始化的时候，需要调用此接口将CRM中的所有客户公司ID、名称及所属分组导入到帮我吧服务器中。

请求地址：

https://www.bangwo8.com/api/apiImportUser_V2.php?vendorID={vendorID}&authcode={authcode}

请求方法：POST
URL参数说明：

参数 是否必填 说明
vendorID 是 帮我吧后台唯一标示的vendorID
authcode 是 用于接口保护的共享密钥，具体参见接口的安全保护

POST数据内容：

{ 		 
    "companyid":"第三方系统客户的唯一id",	 
    "groupid":"第三方系统客户所属分组id",		 		 
    "servicestarttime":"客户服务开始时间" ,    	
    "serviceendtime":"客户服务到期时间"
    "custmers" :{"CRM系统中的用户ID"："帮我吧ID"}
}

POST参数说明:

参数 是否必填 说明 示例
companyid 是 第三方系统客户的唯一id
groupid 是 第三方系统客户所属分组id
servicestarttime 否 服务开始时间
serviceendtime 否 服务结束时间
custmers 否 绑定帮我吧ID {“CRM系统中的用户ID”：“帮我吧ID”} “customers”:{“123”:123456789,“321”:987654321}

请求示例: 

[{
    "companyid":12,
    "groupid":33
    "servicestarttime":"2015-12-12",
    "serviceendtime":"2016-12-12",
    "custmers":
    {
        "123":"999888777";
        "124":"333222111";
    }
},
{
    "companyid":13,
    "groupid":44,
    "servicestarttime":"2015-12-12",
    "serviceendtime":"2016-12-12",
    "custmers": {}
}]

返回说明：
正确时返回如下格式的JSON数据： 

{
     "errcode" : 0,
     "errmsg" : "ok",
}

<BOOKMARK:BW8_API_4>

4. BW8_API_4：增删改公司信息

当CRM系统发生客户公司的增加/删除或者服务到期时间修改时，调用此接口来同步修改帮我吧系统中的数据。

请求方式: POST
请求地址： 

https://www.bangwo8.com/api/apiCRMUserSync.php?action={action}&authcode={authcode}

URL参数说明：

参数 是否必填 说明
action 是 add: 添加客户
del : 删除客户
update : 修改客户
authcode 是 用于接口保护的共享密钥，具体参见接口的安全保护

POST数据示例如下：

{
    "vendorID":1,   		 
    "companyid":1,	 		 		 
    "servicestarttime":"2016-01-01" ,    	
    "serviceendtime":"2016-02-01"
}

POST变量说明

变量 是否必须 说明 示例
vendorID 是 帮我吧后台标识一个服务商的vendorID 1
companyid 是 公司ID 1
servicestarttime 是 客户服务开始时间 2016-01-01
serviceendtime 是 客户服务到期时间 2016-02-01

返回说明（正确时的JSON返回结果）： 

{
     "errcode" : 0,
     "errmsg" : "ok",
}

<BOOKMARK:BW8_API_5>

5. BW8_API_5：获取服务记录

如果CRM系统希望将帮我吧中的服务记录导入，则需要调用此接口。

请求方式: POST
请求地址： 

https://www.bangwo8.com/api/apiGetAllCustServers.php?authcode={authcode}

URL参数说明：

参数 是否必填 说明
authcode 是 用于接口保护的共享密钥，具体参见接口的安全保护

POST数据示例如下：

{
    "vendorID":1,   		 
    "starttime":"2016-01-01 12:30:00",
    "endtime":"2016-02-01 12:30:00"
}

POST变量说明

变量 是否必须 说明 示例
vendorID 是 帮我吧后台标识一个服务商的vendorID 1
starttime 是 开始时间，可以是日期数据，也可以精确到秒的时间数据 比如：“2016-01-01”或者“2016-01-01 12:30:00”
endtime 是 结束时间，可以是日期数据，也可以精确到秒的时间数据 比如：“2016-01-01”或者“2016-01-01 12:30:00”

返回示例

{
    "errcode":0,
    "errmsg":"ok",
    "info":
    [{
          "id":"4",
          "btime":"2009-09-09 12:23:24",
          "etime":null,
          "cardid":1235,
          "cardname":"上门服务",
          "stat":null,
          "companyid":"123",
          "contactor":"sss",
          "contactmethod":"dddd",
          "servicername":"jianwk222",
          "note":"ddd",
          "problemsolution":null,
          "uniquenumber":"125523232",
          "paystat":"1",
          "commentscore":"5",
          "comment":"",
          "paymentmethod":"1",
          "acctbalance":"10.10",
          "paydatetime":"2010-12-11 12:30:34",
          "problem":null,
          "ptchild":"123",
          "ptthird":"",
          "isfinish":"1",
          "computername":"",
          "chatrecord":null,
          "remote":null,
          "transferfile":null,
          "filecount":null

    }]
}

返回结果说明

id 服务号
btime 开始服务时间
etime 结束服务时间
cardid 服务卡编号
cardname 服务卡名称
stat 服务状态 (0无效、1服务中、2服务等待中、3服务延长中、4服务保留中、5服务完成)
companyid 该公司在CRM系统中的公司ID
contactor 联系人
contactmethod 联系方式
servicername 客服账号
note 问题描述
problemsolution 解决办法
uniquenumber 客户端9位id
paystat 支付状态(0没支付 1支付成功 2支付失败 3刚打开支付页面 更新记录 4-在线扣费成功)
commentscore 打分(好评 5 中评 3 差评1 0 无评价)
comment 评价
paymentmethod 支付方式(0-网银 1-手机)
acctbalance 财富值
paydatetime 支付时间
problem 问题
ptchild 问题类型的子级
ptthird 三级问题类型
isfinish 0-没解决 1-解决
computername 主机备注
chatrecord 文字聊天(0-无聊天记录 1-有聊天记录)
remote 远程服务(0-没有发起远程 1-发起远程)
transferfile 文件传输(0-没有传输文件 1-有传输文件)
filecount 该服务传文件的总数

<BOOKMARK:BW8_API_6>

6. BW8_API_6：获取客服账号列表

当需要在CRM系统中建立CRM账户和帮我吧客服账号的对应关系时，可以调用帮我吧的此接口获取当前服务商的所有客服人员帮我吧用户名列表。 请求方式: GET
请求地址： 

https://www.bangwo8.com/api/apiGetSupprotNames.php?vendorID={vendorID}&authcode={authcode}

参数说明:

参数 是否必填 说明
vendorID 是 帮我吧后台唯一标示的vendorID
authcode 是 用于接口保护的共享密钥，具体参见接口的安全保护

返回说明（正确时的JSON返回结果）： 

{
    "errcode":0,
    "errmsg":"ok",
    "supprotnames":["account1","account2"]
}

<BOOKMARK:BW8_API_7>

7. BW8_API_7：增/删/改/查服务卡

此接口用于增/删/改/查帮我吧平台里的当前服务商名下的服务卡记录，当需要将CRM系统中的收费科目与帮我吧服务卡建立对应关系时，可以调用此接口。

请求方式: POST
请求地址： 

https://www.bangwo8.com/api/apiCRMServiceCard.php?action={action}&vendorID={vendorID}&authcode={authcode}

URL参数说明：

参数 是否必填 说明
action 是 list: 列出所有服务卡(此时可用GET方法访问此接口)
add: 添加服务卡
del : 删除服务卡
update : 修改服务卡
vendorID 是 帮我吧后台唯一标示的vendorID
authcode 是 用于接口保护的共享密钥，具体参见接口的安全保护

POST数据示例如下：

{
    "cardid":1,	 		 		 
    "name":"测试服务卡" ,    	
    "price":"100.00",
    "type":"0",
    "state":"1",
    "description":"这是一个测试服务卡"
}

注意：

  • 列出所有服务卡时，POST参数可以为空，此时也可以使用GET方法访问；
  • 添加服务卡时，cardid为空值，需要提供其他所有字段；
  • 更新服务卡时，需要提供vendorID、cardid以及需要更新的字段；
  • 删除服务卡时，仅需要提供vendorID和要删除的cardid；

POST变量说明

变量 是否必须 说明 示例
cardid 是 服务卡的ID号，修改、删除服务卡的时候必须有此字段 1
name 是 服务卡的UTF-8编码的名称，添加、修改服务卡信息的时候需要有此字段 测试服务卡
price 是 服务卡价格，添加、修改服务卡信息的时候需要有此字段 100.00
type 是 服务卡类型，添加、修改服务卡信息的时候需要有此字段，取值范围如下：
0: 按次计费的服务卡；
2: 按包年计费的服务卡； 		0
state 是 服务卡的状态，添加、修改服务卡信息的时候需要有此字段，取值范围如下：
0: 禁用此服务卡；
1: 启用此服务卡； 		1
description 否 服务卡的备注说明，添加、修改服务卡信息的时候需要有此字段 任意说明字符串

返回说明（正确时的JSON返回结果）：
该调用的返回结果如下： 

{
     "errcode" : 0,
     "errmsg" : "ok",
     "info" :  xxx
}

其中info字段的取值说明如下：

  • 当列出所有服务卡时（即action是list），返回结果中的info字段是如下所示的当前服务商所有服务卡的列表：
     [
          {
               "cardid":1,
               "name":"测试服务卡1" ,    	
               "price":"100.00",
               "type":"0",
               "state":"1",
               "description":"这是一个测试服务卡1"
          },
          {
               "cardid":2,
               "name":"测试服务卡2" ,
               "price":"100.00",
               "type":"0",
               "state":"1",
               "description":"这是一个测试服务卡2"
          }
     ]
  • 当添加/修改/删除服务卡时，返回结果中的info字段是如下所示的当前添加/修改/删除的服务卡的ID：
{
     "cardid":1
}

页面工具

关于我们 | 联系我们 | 意见建议 | 论 坛 | 管理后台

增值电信业务经营许可证:京B2-20192684 京ICP备05008343号

Copyright @ 2004-2020 Gnway.com All rights reserved