工单系统
查询工单模板的自定义字段
返回指定模板下可用的字段项,并过滤不可用的自定义字段。templateId 缺失时返回 14004;模板在企业下不存在时返回 14110。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | |
| time | int64 | 是 | 请求时间戳(秒) | |
| checksum | string | 是 | 请求签名校验和 | |
| checksumAlgorithm | int32 | 否 | 签名算法:0 - 默认(SHA1),1 - SHA256 |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| templateId | int64 | 是 | 模板 ID | 30001 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | object[] | 模板字段列表(仅含可用字段) | [{"id":1001,"fieldId":81001,"name":"订单号","required":1,"type":1,"status":1,"description":"请填写订单号","prefill":"","hint":"例如:SO202407010001","customer":0}] |
| └id | int64 | 模板字段记录 ID | 1001 |
| └fieldId | int64 | 自定义字段定义 ID | 81001 |
| └name | string | 字段名称 | 订单号 |
| └required | int32 | 是否必填:0-否,1-是 | 1 |
| └fieldType | int32 | 控件类型(响应字段名为 type) | 1 |
| └status | int32 | 字段状态:1-启用,2-停用 | 1 |
| └description | string | 字段描述/占位提示 | 请填写订单号 |
| └prefill | string | 预填值 | |
| └hint | string | 输入框暗纹(placeholder) | 例如:SO202407010001 |
| └customer | int32 | 访客是否可填写:0-关闭,1-开启 | 0 |
错误码
| 状态码 | 描述 |
|---|---|
| 14001 | AppKey 不存在 |
| 14002 | checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | templateId 缺失;请求体 JSON 格式错误 |
| 14110 | templateId 对应的模板不存在 |
| 14500 | 服务内部异常 |
postEndpoint
/openapi/v2/ticket/template/fieldscurl -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": "服务内部异常"
}这篇文档有帮助吗?