查询工单列表

描述

按照条件查询工单列表机机接口。

接口方法

POST

接口URI

https://域名/service/AICC__Case/1.0.0/openapi/case/list，例如域名是service.besclouds.com。

请求说明

表1 请求头参数
序号	名称	参数类型	是否必选	说明
1	Content-Type	string	True	消息正文的类型为JSON
2	access-token	string	True	用户访问租间token，参见鉴权配置机机接口(SaaS集成)

表2 请求体参数
序号	名称	参数类型	长度（字节）	是否必选	说明
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	工单分类： Todo Follow Created Processed

如果查询工单列表涉及的工单类别使用了自定义的工单模板，则工单模板上扩展的字段可继续在请求消息体中继续往后添加。

响应说明

响应状态码: 200

表3 响应体参数
序号	名称	参数类型	是否必选	说明
1	caseList	object[]	True	工单信息，字段为工单主表的字段，可以支持动态扩展，参见表4
2	count	number	True	符合条件的总数

表4 caseList参数说明
序号	名称	参数类型	是否必选	说明
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	parentId	string	False	父工单
20	contactPhone	string	False	联系人电话
21	dueDate	DateTime	False	期望处理完成时间
22	closedDate	DateTime	False	关单时间
23	creatorId	string	True	工单创建人
24	createdDate	DateTime	True	创建时间

消息样例

场景描述：查询工单列表

URL：https://域名/service/AICC__Case/1.0.0/openapi/case/list

请求头:

{
 "Content-Type": "application/json"，
 "access-token": "0000000000************7bm63KsRmEztTvyA="
}

请求体：

{
  "limit": 2,
   "start": 0
}

响应头：

{ "connection": "keep-alive",
 "Content-Length": "16",
"Content-Type": "application/json%3Bcharset=UTF-8"}

响应参数：

{ "resCode": "0", "resMsg": "成功", "result": [   {     "caseList": [       {         "caseNo": "000000000000000000000000035013",         "closedDate": null,         "contactId": "ciIy0000012YLAA4Dulc",         "contactPhone": null,         "createdDate": "2023-06-16 16:25:22",         "creatorId": "10gd000000rDybBRYkuu",         "dueDate": "2023-06-30 00:00:00",         "extternalNo": null,         "id": "c6m800000149ndrHRVNQ",         "isCanced": false,         "isSuspend": false,         "isUpgraded": false,         "origin": "Email",         "ownerId": "10gg000000sGyLvwHvOK",         "parentId": null,         "priority": "Critical",         "reason": null,         "state": "Processing",         "status": "y",         "stayDate": null,         "suspendAccumulatedTime": null,         "suspendDate": null,         "title": "test",         "type": "cvmC00000149NzxF1ePA",         "type.__objectType": "AICC__CaseType__CST",         "type.name": "",         "typeName": "aaa"       },       {         "caseNo": "000000000000000000000000037005",         "closedDate": null,         "contactId": "ciIy0000012mm24P7vNo",         "contactPhone": null,         "createdDate": "2023-06-16 10:47:28",         "creatorId": "10gd00000143C5ONGb0y",         "dueDate": "2023-06-30 00:00:00",         "extternalNo": null,         "id": "c6m800000149PUlLziBU",         "isCanced": false,         "isSuspend": false,         "isUpgraded": false,         "origin": "Voice",         "ownerId": "10gg0000013jLh0NEdH6",         "parentId": null,         "priority": "",         "reason": null,         "state": "Processing",         "status": "y",         "stayDate": null,         "suspendAccumulatedTime": null,         "suspendDate": null,         "title": "bb",         "type": "cvmC00000149PQzoNeq0",         "type.__objectType": "AICC__CaseType__CST",         "type.name": "",         "typeName": "bbb"       }     ],     "count": 284   } ]}

父主题： 工单处理接口(V2.0)

上一篇：创建工单

下一篇：查询工单详情