1. 公司字段
帮我吧API接口文档v1
  • 接口地图
  • 一、快速入门
    • 帮我吧数据接口 - 开发向导
    • 1.1 获取 Token
      POST
  • 二、核心业务实体
    • 2.1 客户与联系人
      • 联系人管理
        • 获取联系人列表
        • 获取多个联系人详情
        • 批量联系人详情
        • 搜索联系人
        • 创建联系人
        • 修改联系人
        • 删除联系人
        • 批量删除联系人
      • 客户分组
        • 获取分组列表
        • 获取分组详情
        • 批量分组详情
        • 创建分组
        • 修改分组
        • 获取分组用户
      • 联系人字段
        • 获取联系人字段列表
      • 公司管理
        • 获取公司列表
        • 获取公司详情
        • 批量公司详情
        • 创建公司
        • 修改公司
        • 删除公司
        • 批量删除公司
        • 搜索公司
      • 公司字段
        • 获取公司字段列表
          GET
        • 获取公司联系人
          GET
      • 远程 ID 管理
        • 获取远程ID信息
        • 修改远程ID备注
        • 远程ID绑定联系人
        • 解绑远程 ID
    • 2.2 工单
      • 工单管理
        • 获取工单列表
        • 获取工单详情
        • 批量工单详情
        • 搜索工单
        • 创建工单
        • 修改工单
        • 批量修改工单
        • 工单拆单
      • 工单回复
        • 获取工单回复列表
      • 工单附件
        • 上传工单附件
      • 工单字段
        • 获取工单自定义字段
        • 获取工单所有字段
        • 覆盖字段选项
        • 更新字段选项
        • 删除字段选项
      • 工单模板
        • 获取模板列表
        • 批量工单模板
        • 获取模板详情
        • 获取模板字段
      • 工单查询器
        • 获取查询器列表
        • 获取查询器详情
        • 获取查询器的工单列表
        • 获取查询器的工单总数
        • 批量获取查询器工单数量
    • 2.3 服务记录
      • IM 服务记录
        • 获取 IM 聊天记录
        • 获取 IM 会话列表
        • 获取 IM 会话详情
        • 获取服务总结(IM)
      • CC 服务记录
        • 获取呼叫中心记录列表
        • 获取呼叫中心记录详情
        • 获取指定客服的通话记录列表
        • 获取服务总结(CC)
        • 录音解冻
      • 远程协助记录
        • 获取远程记录列表
        • 获取坐席远程记录
        • 获取远程记录的聊天记录
        • 获取服务总结(远程协助)
      • 服务总结
        • 获取业务模板列表
        • 获取业务模板详情
        • 获取业务记录列表
        • 获取业务记录详情
        • 修改业务记录
    • 2.4 知识库
      • 知识库条目
        • 获取知识库列表
        • 获取知识库详情
        • 获取多条知识库
        • 创建知识库
        • 修改知识库
        • 上传知识库附件
      • 知识库分类
        • 获取知识库分类列表
        • 新增知识库分类
        • 修改知识库分类
        • 删除知识库分类
      • 附件上传
        • 上传附件
  • 三、人员与组织
    • 3.1 客服管理
      • 获取客服列表
      • 获取客服详情
      • 搜索客服
      • 获取多个客服信息
      • 创建客服
      • 修改客服信息
      • 删除客服信息
      • 恢复删除的客服
      • 客服授权
      • 查看客服状态
      • 修改客服状态
      • 获取客服签到列表
      • 创建客服签到
      • 获取客服排班列表
      • 新增客服排班
      • 更新客服排班
      • 删除客服排班
    • 3.2 客服组管理
      • 获取客服组列表
      • 获取客服组详情
      • 获取客服组下的客服
      • 创建客服组
      • 修改客服组
      • 删除客服组
  • 四、系统配置
    • 4.1 表单管理
      • 获取表单列表
      • 获取表单详情
      • 创建表单
      • 修改表单
      • 删除表单
    • 4.2 表单字段
      • 查询指定表单的字段列表
      • 表单字段选项增加、更新
    • 4.3 资产表
      • 获取指定资产表的所有数据
      • 给指定资产表添加一行数据
      • 给指定资产表添加多行数据
      • 根据唯一值更新指定资产表一行数据
      • 更新指定资产表一行数据
      • 删除一行数据
      • 搜索资产表中的资产数据
    • 4.4 自定义字段配置
      • 查询联系人字段列表
      • 查询公司字段列表
      • 查询工单自定义字段列表
      • 查询工单字段列表(包含系统字段)
      • 下拉字段选项全量覆盖
      • 新增、修改字段选项内容
      • 删除字段选项内容
    • 4.5 客服分组管理
      • 获取客服分组列表
      • 获取客服分组详情
      • 创建客服分组
      • 修改客服分组
      • 删除客服分组
    • 4.6 工单查询器管理
      • 获取查询器列表
      • 获取查询器详情
      • 获取查询器的工单列表
      • 获取查询器的工单总数
      • 批量获取查询器工单数量
    • 4.7 工单模板管理
      • 获取模板列表
      • 批量工单模板
      • 获取模板详情
      • 获取模板字段
    • 4.8 客户分组管理
      • 获取分组列表
      • 获取分组详情
      • 批量分组详情
      • 创建分组
      • 修改分组
      • 获取分组用户
    • 4.9 短信接口
      • 获取模板列表
      • 发送短信
    • 4.10 服务商设置
      • 获取服务商账号到期时间
    • 4.11 外部扩展集成
      • 扩展系统配置文档
      • 扩展页接口文档
      • 适用客户
  • 五、呼叫中心
    • 5.1 获取客服话机状态
      • 获取客服话机状态
    • 5.2 接听模式切换
      • 切换接听模式
    • 5.3 SDK网页集成(CC)
      • 适用场景
      • 快速集成
      • 高级对接
  • 六、在线客服
    • 6.1 SDK网页集成(IM)
      • 适用场景
      • 快速集成
      • 高级对接
  • 七、公共接口
    • 7.1 获取 Token
      • 获取 OAuth2 Token
    • 7.2 标签接口
      • 获取标签列表
  1. 公司字段

获取公司字段列表

GET
https://www.bangwo8.com/api/v1/companies/company_fields.json
最后修改时间:2026-04-06 05:16:25
责任人:未设置
获取公司自定义字段

公司字段说明#

名称类型注释
idint字段id,字段在创建的时候由系统自动分配,系统字段默认为1
urlvarchar字段的资源url
namevarchar字段名字
keyvarchar字段的唯一标识
typeint字段类型,取值为:1-下拉列表2-单行文本3-多行文本4-正整数5-小数6-复选框7-正则表达式8-日期(格式为:2018-02-03)12-附件14-高级复选框17-电话类型的文本18-级联
systemtinyint是否为系统字段,取值为:1-系统字段0-自定义字段
custom_field_optionsarray展示下拉列表选项或级联目录:• 如果字段类型是下拉列表,该字段会展示下拉列表的选项• 如果字段是级联字段,会展示级联的多级目录• 其他的字段类型展示为空

外部扩展配置文档#

功能介绍#

公司外部扩展功能允许在公司自定义字段中,将单行文本字段的数据源配置为帮我吧客户档案的资产表数据。通过此功能,可以将资产表中的数据自动提取并回填到对应的公司字段中,实现数据的联动与同步。

配置地址#

点击访问配置地址

配置参数说明#

名称类型必填注释
tableIdint否资产表id注意:tableId 与 tableName 参数至少填写一个
tableNamestring否资产表唯一标识优先级说明:两个参数同时存在但指向不同资产表时,以该参数为准
cParastring是字段映射参数用于配置选中的资产中,哪些资产字段取值回填到公司的哪些字段中。格式示例:asset_field_1:company_price,_id:company_x其中 asset_field_1 为资产表字段唯一标识,company_price 和 company_x 为公司自定义字段唯一标识。特殊字段:_id 代表选中资产的对应资产 ID。多个参数时以逗号分隔
filterstring否**筛选条件(模糊搜索)**格式:资产表字段:取值逻辑:传了该参数再判断是否有值,有值则按值筛选,无值则不筛选;未传该参数也不筛选。典型用途:筛选资产表所属人的数据。示例:ownerType:company,owner:{{company.companyId}}(显示所属人为工单当前公司的所有资产数据)
displaystring否初始化显示设置****首次配置逻辑:若配置 display=asset_field_1,asset_field_2,则默认显示这两列,但可视化选项中仍展示所有字段。冲突处理:如果用户在右上角通过可视化操作选择了显示/隐藏字段(如 field_a, field_b, field_d),则以用户的可视化选择为准。偏好保存:可视化的操作以客服偏好为准,不同客服之间的选择互不影响

Filter参数使用注意事项#

在使用 filter 参数筛选资产表所属人数据时,请遵循以下规则:
1.
固定参数:必须同时传递 ownerType 和 owner 两个参数。
2.
参数依赖:如果 owner 不为空,则 ownerType 也不能为空;否则将显示所有数据。
3.
ownerType 取值:
contacter:所属人类型为联系人
company:所属人类型为公司
4.
owner 占位符取值:
联系人类型:{{user.cId}}(联系人 ID)
公司类型:{{company.companyId}}(公司 ID)
5.
非占位符场景:可直接填写具体的联系人 ID 或公司 ID 值。
6.
数据获取:该占位符获取的是当前页面的数据,而非数据库数据。
7.
空值处理:如果配置了这两个参数,但工单页面数据为空,则这两个参数不生效,将显示所有数据。

Display参数显示逻辑#

未设置 display:首次配置时默认显示所有字段,可视化选项中也默认选中所有字段。
设置了 display:首次配置时仅显示该参数指定的列,可视化选项也仅包含这些字段。
后续修改:如果已经配置过并再次添加字段参数,display 参数将不再生效,显示内容由客服的可视化操作偏好决定。

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Basic 之后拼接空格,以及经过 Base64 编码的 username:password
示例:
Authorization: Basic *****************

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://www.bangwo8.com/api/v1/companies/company_fields.json' \
--header 'Authorization: Basic <encoded-value>'

返回响应

🟢200成功
application/json
Body

示例
{}
修改于 2026-04-06 05:16:25
上一页
搜索公司
下一页
获取公司联系人
Built with