工单系统
查询工单分类列表
返回企业下启用状态的工单分类列表。请求体 type 必填,目前仅支持 type=2(工单分类);其他类型返回 14200。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | |
| time | int64 | 是 | 请求时间戳(秒) | |
| checksum | string | 是 | 请求签名校验和 | |
| checksumAlgorithm | int32 | 否 | 签名算法:0 - 默认(SHA1),1 - SHA256 |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| type | int32 | 是 | 分类类型:2-工单分类,目前仅支持 2 | 2 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | object[] | 工单分类列表 | [{"id":40001,"parentId":0,"name":"售后服务","rank":1},{"id":40002,"parentId":40001,"name":"退款问题","rank":2}] |
| └id | int64 | 分类 ID | 40001 |
| └parentId | int64 | 父级分类 ID,顶级分类为 0 | 0 |
| └name | string | 分类名称 | 售后服务 |
| └rank | int32 | 分类排序值 | 1 |
错误码
| 状态码 | 描述 |
|---|---|
| 14001 | AppKey 不存在 |
| 14002 | checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | type 缺失;请求体 JSON 格式错误 |
| 14200 | 不支持的分类类型 |
| 14500 | 服务内部异常 |
postEndpoint
/openapi/category/listcurl -X POST "https://qiyukf.com/openapi/category/list?appKey=string&time=0&checksum=string" \ -H "Content-Type: application/json" \ -d '{ "type": 2 }'{
"code": 200,
"message": [
{
"id": 40001,
"parentId": 0,
"name": "售后服务",
"rank": 1
},
{
"id": 40002,
"parentId": 40001,
"name": "退款问题",
"rank": 2
}
]
}{
"code": 14001,
"message": "AppKey 不存在"
}{
"code": 14002,
"message": "checksum 校验失败"
}{
"code": 14003,
"message": "请求时间戳与服务器时间误差超过 10 分钟"
}{
"code": 14004,
"message": "type 缺失;请求体 JSON 格式错误"
}{
"code": 14200,
"message": "不支持的分类类型"
}{
"code": 14500,
"message": "服务内部异常"
}这篇文档有帮助吗?
查询工单模板的自定义字段
返回指定模板下可用的字段项,并过滤不可用的自定义字段。templateId 缺失时返回 14004;模板在企业下不存在时返回 14110。
修改工单单个字段
修改工单的单个字段值,每次只能修改一个字段(type 参数决定字段类型)。type=0(自定义字段):customId 与 fieldId 二选一定位记录;必填项 value 不能为空;附件类型字段需通过 getFieldValue 转换。type=2(优先级):value 必须为 2(低)、5(一般)、8(紧急)、10(非常紧急)之一;type=3(分类):传空或 0 代表未分类,否则需校验分类存在且未删除。修改前会校验工单是否已被删除。