七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
工单系统

查询工单模板的自定义字段

返回指定模板下可用的字段项,并过滤不可用的自定义字段。templateId 缺失时返回 14004;模板在企业下不存在时返回 14110。

请求参数

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

请求体

名称类型必填描述示例值
templateIdint64是模板 ID30001

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
messageobject[]模板字段列表(仅含可用字段)[{"id":1001,"fieldId":81001,"name":"订单号","required":1,"type":1,"status":1,"description":"请填写订单号","prefill":"","hint":"例如:SO202407010001","customer":0}]
└idint64模板字段记录 ID1001
└fieldIdint64自定义字段定义 ID81001
└namestring字段名称订单号
└requiredint32是否必填:0-否,1-是1
└fieldTypeint32控件类型(响应字段名为 type)1
└statusint32字段状态:1-启用,2-停用1
└descriptionstring字段描述/占位提示请填写订单号
└prefillstring预填值
└hintstring输入框暗纹(placeholder)例如:SO202407010001
└customerint32访客是否可填写:0-关闭,1-开启0

错误码

状态码描述
14001AppKey 不存在
14002checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004templateId 缺失;请求体 JSON 格式错误
14110templateId 对应的模板不存在
14500服务内部异常
postEndpoint
/openapi/v2/ticket/template/fields
POST
/openapi/v2/ticket/template/fields
curl -X POST "https://qiyukf.com/openapi/v2/ticket/template/fields?appKey=string&time=0&checksum=string" \  -H "Content-Type: application/json" \  -d '{    "templateId": 30001  }'
{
  "code": 200,
  "message": [
    {
      "id": 1001,
      "fieldId": 81001,
      "name": "订单号",
      "required": 1,
      "type": 1,
      "status": 1,
      "description": "请填写订单号",
      "prefill": "",
      "hint": "例如:SO202407010001",
      "customer": 0
    }
  ]
}
{
  "code": 14001,
  "message": "AppKey 不存在"
}
{
  "code": 14002,
  "message": "checksum 校验失败"
}
{
  "code": 14003,
  "message": "请求时间戳与服务器时间误差超过 10 分钟"
}
{
  "code": 14004,
  "message": "templateId 缺失;请求体 JSON 格式错误"
}
{
  "code": 14110,
  "message": "templateId 对应的模板不存在"
}
{
  "code": 14500,
  "message": "服务内部异常"
}

这篇文档有帮助吗?