七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
系统设置自定义字段

回调更新自定义字段枚举

用于外部系统回调更新自定义字段。fieldId 必填。单选/多选字段传 description,description 是 JSON 数组字符串;级联字段传 parentId 和 categoryList。若仅传 fieldId 且字段为 API 配置模式,将按字段配置的 API 地址执行全量覆盖更新。

请求参数

名称类型必填描述示例值
appKeystring是应用 AppKey
timeint64是请求时间戳(秒)
checksumstring是请求签名校验和
checksumAlgorithmint32否签名算法:0 - 默认(SHA1),1 - SHA256

请求体

名称类型必填描述示例值
fieldIdint64是自定义字段 ID10001
parentIdint64否级联字段父级枚举 ID;更新第一级枚举时传 0。非级联字段不需要传。0
categoryListobject[]否级联字段枚举项列表,每项需包含 id 和 name;当 categoryList 或 description 非空时更新传入的枚举项。[{"id":100001,"name":"华东"},{"id":100002,"name":"华南"}]
└opIdstring否数据项 ID。单选/多选字段由 description 中的 opId 指定;级联字段不需要传。high
└idint64否枚举项 ID。级联字段使用真实分类 ID;单选/多选字段查询枚举值时使用从 0 开始的序号。100001
└namestring否枚举项名称高意向
└childrenobject[]否子枚举项,仅级联字段可能返回[{"id":100101,"name":"上海","disabled":false}]
└opIdstring否数据项 ID。单选/多选字段由 description 中的 opId 指定;级联字段不需要传。high
└idint64否枚举项 ID。级联字段使用真实分类 ID;单选/多选字段查询枚举值时使用从 0 开始的序号。100001
└namestring否枚举项名称高意向
└childrenobject[]否子枚举项,仅级联字段可能返回[{"id":100101,"name":"上海","disabled":false}]
└disabledboolean否是否禁用;未返回时可按 false 处理。false
└disabledboolean否是否禁用;未返回时可按 false 处理。false
descriptionstring否单选/多选字段枚举定义的 JSON 数组字符串。数组元素格式为 {"text":"显示文案","opId":"数据项ID"};如果任一元素有 opId,则所有元素 opId 都必须非空、不能重复,长度不能超过配置上限(默认 60)。[{"text":"高意向","opId":"high"},{"text":"低意向","opId":"low"}]

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
dataobject自定义字段详情{"id":10001,"name":"客户意向","type":1,"description":"[{\"text\":\"高意向\",\"opId\":\"high\"}]","updateTime":1739347200000,"status":0}
└idint64自定义字段 ID10001
└namestring自定义字段名称客户意向
└typeint32字段类型:1-单选,2-多选,6-级联。/queryCustomField 当前只返回这三类字段。1
└descriptionstring字段描述。单选/多选字段通常是枚举项 JSON 数组字符串,元素包含 text 和可选 opId;级联字段可能为空。[{"text":"高意向","opId":"high"},{"text":"低意向","opId":"low"}]
└updateTimeint64字段更新时间,毫秒时间戳1739347200000
└statusint32字段状态:0-正常,1-删除0
└categoryItemobject[]级联字段枚举树;仅级联字段可能返回[{"id":100001,"name":"华东","disabled":false,"children":[{"id":100101,"name":"上海","disabled":false}]}]
└opIdstring数据项 ID。单选/多选字段由 description 中的 opId 指定;级联字段不需要传。high
└idint64枚举项 ID。级联字段使用真实分类 ID;单选/多选字段查询枚举值时使用从 0 开始的序号。100001
└namestring枚举项名称高意向
└childrenobject[]子枚举项,仅级联字段可能返回[{"id":100101,"name":"上海","disabled":false}]
└opIdstring数据项 ID。单选/多选字段由 description 中的 opId 指定;级联字段不需要传。high
└idint64枚举项 ID。级联字段使用真实分类 ID;单选/多选字段查询枚举值时使用从 0 开始的序号。100001
└namestring枚举项名称高意向
└childrenobject[]子枚举项,仅级联字段可能返回[{"id":100101,"name":"上海","disabled":false}]
└disabledboolean是否禁用;未返回时可按 false 处理。false
└disabledboolean是否禁用;未返回时可按 false 处理。false

错误码

状态码描述
14001AppKey 不存在
14002checksum 校验失败
14003time 缺失,或请求时间戳与服务器时间误差超过 10 分钟
14004请求体不是合法 JSON 对象;或 fieldId 缺失
14500服务内部异常;字段不存在、请求字段类型不符合要求或服务处理失败
19100字段同步中;字段为手动配置模式不允许回调更新;或其它自定义字段通用业务错误
19104description 中存在 opId 时,某个数据项 opId 为空或长度超过配置上限
19106description 中存在重复 opId
postEndpoint
/openapi/customfield/callback
POST
/openapi/customfield/callback
curl -X POST "https://qiyukf.com/openapi/customfield/callback?appKey=9f1d7c2b8a6e4d3c&time=1739347200&checksum=a1b2c3d4e5f607182930abcdefabcdef&checksumAlgorithm=0" \  -H "Content-Type: application/json" \  -d '{    "fieldId": 10001  }'
{
  "code": 200,
  "data": {
    "id": 10001,
    "name": "客户意向",
    "type": 1,
    "description": "[{\"text\":\"高意向\",\"opId\":\"high\"}]",
    "updateTime": 1739347200000,
    "status": 0
  }
}
{
  "code": 14001,
  "message": "AppKey 不存在"
}
{
  "code": 14002,
  "message": "checksum 校验失败"
}
{
  "code": 14003,
  "message": "time 缺失,或请求时间戳与服务器时间误差超过 10 分钟"
}
{
  "code": 14004,
  "message": "请求体不是合法 JSON 对象;或 fieldId 缺失"
}
{
  "code": 14500,
  "message": "服务内部异常;字段不存在、请求字段类型不符合要求或服务处理失败"
}
{
  "code": 19100,
  "message": "字段同步中;字段为手动配置模式不允许回调更新;或其它自定义字段通用业务错误"
}
{
  "code": 19104,
  "message": "description 中存在 opId 时,某个数据项 opId 为空或长度超过配置上限"
}
{
  "code": 19106,
  "message": "description 中存在重复 opId"
}

这篇文档有帮助吗?