POST /CCSQM/rest/ccisqm/v1/scenariomanage/queryAllScenario

Scenario

This interface is invoked to query all business scenarios.

Method

POST

URI

https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/scenariomanage/queryAllScenario (For example, the domain name is service.besclouds.com.)

Request Description

**Table 1** Request header parameters
No.	Parameter	Type	Mandatory or Not	Description
1	Content-Type	String	No	The value is fixed to application/json; charset=UTF-8.
2	x-app-key	String	No	App key
3	Authorization	String	Yes	Authentication field. The format is Bearer {Value of AccessToken* returned by the tokenByAkSk interface}. (A space is required after Bearer*.)
4	x-UserId	String	Yes	Operator ID You can sign in to the system and go to the employee management page to view the value of userId returned by an interface.

**Table 2** Request body parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	limit	Number	Yes	Number of records on each page
1.2	page	Number	Yes	Page number
1.3	scenarioName	String	No	Business scenario name
1.4	scenarioStatus	String	No	Whether to enable a business scenario. The options are 0 (no) and 1 (yes).
1.5	startTime	String	No	Creation start time
1.6	endTime	String	No	Creation end time

Response Description

Status code: 200

**Table 3** Response body parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	total	Number	No	Total number of query results
1.2	data	Array [Object]	No	Business scenario query result object
1.2.1	group_id	String	Yes	Business scenario ID
1.2.2	group_name	String	No	Business scenario name
1.2.3	is_enable	Number	Yes	Whether to enable a business scenario. The options are 0 (no) and 1 (yes).
1.2.4	create_time	Number	Yes	Time when a business scenario is created
1.2.5	description	String	No	Business scenario description
1.2.6	other	Object	No	Overall call filter conditions of a scenario
1.2.6.1	call_from	Number	No	Call start time. The value is a timestamp, in seconds.
1.2.6.2	call_end	Number	No	Call end time. The value is a timestamp, in seconds.
1.2.7	rule_count	Number	No	Total number of configured inspection rules
1.2.8	ignore_sensitive	Number	No	Whether to calculate the points deducted for sensitive words. The options are 0 (yes) and 1 (no).
1.2.9	interaction_type	Number	No	Inspection type 0 or empty: voice 2: multimedia

Status code: 400
Incorrect request. Check the request path and parameters.
Status code: 401
Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.
Status code: 404
The requested content is not found. Check the request path.
Status code: 500
Business failure. Check the values of parameters in the request.

Error Codes

None

Example

Scenario: Query all business scenarios.

Request header:

x-app-key:************************************  
X-UserID:1611917095665261978  
Authorization:Bearer ********************************

Request parameters:

{
    "limit": 10,
    "page": 1,
    "scenarioName": null,
    "startTime": null,
    "endTime": null,
    "scenarioStatus": null
}

Response parameters:

{
	"total": 1,
	"data": [{
		"tenant_id": "202106114153",
		"silence_rules": ["920806740809748480"],
		"other": {},
		"speed_rules": [],
		"interposal_rules": [],
		"create_time": 1623391966,
		"group_name": "test3",
		"ignore_sensitive": 0,
		"is_enable": 1,
		"description": "3",
		"rules": [],
		"group_id": "groupid_1760cfbb-e24c-4c9f-92f7-2701f154577c",
		"rule_count": 1
	}]
}

Parent topic: scenariomanage

Previous topic: POST /CCSQM/rest/ccisqm/v1/scenariomanage/updateScenario

Next topic: qualitycheckmanage