工单管理接口

1、创建工单。

1.1、请求路径

POST /openapi/flow/v1/order/create

1.2、请求参数

参数名参数类型是否必填备注
流程模型idtemplateIdStringYtemplateId, templateName只能有一个
创建类型createTypeIntegerY创建类型; 2 座席工号, 3 客户名称, 4 客户ID,5 客户手机号
创建类型对应值contentStringY创建类型对应值; 座席工号/客户名称/客户ID/客户手机号
工单内容dataJsonY工单内容, 工单模型属性编码kv键值对,示例:{"multi_text_wAXC_1700543422750":"test"}
客户idcustomerIdStringY工单需关联一位客户

1.3、请求示例

{ "templateId": "742554901119381504", "templateName": "", "createType": 2, "content": "6000", "data": { "text_p2jU_1701330017675": "测试文本444", "checkbox_SFpa_1701330020818":[1,3], "cascade_select_ebM6_1701657253066":["四川省","成都市","自贡市"] }, "customerId": "742554901119381504" }

1.4、响应参数

参数名参数类型备注
工单ididString
工单编号orderNoString
工单状态orderStatusInteger工单状态: 0 未提交, 10 待领取, 20 待处理, 30 完成, 40 终止, 默认待领取
创建时间createTimeStringyyyy-MM-dd HH:mm:ss

1.5、响应示例:

{ "success": true, "message": "200 ok!", "code": "200", "data": { "id": "841144181148815361", "orderNo": "2024082800001", "orderStatus": null, "satisfactionStatus": null, "businessId": null, "createTime": "2024-08-28 16:59:01" } }

2、提交工单。

2.1、请求路径

POST /openapi/flow/v1/order/commit

2.2、请求参数

参数名参数类型是否必填备注
用户工号userNumberStringY
工单流程模型idtemplateIdStringY
工单idorderIdStringY
活动节点idactivityIdStringY
活动节点名称activityNameStringN
按钮名称buttonNameStringY
备注内容notesStringN

2.3、请求示例

{
"templateId": "742554901119381504",
"userNumber": "6000",
"orderId":"742625216906276865",
"activityId":"celldc2478440fbf41f3a1b8e250230a3359",
"activityName": "处理节点",
"buttonName":"提交"
}

2.4、响应参数

字段名称字段类型字段描述
successboolean请求是否成功
messageString响应结果
codeString响应码
dataString响应文本

2.5、响应示例

{ "success": true, "message": "200 ok!", "code": "200", "data": null }

3、暂存/更新工单。

3.1、请求路径

POST /openapi/flow/v1/order/update

3.2、请求参数

参数名参数类型是否必填备注
用户工号userNumberStringY
工单流程模型idtemplateIdStringY
工单idorderIdStringY
活动节点idactivityIdStringY
活动节点名称activityNameStringN
按钮名称buttonNameStringY
备注内容notesStringN
工单内容dataJsonY工单内容, 工单模型属性编码kv键值对,示例:{"multi_text_wAXC_1700543422750":"test"}

3.3、请求示例

{
"templateId": "742554901119381504",
"userNumber": "6000",
"orderId":"742625037079687169",
"activityId":"celldc2478440fbf41f3a1b8e250230a3359",
"activityName": "处理节点",
"data": {
"text_p2jU_1701330017675": "1201测试",
"checkbox_SFpa_1701330020818":[2],
"radio_RIVM_1701347818101":1,
"number_scPj_1701347821771":666,
"dateTime_cX2Y_1701347849129":"2023-11-30 20:47:49",
"accessory_ksKQ_1701347861959": [
{
"url": "https://fs1.useasy.net/1124/customer/2023124/新建文本文档 (2).txt",
"fileName": "新建文本文档 (2).txt",
"name": "新建文本文档 (2)",
"suffix": "txt",
"type": "txt"
}
]
},
"buttonName":"更新"
}

3.4、响应参数

字段名称字段类型字段描述
successboolean请求是否成功
messageString响应结果
codeString响应码
dataString响应文本

3.5、响应示例

{ "success": true, "message": "200 ok!", "code": "200", "data": null }

4、领取工单

4.1、请求路径

POST /openapi/flow/v1/order/claim

4.2、请求参数

参数名参数类型是否必填备注
用户工号userNumberStringY
工单流程模型idtemplateIdStringY
工单idorderIdStringY
活动节点idactivityIdStringY
活动节点名称activityNameStringN
按钮名称buttonNameStringY
备注内容notesStringN

4.3、请求示例

{
"templateId": "742554901119381504",
"userNumber": "6000",
"orderId":"742625037079687169",
"activityId":"celldc2478440fbf41f3a1b8e250230a3359",
"buttonName":"更新"
}

4.4、响应参数

字段名称字段类型字段描述
successboolean请求是否成功
messageString响应结果
codeString响应码
dataString响应文本

4.5、响应示例

{ "success": true, "message": "200 ok!", "code": "200", "data": null }

5、转派工单

5.1、请求路径

POST /openapi/flow/v1/order/toAssign

5.2、请求参数

参数名参数类型是否必填备注
用户工号userNumberStringY
工单流程模型idtemplateIdStringY
工单idorderIdStringY
活动节点idactivityIdStringY
活动节点名称activityNameStringN
按钮名称buttonNameStringY
备注内容notesStringN
指派成员toUsersArray(String)N用户工号数组
指派部门toDepartmentsArray(String)N部门/服务组编号

5.3、请求示例

{
"templateId": "742554901119381504",
"userNumber": "6000",
"orderId":"742625037079687169",
"activityId":"celldc2478440fbf41f3a1b8e250230a3359",
"buttonName":"更新"
}

5.4、响应参数

字段名称字段类型字段描述
successboolean请求是否成功
messageString响应结果
codeString响应码
dataString响应文本

5.3、响应示例

6、终止工单

6.1、请求路径

POST /openapi/flow/v1/order/stop

6.2、请求参数

参数名参数类型是否必填备注
用户工号userNumberStringY
工单流程模型idtemplateIdStringY
工单idorderIdStringY
活动节点idactivityIdStringY
活动节点名称activityNameStringN
按钮名称buttonNameStringY
备注内容notesStringN
用户来源userSourceIntegerY用户来源: 1, 工程师端, 2, 用户端

6.3、请求示例

{
"templateId": "742554901119381504",
"userNumber": "6000",
"orderId":"742625037079687169",
"activityId":"celldc2478440fbf41f3a1b8e250230a3359",
"buttonName":"更新"

6.4、响应参数

字段名称字段类型字段描述
successboolean请求是否成功
messageString响应结果
codeString响应码
dataString响应文本

6.5、响应示例

{ "success": true, "message": "200 ok!", "code": "200", "data": null }

7、获取历史节点信息。

7.1、请求路径

POST /openapi/flow/v1/order/historyActivity

7.2、请求参数

参数名参数类型是否必填备注
用户工号userNumberStringY
工单流程模型idtemplateIdStringY
工单idorderIdStringY

7.3、请求示例

{
"templateId": "742554901119381504",
"userNumber": "6000",
"orderId":"742625037079687169"
}

7.4、响应参数

参数名参数类型备注
节点ididString
节点名称nameString
处理人handlerString工号
处理人名字handlerNameString
开始时间startTimeString格式:yyyy-MM-dd HH:mm:ss
结束时间endTimeString格式:yyyy-MM-dd HH:mm:ss

7.5、响应示例

{ "success": true, "message": "200 ok!", "code": "200", "data": [ { "id": "", "name": "", "handler": "", "handlerName":"", "startTime": "", "endTime": "" } ] }

8、回退工单

8.1、请求路径

POST /openapi/flow/v1/order/back

8.2、请求参数

参数名参数类型是否必填备注
用户工号userNumberStringY
工单流程模型idtemplateIdStringY
工单idorderIdStringY
活动节点idactivityIdStringY
活动节点名称activityNameStringN
按钮名称buttonNameStringY
备注内容notesStringN
目标活动idtoActivityIdStringN不传就是返回上一个节点
目标活动名称toActivityNameStringN

8.3、请求示例

{
"templateId": "742554901119381504",
"userNumber": "6000",
"orderId":"742625037079687169",
"activityId":"celldc2478440fbf41f3a1b8e250230a3359",
"buttonName":"更新"

8.4、响应参数

字段名称字段类型字段描述
successboolean请求是否成功
messageString响应结果
codeString响应码
dataString响应文本

8.5、响应示例

{ "success": true, "message": "200 ok!", "code": "200", "data": null }

9、获取当前节点活动的配置信息。

9.1、请求路径

POST /openapi/flow/v1/get/current/activity

9.2、请求参数

参数名参数类型是否必填备注
工单流程模型idtemplateIdStringY
工单idorderIdStringY

9.3、请求示例

{
"templateId": "742554901119381504",
"orderId":"752726817239625729"
}

9.4、响应参数

参数名参数类型备注
工单流程模型的idtemplateIdString
节点活动idactivityIdString
表单配置formConfigArray(JSON)
页签设置pageConfigArray(JSON)当前节点的页面配置
处理设置dealConfigJSON
表单配置JSON:
参数名参数类型备注
字段idfieldIdString
字段名称fieldNameString
字段类型fieldTypeString文本:text 富文本:multiText日期时间:dateTime数字:number单选:radio多选:checkbox用户:member部门:department
只读readonlyBoolean
必填requireBoolean
隐藏hideBoolean
页签设置JSON
参数名参数类型备注
类型typeString
名称nameString
默认名称defaultNameString
是否启用enableBoolean
处理设置JSON
参数名参数类型备注
指派方式assignTypeInteger0 跟随字段 1 固定处理人 3 自动分配
指派内容assignContentString跟随字段时(字段id) 自动分配时:范围
流转类型flowTypeInteger1 用户 2部门
节点处理人handlersArray(String)
节点处理人的默认处理人defaultHandlerString

9.5、响应示例

{ "success": true, "message": "200 ok!", "code": "200", "data": { "activityId": "", "dealConfig": null, "formConfig": [ { "fieldId": "", "fieldName": "", "fieldType": "", "hide": false, "readonly": false, "require": false } ], "pageConfig": [ { "defaultName": "", "enable": false, "name": "", "type": "" } ], "templateId": "" } }

10、查询工单流程模板列表。

10.1、请求路径

POST /openapi/flow/v1/template/list

10.2、请求参数

参数名参数类型是否必填备注
工号userNumberStringN可选参数,只查询此座席有创建权限的模板

10.3、请求示例

{
"userNumber":"6001"
}

10.4、响应参数

参数名参数类型备注
流程模板idtemplateIdString
流程模板名字templateNameString
工单表单内容配置formConfigJSON
工单表单内容配置
参数名参数类型备注
字段idfieldIdString
字段名字fieldNameString
字段类型fieldTypeString单行文本:text多行文本:multiText日期时间:dateTime数字:number单选:radio多选:checkbox人员:member部门:department
是否只读readonlyBoolean
是否必填requireBoolean
是否隐藏hideBoolean

10.5、响应示例

{ "success": true, "message": "200 ok!", "code": "200", "data": [ { "templateId": "", "templateName": "", "formConfig": { "fieldId": "", "fieldName": "", "fieldType": "", "readonly": false, "require": false, "hide": false } } ] }

11、分页查询工单列表。

11.1、请求路径

POST /openapi/flow/v1/order/pageList

11.2、请求参数

参数名参数类型是否必填备注
工号userNumberStringN可选参数,只查询与此座席相关的
客户idcustomerIdStringN可选参数,只查询与此客户相关的
查询页码pageNumberIntegerY
每页最大条数pageSizeIntegerY
创建工单开始时间createTimeBeginStringN
创建工单结束时间createTimeEndStringN
关闭工单开始时间closeTimeBeginStringN
关闭工单结束时间closeTimeEndStringN
修改工单开始时间updateTimeBeginStringN
修改工单结束时间updateTimeEndStringN

11.3、请求示例

{
"userNumber":"6000",
"pageNumber":1,
"pageSize":10
}

11.4、响应参数

参数名参数类型备注
数据列表listArray
分页返回参数pageJSON
数据列表内容
参数名参数类型备注
工单idorderIdString
工单编号orderNoString
流程模型idtemplateIdString
当前节点名称activityNameString
状态orderStatusInteger未提交:0待领取:10待处理:20完成:30终止:40挂起:50
创建时间createTimeString
修改时间updateTimeString
工单内容detailJSON
当前处理人工号masterNumberString
工单创建人工号createUserNumberString
工单修改人工号updateUserNumberString

11.5、响应示例

{ "success": true, "message": "200 ok!", "code": "200", "data": { "list": [ { "accountId": "1019", "orderId": "977664725730603009", "orderNo": "2025090900002", "orderStatus": 20, "preOrderStatus": null, "suspendIndex": null, "suspendStartTime": null, "segmentList": null, "orderCategory": "投诉 工单", "estimateStatus": 1, "assignType": 1, "master": "686299681458982912", "candidates": [ "sk_10001218" ], "source": 2, "userSource": 1, "joinList": [ "686299681458982912" ], "activityId": "celldc2478440fbf41f3a1b8e250230a3359", "activityName": "处理节点", "satisfactionConfigId": null, "templateId": "855613796286070784", "customerId": "", "customerName": null, "version": 1757384584669, "createUser": "686299681458982912", "updateUser": "686299681458982912", "updateTime": "2025-09-09 10:22:55", "createTime": "2025-09-09 10:22:55", "overTime": null, "relatedStatus": 0, "urgency": 2, "slaTargetTimestamp": 1757385064000, "followAgent": [], "associationWorkList": null, "webchatIds": [], "cdrIds": [], "id": "977664725730603009", "urgeSign": false, "detail": { "id": "977664725730603009", "multi_text_W0Xr_1728285295147": "22", "text_j2LA_1728285285388": "11", "text_Qm8G_1728285344105": "", "accessory_sHAn_1728285353031": null, "showClaim": false, "urgeInfo": null, "remark": null }, "createUserNumber": "8073", "updateUserNumber": "8073", "joinListNumber": [ "8073" ], "masterNumber": "8073" } ], "page": { "pageSize": 1, "pageNumber": 1, "totalPage": 61, "total": 61 } }, "traceId": "94ded9ab9fce42efb8dd22414745af14" }

12、查询模板表单配置明细。

12.1、请求路径

POST /openapi/flow/v1/template/getFormConfig

12.2、请求参数

参数名参数类型是否必填备注
流程模型idtemplateIdStringY

12.3、请求示例

{
"templateId":"742554901119381504"
}

12.4、响应参数

参数名参数类型备注
字段类型fieldTypeString
名称nameString
上传格式attachFormatString图片 视频 文档 音频
附件默认值defaultAttachListArray(){"fileName":"","url":""}
多选类型checkboxTypeInteger1 下拉菜单 2 平铺
单选选项optionsArray[{"key":"","value":""}]
多选默认值defaultValueCheckboxArray(Integer)
默认值defaultValueString
单选默认值defaultValueRadioInteger

12.5、响应示例

{ "success": true, "message": "200 ok!", "code": "200", "data": [ { "isChildTableField": 0, "dataFieldType": "String", "format": 1, "sort": 1, "isSystem": 0, "name": "文本", "fieldType": "text", "dataFieldName": "text_rFHy_1703146323014", "isDelete": 0, "defaultType": 1, "isFilter": 1, "fieldId": "text_rFHy_1703146323014" }, { "isChildTableField": 0, "dataFieldType": "Integer", "arrangeType": 1, "optionType": 0, "options": [ { "isDelete": 0, "value": "选项1", "key": 1 }, { "isDelete": 0, "value": "选项2", "key": 2 }, { "isDelete": 0, "value": "选项3", "key": 3 } ], "sort": 2, "isSystem": 0, "name": "单选", "fieldType": "radio", "dataFieldName": "radio_K1kQ_1703146325263", "isDelete": 0, "externalSource": { "requestType": "GET", "requestUrl": "" }, "isFilter": 1, "radioType": 1, "fieldId": "radio_K1kQ_1703146325263" } ] }

13、添加工单备注。

13.1、请求路径

POST /openapi/work/log/workNote

13.2、请求参数

参数名参数类型是否必填备注
工单IDorderIdStringY
流程模型idtemplateIdStringY
工号userNumberStringY
备注内容remarkStringY
附件attachmentArrayN[{"fileName":"","fileURL":""}]

13.3、请求示例

{
"templateId": "742554901119381504",
"userNumber": "6000",
"orderId":"742625037079687169",
"remark":"测试备注"
}

13.4、响应参数

字段名称字段类型字段描述
successboolean请求是否成功
messageString响应结果
codeString响应码
dataString响应文本

13.5、响应示例

{ "success": true, "message": "200 ok!", "code": "200", "data": null }

14、根据工单id或者工单编号查询工单。

14.1、请求路径

POST /openapi/flow/v1/order/findOne

14.2、请求参数

参数名参数类型是否必填备注
工单IDorderIdStringN
工单编号orderNoStringN

14.3、请求示例

{
"orderId":"742625037079687169",
"orderNo":"2024010200009"
}

14.3、响应参数

参数名参数类型备注
工单idorderIdString
工单编号orderNoString
流程模型idtemplateIdString
当前节点名称activityNameString
状态orderStatusInteger未提交:0待领取:10待处理:20完成:30终止:40挂起:50
创建时间createTimeString
修改时间updateTimeString
工单内容detailJSON
当前处理人工号masterNumberString
创建人工号createUserNumberString
修改人工号updateUserNumberString

14.4、响应示例

{ "success": true, "message": "200 ok!", "code": "200", "data": { "accountId": "1019", "orderId": "977664725730603009", "orderNo": "2025090900002", "orderStatus": 20, "preOrderStatus": null, "suspendIndex": null, "suspendStartTime": null, "segmentList": null, "orderCategory": "投诉 工单", "estimateStatus": 1, "assignType": 1, "master": "686299681458982912", "candidates": [ "sk_10001218" ], "source": 2, "userSource": 1, "joinList": [ "686299681458982912" ], "activityId": "celldc2478440fbf41f3a1b8e250230a3359", "activityName": "处理节点", "satisfactionConfigId": null, "templateId": "855613796286070784", "customerId": "", "customerName": null, "version": 1757384584669, "createUser": "686299681458982912", "updateUser": "686299681458982912", "updateTime": "2025-09-09 10:22:55", "createTime": "2025-09-09 10:22:55", "overTime": null, "relatedStatus": 0, "urgency": 2, "slaTargetTimestamp": 1757385064000, "followAgent": [], "associationWorkList": null, "webchatIds": [], "cdrIds": [], "id": "977664725730603009", "urgeSign": false, "detail": { "id": "977664725730603009", "multi_text_W0Xr_1728285295147": "22", "text_j2LA_1728285285388": "11", "text_Qm8G_1728285344105": "", "accessory_sHAn_1728285353031": null, "showClaim": false, "urgeInfo": null, "remark": null }, "createUserNumber": "8073", "updateUserNumber": "8073", "joinListNumber": [ "8073" ], "masterNumber": "8073" }, "traceId": "f55e033eea104b4989189bdae9c1b513" }

15、根据工单字段或客户资料/访客id查询工单。

15.1、请求路径

POST /openapi/flow/v1/order/search

15.2、请求参数

参数名参数类型是否必填备注
工单模板IDtemplateIdStringY从查询模版表单接口获取
指定搜索的字段ID列表fieldIdList<String>N从查询模板表单配置明细接口中获取
搜索关键字keywordsStringN检索文本字段中对应的关键字,支持模糊搜索(仅支持单行文本字段与多行文本字段)。客户id/访客id/和模糊搜索字段 三个任选其一
客户IDcustomerIdStringN客户ID,可从客户资料查询接口获取。客户id/访客id/和模糊搜索字段 三个任选其一
访客IDvisitorIdStringN访客ID,在线客服自定义传入的visitorId客户id/访客id/和模糊搜索字段 三个任选其一
页码pageNumberIntegerY页码
每页pageSizeIntegerY每页条数

15.3、请求示例

{ "keywords": "退款", "templateId": "tmp_1890001", "fieldId": ["field_01", "field_02"], "customerId": "cus_10001", "visitorId": "vis_20001", "pageNumber": 1, "pageSize": 10 }

15.4、响应参数

参数名参数类型备注
响应码codeString响应码,成功通常为 200
响应消息msgString
分页结果dataObject
参数名 类型 说明
records List<Object> 工单列表
total Long 总条数
pageNumber Integer 当前页码
pageSize Integer 每页条数

records 中单个工单对象为动态字段结构,常见字段包括:

字段名 类型 说明
id String 工单ID
orderNo String 工单编号
templateId String 工单模板ID
createUser String 创建人ID
createUserNumber String 创建人工号
updateUser String 更新人ID
updateUserNumber String 更新人工号
master String 负责人ID
masterNumber String 负责人工号
followAgent List<String> 关注人ID列表
followAgentNumber List<String> 关注人工号列表
joinList List<String> 参与人ID列表
joinListNumber List<String> 参与人工号列表
detail Object 工单业务字段

15.5、响应示例

{ "code": "200", "msg": "success", "data": { "records": [ { "orderId": "10000000000001", "orderNo": "GD202606150001", "templateId": "tmp_1890001", "activityName": "当前节点名称", "orderStatus": 20, "masterNumber": "6000", "detail": { "text_xxxxxxx00001": "工单内容" } } ], "total": 1, "pageNumber": 1, "pageSize": 10 } }

15.6、响应示例

{ "code": "500", "msg": "请求失败", "data": null }
2026-06-22