查询工单列表
描述
按照条件查询工单列表机机接口。
接口方法
POST
接口URI
https://域名/service/AICC__Case/1.0.0/openapi/case/list,例如域名是service.besclouds.com。
请求说明
| 序号 | 名称 | 参数类型 | 是否必选 | 说明 |
|---|---|---|---|---|
| 1 | Content-Type | string | True | 消息正文的类型为JSON |
| 2 | access-token | string | True | 用户访问租间token,参见鉴权配置机机接口(SaaS集成) |
| 序号 | 名称 | 参数类型 | 长度(字节) | 是否必选 | 说明 |
|---|---|---|---|---|---|
| 1 | title | string | 128 | False | 工单标题 |
| 2 | status | string | - | False | 工单流程 dataType : SingleSelect 枚举值: 0.Completed(默认值) 其他值在业务自定义。 |
| 3 | priority | string | - | False | 优先级 dataType : SingleSelect 枚举值: 0.低 1.中 2.高 3.严重 |
| 4 | origin | string | - | False | 工单来源 0.邮件 1.语音 2.网页 3.Whatsapp |
| 5 | ownerId | string | 20 | False | 工单责任人 |
| 6 | type | string | 20 | False | 工单类型,业务自定义 |
| 7 | contactId | string | 20 | False | 工单联系人id |
| 8 | contactPhone | string | 20 | False | 客户联系人号码 |
| 9 | creatorId | string | 20 | False | 创建人 |
| 10 | startTime | string | - | False | 起始时间,时间格式为YYYY-MM-DD HH:mm:ss |
| 11 | endTime | string | - | False | 结束时间,时间格式为YYYY-MM-DD HH:mm:ss,起始时间最大间隔为31天 |
| 12 | start | number | - | True | 起始行数。(min:0) |
| 13 | limit | number | - | True | 本次查询要求返回的行数(min:1,max:100) |
| 14 | classification | string | - | False | 工单分类:
|
| 15 | queueId | string | - | False | 队列id |
| 16 | caseNo | string | - | False | 工单编号 |
| 17 | isReopen | boolean | - | False | 是否重启 |
| 18 | isDirectResponse | boolean | - | False | 是否直接答复 |
| 19 | resumenType | string | - | False | 工单分类:
|
| 20 | isExport | boolean | - | False | 是否是导出数据查询 |
| 21 | locale | string | - | False | 当前语言 |
| 22 | processStatus | string | - | False | 高级流程状态 |
| 23 | state | string | - | False | 工单流程 |
| 24 | interactionId | string | - | False | 工单关联接触记录id |
| 25 | contactNumber | string | - | False | 联系人号码 |
如果查询工单列表涉及的工单类别使用了自定义的工单模板,则工单模板上扩展的字段可继续在请求消息体中继续往后添加。
响应说明
- 响应状态码: 200
| 序号 | 名称 | 参数类型 | 是否必选 | 说明 |
|---|---|---|---|---|
| 1 | caseList | object[] | True | 工单信息,字段为工单主表的字段,可以支持动态扩展,参见表4 |
| 2 | count | number | True | 符合条件的总数 |
| 序号 | 名称 | 参数类型 | 是否必选 | 说明 |
|---|---|---|---|---|
| 1 | id | string | True | 工单id |
| 2 | caseNo | string | True | 工单编号 |
| 3 | title | string | True | 工单名称 |
| 4 | type | string | True | 工单类型id |
| 5 | typeName | string | False | 工单类型名称 |
| 6 | extternalNo | string | False | 外部工单编号 |
| 7 | status | string | True | 工单流程 |
| 8 | state | string | True | 工单状态 |
| 9 | isUpgraded | boolean | False | 工单是否升级 |
| 10 | priority | string | False | 工单等级 |
| 11 | origin | string | True | 工单来源 |
| 12 | reason | string | False | 工单原因分类 |
| 13 | stayDate | DateTime | False | 当前状态的停留时间 |
| 14 | suspendDate | DateTime | False | 工单暂停时间 |
| 15 | suspendAccumulatedTime | number | False | 工单累计暂停时长 |
| 16 | contactId | string | True | 工单联系人 |
| 17 | ownerType | string | True | 处理人类型 |
| 18 | ownerId | string | True | 当前处理人或者组 |
| 19 | ownerName | string | True | 当前处理人姓名 |
| 20 | parentId | string | False | 父工单 |
| 21 | contactPhone | string | False | 联系人电话 |
| 22 | dueDate | DateTime | False | 期望处理完成时间 |
| 23 | closedDate | DateTime | False | 关单时间 |
| 24 | creatorId | string | True | 工单创建人 |
| 25 | createdDate | DateTime | True | 创建时间 |
| 26 | contactName | string | False | 关联客户名称 |
| 27 | contactCode | string | False | 关联客户code |
| 28 | isReopen | boolean | False | 是否重启 |
| 29 | isSlAExpired | boolean | False | 是否sla超期 |
| 30 | processStatus | string | False | 高级流程状态 |
| 31 | processInsID | string | False | 高级流程实例id |
| 32 | isDirectResponse | boolean | False | 是否直接答复 |
| 33 | interactionId | string | False | 接触记录id |
| 34 | contactNumber | string | False | 联系人号码 |
| 35 | caseProcessStatus | string | False | 工单bpm实例当前流程 |
| 36 | caseProcessStatusName | string | False | 工单bpm实例当前流程名称 |
| 37 | isFSMStatus | boolean | False | 是否是高级工单 |
| 38 | caseFSMStatus | string | False | 工单高级流程 |
| 39 | createdTime | string | False | 创建时间 |
| 40 | contactName1 | string | False | 超出255长度的客户名称 |
| 41 | smartCareContent | string | False | 深度定界详情 |
| 42 | description | string | False | 工单描述 |
消息样例
场景描述:查询工单列表
URL:https://域名/service/AICC__Case/1.0.0/openapi/case/list
- 请求头:
{
"Content-Type": "application/json",
"access-token": "0000000000************7bm63KsRmEztTvyA="
} - 请求体:
{ "start": 0, "limit": 10, "classification": "Todo", "origin": "webchat", "priority": "Critical", "ownerId": "10gg000001FndWngIKPo", "type": "cvmC000001MpovlebAjw", "title": "32323", "caseNo": "213213", "contactPhone": "2312321", "isReopen": true, "isDirectResponse": true, "interactionId": "3213232", "startTime": "2025-06-04 00:00:00", "endTime": "2025-06-05 00:00:00", "state": "Completed" }
- 响应头:
{ "connection": "keep-alive",
"Content-Length": "16",
"Content-Type": "application/json%3Bcharset=UTF-8"} - 响应参数:
{ "resCode": "0", "resMsg": "success", "result": [{ "caseList": [{ "caseFSMStatus": null, "caseNo": "000000000000002", "caseProcessStatus": null, "caseProcessStatusName": null, "closedDate": null, "closedReason": "", "contactCode": null, "contactId": null, "contactName": null, "contactName1": "", "contactNumber": null, "contactPhone": null, "createdDate": "2025-05-28 17:18:25", "creatorId": { "id": "10gg000001EmpSz1705I", "name": "huang1" }, "description": "", "dueDate": null, "extternalNo": null, "id": "c6m8000001NDb0Zc6Ats", "interactionId": null, "isDirectResponse": null, "isFSMStatus": false, "isReopen": false, "isSlAExpired": false, "isUpgraded": false, "origin": null, "ownerId": { "id": "10gg000001EmpSz1705I", "name": "huang1" }, "ownerType": "user", "parentId": null, "priority": null, "processInsID": null, "processStatus": null, "reason": null, "smartCareContent": "", "state": "Processing", "status": "", "stayDate": null, "suspendAccumulatedTime": null, "suspendDate": null, "title": "case0528", "type": { "id": "cvmC000001NDaxRc7ZC4", "name": "type0528" }, "type.__objectType": "AICC__CaseType__CST", "type.name": "" }], "count": 1 }] }