公司接口 (Companies)

1. 获取公司列表

GET /companies.json

参数	类型	必填	默认值	说明
page	int	否	1	页码，最小 1
per_page	int	否	100	每页条数，最大 100
deStat	int	否	0	0=未删除，1=包含已删除
created_start	string	否		创建时间范围起始，格式 Y-m-d
created_end	string	否		创建时间范围结束，格式 Y-m-d
created_order	string	否		按创建时间排序，ASC 或 DESC
updated_start	string	否		更新时间范围起始，格式 Y-m-d
updated_end	string	否		更新时间范围结束，格式 Y-m-d
updated_order	string	否		按更新时间排序，ASC 或 DESC

响应示例:

{
  "companies": [
    {
      "uId": "1162622",
      "companyName": "示范公司3",
      "province": "北京",
      "city": "丰台",
      "supportId": "0",
      "servicestarttime": "0000-00-00",
      "serviceendtime": "0000-00-00",
      "serviceCharge": "0.00",
      "serviceaccount": "",
      "servicepassword": "",
      "address": "南四环西路186号四区",
      "userURL": "www.bangwo8.com",
      "serveNote": "实例",
      "multiServiceList": "",
      "service_groupid": "",
      "createDT": "2017-09-16 14:53:59",
      "updateDT": "2025-09-11 22:04:43",
      "tableName": "",
      "userGroup": "",
      "solveDT": "",
      "waitDT": "",
      "openDT": "",
      "closeDT": "",
      "status": "1",
      "custom_fields": [{"key": "field_2", "value": ""}]
    }
  ],
  "count": "1",
  "previous_page": null,
  "next_page": "https://xxx/api/v1/companies.json?per_page=50&page=2"
}

2. 搜索公司

GET /companies/search.json

参数	类型	必填	默认值	说明
query	string	是		搜索条件，空格分隔多个条件
page	int	否	1	页码
per_page	int	否	100	每页条数
deStat	int	否	0	0=排除已删除，1=包含已删除
sort_by	string	否		createDT / updateDT
sort_order	string	否	desc	asc / desc

query 语法（空格分隔）:

格式	示例	说明
`field:value`	`companyName:帮我吧`	模糊搜索（companyName/mobile/phone）
`field:value`	`serviceaccount:admin`	精确匹配（service_account/email/QQ/note/sId）
`createDT:2024-01-01`		日期等于（当天范围）
`createDT>=2024-01-01`		日期大于等于
`createDT<=2024-01-31`		日期小于等于
`field:v1,v2`	`companyName:阿里,腾讯`	多值 OR 查询

可搜索系统字段: companyName(模糊), mobile(模糊), phone(模糊), email(精确), position(精确), QQ(精确), note(精确), sId(精确), service_account(精确), serviceaccount(精确), createDT(日期), updateDT(日期)

自定义字段: 任意自定义字段名，下拉型(datatype=1)精确匹配，其他类型模糊匹配

响应示例:

{
  "results": [
    {
      "uId": "1346525",
      "companyName": "响应示例公司B",
      "status": "1",
      "createDT": "2026-08-17 17:24:33",
      "updateDT": "",
      "custom_fields": [{"key": "field_2", "value": ""}],
      "url": "https://xxx/api/v1/companies/1346525.json"
    }
  ],
  "count": "1",
  "previous_page": null,
  "next_page": "https://xxx/api/v1/companies/search.json?per_page=20&page=1&"
}

3. 批量获取公司

GET /companies/show_many.json

参数	类型	必填	默认值	说明
ids	string	是		公司 ID，逗号分隔
deStat	int	否	0	0=未删除，1=包含已删除

响应示例:

{
  "companies": [
    {
      "uId": "123",
      "companyName": "公司A",
      "province": "北京",
      "city": "丰台",
      "createDT": "2024-01-01 10:00:00",
      "status": "1",
      "custom_fields": [{"key": "field_2", "value": ""}]
    },
    {
      "uId": "456",
      "companyName": "公司B",
      "province": "",
      "city": "",
      "createDT": "2024-02-01 10:00:00",
      "status": "1",
      "custom_fields": [{"key": "field_2", "value": ""}]
    }
  ]
}

4. 获取单个公司

GET /companies/{id}.json

参数	类型	必填	默认值	说明
deStat	int	否	0	0=未删除，1=包含已删除

响应示例:

{
  "company": {
    "uId": "1346524",
    "companyName": "响应示例公司",
    "province": "",
    "city": "",
    "supportId": "0",
    "servicestarttime": "0000-00-00",
    "serviceendtime": "0000-00-00",
    "serviceCharge": "0.00",
    "serviceaccount": "",
    "servicepassword": "",
    "address": "示例地址",
    "userURL": "",
    "serveNote": "",
    "multiServiceList": "",
    "service_groupid": "",
    "createDT": "2026-08-17 17:23:59",
    "updateDT": "",
    "tableName": "",
    "userGroup": "",
    "status": "1",
    "custom_fields": [{"key": "c_company_txt", "value": "示例值"}]
  }
}

5. 获取公司服务记录

GET /companies/{id}/service_record.json

参数	类型	必填	默认值	说明
page	int	否	1	页码，最小 1
per_page	int	否	100	每页条数，最大 100
returnItemValue	int	否		自定义字段返回值类型

响应示例:

{
  "service_records": [
    {
      "sId": "记录ID",
      "recordRelationId": "关联ID",
      "supportId": "客服ID",
      "serviceType": "1",
      "callType": "1",
      "callRecordUrl": "",
      "cId": "联系人ID",
      "uId": "公司ID",
      "customerSign": "客户标识",
      "serviceStartTime": "2024-01-01 10:00:00",
      "serviceEndTime": "2024-01-01 10:30:00",
      "template": {
        "templateId": "1",
        "templateInfo": []
      }
    }
  ],
  "count": "10",
  "previous_page": null,
  "next_page": "https://xxx/api/v1/companies/123/service_record.json?per_page=50&page=2"
}

6. 创建公司

POST /companies.json
Content-Type: application/json

{
  "company": {
    "companyName": "string (公司名, 必填, 最大240字符)",
    "serviceCharge": "number (服务费余额, 正数)",
    "servicestarttime": "string (服务开始时间, 格式 Y-m-d)",
    "serviceendtime": "string (服务结束时间, 格式 Y-m-d)",
    "province": "string (省份名称, 需匹配省份表)",
    "city": "string (城市名称, 需先填 province)",
    "supportId": "int (负责客服ID, 正整数)",
    "multiServiceList": "string (多客服ID列表, 逗号分隔)",
    "service_groupid": "string (受理客服组ID列表, 逗号分隔)",
    "serviceaccount": "string (服务账号, 3-30字符)",
    "servicepassword": "string (服务密码, 4-30字符, 字母数字)",
    "address": "string (地址, 最大50字符)",
    "userURL": "string (网址)",
    "serveNote": "string (服务备注)",
    "custom_fields": [
      {"key": "c_company_txt", "value": "文本字段值"},
      {"key": "field_2", "value": "字段2的值"}
    ],
    "userGroup": "string (客户分组, 逗号分隔, ID或名称)",
    "tableName": "string (标签名, 逗号分隔)"
  }
}

参数	类型	必填	说明
company.companyName	string	是	公司名，最大 240 字符
company.serviceCharge	number	否	服务费余额，正数
company.servicestarttime	string	否	服务开始时间，格式 Y-m-d
company.serviceendtime	string	否	服务结束时间，格式 Y-m-d
company.province	string	否	省份名称（需匹配省份表）
company.city	string	否	城市名称（需先填 province）
company.supportId	int	否	负责客服 ID，正整数
company.multiServiceList	string	否	多客服 ID 列表，逗号分隔
company.service_groupid	string	否	受理客服组 ID 列表，逗号分隔
company.serviceaccount	string	否	服务账号，3-30 字符
company.servicepassword	string	否	服务密码，4-30 字符，字母数字
company.address	string	否	地址，最大 50 字符
company.userURL	string	否	网址
company.serveNote	string	否	服务备注
company.custom_fields	array	否	自定义字段，`[{key, value}]` 格式
company.userGroup	string	否	客户分组，逗号分隔（ID 或名称）
company.tableName	string	否	标签名，逗号分隔

URL Query 参数:

参数	类型	必填	说明
unique_key	string	否	幂等校验字段名，用于自定义字段唯一性检查

响应示例:

{
  "company": {
    "uId": "1346524",
    "companyName": "响应示例公司",
    "province": "",
    "city": "",
    "supportId": "0",
    "servicestarttime": "0000-00-00",
    "serviceendtime": "0000-00-00",
    "serviceCharge": "0",
    "serviceaccount": "",
    "servicepassword": "",
    "address": "示例地址",
    "userURL": "",
    "deStat": "0",
    "serveNote": "",
    "multiServiceList": "",
    "service_groupid": "",
    "createDT": "2026-08-17 17:23:59",
    "updateDT": "",
    "tableName": "",
    "custom_fields": [{"key": "c_company_txt", "value": "示例值"}],
    "userGroup": ""
  }
}

7. 更新公司

PUT /companies/{id}.json
Content-Type: application/json

参数同创建，全部可选。

响应示例: 同创建公司，返回更新后的公司完整对象（{"company": {...}}）。

8. 删除单个公司

DELETE /companies/{id}.json

响应示例:

{
  "uId": "1346524",
  "companyName": "响应示例公司",
  "active": "false"
}

注：删除公司会同时将其下所有联系人置为删除状态（status=3）。

9. 批量删除公司

DELETE /companies/destroy_many.json

参数	类型	必填	说明
ids	string	是	公司 ID，逗号分隔

响应示例:

{
  "companies": [
    {"uId": "123", "companyName": "公司A", "active": "false"},
    {"uId": "456", "companyName": "公司B", "active": "false"}
  ]
}

公司管理

公司接口 (Companies)#

1. 获取公司列表#

2. 搜索公司#

3. 批量获取公司#

4. 获取单个公司#

5. 获取公司服务记录#

6. 创建公司#

7. 更新公司#

8. 删除单个公司#

9. 批量删除公司#

公司接口 (Companies)

1. 获取公司列表

2. 搜索公司

3. 批量获取公司

4. 获取单个公司

5. 获取公司服务记录

6. 创建公司

7. 更新公司

8. 删除单个公司

9. 批量删除公司