查询字段定义信息
服务描述
本接口，可用于企业查询客户自定义字段定义信息
开发须知
调用本接口前，请先获取appId
服务地址
GET https://{您的专属域名}/basic/openapi/v1/customer/field/define
请求参数
| 参数 |
位置 |
类型 |
是否必填 |
说明 |
| appId |
header |
String |
Y |
应用ID |
| timestamp |
header |
String |
Y |
时间戳，毫秒 |
| sign |
header |
String |
Y |
签名 |
返回结果
BasicCustomerFieldDefineDTO
| 名称 |
说明 |
类型 |
是否必填 |
| category |
字段分类：0系统字段 1 自定义字段 |
integer (int32) |
N |
| ccWorkbench |
呼叫中心展示 0否 1是 |
integer (int32) |
N |
| code |
字段编码 |
string |
N |
| createTime |
创建时间 |
string (date) |
N |
| defaultValue |
字段默认值 |
string |
N |
| description |
字段的描述 |
string |
N |
| formType |
表单类型：1公司自定义字段，2客户自定义字段 |
integer (int32) |
N |
| id |
ID |
integer (int64) |
N |
| imWorkbench |
im工作台 0否 1是 |
integer (int32) |
N |
| isRequired |
字段是否是必填: 0否 1是 |
integer (int32) |
N |
| isSensitive |
字段是否需要脱敏：0否，1是 |
integer (int32) |
N |
| isShowSensitive |
是否在字段上显示脱敏或者不脱敏的单选框：0否，1是 |
integer (int32) |
N |
| name |
字段显示名称 |
string |
N |
| priority |
字段排序 |
integer (int32) |
N |
| remark |
字段备注 |
string |
N |
| status |
字段状态：0禁用，1启用 |
integer (int32) |
N |
| tenantId |
租户ID |
string |
N |
| type |
字段类型,0:文本,1:多行文本,2:多选下拉框,3:单选下拉框,4:复选框,5:单选框,6:数值,7:百分比,8:仅日期,9:日期和时间,10:附件,11:手机号,12:联系电话 |
integer (int32) |
N |
| typeDefine |
字段类型定义。例如定义下拉框的能够显示的可选名称，可选值。Json格式 |
string |
N |
| typeValueRange |
字段类型的可选值 |
string |
N |
返回结果示例：
{
"code" : "10000",
"data" : [
{
"category" : 1,
"ccWorkbench" : "1",
"code" : "custom_field_1",
"createTime" : "string",
"defaultValue" : "string",
"description" : "string",
"formType" : 2,
"id" : 1,
"imWorkbench" : 1,
"isRequired" : 0,
"isSensitive" : 0,
"isShowSensitive" : 0,
"name" : "string",
"priority" : 1,
"remark" : "string",
"status" : 1,
"tenantId" : "string",
"type" : 0,
"typeDefine" : "string",
"typeValueRange" : "string"
},
{
"category": 1,
"ccWorkbench": 1,
"code": "custom_field_6",
"defaultValue": "",
"description": "",
"formType": 2,
"id": 823781,
"imWorkbench": 1,
"isRequired": 0,
"name": "单选框",
"priority": 1009,
"remark": "",
"status": 1,
"tenantId": "string",
"type": 5,
"typeDefine": "{\"options\":[{\"key\":\"1\",\"value\":\"单选框1\"},{\"key\":\"2\",\"value\":\"单选框2\"},{\"key\":\"3\",\"value\":\"单选框3\"}]}",
"typeValueRange": ""
}
],
"message" : "请求成功"
}
结果码说明
| 结果码 |
说明 |
| 10000 |
请求成功 |
| 20001 |
请求失败 |
| 21002 |
认证失败,请重新登录 |
| 21012 |
用户名或密码错误 |
| 21013 |
错误超过限制,需要验证码通过 |
| 21116 |
非法的公司类型 |
| 21112 |
该账号已被注册 |
| 21114 |
激活码已过期 |
| 21115 |
激活码错误 |