帮我吧文档:数据接口:客户管理:公司 [帮我吧开发文档]

公司接口

JSON格式

名称	类型	只读	必填	注释
uId	int	是	否	联系人所属公司ID，系统自动生成
url	varchar	是	否	公司的资源url
companyName	varchar	否	是	公司名称
supportId	int	是	否	负责该公司的客服ID，系统自动生成
servicestarttime	varchar	否	否	服务开始时间，格式为：2012-01-01
serviceendtime	varchar	否	否	服务结束时间，格式为：2012-01-01
userURL	varchar	否	否	公司网址
serveNote	varchar	否	否	备注
serviceCharge	varchar	否	否	服务费余额
serviceaccount	varchar	否	否	服务账号
servicepassword	varchar	否	否	服务密码
address	varchar	否	否	公司地址
createDT	date	是	否	创建时间，格式为：2018-02-03 00:00:00
updateDT	date	是	否	更新时间，格式为：2018-02-03 00:00:00
custom_fields	array	否	否	公司自定义字段
userGroup	int	否	否	公司所属分组，2B模式下存在该字段，默认取值为0，即不属于任何分组
tableName	varchar	否	否	标签，多个英⽂逗号隔开
province	varchar	否	否	省份/城市（区域第一个字段）
city	varchar	否	否	城市/区（区域第二个字段）
status	int	否	否	1-未删除，2-已删除
service_groupid	varchar	否	否	受理客服组，多个值用因为逗号分隔

JSON示例

{
     "uId": 111,
     "url": "https://www.bangwo8.com/api/v1/companies/111.json",
     "companyName": "北京金万维科技有限公司",
     "servicestarttime": "2017-01-01",
     "serviceendtime": "2017-12-31",
     "serviceaccount": "gnkefu",
     "servicepassword": "helloworld",
     "address": "北京市丰台区汉威国际广场",
     "createDT": "2016-12-21",
     "updateDT": "2017-02-12",
     "custom_fields": [
      {
          "key": "field_1",
          "value": "4334"
      },
      {
          "key": "field_3",//复选框
          "value": "是" 
      },
      {
          "key": "field_2",//下拉列表
          "value": "下拉菜单的某一项"
      }
     ],
     "userGroup": 221
}

获取公司列表

GET /api/v1/companies.json

查询参数

名称	必需的	类型	注释
created_start	否	string	按创建时间筛选，开始时间，包含当天
created_end	否	string	按创建时间筛选，结束时间，包含当天
updated_start	否	string	按更新时间筛选，开始时间，包含当天
updated_end	否	string	按更新时间筛选，结束时间，包含当天
created_order	否	string	按创建时间排序，取值为：asc-升序，desc-降序
updated_order	否	string	按更新时间排序，取值为：asc-升序，desc-降序
deStat	否	int	0-未删除 1-获取全部数据，不传该参数时默认为0
page	否	int	分页获取，默认为1
per_page	否	int	每页大小，默认为100

说明：默认按编码升序返回。时间参数（created_start、created_end、updated_start、updated_end）格式为“2012-01-01”。

调用者权限

所有客服

调用示例

curl https://www.bangwo8.com/api/v1/companies.json \
  -v -u {account}:{password}

返回值示例

Status: 200 OK

{
	"companies": [
	  {
            "uId": "9516936",
            "companyName": "测试公司2",
            "province": "吉林",
            "city": "长春",
            "supportId": "0",
            "servicestarttime": "2021-09-28",
            "serviceendtime": "2022-01-31",
            "serviceCharge": "0.00",
            "serviceaccount": "002",
            "servicepassword": "002",
            "address": "",
            "multiServiceList": "",
            "createDT": "2021-09-28 11:38:56",
            "updateDT": "2022-11-15 10:33:16",
            "tableName": "",
            "custom_fields": [
                {
                    "key": "deptid",
                    "value": ""
                },
                {
                    "key": "field_1",
                    "value": [
                        "天津市"
                    ]
                },
                {
                    "key": "field_2",
                    "value": "0"
                },
                {
                    "key": "fxk",
                    "value": "否"
                }
            ],
            "userGroup": "",
            "solveDT": "",
            "waitDT": "",
            "openDT": "",
            "closeDT": ""
        },
        {
            "uId": "10722418",
            "companyName": "123",
            "province": "",
            "city": "",
            "supportId": "0",
            "servicestarttime": "0000-00-00",
            "serviceendtime": "0000-00-00",
            "serviceCharge": "0.00",
            "serviceaccount": "",
            "servicepassword": "",
            "address": "",
            "multiServiceList": "N1331193N",
            "createDT": "2022-05-10 10:00:30",
            "updateDT": "2022-10-31 09:58:53",
            "tableName": "",
            "custom_fields": [
                {
                    "key": "deptid",
                    "value": ""
                },
                {
                    "key": "field_1", //级联字段
                    "value": [
                        "北京市",
                        "二级1",
                        "三级1",
                        "四级1",
                        "五级2"
                    ]
                },
                {
                    "key": "field_2",
                    "value": "0"
                },
                {
                    "key": "fxk",
                    "value": "否"
                }
            ],
            "userGroup": "",
            "solveDT": "",
            "waitDT": "",
            "openDT": "",
            "closeDT": ""
        }
     ]
}

查看指定公司信息

GET /api/v1/companies/{id}.json

调用者权限

所有客服

调用示例

curl https://www.bangwo8.com/api/v1/companies/223.json \
  -v -u {account}:{password}

返回值示例

Status: 200 OK
{
    "company": {
        "uId": "12352625",
        "companyName": "测试公司a",
        "province": "北京",
        "city": "宣武",
        "supportId": "0",
        "servicestarttime": "2022-11-30",
        "serviceendtime": "2022-12-02",
        "serviceCharge": "0.00",
        "serviceaccount": "",
        "servicepassword": "12345",
        "address": "地址",
        "multiServiceList": "N1331193N",
        "service_groupid": "344124,344214,344217",
        "createDT": "2022-11-16 09:18:11",
        "updateDT": "2022-11-30 17:41:20",
        "tableName": "",
        "custom_fields": [
            {
                "key": "deptid",
                "value": "123456789098"
            },
            {
                "key": "field_1", //级联字段
                "value": [
                    "北京市",
                    "二级1",
                    "三级1",
                    "四级1",
                    "五级2"
                ]
            },
            {
                "key": "field_2",
                "value": "4668669"
            },
            {
                "key": "gjfx",
                "value": "4672422,4672423,4672424"
            },
            {
                "key": "fxk",
                "value": "是"
            }
        ],
        "userGroup": ""
    }
}

获取多个公司信息

GET /api/v1/companies/show_many.json?ids={ids}

调用者权限

所有客服

调用示例

curl https://www.bangwo8.com/api/v1/companies/show_many.json?ids=1,2,3 \
  -v -u {account}:{password}

返回值示例

Status: 200 OK

{
  "companies": [
    {
      "uId": 1,
      "companyName": "测试公司1",
      ...
    },
    {
      "uId": 2,
      "companyName": "测试公司2",
      ...
    }
  ]
}

创建公司

POST /api/v1/companies.json

调用者权限

所有客服

调用示例

curl -v -u {account}:{password} https://www.bangwo8.com/api/v1/companies.json \
  -H "Content-Type: application/json" -X POST -d '{"company":{"companyName":"测试公司API", \
  -"custom_fields":[{"key":"field_1","value":"华中"},{"key":"field_3","value":"是"}]}}'

说明：目前只能通过companyName属性来创建公司。也就是说，创建公司时，companyName必须有值。

返回值示例

Status: 200 OK
Location: https://www.bangwo8.com/api/v1/companies/{id}.json

{
  "company": {
    "uId":   11,
    "companyName": "北京金万维科技有限公司",
    ...
  }
}

修改公司信息

PUT /api/v1/companies/{id}.json

调用者权限

所有客服

调用示例

curl -v -u {account}:{password} https://www.bangwo8.com/api/v1/companies/123.json \
  -H "Content-Type: application/json" -X PUT -d '{"company": {"companyName": "北京金万维科技有限公司","service_groupid": "344124,344214,344217"}}'

返回值示例

Status: 200 OK

{
  "company": {
    "uId":   11,
    "companyName": "北京金万维科技有限公司",
    ...
  }
}

搜索公司

GET /api/v1/companies/search.json

调用者权限

所有客服

请求参数

名称	类型	必需的	注释
query	string	是	搜索内容
deStat	int	否	0-获取未删除数据 1-获取全部数据，不传该参数时默认为0
sort_by	string	否	按时间排序，目前支持：createDT-创建时间，updateDT-更新时间
sort_order	string	否	按升序还是降序返回，取值为：asc-升序，desc-降序，默认为降序

query参数说明

搜索内容	返回结果
query=companyName:金万维	返回公司名称包含该内容的所有公司
query=serviceaccount:xxx	搜索服务账号为“xxx”的公司，此为精确搜索
query=field_1:454	返回自定义字段唯一标识为“field_1”的内容里面包含“454”的公司
query=companyName:金万维 createDT>2017-07-01	返回公司名称包含“金万维”，并且创建时间是2017年7月1日以后的公司

说明：
1、目前不支持搜索内容本身带有空格
2、当query参数增加了时间的过滤条件时，两个条件之间要以空格分开，比如“companyName:金万维 createDT>2017-07-01”
3、时间过滤条件目前支持以下几种方式：（以createDT为例）

  * createDT<2017-09-01 //过滤创建时间为2017-09-01之前的联系人，不包含2017-09-01当天
  * createDT>2017-09-01 //过滤创建时间为2017-09-01之后的联系人，不包含2017-09-01当天 
  * createDT:2017-09-01 //过滤创建时间为2017-09-01当天的联系人 
  * createDT<=2017-09-01 //过滤创建时间为2017-09-01之前的联系人，包含2017-09-01当天 
  * createDT>=2017-09-01 //过滤创建时间为2017-09-01之后的联系人，包含2017-09-01当天

4、目前搜索功能只支持按公司名称、服务账号（serviceaccount）筛选。

调用示例

curl "https://www.bangwo8.com/api/v1/companies/search.json" \
  -G --data-urlencode "query=132 createDT>2017-07-03" \
  -v -u {account}:{password}

返回值示例

Status: 200 OK

{
  "results": [
    {
      "companyName":   "金万维",
      "createDT":  "2009-05-13 10:07:08",
      "updateDT":  "2011-07-22 11:11:12",
      "uId":  111,
      "url":       "https://www.bangwo8.com/api/v1/companies/111.json"
    },
    {
      "companyName":   "金万维测试",
      "createDT":  "2010-07-13 10:07:08",
      "updateDT":  "2011-07-13 11:11:12",
      "uId":  112,
      "url":       "https://www.bangwo8.com/api/v1/companies/112.json"
    },
    ...
  ],
  "next_page": "https://www.bangwo8.com/api/v1/companies/search.json?query=132 createDT>2017-07-03&sort_by=createDT&sort_order=desc&page=2",
  "previous_page": null,
  "count":     100
}

公司外部扩展

功能介绍

公司外部扩展，指的是公司自定义字段中单行文本字段可支持数据源来自于帮我吧客户档案的资产表的数据，然后赋值到公司字段中。

配置地址

https://www.bangwo8.com/osp2016/SDK/Tables/ticketAssetTable.php

配置参数

名称	类型	必填	注释
tableId	int	tableId与tableName参数至少填写一个	资产表id
tableName	string	tableId与tableName参数至少填写一个	资产表唯一标识，两个参数同时存在但又不是同一个资产表时，以该参数指向的资产表为准。
cPara	string	是	资产表的字段与公司自定义字段对应参数,该参数用于配置选中的资产里的哪些资产字段取值回填到公司的哪些字段中；如asset_field_1:company_price,_id:company_x；其中asset_field_1为资产表字段唯一标识，company_price和company_x为公司自定义字段唯一标识；特殊字段标识说明：_id为选中资产的对应资产id；参数有多个时，以逗号分隔
filter	string	否	筛选资产表数据的条件（模糊搜索），资产表字段:取值。判断是否传filter，传了再判断是否有值，有值就按值的内容筛选，没有就不用筛选；没传filter，也不用筛选。filter参数可用于筛选资产表所属人的数据，如在弹框时要显示的是所属人为工单当前公司的所有资产表数据，则配置为ownerType:company,owner:{ {company.companyId}}
display	string	否	用于初始化设置，如第一次配置该资产表时，配置参数display=asset_field_1,asset_field_2，则显示这两列数据，但是可视化选项中是展示所有资产表字段，但是如果右上角的按钮选择显示/隐藏字段选中field_a,field_b，field_d这三个不同字段，则以这三个字段为准来显示，即display参数与可视化操作冲突时以可视化为准；可视化的操作以客服偏好为准，及每个客服之间选择显示的数据互不影响；

注意：

①filter参数用于筛选资产表所属人的数据时，固定传两个参数：ownerType；owner 非必填，如果owner不为空，则ownerType也不能为空，否则显示所有数据

②ownerType：资产表数据的所属人类型，所属人类型为联系人取值：contacter，所属人类型为公司取值：company

③owner ：资产表数据的所属人，所属人类型为联系人占位符取值为：{ {user.cId} }（联系人id），所属人类型为公司占位符取值为：{ {company.companyId} }（公司id）

④非占位符时直接写联系人id或者公司id值; 该占位符获取的是当前页面数据，非数据库数据;如果配置了这两个参数，但是工单页面数据为空，则这两个参数不生效，显示所有数据；如果owner不为空，则ownerType也不能为空，否则显示所有数据

⑤没有设置display参数时，第一次配置该外部扩展：默认显示所有字段，可视化选项选择中所有字段。

⑥有传display参数，第一次配置该外部扩展：显示的是该参数列，可视化选中的也是显示的字段。再次添加字段参数，不会再生效。

侧边栏

CRM扩展

数据接口

呼叫能力

Android IM SDK手册（暂停使用）

iOS IM SDK手册（暂停使用）

Android SIP SDK手册

iOS SIP SDK手册

客户端标准版快速集成

帮我吧远程SDK版本

网页在线客服集成

微信接入

目录

公司接口

JSON格式

JSON示例

获取公司列表

查看指定公司信息

获取多个公司信息

创建公司

修改公司信息

搜索公司

公司外部扩展

侧边栏

CRM扩展

数据接口

呼叫能力

Android IM SDK手册（暂停使用）

iOS IM SDK手册（暂停使用）

Android SIP SDK手册

iOS SIP SDK手册

客户端标准版快速集成

帮我吧远程SDK版本

网页在线客服集成

微信接入

目录

公司接口

JSON格式

JSON示例

获取公司列表

查看指定公司信息

获取多个公司信息

创建公司

修改公司信息

搜索公司

公司外部扩展

页面工具