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

公司接口


JSON格式

名称 类型 只读 必填 注释
uId int 联系人所属公司ID,系统自动生成
url varchar 公司的资源url
companyName varchar 公司名称
supportId int 负责该公司的客服ID,系统自动生成
servicestarttime varchar 服务开始时间,格式为:2012-01-01
serviceendtime varchar 服务结束时间,格式为:2012-01-01
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 公司自定义字段
userGroupint 公司所属分组,2B模式下存在该字段,默认取值为0,即不属于任何分组

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-降序
page int 分页获取,默认为1
per_page int 每页大小,默认为100

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

调用者权限

所有客服

调用示例

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

返回值示例

Status: 200 OK

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

查看指定公司信息

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":   223,
    "companyName": "北京金万维科技有限公司",
    ...
  }
}

获取多个公司信息

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": "北京金万维科技有限公司"}}'

返回值示例

Status: 200 OK

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

搜索公司

GET /api/v1/companies/search.json

调用者权限

所有客服

请求参数

名称 类型 必需的 注释
query string 搜索内容
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
}

页面工具