1. 四、系统配置
帮我吧API接口文档v1
  • 接口地图
  • 一、快速入门
    • 帮我吧数据接口 - 开发向导
    • 1.1 获取 Token
      POST
  • 二、核心业务实体
    • 2.1 客户与联系人
      • 联系人管理
        • 获取联系人列表
        • 获取多个联系人详情
        • 批量联系人详情
        • 搜索联系人
        • 创建联系人
        • 修改联系人
        • 删除联系人
        • 批量删除联系人
      • 客户分组
        • 获取分组列表
        • 获取分组详情
        • 批量分组详情
        • 创建分组
        • 修改分组
        • 获取分组用户
      • 联系人字段
        • 获取联系人字段列表
      • 公司管理
        • 获取公司列表
        • 获取公司详情
        • 批量公司详情
        • 创建公司
        • 修改公司
        • 删除公司
        • 批量删除公司
        • 搜索公司
      • 公司字段
        • 获取公司字段列表
        • 获取公司联系人
      • 远程 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 自定义字段配置
      • 列表
        • 获取字段列表-工单
        • 获取字段列表-企业
        • 获取字段列表-联系人
        • 获取字段列表-客服
        • 获取字段列表-服务总结
        • 获取字段列表-表单/资产表
      • 创建
        • 创建-单行文本 (type=2)
        • 创建-多行文本 (type=3)
        • 创建-正整数 (type=4)
        • 创建-小数 (type=5)
        • 创建-复选框 (type=6)
        • 创建-正则表达式 (type=7)
        • 创建-日期 (type=8)
        • 创建-文件上传 (type=12)
        • 创建-下拉列表 (type=1)
        • 创建-下拉列表-带外部映射ID
        • 创建-高级复选框 (type=14)
        • 创建-级联 (type=18)
        • 创建-评分 (type=13)
        • 创建-文本电话 (type=17)
        • 创建-地理位置 (type=19)
        • 创建-表格文本 (type=21)
        • 创建-签名 (type=23)
        • 创建-支付 (type=24)
        • 创建-计算字段 (type=25)
        • 创建-日期时间 (type=26)
      • 更新
        • 更新字段-基本信息
        • 更新字段-选项列表 (type=1/14)
        • 更新字段-级联 (type=18)
        • 更新字段-文本 (type=2/3)
        • 更新字段-文件上传 (type=12)
        • 更新字段-计算字段 (type=25)
      • 删除
        • 删除字段
        • 删除字段-表单/资产表
      • 查询联系人字段列表
      • 查询公司字段列表
      • 查询工单自定义字段列表
      • 查询工单字段列表(包含系统字段)
      • 下拉字段选项全量覆盖
      • 新增、修改字段选项内容
      • 删除字段选项内容
    • 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 标签接口
      • 获取标签列表
  • 八、远程工具
    • 8.1 SDK客户端集成
      • 适用场景
      • 集成方式
  1. 四、系统配置

4.4 自定义字段配置

自定义字段 (国际化新版)#

概述#

自定义字段 CRUD 接口,支持按模块管理客服系统的自定义字段(工单、联系人、客服等)。
Base URL: /api/v1
Content-Type: application/json
认证方式(二选一):
Basic Auth — HTTP Basic Auth 头,账号密码登录
Bearer Token — OAuth2 令牌,Header: Authorization: Bearer <token>
权限: 仅管理员可操作(isAdmin)

模块与支持类型#

模块一览#

module说明对应表前缀
ticket工单FreeColumnAGent + 租户 ID
company企业companyColumnAgent + 租户 ID
contact联系人contacterColumnAgent + 租户 ID
servicer客服servicerColumnAgent + 租户 ID
service_summary服务总结FreeColumnAGent + 租户 ID
asset_table表单/资产表tableList(需传 tableId)

字段类型一览#

type名称说明输入格式
1下拉列表单选下拉,带选项列表custom_field_options + extraConfig
2单行文本短文本输入defaultValue(顶层) + extraConfig
3多行文本长文本域defaultValue(顶层) + extraConfig
4正整数正整数输入extraConfig
5小数小数输入(可设精度)extraConfig
6复选框布尔开关extraConfig
7正则表达式格式校验文本extraConfig
8日期日期选择器extraConfig
10验证码短信验证码extraConfig
11表单子表单extraConfig
12文件上传附件上传extraConfig(必填 maxUpload/maxFileSize)
13评分星级评分extraConfig
14高级复选框多选,带选项列表custom_field_options + extraConfig
16满意度评价满意度评价extraConfig
17文本电话电话输入extraConfig
18级联多级联动选择custom_field_options(树形结构)
19地理位置地图定位extraConfig
20资产关联关联资产extraConfig
21表格文本表格文本extraConfig
23签名手写签名extraConfig
24支付支付extraConfig
25计算字段表达式自动计算extraConfig(必填 expressions)
26日期时间日期+时间选择extraConfig

模块支持类型矩阵#

模块 \ 字段下拉列表单行文本多行文本正整数小数复选框正则表达式日期验证码表单文件上传评分高级复选框满意度评价文本电话级联地理位置资产关联表格文本签名支付计算字段日期时间
module✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅
ticket✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅✅-✅✅✅✅
company✅✅✅✅✅✅✅✅--✅-✅--✅-------
contact✅✅✅✅✅✅✅✅--✅-✅-✅✅-------
servicer✅✅✅✅✅✅✅✅--✅-✅--✅-------
service_summary✅✅✅✅✅✅✅✅--✅-✅--✅✅-----✅
asset_table✅✅✅✅✅✅-✅--✅✅✅--✅--✅--✅-

通用说明#

认证#

Basic Auth 或 Cookie 登录态,需管理员权限。

响应格式#

所有接口返回统一格式:
{
    "code": 0,
    "message": "success",
    "data": {}
}

关键参数说明#

参数类型说明
namestring字段标题,最长 100 字符
keystring字段唯一标识,小写字母/数字/下划线,最长 45 字符,必须含字母,创建后不可修改
typeint字段类型,创建后不可修改
descriptionstring字段描述
isRequiredint是否必选(0=非必选,1=必选,默认 0)
isReadonlyint是否只读(0=可编辑,1=只读,默认 0)
isFooterint/bool是否表尾字段(仅 asset_table 模块,默认 false)
custom_field_optionsarray选项数据(type 1/14/18 必填)
extraConfigobject额外配置(按类型不同)
i18nobject多语言翻译

API 接口#

1. 获取自定义字段列表#

GET /custom_fields?module={module}[&tableId={tableId}][&isFooter=1]
获取指定模块所有自定义字段列表。

Query Parameters#

参数类型必填说明
modulestring是模块名称
tableIdintasset_table 必填表单 ID
isFooterint否仅返回表尾字段

Response 字段说明#

字段类型说明
idint字段 ID
namestring字段标题
keystring字段标识
typeint字段类型
systemint是否系统字段(1=系统字段,0=自定义)
descriptionstring字段描述
isRequiredint是否必选(1=必选,0=非必选)
isReadonlyint是否只读(0=可编辑,1=只读)
readonly_rangeint只读范围(1=所有客服,2=客服分组,3=客服,4=当前用户)
readonly_supportstring只读范围对应的客服 ID 或分组 ID
isFooterint是否表尾字段(仅 asset_table 模块)
tabletypeint表单类型(仅 asset_table 模块)
tableIdint表单 ID(仅 asset_table 模块)
extra_configobject额外配置(按类型不同)
custom_field_optionsarray选项列表(type 1/14/18)
i18nobject多语言配置

表单类型(tabletype)#

tabletype说明
0普通
1普通表单
2评价表单
3工单资产表单
4客户管理资产表单

响应示例#

{
    "code": 0,
    "message": "success",
    "data": {
        "custom_fields": [
            {
                "id": 925433,
                "name": "客户名称",
                "key": "customer_name",
                "type": 2,
                "system": 0,
                "description": "客户公司名称",
                "isRequired": 1,
                "isReadonly": 0,
                "tabletype": 0,
                "tableId": 0,
                "isFooter": 0,
                "extra_config": {
                    "defaultValue": "",
                    "placeholder": "请输入客户名称",
                    "maxLength": "200",
                    "popover_tip": "填写完整的公司名称",
                    "showLevel": ""
                },
                "custom_field_options": [],
                "i18n": {
                    "zh_CN": {
                        "name": "客户名称",
                        "popover_tip": "填写完整的公司名称",
                        "default_value": "",
                        "placeholder": "请输入客户名称",
                        "opt_labels": {},
                        "cascade_labels": {}
                    },
                    "en_US": {
                        "name": "Customer Name",
                        "popover_tip": "Enter full company name",
                        "default_value": "",
                        "placeholder": "Enter customer name",
                        "opt_labels": {},
                        "cascade_labels": {}
                    }
                }
            }
        ]
    }
}

curl 示例#

认证方式二选一:Basic Auth 用 -u 'username:password',Bearer Token 用 -H 'Authorization: Bearer <token>'。

2. 创建自定义字段#

POST /custom_fields?module={module}[&tableId={tableId}][&isFooter=1]

通用请求参数#

字段类型必填说明
namestring是字段标题,最长 100 字符
keystring是字段标识,小写字母/数字/下划线,最长 45 字符,必须含字母
typeint是字段类型,需在模块支持范围内
descriptionstring否字段描述
isRequiredint否是否必选(0=非必选,1=必选,默认 0)
isReadonlyint否0=可编辑,1=只读(默认 0)
custom_field_optionsarraytype 1/14/18 必填选项或级联数据
extraConfigobject否额外配置
i18nobject否多语言翻译
isFooterbool否是否表尾字段(仅 asset_table 模块)

各类型创建参数详解#


type=1 下拉列表#
参数必填说明
custom_field_options是选项列表,[{key, value, externalId?}]
extraConfig.defaultValue否默认选中值
extraConfig.placeholder否占位提示
extraConfig.popover_tip否浮窗提示
extraConfig.showLevel否只读范围配置
{
    "name": "客户等级",
    "key": "customer_level",
    "type": 1,
    "description": "客户等级分类",
    "isRequired": 0,
    "custom_field_options": [
        {"key": 1, "value": "普通"},
        {"key": 2, "value": "VIP"},
        {"key": 3, "value": "VVIP"}
    ],
    "extraConfig": {
        "defaultValue": "1",
        "placeholder": "请选择客户等级"
    },
    "i18n": {
        "en_US": {
            "name": "Customer Level",
            "popover_tip": "Select customer tier",
            "placeholder": "Select tier",
            "opt_labels": {"1": "Normal", "2": "VIP", "3": "VVIP"}
        }
    }
}
带外部系统映射 ID:
{
    "name": "ERP 客户分类",
    "key": "erp_category",
    "type": 1,
    "custom_field_options": [
        {"key": 1, "value": "经销商", "externalId": "EXT_001"},
        {"key": 2, "value": "直客", "externalId": "EXT_002"}
    ]
}

type=2 单行文本#
参数必填说明
defaultValue否默认值(顶层字段,不在 extraConfig 内)
extraConfig.maxLength否最大字符数
extraConfig.placeholder否占位提示
extraConfig.popover_tip否浮窗提示
extraConfig.showLevel否只读范围配置
{
    "name": "客户名称",
    "key": "customer_name",
    "type": 2,
    "description": "客户公司全称",
    "isRequired": 0,
    "defaultValue": "默认公司名",
    "extraConfig": {
        "maxLength": "200",
        "placeholder": "请输入客户名称",
        "popover_tip": "填写完整的客户公司名称"
    }
}

type=3 多行文本#
参数同 type=2:
{
    "name": "备注信息",
    "key": "remark",
    "type": 3,
    "description": "客户备注信息",
    "isRequired": 1,
    "extraConfig": {
        "maxLength": "500",
        "placeholder": "请输入备注信息",
        "popover_tip": "补充客户相关信息"
    }
}

type=4 正整数#
参数必填说明
extraConfig.min否最小值
extraConfig.max否最大值
extraConfig.placeholder否占位提示
{
    "name": "客户人数",
    "key": "employee_count",
    "type": 4,
    "description": "企业员工人数",
    "extraConfig": {
        "min": "1",
        "max": "100000",
        "placeholder": "请输入员工人数"
    }
}

type=5 小数#
参数必填说明
extraConfig.min否最小值
extraConfig.max否最大值
extraConfig.precision否小数精度(小数位数)
extraConfig.placeholder否占位提示
{
    "name": "成交金额",
    "key": "deal_amount",
    "type": 5,
    "description": "订单成交金额",
    "extraConfig": {
        "min": "0",
        "max": "999999.99",
        "precision": "2",
        "placeholder": "请输入成交金额"
    }
}

type=6 复选框#
参数必填说明
extraConfig.defaultValue否默认值("1"=选中,"0"=未选)
extraConfig.placeholder否占位提示
{
    "name": "是否VIP",
    "key": "is_vip",
    "type": 6,
    "description": "是否为VIP客户",
    "extraConfig": {
        "defaultValue": "1"
    }
}

type=7 正则表达式#
参数必填说明
extraConfig.pattern是正则表达式
extraConfig.patternMessage否校验失败提示
extraConfig.maxLength否最大字符数
extraConfig.placeholder否占位提示
extraConfig.popover_tip否浮窗提示
{
    "name": "手机号",
    "key": "phone_number",
    "type": 7,
    "description": "客户手机号",
    "extraConfig": {
        "pattern": "^1[3-9]\\d{9}$",
        "patternMessage": "请输入正确的11位手机号",
        "maxLength": "11",
        "placeholder": "请输入手机号",
        "popover_tip": "仅支持中国大陆手机号"
    }
}

type=8 日期#
参数必填说明
extraConfig.format否日期格式(如 yyyy-MM-dd)
extraConfig.minDate否最小可选日期
extraConfig.maxDate否最大可选日期
extraConfig.defaultValue否默认值
extraConfig.placeholder否占位提示
{
    "name": "到期日期",
    "key": "expiry_date",
    "type": 8,
    "description": "合同到期日期",
    "extraConfig": {
        "format": "yyyy-MM-dd",
        "minDate": "2024-01-01",
        "maxDate": "2099-12-31",
        "placeholder": "请选择到期日期"
    }
}

type=12 文件上传#
参数必填说明
extraConfig.maxUpload是最大上传文件数(≥1)
extraConfig.maxFileSize是最大文件大小(MB,≥1)
extraConfig.popover_tip否浮窗提示
{
    "name": "附件上传",
    "key": "attachment",
    "type": 12,
    "description": "上传相关附件",
    "extraConfig": {
        "maxUpload": 5,
        "maxFileSize": 15,
        "popover_tip": "支持 jpg/png/pdf,单文件不超过 15MB"
    }
}

type=13 评分#
{
    "name": "满意度评分",
    "key": "satisfaction_score",
    "type": 13,
    "description": "客户满意度评分"
}

type=14 高级复选框#
参数必填说明
custom_field_options是选项列表,[{key, value, externalId?}]
extraConfig.defaultValue否默认选中值
extraConfig.placeholder否占位提示
extraConfig.popover_tip否浮窗提示
extraConfig.showLevel否只读范围配置
{
    "name": "兴趣爱好",
    "key": "hobbies",
    "type": 14,
    "description": "客户兴趣爱好(多选)",
    "isRequired": 1,
    "custom_field_options": [
        {"key": 1, "value": "阅读"},
        {"key": 2, "value": "运动"},
        {"key": 3, "value": "音乐"},
        {"key": 4, "value": "旅行"}
    ],
    "extraConfig": {
        "placeholder": "请选择兴趣爱好"
    }
}

type=17 文本电话#
{
    "name": "联系电话",
    "key": "contact_phone",
    "type": 17,
    "description": "客户联系电话"
}

type=18 级联#
custom_field_options 为树形嵌套结构,key 可选(不传自动分配 ID):
{
    "name": "所在地区",
    "key": "region",
    "type": 18,
    "description": "客户所在地区(省市区)",
    "isRequired": 0,
    "custom_field_options": [
        {
            "value": "北京市",
            "subset_value": [
                {
                    "value": "海淀区",
                    "subset_value": [
                        {"value": "中关村"},
                        {"value": "清华大学"}
                    ]
                },
                {"value": "丰台区"},
                {"value": "朝阳区"}
            ]
        },
        {
            "value": "上海市",
            "subset_value": [
                {"value": "浦东新区"},
                {"value": "徐汇区"}
            ]
        },
        {"value": "广东省"}
    ],
    "extraConfig": {
        "popover_tip": "选择省市区"
    },
    "i18n": {
        "en_US": {
            "name": "Region",
            "popover_tip": "Select region",
            "cascade_labels": {"1": "Beijing", "2": "Shanghai"}
        }
    }
}

type=19 地理位置#
{
    "name": "服务地址",
    "key": "service_address",
    "type": 19,
    "description": "上门服务地址"
}

type=21 表格文本(仅 asset_table)#
{
    "name": "备注列",
    "key": "remark_col",
    "type": 21,
    "description": "表格备注列"
}

type=23 签名#
参数必填说明
extraConfig.showLevel否只读范围配置
extraConfig.placeholder否占位提示
extraConfig.popover_tip否浮窗提示
{
    "name": "客户签名",
    "key": "customer_signature",
    "type": 23,
    "description": "客户手写签名确认",
    "isRequired": 0,
    "extraConfig": {
        "placeholder": "请在下方签名"
    }
}

type=24 支付#
参数必填说明
extraConfig.tableName否关联表名
extraConfig.alipay否支付宝配置
extraConfig.showLevel否只读范围配置
extraConfig.placeholder否占位提示
extraConfig.popover_tip否浮窗提示
{
    "name": "支付金额",
    "key": "payment_amount",
    "type": 24,
    "description": "在线支付金额",
    "extraConfig": {
        "tableName": "order_table",
        "placeholder": "请输入支付金额"
    }
}

type=25 计算字段#
参数必填说明
extraConfig.expressions是计算公式,用 {{field_key}} 引用其他字段
extraConfig.placeholder否占位提示
extraConfig.popover_tip否浮窗提示
{
    "name": "总价",
    "key": "total_price",
    "type": 25,
    "description": "单价×数量自动计算",
    "extraConfig": {
        "expressions": "{{unit_price}} * {{quantity}}",
        "placeholder": "自动计算总价"
    }
}

type=26 日期时间#
参数必填说明
extraConfig.datechose否日期时间模式("1"=日期+时间,默认 "1")
extraConfig.showLevel否只读范围配置
extraConfig.placeholder否占位提示
extraConfig.popover_tip否浮窗提示
{
    "name": "预约时间",
    "key": "appointment_time",
    "type": 26,
    "description": "客户预约服务时间",
    "isRequired": 0,
    "extraConfig": {
        "datechose": "1",
        "placeholder": "请选择预约时间",
        "popover_tip": "选择预约上门服务时间"
    }
}

3. 更新自定义字段#

PUT /custom_fields/{id}?module={module}[&tableId={tableId}][&isFooter=1]

约束#

约束说明
key❌ 不可变更
type❌ 不可变更
其他字段✅ 可选更新,不传的字段保持原有值

请求参数#

字段类型说明
namestring更新字段标题
descriptionstring更新字段描述
isRequiredint更新是否必选(0=非必选,1=必选)
isReadonlyint更新是否只读(0=可编辑,1=只读)
custom_field_optionsarray更新选项或级联数据(type 1/14/18)
extraConfigobject更新额外配置
i18nobject更新多语言翻译
各类型的 extraConfig 和 custom_field_options 参数同创建接口。

更新示例#

响应#

同创建接口,返回更新后的完整字段数据。

4. 删除自定义字段#

DELETE /custom_fields/{id}?module={module}[&tableId={tableId}]
删除自定义字段,同时清理国际化数据。

示例#

响应#

{
    "code": 0,
    "message": "success",
    "data": {
        "custom_fields": {
            "message": "Field deleted successfully"
        }
    }
}

extra_config 字段参考#

各类型 extra_config 响应字段#

typeextra_config 返回字段
1defaultValue, placeholder, popover_tip, showLevel, optExternalId, optVisibility, dropExternalCheckVal, maxLength
2, 3defaultValue, placeholder, popover_tip, showLevel, maxLength
4defaultValue, placeholder, popover_tip, showLevel, min, max, maxLength
5defaultValue, placeholder, popover_tip, showLevel, min, max, precision, maxLength
6defaultValue, placeholder, popover_tip, showLevel, maxLength
7defaultValue, placeholder, popover_tip, showLevel, pattern, patternMessage, maxLength
8defaultValue, placeholder, popover_tip, showLevel, format, minDate, maxDate, maxLength
12defaultValue, placeholder, popover_tip, showLevel, maxUpload, maxFileSize, maxLength
13defaultValue, placeholder, popover_tip, showLevel, maxLength
14defaultValue, placeholder, popover_tip, showLevel, adcheckbox_min, adcheckbox_max, defaultcheckboxhigthValue, optExternalId, maxLength
17defaultValue, placeholder, popover_tip, showLevel, maxLength
18defaultValue, placeholder, popover_tip, showLevel, maxLength
19defaultValue, placeholder, popover_tip, showLevel, maxLength
21defaultValue, placeholder, popover_tip, showLevel, maxLength
23defaultValue, placeholder, popover_tip, showLevel, signatureurl, maxLength
24defaultValue, placeholder, popover_tip, showLevel, tableName, alipay, maxLength
25defaultValue, placeholder, popover_tip, showLevel, expressions, maxLength
26defaultValue, placeholder, popover_tip, showLevel, datechose, maxLength
其他defaultValue, placeholder, popover_tip, showLevel, maxLength

custom_field_options 格式#

type 1 / 14 — 选项列表#

[
    {"key": 1, "value": "选项A"},
    {"key": 2, "value": "选项B"},
    {"key": 3, "value": "选项C", "externalId": "EXT_003"}
]
字段类型必填说明
keyint否选项 ID,传 0 由系统自动分配
valuestring是选项名称,最长 130 字符,同一字段内不可重复
externalIdstring否外部系统映射 ID(ERP 等)

type 18 — 级联树形结构#

[
    {
        "key": "1",
        "value": "北京市",
        "subset_value": [
            {
                "key": "3",
                "value": "海淀区",
                "subset_value": [
                    {"key": "5", "value": "中关村"},
                    {"key": "6", "value": "清华大学"}
                ]
            }
        ]
    }
]
字段类型必填说明
keystring否选项 ID,不传由系统自动分配顺序 ID
valuestring是选项名称
subset_valuearray否子级选项,可无限嵌套

多语言(i18n)#

各类型支持的可翻译字段#

typenamepopover_tipplaceholderdefault_valueopt_labelscascade_labels
1✓✓--✓-
2✓✓✓✓--
3✓✓✓✓--
6✓-----
7✓✓----
8✓-----
12✓✓----
14✓✓--✓-
18✓✓---✓
23✓✓✓---
24✓✓✓---
25✓✓✓---
26✓✓✓---
其他✓-----

自动翻译#

若不传 i18n 且租户已启用国际化,系统会自动调用 AI 翻译补充其他语言内容。

i18n 请求示例#

{
    "i18n": {
        "en_US": {
            "name": "Customer Level",
            "popover_tip": "Select customer tier",
            "placeholder": "Select tier",
            "default_value": "Normal",
            "opt_labels": {"1": "Normal", "2": "VIP", "3": "Premium"},
            "cascade_labels": {"1": "Beijing", "2": "Shanghai"}
        }
    }
}

错误码#

codemessage说明
0success成功
100047Missing module parameter缺少 module 参数
100047Invalid module: xxx无效的模块名称
100047Unsupported module: xxx不支持的模块
100047Table not found: xxx表单不存在(asset_table)
100047Field table not found for module: xxx字段表不存在
100047Failed to create field创建字段失败
110100No administrator privileges非管理员无权操作
200001Missing required fields: name, key, type缺少必填字段
200001name and key cannot be emptyname/key 不能为空
200001name max 100 charactersname 超过 100 字符
200001key max 45 characterskey 超过 45 字符
200001key cannot be modifiedkey 不可修改(PUT)
200001type cannot be modifiedtype 不可修改(PUT)
200001custom_field_options[X].value cannot be empty选项值不能为空
200001custom_field_options[X].value length must be 1-130选项值长度不合法
200001option values cannot duplicate选项值不能重复
200001extraConfig.maxUpload is required for type 12文件上传必须指定 maxUpload
200001extraConfig.maxFileSize is required for type 12文件上传必须指定 maxFileSize
200001extraConfig.expressions is required for type 25计算字段必须指定 expressions
200001adcheckbox_min cannot exceed adcheckbox_max最少可选数不能超过最多可选数
200002Unsupported field type: X该模块不支持此字段类型
200003key can only contain letters, numbers and underscoreskey 格式错误
200003key must contain at least one letterkey 必须含字母
200004Field not found字段不存在
200005key already exists: xxxkey 已存在
200005name already exists: xxxname 已存在

完整 curl 示例集#

以下示例使用 Basic Auth 方式。若使用 Bearer Token,将 -u 'username:password' 替换为 -H 'Authorization: Bearer <token>' 即可。

获取列表#

创建字段#

更新字段#

删除字段#

修改于 2026-08-13 06:39:04
上一页
搜索资产表中的资产数据
下一页
获取字段列表-工单
Built with