Querying the Case List

Description

This is a machine-machine interface for querying the case list based on conditions.

Method

POST

URI

https://Domain name/service/AICC__Case/1.0.0/openapi/case/list (For example, the domain name is service.besclouds.com.)

Request Description

**Table 1** Parameters in the request header
No.	Parameter	Type	Mandatory	Description
1	Content-Type	String	Yes	Request body type, which is JSON
2	access-token	String	Yes	Token for a user to access a tenant space. For details, see Authentication Machine-Machine Interface (SaaS Integrated Deployment).

**Table 2** Parameters in the request body
No.	Parameter	Type	Length (Bytes)	Mandatory	Description
1	title	String	128	No	Case title
2	status	String	-	No	Case status dataType: SingleSelect Value range: 0. Completed (default value) Other values are defined by the business side.
3	priority	String	-	No	Priority dataType: SingleSelect Value range: 0. Low 1. Medium 2. High 3. Critical
4	origin	String	-	No	Case source 0. Email 1. Voice 2. webchat 3. Whatsapp
5	ownerId	String	20	No	Case owner
6	type	String	20	No	Case type, which is customized by the business side
7	contactId	String	20	No	Case contact ID
8	contactPhone	String	20	No	Customer contact phone number
9	creatorId	String	20	No	Creator
10	startTime	String	-	No	Start time, in YYYY-MM-DD HH:mm:ss format
11	endTime	String	-	No	End time, in YYYY-MM-DD HH:mm:ss format. The interval between the start time and end time cannot exceed 31 days.
12	start	Number	-	Yes	Start row number (minimum value: 0)
13	limit	Number	-	Yes	Number of rows returned for the query (minimum value: 1; maximum value: 100)
14	classification	String	-	No	Case category Todo Follow Created Processed
15	queueId	String	-	No	Queue ID
16	caseNo	String	-	No	Case No.
17	isReopen	Boolean	-	No	Restart
18	isDirectResponse	Boolean	-	No	Direct reply
19	resumenType	String	-	No	Case category newCases finishedCases unfinishedCases overCases
20	isExport	Boolean	-	No	Export data for query
21	locale	String	-	No	Current language
22	processStatus	String	-	No	Advanced process status
23	state	String	-	No	Case process
24	interactionId	String	-	No	ID of the contact record associated with the case
25	contactNumber	String	-	No	Contact number

If the case type involved in the case list query is associated with a customized case template, extended fields in the case template can be added to the request body.

Response Description

Status code: 200

**Table 3** Parameters in the response body
No.	Parameter	Type	Mandatory	Description
1	caseList	Object []	Yes	Case information. The fields are fields in the primary case table and can be dynamically extended. For details, see Table 4.
2	count	Number	Yes	Total number of records that meet conditions

**Table 4** caseList parameters
No.	Parameter	Type	Mandatory	Description
1	id	String	Yes	Case ID
2	caseNo	String	Yes	Case No.
3	title	String	Yes	Case name
4	type	String	Yes	Case type ID
5	typeName	String	No	Case type name
6	extternalNo	String	No	External case No.
7	status	String	Yes	Case process
8	state	String	Yes	Case status
9	isUpgraded	Boolean	No	Case upgraded
10	priority	String	No	Case priority
11	origin	String	Yes	Case source
12	reason	String	No	Case reason category
13	stayDate	Datetime	No	Stay duration of the current status
14	suspendDate	Datetime	No	Case suspension time
15	suspendAccumulatedTime	Number	No	Accumulated case suspension duration
16	contactId	String	Yes	Case contact
17	ownerType	String	Yes	Handler type
18	ownerId	String	Yes	Current handler or group
19	parentId	String	No	Parent case
20	contactPhone	String	No	Contact phone number
21	dueDate	Datetime	No	Deadline
22	closedDate	Datetime	No	Case closure time
23	creatorId	String	Yes	Case creator
24	createdDate	Datetime	Yes	Creation time
25	contactName	String	No	Associated customer name
26	contactCode	String	No	Associated customer code
27	isReopen	boolean	No	Restart
28	isSlAExpired	Boolean	No	SLA expired
29	processStatus	String	No	Advanced process status
30	processInsID	String	No	Advanced process instance ID
31	isDirectResponse	Boolean	No	Direct reply
32	interactionId	String	No	Contact record ID
33	contactNumber	String	No	Contact number
34	caseProcessStatus	String	No	Current process of the case BPM instance
35	caseProcessStatusName	String	No	Current process name of the case BPM instance
36	isFSMStatus	Boolean	No	Advanced case
37	caseFSMStatus	String	No	Advanced case process
38	createdTime	String	No	Creation time
39	contactName1	String	No	Customer name exceeding 255 characters
40	smartCareContent	String	No	In-depth demarcation details
41	description	String	No	Case description

Example

Scenario: Query the case list.

URL: https://Domain name/service/AICC__Case/1.0.0/openapi/case/list

Request header

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

Request body

{
	"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"
}

Response header

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

Response parameters

{
	"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
	}]
}

Parent topic: Interface of a Single UPS

Previous topic: Creating a Case

Next topic: Querying Case Details