工单系统
完结工单
将工单标记为已完结状态,用于对已处理完成的工单执行完结操作。支持普通完结和画布流程引擎完结两种模式。画布流程模式下 nodeId 必须传入;工单状态为「待处理」或「已完结」时拒绝操作。普通模式无需传 nodeId。两种模式均会先校验工单是否已被删除。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | |
| time | int64 | 是 | 请求时间戳(秒) | |
| checksum | string | 是 | 请求签名校验和 | |
| checksumAlgorithm | int32 | 否 | 签名算法:0 - 默认(SHA1),1 - SHA256 |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ticketId | int64 | 是 | 工单 ID | 123456 |
| staffId | int64 | 是 | 操作坐席 ID | 10001 |
| comment | string | 否 | 完结备注 | 退款已到账,问题处理完成。 |
| attachments | string | 否 | 附件列表 JSON 字符串,每项:{type, payload, fileName} | [{"type":2,"payload":"openapi/attachments/2024/07/refund-proof.pdf","fileName":"退款凭证.pdf"}] |
| nodeId | int64 | 否 | 画布流程节点执行记录 ID(画布模式必填) | 567890 |
| groupId | int64 | 否 | 画布流程当前节点所属客服组 ID | 20001 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | string | 提示信息:成功时为业务数据,失败时为错误描述 | true |
错误码
| 状态码 | 描述 |
|---|---|
| 14004 | ticketId 或 staffId 为空;画布模式下 nodeId 为空;工单状态不合法;JSON 格式错误 |
| 14100 | staffId 不存在或已停用 |
| 14106 | 工单已被删除 |
| 14500 | 服务内部异常 |
postEndpoint
/openapi/v2/ticket/finishcurl -X POST "https://qiyukf.com/openapi/v2/ticket/finish?appKey=string&time=0&checksum=string" \ -H "Content-Type: application/json" \ -d '{ "ticketId": 123456, "staffId": 10001 }'{
"code": 200,
"message": "true"
}{
"code": 14004,
"message": "ticketId 或 staffId 为空;画布模式下 nodeId 为空;工单状态不合法;JSON 格式错误"
}{
"code": 14100,
"message": "staffId 不存在或已停用"
}{
"code": 14106,
"message": "工单已被删除"
}{
"code": 14500,
"message": "服务内部异常"
}这篇文档有帮助吗?