工单系统
批量修改工单自定义字段
批量修改工单自定义字段,默认最多 20 个。staffId=-1 时按访客补充材料模式处理,附件类型字段需先上传并转换为 URL;级联字段会被自动过滤,不参与修改。普通坐席模式下返回每个字段的操作结果,key 格式为 custom[recordId,fieldId]。customFields 为空时报错;字段数量超限时直接返回错误。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | |
| time | int64 | 是 | 请求时间戳(秒) | |
| checksum | string | 是 | 请求签名校验和 | |
| checksumAlgorithm | int32 | 否 | 签名算法:0 - 默认(SHA1),1 - SHA256 |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ticketId | int64 | 是 | 工单 ID | 123456 |
| staffId | int64 | 是 | 操作坐席 ID(-1 代表访客补充材料) | 10001 |
| customFields | string | 否 | 自定义字段列表 JSON 字符串,最多 20 项,每项:{id, fieldId, name, value} | [{"fieldId":81001,"name":"订单号","value":"SO202407010001"}] |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | object | 字段处理结果,字段名为自定义字段项标识,字段值为处理结果 | {"custom[91001,81001]":"true"} |
错误码
| 状态码 | 描述 |
|---|---|
| 14004 | ticketId 或 staffId 为空;customFields 为空;字段数量超过 20;附件 payload/fileName 为空;JSON 格式错误 |
| 14100 | staffId 不存在或已停用(staffId≠-1 时校验) |
| 14106 | 工单不存在 |
| 14500 | 服务内部异常 |
postEndpoint
/openapi/v2/ticket/batch/modifycurl -X POST "https://qiyukf.com/openapi/v2/ticket/batch/modify?appKey=string&time=0&checksum=string" \ -H "Content-Type: application/json" \ -d '{ "ticketId": 123456, "staffId": 10001 }'{
"code": 200,
"message": {
"custom[91001,81001]": "true"
}
}{
"code": 14004,
"message": "ticketId 或 staffId 为空;customFields 为空;字段数量超过 20;附件 payload/fileName 为空;JSON 格式错误"
}{
"code": 14100,
"message": "staffId 不存在或已停用(staffId≠-1 时校验)"
}{
"code": 14106,
"message": "工单不存在"
}{
"code": 14500,
"message": "服务内部异常"
}这篇文档有帮助吗?
修改工单单个字段
修改工单的单个字段值,每次只能修改一个字段(type 参数决定字段类型)。type=0(自定义字段):customId 与 fieldId 二选一定位记录;必填项 value 不能为空;附件类型字段需通过 getFieldValue 转换。type=2(优先级):value 必须为 2(低)、5(一般)、8(紧急)、10(非常紧急)之一;type=3(分类):传空或 0 代表未分类,否则需校验分类存在且未删除。修改前会校验工单是否已被删除。
回复工单
坐席对工单进行回复,产生一条流转记录。comment 最长 3000 字符;customerSee=true 表示访客可见,仅支持非邮件工单且模板开启了访客查询功能(queryStatus=1)。appendFields 格式为 JSON 数组,每项 typename 为自定义字段 ID 或字符串 uploadFile(对应模板文件字段),最多 50 项。有 appendFields 时 customerSee 必须为 true;工单被删除时返回对应业务错误。